Gmail API

Gmail API memungkinkan Anda melihat dan mengelola data kotak surat Gmail seperti rangkaian pesan, pesan, dan label.

Layanan: gmail.googleapis.com

Untuk memanggil layanan ini, sebaiknya gunakan library klien yang disediakan Google. Jika aplikasi perlu menggunakan library Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat membuat permintaan API.

Dokumen discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca mesin untuk mendeskripsikan dan menggunakan REST API. Dokumen ini digunakan untuk membuat library klien, plugin IDE, dan alat lainnya yang berinteraksi dengan Google API. Satu layanan dapat menyediakan beberapa dokumen discovery. Layanan ini menyediakan dokumen discovery berikut:

Endpoint layanan

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan dapat memiliki beberapa endpoint layanan. Layanan ini memiliki endpoint layanan berikut dan semua URI di bawah didasarkan pada endpoint layanan ini:

  • https://gmail.googleapis.com

REST Resource: v1.users

Metode
getProfile GET /gmail/v1/users/{userId}/profile
Mendapatkan profil Gmail pengguna saat ini.
stop POST /gmail/v1/users/{userId}/stop
Menonaktifkan pengiriman notifikasi push untuk kotak surat pengguna tertentu.
watch POST /gmail/v1/users/{userId}/watch
Menyiapkan atau memperbarui pengamatan notifikasi push di kotak surat pengguna tertentu.

REST Resource: v1.users.drafts

Metode
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
Membuat draf dengan label DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
Segera dan secara permanen menghapus draf yang ditentukan.
get GET /gmail/v1/users/{userId}/drafts/{id}
Mendapatkan draf yang ditentukan.
list GET /gmail/v1/users/{userId}/drafts
Mencantumkan draf di kotak surat pengguna.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
Mengirim draf yang ada dan ditentukan kepada penerima di header To, Cc, dan Bcc.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
Menggantikan konten draf.

REST Resource: v1.users.history

Metode
list GET /gmail/v1/users/{userId}/history
Mencantumkan histori semua perubahan pada kotak surat tertentu.

REST Resource: v1.users.labels

Metode
create POST /gmail/v1/users/{userId}/labels
Membuat label.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
Segera menghapus label yang ditentukan secara permanen dan menghapusnya dari semua pesan dan rangkaian pesan yang menggunakan label tersebut.
get GET /gmail/v1/users/{userId}/labels/{id}
Mendapatkan label yang ditentukan.
list GET /gmail/v1/users/{userId}/labels
Mencantumkan semua label di kotak surat pengguna.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
Membuat patch label yang ditentukan.
update PUT /gmail/v1/users/{userId}/labels/{id}
Memperbarui label yang ditentukan.

REST Resource: v1.users.messages

Metode
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
Menghapus banyak pesan menurut ID pesan.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
Mengubah label pada pesan yang ditentukan.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
Segera menghapus pesan yang ditentukan secara permanen.
get GET /gmail/v1/users/{userId}/messages/{id}
Mendapatkan pesan yang ditentukan.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
Mengimpor pesan hanya ke kotak surat pengguna ini, dengan pemindaian dan klasifikasi pengiriman email standar yang serupa dengan penerimaan melalui SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
Memasukkan pesan secara langsung ke kotak surat pengguna ini saja, mirip dengan IMAP APPEND, dengan melewati sebagian besar pemindaian dan klasifikasi.
list GET /gmail/v1/users/{userId}/messages
Mencantumkan pesan di kotak surat pengguna.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
Mengubah label pada pesan yang ditentukan.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
Mengirim pesan yang ditentukan kepada penerima di header To, Cc, dan Bcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
Memindahkan pesan yang ditentukan ke sampah.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
Menghapus pesan yang ditentukan dari sampah.

REST Resource: v1.users.messages.attachments

Metode
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
Mendapatkan lampiran pesan yang ditentukan.

REST Resource: v1.users.settings

Metode
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
Mendapatkan setelan penerusan otomatis untuk akun yang ditentukan.
getImap GET /gmail/v1/users/{userId}/settings/imap
Mendapatkan setelan IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
Mendapatkan setelan bahasa.
getPop GET /gmail/v1/users/{userId}/settings/pop
Mendapatkan setelan POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
Mendapatkan setelan penjawab saat libur.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
Memperbarui setelan penerusan otomatis untuk akun yang ditentukan.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
Memperbarui setelan IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
Memperbarui setelan bahasa.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
Memperbarui setelan POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
Memperbarui setelan penjawab saat libur.

