Layanan ini memungkinkan Anda mengirim email, menulis draf, mengelola label, menandai pesan dan rangkaian pesan, serta melakukan berbagai tugas pengelolaan akun Gmail lainnya. Lihat juga Layanan Email, layanan lebih sederhana yang hanya mengizinkan pengiriman email.
Class
Name | Deskripsi singkat |
---|---|
GmailApp | Menyediakan akses ke rangkaian pesan, pesan, dan label Gmail. |
GmailAttachment | Lampiran dari Gmail. |
GmailDraft | Pesan draf yang dibuat pengguna di akun Gmail pengguna. |
GmailLabel | Label yang dibuat pengguna di akun Gmail pengguna. |
GmailMessage | Pesan di akun Gmail pengguna. |
GmailThread | Rangkaian pesan di akun Gmail pengguna. |
GmailApp
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
createDraft(recipient, subject, body) | GmailDraft | Membuat draf pesan email. |
createDraft(recipient, subject, body, options) | GmailDraft | Membuat draf pesan email dengan argumen opsional. |
createLabel(name) | GmailLabel | Membuat label pengguna baru dari nama yang diberikan. |
deleteLabel(label) | GmailApp | Menghapus label yang ditentukan. |
getAliases() | String[] | Mendapatkan daftar email yang disiapkan sebagai alias untuk akun ini di Gmail. |
getDraft(draftId) | GmailDraft | Ambil draf pesan email menurut ID. |
getDraftMessages() | GmailMessage[] | Mengambil semua pesan draf. |
getDrafts() | GmailDraft[] | Mendapatkan semua pesan draf Gmail. |
getInboxThreads() | GmailThread[] | Mengambil semua rangkaian pesan Kotak Masuk terlepas dari label. |
getInboxThreads(start, max) | GmailThread[] | Mengambil rentang rangkaian pesan Kotak Masuk terlepas dari label. |
getInboxUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca di kotak masuk. |
getMessageById(id) | GmailMessage | Mendapatkan pesan menurut ID. |
getMessagesForThread(thread) | GmailMessage[] | Mengambil semua pesan di rangkaian pesan yang ditentukan. |
getMessagesForThreads(threads) | GmailMessage[][] | Mengambil semua pesan di rangkaian pesan yang ditentukan. |
getPriorityInboxThreads() | GmailThread[] | Mengambil semua thread Kotak Prioritas terlepas dari labelnya. |
getPriorityInboxThreads(start, max) | GmailThread[] | Mengambil rentang rangkaian Kotak Prioritas, terlepas dari labelnya. |
getPriorityInboxUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca dalam Kotak Prioritas. |
getSpamThreads() | GmailThread[] | Mengambil semua rangkaian pesan spam terlepas dari labelnya. |
getSpamThreads(start, max) | GmailThread[] | Mengambil rangkaian thread spam terlepas dari label. |
getSpamUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca yang merupakan spam. |
getStarredThreads() | GmailThread[] | Mengambil semua thread berbintang terlepas dari label. |
getStarredThreads(start, max) | GmailThread[] | Mengambil rentang thread berbintang terlepas dari label. |
getStarredUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca yang berbintang. |
getThreadById(id) | GmailThread | Mendapatkan thread berdasarkan ID. |
getTrashThreads() | GmailThread[] | Mengambil semua thread sampah terlepas dari labelnya. |
getTrashThreads(start, max) | GmailThread[] | Mengambil kumpulan thread sampah terlepas dari labelnya. |
getUserLabelByName(name) | GmailLabel | Mengambil label yang diberi nama label. |
getUserLabels() | GmailLabel[] | Mengambil daftar label buatan pengguna. |
markMessageRead(message) | GmailApp | Menandai pesan ini sebagai telah dibaca dan memaksa pesan tersebut untuk dimuat ulang. |
markMessageUnread(message) | GmailApp | Menandai pesan ini sebagai belum dibaca dan memaksanya untuk dimuat ulang. |
markMessagesRead(messages) | GmailApp | Menandai pesan ini sebagai telah dibaca dan memaksanya untuk dimuat ulang. |
markMessagesUnread(messages) | GmailApp | Menandai pesan ini sebagai belum dibaca dan memaksanya untuk dimuat ulang. |
markThreadImportant(thread) | GmailApp | Menandai thread ini sebagai penting dan memaksa thread untuk dimuat ulang. |
markThreadRead(thread) | GmailApp | Menandai thread ini sebagai telah dibaca dan memaksa thread untuk dimuat ulang. |
markThreadUnimportant(thread) | GmailApp | Menandai thread ini sebagai tidak penting dan memaksa thread untuk dimuat ulang. |
markThreadUnread(thread) | GmailApp | Menandai thread ini belum dibaca dan memaksa thread untuk dimuat ulang. |
markThreadsImportant(threads) | GmailApp | Menandai thread ini sebagai penting dan memaksa thread untuk dimuat ulang. |
markThreadsRead(threads) | GmailApp | Menandai thread ini sebagai telah dibaca dan memaksa thread untuk dimuat ulang. |
markThreadsUnimportant(threads) | GmailApp | Menandai thread ini sebagai tidak penting dan memaksa thread untuk dimuat ulang. |
markThreadsUnread(threads) | GmailApp | Menandai thread ini sebagai belum dibaca dan memaksa thread untuk dimuat ulang. |
moveMessageToTrash(message) | GmailApp | Memindahkan pesan ke sampah dan memaksa pesan dimuat ulang. |
moveMessagesToTrash(messages) | GmailApp | Memindahkan pesan yang ditentukan ke sampah dan memaksa pesan untuk dimuat ulang. |
moveThreadToArchive(thread) | GmailApp | Memindahkan thread ini ke arsip dan memaksa thread untuk dimuat ulang. |
moveThreadToInbox(thread) | GmailApp | Memindahkan thread ini ke kotak masuk dan memaksa thread untuk dimuat ulang. |
moveThreadToSpam(thread) | GmailApp | Memindahkan thread ini ke spam dan memaksa thread untuk dimuat ulang. |
moveThreadToTrash(thread) | GmailApp | Memindahkan thread ini ke sampah dan memaksa thread untuk dimuat ulang. |
moveThreadsToArchive(threads) | GmailApp | Memindahkan thread ini ke arsip dan memaksa thread untuk dimuat ulang. |
moveThreadsToInbox(threads) | GmailApp | Memindahkan thread ini ke kotak masuk dan memaksa thread untuk dimuat ulang. |
moveThreadsToSpam(threads) | GmailApp | Memindahkan thread ini ke spam dan memaksa thread untuk dimuat ulang. |
moveThreadsToTrash(threads) | GmailApp | Memindahkan thread ini ke sampah dan memaksa thread untuk dimuat ulang. |
refreshMessage(message) | GmailApp | Memuat ulang pesan dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah). |
refreshMessages(messages) | GmailApp | Memuat ulang pesan dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah). |
refreshThread(thread) | GmailApp | Memuat ulang thread dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah). |
refreshThreads(threads) | GmailApp | Memuat ulang thread dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah). |
search(query) | GmailThread[] | Menelusuri Gmail dengan kueri yang ditentukan. |
search(query, start, max) | GmailThread[] | Menelusuri Gmail dengan kueri yang ditentukan. |
sendEmail(recipient, subject, body) | GmailApp | Mengirim pesan email. |
sendEmail(recipient, subject, body, options) | GmailApp | Mengirim pesan email dengan argumen opsional. |
setCurrentMessageAccessToken(accessToken) | void | Menetapkan token akses pesan saat ini yang memungkinkan skrip mengakses properti GmailMessage saat ini. |
starMessage(message) | GmailApp | Menambahkan bintang ke pesan ini dan memaksa pesan dimuat ulang. |
starMessages(messages) | GmailApp | Menambahkan bintang ke pesan ini dan memaksa pesan untuk dimuat ulang. |
unstarMessage(message) | GmailApp | Menghapus bintang dari pesan ini dan memaksa pesan dimuat ulang. |
unstarMessages(messages) | GmailApp | Menghapus bintang dari pesan ini dan memaksa pesan dimuat ulang. |
GmailAttachment
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
copyBlob() | Blob | Menampilkan salinan blob ini. |
getAs(contentType) | Blob | Menampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan. |
getBytes() | Byte[] | Mendapatkan data yang disimpan di blob ini. |
getContentType() | String | Mendapatkan jenis konten byte di blob ini. |
getDataAsString() | String | Mendapatkan data blob ini sebagai String dengan encoding UTF-8. |
getDataAsString(charset) | String | Mendapatkan data blob ini sebagai string dengan encoding yang ditentukan. |
getHash() | String | Mendapatkan hash konten SHA1 untuk lampiran ini. |
getName() | String | Mendapatkan nama blob ini. |
getSize() | Integer | Mendapatkan ukuran lampiran ini. |
isGoogleType() | Boolean | Menampilkan apakah blob ini adalah file Google Workspace (Spreadsheet, Dokumen, dll.). |
setBytes(data) | Blob | Menetapkan data yang disimpan di blob ini. |
setContentType(contentType) | Blob | Menetapkan jenis konten byte dalam blob ini. |
setContentTypeFromExtension() | Blob | Menetapkan jenis konten byte dalam blob ini berdasarkan ekstensi file. |
setDataFromString(string) | Blob | Menetapkan data blob ini dari string dengan encoding UTF-8. |
setDataFromString(string, charset) | Blob | Menetapkan data blob ini dari string dengan encoding yang ditentukan. |
setName(name) | Blob | Menetapkan nama blob ini. |
GmailDraft
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
deleteDraft() | void | Menghapus pesan draf ini. |
getId() | String | Mendapatkan ID pesan draf ini. |
getMessage() | GmailMessage | Menampilkan GmailMessage yang mewakili draf ini. |
getMessageId() | String | Menampilkan ID GmailMessage yang mewakili draf ini. |
send() | GmailMessage | Mengirim draf pesan email ini. |
update(recipient, subject, body) | GmailDraft | Mengganti konten pesan draf ini. |
update(recipient, subject, body, options) | GmailDraft | Mengganti konten pesan draf ini menggunakan argumen opsional. |
GmailLabel
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
addToThread(thread) | GmailLabel | Menambahkan label ini ke thread yang diberikan dan memaksa thread untuk dimuat ulang (GmailThread.refresh() ). |
addToThreads(threads) | GmailLabel | Menambahkan label ini ke thread yang diberikan dan memaksa thread untuk dimuat ulang. |
deleteLabel() | void | Menghapus label ini. |
getName() | String | Mendapatkan nama label ini. |
getThreads() | GmailThread[] | Mendapatkan rangkaian pesan yang ditandai dengan label ini. |
getThreads(start, max) | GmailThread[] | Mendapatkan rangkaian pesan yang ditandai dengan label ini. |
getUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca yang diberi tag ini. |
removeFromThread(thread) | GmailLabel | Menghapus label ini dari thread yang diberikan dan memaksa thread untuk dimuat ulang. |
removeFromThreads(threads) | GmailLabel | Menghapus label ini dari thread yang diberikan dan memaksa thread untuk dimuat ulang. |
GmailMessage
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
createDraftReply(body) | GmailDraft | Membuat draf pesan yang membalas pengirim pesan ini menggunakan alamat balas-ke. |
createDraftReply(body, options) | GmailDraft | Membuat draf pesan yang membalas pengirim pesan ini menggunakan alamat balas-ke, dengan argumen opsional. |
createDraftReplyAll(body) | GmailDraft | Membuat draf pesan yang membalas pengirim menggunakan alamat balas-ke dan semua penerima pesan ini. |
createDraftReplyAll(body, options) | GmailDraft | Membuat draf pesan yang membalas pengirim pesan ini menggunakan alamat balas-ke dan semua penerima, dengan argumen opsional. |
forward(recipient) | GmailMessage | Meneruskan pesan ini ke penerima baru. |
forward(recipient, options) | GmailMessage | Meneruskan pesan ini ke penerima baru, dengan argumen opsional. |
getAttachments() | GmailAttachment[] | Mendapatkan semua lampiran untuk pesan ini. |
getAttachments(options) | GmailAttachment[] | Mendapatkan semua lampiran untuk pesan ini. |
getBcc() | String | Mendapatkan penerima yang dipisahkan koma berdasarkan pesan ini. |
getBody() | String | Mendapatkan konten HTML dari isi pesan ini. |
getCc() | String | Mendapatkan penerima yang dipisahkan koma di CC'd pada pesan ini. |
getDate() | Date | Mendapatkan tanggal dan waktu pesan ini. |
getFrom() | String | Mendapatkan pengirim pesan ini. |
getHeader(name) | String | Mendapatkan nilai header RFC 2822 dengan nama header. |
getId() | String | Mendapatkan ID pesan ini. |
getPlainBody() | String | Mendapatkan konten isi pesan ini tanpa format HTML. |
getRawContent() | String | Mendapatkan konten mentah pesan ini. |
getReplyTo() | String | Mendapatkan alamat balas-ke pesan ini (biasanya pengirim). |
getSubject() | String | Mendapatkan subjek pesan ini. |
getThread() | GmailThread | Mendapatkan rangkaian pesan yang berisi pesan ini. |
getTo() | String | Mendapatkan penerima yang dipisahkan koma untuk pesan ini. |
isDraft() | Boolean | Mendapatkan apakah pesan ini adalah draf. |
isInChats() | Boolean | Mendapatkan apakah pesan ini berupa chat. |
isInInbox() | Boolean | Mendapatkan apakah pesan ini ada di kotak masuk. |
isInPriorityInbox() | Boolean | Menampilkan true jika pesan ini berada dalam kotak masuk prioritas; menampilkan false jika tidak. |
isInTrash() | Boolean | Mendapatkan apakah pesan ini ada di sampah. |
isStarred() | Boolean | Mendapatkan apakah pesan ini berbintang. |
isUnread() | Boolean | Mendapatkan apakah pesan ini belum dibaca. |
markRead() | GmailMessage | Menandai pesan sebagai sudah dibaca. |
markUnread() | GmailMessage | Menandai pesan sebagai belum dibaca. |
moveToTrash() | GmailMessage | Memindahkan pesan ke sampah. |
refresh() | GmailMessage | Memuat ulang pesan ini dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah). |
reply(body) | GmailMessage | Balasan untuk pengirim pesan ini menggunakan alamat balas-ke. |
reply(body, options) | GmailMessage | Balasan untuk pengirim pesan ini menggunakan alamat balas-ke, dengan argumen opsional. |
replyAll(body) | GmailMessage | Akan membalas pengirim menggunakan alamat balas-ke dan semua penerima pesan ini. |
replyAll(body, options) | GmailMessage | Akan membalas pengirim pesan ini menggunakan alamat balas-ke dan semua penerima, dengan argumen opsional. |
star() | GmailMessage | Memberi bintang pada pesan. |
unstar() | GmailMessage | Hapus bintang pada pesan. |
GmailThread
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
addLabel(label) | GmailThread | Menambahkan label ini ke rangkaian pesan. |
createDraftReply(body) | GmailDraft | Membuat draf pesan yang membalas pengirim pesan terakhir dalam rangkaian pesan ini menggunakan alamat balas-ke. |
createDraftReply(body, options) | GmailDraft | Membuat draf pesan yang membalas pengirim pesan terakhir dalam rangkaian pesan ini menggunakan alamat balas-ke, dengan argumen opsional. |
createDraftReplyAll(body) | GmailDraft | Membuat draf pesan yang membalas pengirim pesan terakhir di rangkaian pesan ini menggunakan alamat balas-ke dan semua penerima pesan ini. |
createDraftReplyAll(body, options) | GmailDraft | Membuat draf pesan yang membalas pengirim pesan terakhir di thread ini, menggunakan alamat balas-ke dan semua penerima, dengan argumen opsional. |
getFirstMessageSubject() | String | Mendapatkan subjek pesan pertama dalam rangkaian pesan. |
getId() | String | Mendapatkan ID thread ini. |
getLabels() | GmailLabel[] | Menampilkan label buatan pengguna di thread ini. |
getLastMessageDate() | Date | Mendapatkan tanggal pesan terbaru dari rangkaian pesan ini. |
getMessageCount() | Integer | Menampilkan jumlah pesan dalam rangkaian pesan. |
getMessages() | GmailMessage[] | Mendapatkan pesan di rangkaian pesan ini. |
getPermalink() | String | Mendapatkan permalink untuk rangkaian pesan ini. |
hasStarredMessages() | Boolean | Menampilkan apakah rangkaian pesan memiliki pesan berbintang. |
isImportant() | Boolean | Menampilkan apakah thread ditandai sebagai penting. |
isInChats() | Boolean | Menampilkan apakah thread diberi label chat. |
isInInbox() | Boolean | Menampilkan apakah rangkaian pesan ada di kotak masuk. |
isInPriorityInbox() | Boolean | Menampilkan true jika thread ini berada dalam kotak masuk prioritas; menampilkan false jika tidak. |
isInSpam() | Boolean | Menampilkan apakah rangkaian pesan ditandai sebagai spam. |
isInTrash() | Boolean | Menampilkan apakah thread berada di sampah. |
isUnread() | Boolean | Menampilkan apakah rangkaian pesan memiliki pesan yang belum dibaca. |
markImportant() | GmailThread | Menandai rangkaian pesan ini sebagai penting. |
markRead() | GmailThread | Menandai rangkaian pesan ini sebagai sudah dibaca. |
markUnimportant() | GmailThread | Menandai rangkaian pesan ini sebagai tidak penting. |
markUnread() | GmailThread | Menandai rangkaian pesan ini sebagai belum dibaca. |
moveToArchive() | GmailThread | Memindahkan rangkaian pesan ini ke arsip. |
moveToInbox() | GmailThread | Memindahkan rangkaian pesan ini ke kotak masuk. |
moveToSpam() | GmailThread | Memindahkan rangkaian pesan ini ke spam. |
moveToTrash() | GmailThread | Memindahkan rangkaian pesan ini ke sampah. |
refresh() | GmailThread | Memuat ulang thread ini, dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah). |
removeLabel(label) | GmailThread | Menghapus label ini dari rangkaian pesan. |
reply(body) | GmailThread | Membalas pengirim pesan terakhir di rangkaian pesan ini menggunakan alamat balasKe. |
reply(body, options) | GmailThread | Membalas pengirim pesan terakhir di rangkaian pesan ini menggunakan alamat balasKe, dengan argumen opsional. |
replyAll(body) | GmailThread | Balas ke pengirim (menggunakan alamat balasKe), dan semua penerima pesan terakhir di rangkaian pesan ini. |
replyAll(body, options) | GmailThread | Balas ke pengirim (menggunakan alamat replyTo ), dan semua penerima pesan terakhir di rangkaian pesan ini, dengan argumen opsional. |