Bermigrasi dari Email Settings API

Dokumen ini dapat membantu memigrasikan aplikasi Anda dari Email Settings API yang tidak digunakan lagi ke Gmail API.

Mengizinkan permintaan

Seperti Email Settings API, Gmail API menggunakan protokol OAuth 2.0 untuk mengizinkan permintaan. Satu perbedaan utama adalah izin Gmail API yang dicakup ke masing-masing pengguna, bukan ke seluruh domain. Artinya, mengizinkan akun administrator domain tidak memungkinkan Anda memigrasikan email untuk pengguna lain di domain. Sebagai gantinya, Anda harus menggunakan akun layanan standar dengan otoritas di seluruh domain yang ditambahkan ke daftar yang diizinkan di konsol Google Admin untuk membuat token autentikasi yang sesuai.

Email Settings API menggunakan cakupan:

https://apps-apis.google.com/a/feeds/emailsettings/2.0/

Cakupan yang setara di Gmail API adalah:

https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing

Perubahan protokol

Email Settings API menggunakan protokol GDATA berbasis XML. Gmail API menggunakan JSON. Karena setelan sebagian besar terdiri dari pasangan nilai kunci, payload secara konseptual mirip antara versi.

Contoh pembuatan label:

Email Settings API

POST https://apps-apis.google.com/a/feeds/emailsettings/2.0/{domain name}/{username}/label
<?xml version="1.0" encoding="utf-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">
  <apps:property name="label" value="status updates" />
</atom:entry>

Gmail API

POST https://www.googleapis.com/gmail/v1/users/{username}/labels
{
   "name": "status updates"
}

Gunakan library klien yang disediakan, bukan menerapkan protokol secara langsung.

Mengelola label

Untuk mengelola label di Gmail API, gunakan resource labels.

Setelan lama Setelan baru Catatan
labelId id
label nama
unreadCount messagesUnread
visibilitas labelListVisibility SHOW kini menjadi labelShow
HIDE kini menjadi labelHide

Perubahan lainnya:

  • Saat memperbarui atau menghapus label, Gmail API mereferensikan label berdasarkan ID, bukan berdasarkan nama.

Mengelola filter

Untuk mengelola filter di Gmail API, gunakan settings.filters resource.

Setelan lama Setelan baru Catatan
dari criteria.from
hingga criteria.to
subjek criteria.subject
hasTheWord criteria.query
doesNotHaveTheWord criteria.negatedQuery
hasAttachment criteria.hasAttachment
shouldArchive action.removeLabelIds Gunakan INBOX sebagai ID label
shouldMarkAsRead action.removeLabelIds Gunakan UNREAD sebagai ID label
shouldStar action.addLabelIds Gunakan STARRED sebagai ID label
label action.addLabelIds Gunakan ID label yang akan ditambahkan
forwardTo action.forward
shouldTrash action.addLabelIds Gunakan TRASH sebagai ID label
neverSpam action.removeLabelIds Gunakan SPAM sebagai ID label

Perubahan lainnya:

  • Jika label pengguna yang akan ditambahkan belum ada, label tersebut harus dibuat secara eksplisit menggunakan metode labels.create.

Mengelola alias kirim sebagai

Untuk mengelola alias kirim sebagai di Gmail API, gunakan resource settings.sendAs.

Setelan lama Setelan baru
nama displayName
alamat sendAsEmail
replyTo replyToAddress
makeDefault isDefault

Mengelola klip web

Setelan Klip Web tidak tersedia di Gmail API.

Mengelola penerusan otomatis

Untuk mengelola penerusan otomatis di Gmail API, gunakan resource settings.

Setelan lama Setelan baru Catatan
aktifkan diaktifkan
forwardTo emailAddress
tindakan disposition KEEP kini menjadi leaveInInbox
ARCHIVE kini menjadi archive
DELETE kini menjadi trash
MARK_READ kini menjadi markRead

Perubahan lainnya:

  • Alamat penerusan harus dibuat dan diverifikasi sebelum digunakan.
  • Alamat penerusan dapat dikelola menggunakan resource settings.forwardingAddresses.

Mengelola setelan POP

Untuk mengelola akses POP di Gmail API, gunakan settings resource.

Setelan lama Setelan baru Catatan
aktifkan accessWindow Dinonaktifkan jika ditetapkan ke disabled
enableFor accessWindow ALL_MAIL kini menjadi allMail
kini menjadi MAIL_FROM_NOW_ONfromNowOn
tindakan disposition KEEP kini menjadi leaveInInbox
ARCHIVE kini menjadi archive
DELETE kini menjadi trash
MARK_READ kini menjadi markRead

Mengelola setelan IMAP

Untuk mengelola akses IMAP di Gmail API, gunakan settings resource.

Setelan lama Setelan baru
aktifkan diaktifkan

Mengelola setelan balasan otomatis saat libur

Untuk mengelola balasan otomatis saat libur di Gmail API, gunakan resource settings.

Setelan lama Setelan baru
contactsOnly restrictToContacts
domainOnly restrictToDomain
enable enableAutoReply
endDate endTime
pesan responseBodyHtml
responseBodyPlainText
startDate startTime
subjek responseSubject

Mengelola setelan tanda tangan

Untuk mengelola tanda tangan email di Gmail API, gunakan settings.sendAs resource.

Setelan lama Setelan baru
tanda tangan tanda tangan

Perubahan lainnya:

  • Tanda tangan kini dikelola per alias.

Mengelola setelan bahasa

Untuk mengelola setelan bahasa di Gmail API, gunakan settings resource.

Setelan lama Setelan baru
bahasa displayLanguage

Untuk mengetahui informasi selengkapnya, lihat Mengelola setelan bahasa.

Mengelola setelan delegasi

Untuk mengelola delegasi di Gmail API, gunakan settings.delegates resource.

Setelan lama Setelan baru
alamat delegateEmail
status verificationStatus

Perubahan lainnya:

  • Umum
    • Untuk menggunakan salah satu metode delegasi (termasuk settings.delegates.create) pengguna delegator harus diaktifkan untuk Gmail. Artinya, misalnya, pengguna delegator tidak dapat ditangguhkan di Google Workspace.
    • Alias email tidak dapat digunakan sebagai input email delegasi untuk salah satu metode baru. Pengguna delegasi harus dirujuk berdasarkan alamat email utamanya.
  • settings.delegates.create
    • Metode ini kini dapat digunakan untuk membuat hubungan delegasi di beberapa domain yang termasuk dalam organisasi Google Workspace yang sama.
    • Metode ini kini dapat digunakan untuk pengguna yang memerlukan perubahan sandi saat login berikutnya.
    • Jika berhasil, metode ini akan menampilkan settings.delegates resource dalam isi respons, bukan isi respons kosong.
    • Jika pengguna delegator atau delegasi dinonaktifkan (misalnya, ditangguhkan di Google Workspace), metode ini akan gagal dengan error HTTP 4XX, bukan error HTTP 500.
  • settings.delegates.delete
    • Metode ini kini dapat digunakan untuk menghapus delegasi dengan VerificationStatus, bukan hanya delegasi yang accepted atau expired.
  • settings.delegates.get
    • Ini adalah metode baru, yang mungkin lebih disukai daripada metode settings.delegates.list bergantung pada kebutuhan.

Mengelola setelan umum

Setelan umum tidak tersedia di Gmail API.