Gmail API adalah RESTful API yang memungkinkan Anda mengakses kotak surat Gmail dan mengirim email. Untuk sebagian besar aplikasi web, Gmail API adalah pilihan terbaik untuk akses resmi 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
- Pendelegasi adalah pengguna Gmail yang memberikan akses kotak surat kepada pengguna lain dalam organisasi Google Workspace yang sama. Pengguna yang menerima akses ini adalah penerima 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. Anda dapat mengganti pesan yang ada dalam draf.
Mengirim draf akan otomatis menghapus draf dan membuat pesan dengan
label sistem
SENT. Resourcedraftsmewakili draf. 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). Saat 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 tertentu yang terverifikasi dan dikonfigurasi untuk menerima pesan yang diteruskan secara otomatis dari akun pengguna. Sebelum dapat menggunakan alamat dalam aturan penerusan atau filter, Anda harus mendaftarkan dan memverifikasinya untuk membuktikan kepemilikan. Untuk mengetahui informasi selengkapnya, lihat Mengelola penerusan.
- Label
Mekanisme untuk mengatur pesan dan rangkaian pesan. Misalnya, Anda dapat membuat label "pajak" dan menerapkannya ke semua pesan dan rangkaian pesan yang terkait dengan pajak. Untuk mengetahui informasi selengkapnya, lihat Mengelola label.
Ada dua jenis label:
- Label sistem
- Label yang dibuat secara internal, seperti
INBOX,TRASH, atauSPAM. Anda tidak dapat menghapus atau mengubah label ini. Namun, Anda dapat menerapkan atau menghapus beberapa label sistem, sepertiINBOX, ke atau dari pesan dan utas. - Label pengguna
- Label yang dibuat oleh pengguna. Pengguna atau aplikasi dapat menghapus atau mengubah label ini. Resource
labelsmewakili label pengguna.
- Kirim pesan
Pesan email yang berisi pengirim, penerima, subjek, dan isi. Setelah membuat pesan, Anda tidak dapat mengubahnya. Resource
messagesmewakili pesan.- Notifikasi push
Sistem notifikasi sisi server yang terintegrasi dengan Google Cloud Pub/Sub. Aplikasi dapat "memantau" kotak surat, dan Gmail API mengirimkan webhook atau pemberitahuan otomatis setiap kali terjadi perubahan (seperti email baru yang masuk). Dengan demikian, aplikasi Anda tidak perlu 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. Sertifikat ini memungkinkan Anda mengirim email terenkripsi dan yang ditandatangani secara 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 mewakili alamat email utama. Alias sesuai dengan fitur "Kirim email sebagai" di antarmuka web Gmail dan juga menjadi dasar untuk mengonfigurasi tanda tangan email per alamat. Untuk mengetahui informasi selengkapnya, lihat Mengelola alias.
- Thread
Kumpulan pesan terkait yang membentuk percakapan. Di program email, rangkaian pesan terbentuk saat satu atau beberapa penerima membalas pesan dengan pesan mereka sendiri. Untuk mengetahui informasi selengkapnya, lihat Mengelola thread.
Topik terkait
Untuk mempelajari pengembangan dengan Google Workspace API, termasuk penanganan autentikasi dan otorisasi, lihat Mengembangkan di Google Workspace.
Untuk mempelajari cara mengonfigurasi dan menjalankan aplikasi Gmail API, baca Panduan memulai.