Gmail API adalah RESTful API yang dapat digunakan untuk mengakses kotak surat Gmail dan mengirim email. Untuk sebagian besar aplikasi web, Gmail API adalah pilihan terbaik untuk akses yang sah ke data Gmail pengguna dan cocok untuk berbagai aplikasi, seperti:
- Ekstraksi, pengindeksan, dan pencadangan email hanya baca
- Pengiriman pesan otomatis atau terprogram
- Migrasi akun email
- Pengelolaan email, termasuk pemfilteran dan pengurutan pesan
- Standardisasi tanda tangan email di seluruh organisasi
Istilah umum
Berikut adalah daftar istilah umum yang digunakan dalam API ini:
- Pendelegasi dan Penerima Delegasi
- Delegator adalah pengguna Gmail yang memberikan akses kotak surat kepada pengguna lain dalam organisasi Google Workspace yang sama. Pengguna yang menerima akses ini adalah delegasi. Penerima delegasi dapat membaca, mengirim, dan menghapus pesan, serta melihat dan menambahkan kontak atas nama akun pendelegasi. Untuk mengetahui informasi selengkapnya, lihat Mengelola delegasi.
- Draft
- Pesan yang belum terkirim. Pesan yang ada dalam draf dapat diganti.
Mengirim draf akan otomatis menghapus draf dan membuat pesan dengan
label sistem
SENT. Draf diwakili oleh resourcedrafts. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan draf. - Filter
- Aturan lanjutan yang dikonfigurasi untuk akun yang mengevaluasi pesan masuk berdasarkan kriteria pencocokan tertentu (seperti pengirim, subjek, atau ukuran). Jika pesan cocok, filter akan otomatis memicu tindakan seperti menambahkan atau menghapus label, atau meneruskan email ke alamat tertentu. Untuk mengetahui informasi selengkapnya, lihat Mengelola filter.
- Alamat penerusan
- Alamat email spesifik dan terverifikasi yang dikonfigurasi untuk menerima pesan yang diteruskan secara otomatis dari akun pengguna. Sebelum alamat dapat digunakan dalam aturan atau filter penerusan, alamat tersebut harus terdaftar dan terverifikasi secara resmi untuk membuktikan kepemilikan. Untuk mengetahui informasi selengkapnya, lihat Mengelola penerusan.
- Label
Mekanisme untuk mengatur pesan dan rangkaian pesan. Misalnya, label "pajak" dapat dibuat dan diterapkan ke semua pesan dan rangkaian pesan yang berkaitan dengan pajak pengguna. Untuk mengetahui informasi selengkapnya, lihat Mengelola label.
Ada dua jenis label:
- Label sistem
- Label yang dibuat secara internal, seperti
INBOX,TRASH, atauSPAM. Label ini tidak dapat dihapus atau diubah. Namun, beberapa label sistem, sepertiINBOXdapat diterapkan ke, atau dihapus dari, pesan dan rangkaian pesan. - Label pengguna
- Label yang dibuat oleh pengguna. Label ini dapat dihapus atau diubah oleh
pengguna atau aplikasi. Label pengguna diwakili oleh
resource
labels.
- Kirim pesan
Pesan email yang berisi pengirim, penerima, subjek, dan isi. Setelah pesan dibuat, pesan tersebut tidak dapat diubah. Pesan diwakili oleh resource
messages.- Notifikasi push
Sistem notifikasi sisi server yang terintegrasi dengan Google Cloud Pub/Sub. Aplikasi dapat "memantau" kotak surat, dan Gmail API akan mengirimkan webhook atau pemberitahuan otomatis setiap kali terjadi perubahan (seperti email baru yang masuk), sehingga aplikasi tidak perlu terus-menerus melakukan polling server untuk mendapatkan update. Untuk mengetahui informasi selengkapnya, lihat Notifikasi push.
- Sertifikat S/MIME
Sertifikat digital yang diupload ke alias kirim sebagai tertentu yang memungkinkan pengguna mengirim email terenkripsi dan bertanda tangan digital, sehingga memastikan keamanan pesan dan keaslian pengirim. Untuk mengetahui informasi selengkapnya, lihat Mengelola sertifikat S/MIME.
- Alias kirim sebagai
Alamat ini mewakili berbagai alamat email yang diberi otorisasi oleh akun untuk mengirim email. Setiap akun memiliki minimal satu alias yang merepresentasikan alamat email utama. Alias sesuai dengan fitur "Kirim email sebagai" di antarmuka web Gmail dan juga merupakan dasar untuk mengonfigurasi tanda tangan email per alamat. Untuk mengetahui informasi selengkapnya, lihat Mengelola alias.
- Thread
Kumpulan pesan terkait yang membentuk percakapan. Di aplikasi klien email, rangkaian pesan dibuat saat satu atau beberapa penerima membalas pesan dengan pesan mereka sendiri. Untuk mengetahui informasi selengkapnya, lihat Mengelola thread.
Topik terkait
Untuk mempelajari cara mengembangkan dengan Google Workspace API, termasuk menangani autentikasi dan otorisasi, lihat Mengembangkan di Google Workspace.
Untuk mempelajari cara mengonfigurasi dan menjalankan aplikasi Gmail API, baca Panduan memulai.