REST Resource: v1.users.settings.cse.identities

Metode
create POST /gmail/v1/users/{userId}/settings/cse/identities
Membuat dan mengonfigurasi identitas enkripsi sisi klien yang diizinkan untuk mengirim email dari akun pengguna.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Menghapus identitas enkripsi sisi klien.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Mengambil konfigurasi identitas enkripsi sisi klien.
list GET /gmail/v1/users/{userId}/settings/cse/identities
Mencantumkan identitas terenkripsi sisi klien untuk pengguna terautentikasi.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Mengaitkan pasangan kunci yang berbeda dengan identitas enkripsi sisi klien yang ada.

REST Resource: v1.users.settings.cse.keypairs

Metode
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
Membuat dan mengupload rantai sertifikat kunci publik S/MIME enkripsi sisi klien dan metadata kunci pribadi untuk pengguna yang diautentikasi.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Menonaktifkan pasangan kunci enkripsi sisi klien.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Mengaktifkan pasangan kunci enkripsi sisi klien yang dinonaktifkan.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Mengambil pasangan kunci enkripsi sisi klien yang ada.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
Mencantumkan pasangan kunci enkripsi sisi klien untuk pengguna yang diautentikasi.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Menghapus pasangan kunci enkripsi sisi klien secara permanen dan langsung.

REST Resource: v1.users.settings.delegates

Metode
create POST /gmail/v1/users/{userId}/settings/delegates
Menambahkan penerima delegasi dengan status verifikasinya yang ditetapkan langsung ke accepted, tanpa mengirim email verifikasi.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Menghapus penerima delegasi yang ditentukan (yang dapat memiliki status verifikasi apa pun), dan mencabut verifikasi apa pun yang mungkin diperlukan untuk menggunakannya.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
Mendapatkan penerima tugas yang ditentukan.
list GET /gmail/v1/users/{userId}/settings/delegates
Mencantumkan penerima delegasi untuk akun yang ditentukan.

REST Resource: v1.users.settings.filters

Metode
create POST /gmail/v1/users/{userId}/settings/filters
Membuat filter.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
Menghapus filter yang ditentukan secara langsung dan permanen.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
Mendapatkan filter.
list GET /gmail/v1/users/{userId}/settings/filters
Mencantumkan filter pesan pengguna Gmail.

REST Resource: v1.users.settings.forwardingAddresses

Metode
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
Membuat alamat penerusan.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Menghapus alamat penerusan yang ditentukan dan membatalkan verifikasi yang mungkin diperlukan.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
Mendapatkan alamat penerusan yang ditentukan.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
Mencantumkan alamat penerusan untuk akun yang ditentukan.

REST Resource: v1.users.settings.sendAs

Metode
create POST /gmail/v1/users/{userId}/settings/sendAs
Membuat alias "dari" khusus untuk mengirim sebagai.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Menghapus alias 'kirim sebagai' yang ditentukan.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Mendapatkan alias kirim sebagai yang ditentukan.
list GET /gmail/v1/users/{userId}/settings/sendAs
Mencantumkan alias kirim sebagai untuk akun yang ditentukan.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Membuat patch alias kirim sebagai yang ditentukan.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
Memperbarui alias kirim sebagai.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
Mengirim email verifikasi ke alamat alias kirim sebagai yang ditentukan.

REST Resource: v1.users.settings.sendAs.smimeInfo

Metode
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Menghapus konfigurasi S/MIME yang ditentukan untuk alias kirim sebagai yang ditentukan.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
Mendapatkan konfigurasi S/MIME yang ditentukan untuk alias kirim sebagai yang ditentukan.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Menyisipkan (mengupload) konfigurasi S/MIME yang diberikan untuk alias kirim sebagai yang ditentukan.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
Mencantumkan konfigurasi S/MIME untuk alias kirim sebagai yang ditentukan.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
Menetapkan konfigurasi S/MIME default untuk alias kirim sebagai yang ditentukan.

REST Resource: v1.users.threads

Metode
delete DELETE /gmail/v1/users/{userId}/threads/{id}
Menghapus rangkaian pesan yang ditentukan secara langsung dan permanen.
get GET /gmail/v1/users/{userId}/threads/{id}
Mendapatkan rangkaian pesan yang ditentukan.
list GET /gmail/v1/users/{userId}/threads
Mencantumkan rangkaian pesan di kotak surat pengguna.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
Mengubah label yang diterapkan ke rangkaian pesan.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
Memindahkan thread yang ditentukan ke sampah.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
Menghapus thread yang ditentukan dari sampah.