Memberikan akses ke rangkaian pesan, pesan, dan label Gmail.
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 | Buat label pengguna baru untuk nama tertentu. |
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, apa pun labelnya. |
getInboxThreads(start, max) | GmailThread[] | Mengambil berbagai rangkaian pesan Kotak Masuk, apa pun labelnya. |
getInboxUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca di kotak masuk. |
getMessageById(id) | GmailMessage | Mendapatkan pesan berdasarkan ID. |
getMessagesForThread(thread) | GmailMessage[] | Mengambil semua pesan dalam rangkaian pesan yang ditentukan. |
getMessagesForThreads(threads) | GmailMessage[][] | Mengambil semua pesan dalam rangkaian pesan yang ditentukan. |
getPriorityInboxThreads() | GmailThread[] | Mengambil semua rangkaian pesan Kotak Prioritas apa pun labelnya. |
getPriorityInboxThreads(start, max) | GmailThread[] | Mengambil berbagai thread Kotak Prioritas, apa pun labelnya. |
getPriorityInboxUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca di Kotak Prioritas. |
getSpamThreads() | GmailThread[] | Mengambil semua rangkaian pesan spam, apa pun labelnya. |
getSpamThreads(start, max) | GmailThread[] | Mengambil berbagai rangkaian pesan spam, apa pun labelnya. |
getSpamUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca yang merupakan spam. |
getStarredThreads() | GmailThread[] | Mengambil semua rangkaian pesan berbintang, apa pun labelnya. |
getStarredThreads(start, max) | GmailThread[] | Mengambil berbagai thread berbintang, apa pun labelnya. |
getStarredUnreadCount() | Integer | Mendapatkan jumlah rangkaian pesan yang belum dibaca yang diberi bintang. |
getThreadById(id) | GmailThread | Mendapatkan rangkaian pesan berdasarkan ID. |
getTrashThreads() | GmailThread[] | Mengambil semua rangkaian pesan sampah, apa pun labelnya. |
getTrashThreads(start, max) | GmailThread[] | Mengambil berbagai thread sampah, apa pun labelnya. |
getUserLabelByName(name) | GmailLabel | Mengambil label berdasarkan nama label. |
getUserLabels() | GmailLabel[] | Mengambil daftar label yang dibuat pengguna. |
markMessageRead(message) | GmailApp | Menandai pesan ini telah dibaca dan memaksa pesan untuk dimuat ulang. |
markMessageUnread(message) | GmailApp | Menandai pesan ini sebagai belum dibaca dan memaksa pesan untuk dimuat ulang. |
markMessagesRead(messages) | GmailApp | Menandai pesan ini telah dibaca dan memaksa pesan untuk dimuat ulang. |
markMessagesUnread(messages) | GmailApp | Menandai pesan ini sebagai belum dibaca dan memaksa pesan 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 rangkaian pesan ini sebagai tidak penting dan memaksa rangkaian pesan untuk dimuat ulang. |
markThreadUnread(thread) | GmailApp | Menandai rangkaian pesan ini sebagai belum dibaca dan memaksa rangkaian pesan untuk dimuat ulang. |
markThreadsImportant(threads) | GmailApp | Menandai rangkaian pesan 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 rangkaian pesan ini sebagai tidak penting dan memaksa rangkaian pesan untuk dimuat ulang. |
markThreadsUnread(threads) | GmailApp | Menandai rangkaian pesan ini sebagai belum dibaca dan memaksa rangkaian pesan untuk dimuat ulang. |
moveMessageToTrash(message) | GmailApp | Memindahkan pesan ke sampah dan memaksa pesan untuk dimuat ulang. |
moveMessagesToTrash(messages) | GmailApp | Memindahkan pesan yang ditentukan ke sampah dan memaksa pesan untuk dimuat ulang. |
moveThreadToArchive(thread) | GmailApp | Memindahkan rangkaian pesan ini ke arsip dan memaksa thread untuk dimuat ulang. |
moveThreadToInbox(thread) | GmailApp | Memindahkan rangkaian pesan ini ke kotak masuk dan memaksa rangkaian pesan dimuat ulang. |
moveThreadToSpam(thread) | GmailApp | Memindahkan rangkaian pesan ini ke spam dan memaksa rangkaian pesan dimuat ulang. |
moveThreadToTrash(thread) | GmailApp | Memindahkan rangkaian pesan ini ke sampah dan memaksa rangkaian pesan untuk dimuat ulang. |
moveThreadsToArchive(threads) | GmailApp | Memindahkan rangkaian pesan ini ke arsip dan memaksa thread untuk dimuat ulang. |
moveThreadsToInbox(threads) | GmailApp | Memindahkan rangkaian pesan ini ke kotak masuk dan memaksa rangkaian pesan dimuat ulang. |
moveThreadsToSpam(threads) | GmailApp | Memindahkan rangkaian pesan ini ke spam dan memaksa rangkaian pesan dimuat ulang. |
moveThreadsToTrash(threads) | GmailApp | Memindahkan rangkaian pesan ini ke sampah dan memaksa rangkaian pesan untuk dimuat ulang. |
refreshMessage(message) | GmailApp | Memuat ulang pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dan lain-lain, telah berubah). |
refreshMessages(messages) | GmailApp | Memuat ulang pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dan lain-lain, telah berubah). |
refreshThread(thread) | GmailApp | Memuat ulang rangkaian pesan dan status terkait dari Gmail (berguna jika label, status baca, dan lain-lain, telah berubah). |
refreshThreads(threads) | GmailApp | Memuat ulang thread dan status terkait dari Gmail (berguna jika label, status baca, dan lain-lain, 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 | Menyetel pesan saat ini
token akses yang memungkinkan skrip untuk mengakses properti GmailMessage saat ini. |
starMessage(message) | GmailApp | Menambahkan bintang ke pesan ini dan memaksa pesan dimuat ulang. |
starMessages(messages) | GmailApp | Menambahkan bintang pada pesan tersebut dan memaksa pesan untuk disegarkan. |
unstarMessage(message) | GmailApp | Menghapus bintang dari pesan ini dan memaksa pesan dimuat ulang. |
unstarMessages(messages) | GmailApp | Menghapus bintang dari pesan ini dan memaksa pesan untuk dimuat ulang. |
Dokumentasi mendetail
createDraft(recipient, subject, body)
Membuat draf pesan email. Ukuran email (termasuk header) terbatas kuota.
// The code below creates a draft email with the current date and time. var now = new Date(); GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
recipient | String | daftar alamat email yang dipisahkan koma |
subject | String | subjek email |
body | String | isi email |
Pulang pergi
GmailDraft
— Draf Gmail yang baru dibuat
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
createDraft(recipient, subject, body, options)
Membuat draf pesan email dengan argumen opsional. Email dapat berisi teks biasa atau Isi HTML. Ukuran email (termasuk header, tetapi tidak termasuk lampiran) kuota terbatas.
// Create a draft email with a file from Google Drive attached as a PDF. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
recipient | String | alamat penerima |
subject | String | baris subjek |
body | String | isi email |
options | Object | objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini |
Parameter lanjutan
Nama | Jenis | Deskripsi |
---|---|---|
attachments | BlobSource[] | sebuah rangkaian file untuk dikirim melalui email |
bcc | String | daftar alamat email yang dipisahkan koma ke BCC |
cc | String | daftar alamat email yang dipisahkan koma ke CC |
from | String | alamat asal email, yang harus satu
dari nilai yang ditampilkan oleh getAliases() |
htmlBody | String | jika disetel, perangkat yang dapat merender HTML akan menggunakannya
argumen body yang dibutuhkan; Anda dapat menambahkan kolom inlineImages opsional di HTML
body jika Anda memiliki gambar sisipan untuk email |
inlineImages | Object | objek JavaScript yang berisi pemetaan dari kunci gambar
(String ) ke data gambar (BlobSource ); hal ini mengasumsikan bahwa parameter htmlBody digunakan dan berisi referensi ke gambar ini dalam format <img src="cid:imageKey" /> |
name | String | nama pengirim email (default: nama pengguna) |
replyTo | String | alamat email untuk digunakan sebagai alamat balas-ke default (default: alamat email pengguna) |
Pulang pergi
GmailDraft
— Draf Gmail yang baru dibuat
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
createLabel(name)
Buat label pengguna baru untuk nama tertentu.
// Creates the label @FOO and logs label: FOO Logger.log("label: " + GmailApp.createLabel("FOO"));
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | nama label baru |
Pulang pergi
GmailLabel
— label yang baru dibuat
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
deleteLabel(label)
Menghapus label yang ditentukan.
// Have to get the label by name first var label = GmailApp.getUserLabelByName("FOO"); GmailApp.deleteLabel(label);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
label | GmailLabel | label yang akan dihapus |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
getAliases()
Mendapatkan daftar email yang disiapkan sebagai alias untuk akun ini di Gmail.
Anda dapat mengirim pesan dari alias mana pun menggunakan "dari" argumen opsional.
// Log the aliases for this Gmail account and send an email as the first one. var me = Session.getActiveUser().getEmail(); var aliases = GmailApp.getAliases(); Logger.log(aliases); if (aliases.length > 0) { GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]}); } else { GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.'); }
Pulang pergi
String[]
— susunan alias untuk akun ini
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
getDraft(draftId)
Ambil draf pesan email menurut ID.
Gunakan ini bersama dengan getId() pada draf Gmail.
// Get the first draft message in your drafts folder var draft = GmailApp.getDrafts()[0]; // Get its ID var draftId = draft.getId(); // Now fetch the same draft using that ID. var draftById = GmailApp.getDraft(draftId); // Should always log true as they should be the same message Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
draftId | String | ID draf untuk mengambil |
Pulang pergi
GmailDraft
— draf dengan ID yang diberikan
Menampilkan
Error
— jika draf dengan ID yang diberikan tidak dapat ditemukan
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getDraftMessages()
Mengambil semua pesan draf.
// Logs the number of draft messages var drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
Pulang pergi
GmailMessage[]
— array draf pesan Gmail
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getDrafts()
Mendapatkan semua pesan draf Gmail.
var drafts = GmailApp.getDrafts(); for (var i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); }
Pulang pergi
GmailDraft[]
— array pesan draf Gmail
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getInboxThreads()
Mengambil semua rangkaian pesan Kotak Masuk, apa pun labelnya.
Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan kemungkinan sangat besar, gunakan 'paged' panggilan, dan menentukan rentang thread yang akan diambil dalam setiap panggilan.
// Log the subject lines of your Inbox var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Pulang pergi
GmailThread[]
— array rangkaian pesan Gmail di Kotak Masuk
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getInboxThreads(start, max)
Mengambil berbagai rangkaian pesan Kotak Masuk, apa pun labelnya.
// Log the subject lines of up to the first 50 emails in your Inbox var threads = GmailApp.getInboxThreads(0, 50); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
start | Integer | indeks thread pertama untuk mengambil |
max | Integer | jumlah maksimum thread yang akan diambil |
Pulang pergi
GmailThread[]
— array rangkaian pesan Gmail di Kotak Masuk
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getInboxUnreadCount()
Mendapatkan jumlah rangkaian pesan yang belum dibaca di kotak masuk.
Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());
Pulang pergi
Integer
— jumlah rangkaian pesan di kotak masuk yang memiliki pesan yang belum dibaca
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getMessageById(id)
Mendapatkan pesan berdasarkan ID.
Gunakan ini bersama dengan getId() pada pesan Gmail.
// Get the first message in the first thread of your inbox var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // Get its ID var messageId = message.getId(); // Now fetch the same message using that ID. var messageById = GmailApp.getMessageById(messageId); // Should always log true as they should be the same message Logger.log(message.getSubject() == messageById.getSubject());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String | ID pesan untuk mengambil |
Pulang pergi
GmailMessage
— pesan dengan ID yang diberikan
Menampilkan
Error
— jika tidak ada pesan dengan ID yang diberikan yang dapat ditemukan
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
getMessagesForThread(thread)
Mengambil semua pesan dalam rangkaian pesan yang ditentukan.
// Log all the subject lines in the first thread of your inbox var thread = GmailApp.getInboxThreads(0, 1)[0]; var messages = GmailApp.getMessagesForThread(thread); for (var i = 0 ; i < messages.length; i++) { Logger.log("subject: " + messages[i].getSubject()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | rangkaian pesan untuk mengambil |
Pulang pergi
GmailMessage[]
— array pesan yang sesuai dengan rangkaian pesan ini
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
getMessagesForThreads(threads)
Mengambil semua pesan dalam rangkaian pesan yang ditentukan.
// Log the subject lines of all messages in the first two threads of your inbox var thread = GmailApp.getInboxThreads(0, 2); var messages = GmailApp.getMessagesForThreads(thread); for (var i = 0 ; i < messages.length; i++) { for (var j = 0; j < messages[i].length; j++) { Logger.log("subject: " + messages[i][j].getSubject()); } }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | utas pesan untuk diambil |
Pulang pergi
GmailMessage[][]
— array array pesan, dengan setiap item di array luar sesuai dengan
dan array dalam berisi pesan dalam thread tersebut
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
getPriorityInboxThreads()
Mengambil semua rangkaian pesan Kotak Prioritas apa pun labelnya.
Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan kemungkinan sangat besar, gunakan 'paged' panggilan, dan menentukan rentang thread yang akan diambil dalam setiap panggilan.
Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads().length);
Pulang pergi
GmailThread[]
— array rangkaian pesan Gmail di Kotak Prioritas
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getPriorityInboxThreads(start, max)
Mengambil berbagai thread Kotak Prioritas, apa pun labelnya.
// Will log some number 2 or less Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads(0, 2).length);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
start | Integer | indeks thread pertama untuk mengambil |
max | Integer | jumlah maksimum thread yang akan diambil |
Pulang pergi
GmailThread[]
— array rangkaian pesan Gmail di Kotak Prioritas
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getPriorityInboxUnreadCount()
Mendapatkan jumlah rangkaian pesan yang belum dibaca di Kotak Prioritas.
Logger.log("Number of unread emails in your Priority Inbox : " + GmailApp.getPriorityInboxUnreadCount());
Pulang pergi
Integer
— jumlah rangkaian pesan di Kotak Prioritas yang memiliki pesan yang belum dibaca
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getSpamThreads()
Mengambil semua rangkaian pesan spam, apa pun labelnya.
Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan kemungkinan sangat besar, gunakan 'paged' panggilan, dan menentukan rentang thread yang akan diambil dalam setiap panggilan.
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);
Pulang pergi
GmailThread[]
— array rangkaian pesan Gmail di folder spam
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getSpamThreads(start, max)
Mengambil berbagai rangkaian pesan spam, apa pun labelnya.
// Will log a number at most 5 Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
start | Integer | indeks thread pertama untuk mengambil |
max | Integer | jumlah maksimum thread yang akan diambil |
Pulang pergi
GmailThread[]
— array rangkaian pesan Gmail di folder spam
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getSpamUnreadCount()
Mendapatkan jumlah rangkaian pesan yang belum dibaca yang merupakan spam.
// Unless you actually read stuff in your spam folder, this should be the same as // the number of messages in your spam folder. Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());
Pulang pergi
Integer
— jumlah rangkaian pesan spam yang memiliki pesan yang belum dibaca
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getStarredThreads()
Mengambil semua rangkaian pesan berbintang, apa pun labelnya.
Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan kemungkinan sangat besar, gunakan 'paged' panggilan, dan menentukan rentang thread yang akan diambil dalam setiap panggilan.
// Logs the number of starred threads Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);
Pulang pergi
GmailThread[]
— array thread Gmail berbintang
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getStarredThreads(start, max)
Mengambil berbagai thread berbintang, apa pun labelnya.
// Logs the number of starred threads to a maximum of 5 Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
start | Integer | indeks thread pertama untuk mengambil |
max | Integer | jumlah maksimum thread yang akan diambil |
Pulang pergi
GmailThread[]
— array thread Gmail berbintang
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getStarredUnreadCount()
Mendapatkan jumlah rangkaian pesan yang belum dibaca yang diberi bintang.
Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());
Pulang pergi
Integer
— jumlah rangkaian pesan berbintang yang memiliki pesan yang belum dibaca
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getThreadById(id)
Mendapatkan rangkaian pesan berdasarkan ID.
Gunakan ini bersama dengan getId() pada rangkaian pesan Gmail.
// Gets the first inbox thread. const firstThread = GmailApp.getInboxThreads(0,1)[0]; // Gets the same thread by ID. const threadById = GmailApp.getThreadById(firstThread.getId()); // Verifies that they are the same. console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String | ID thread yang akan diambil. |
Pulang pergi
GmailThread
— Thread dengan ID yang diberikan atau null
jika tidak ditemukan.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
getTrashThreads()
Mengambil semua rangkaian pesan sampah, apa pun labelnya.
Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan kemungkinan sangat besar, gunakan 'paged' panggilan, dan menentukan rentang thread yang akan diambil dalam setiap panggilan.
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);
Pulang pergi
GmailThread[]
— array thread Gmail di sampah
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getTrashThreads(start, max)
Mengambil berbagai thread sampah, apa pun labelnya.
// Will log a number at most 5 Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
start | Integer | indeks thread pertama untuk mengambil |
max | Integer | jumlah maksimum thread yang akan diambil |
Pulang pergi
GmailThread[]
— array thread Gmail di sampah
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getUserLabelByName(name)
Mengambil label berdasarkan nama label.
var labelObject = GmailApp.getUserLabelByName("myLabel");
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | nama label untuk mengambil |
Pulang pergi
GmailLabel
— label Gmail dengan nama tertentu
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
getUserLabels()
Mengambil daftar label yang dibuat pengguna.
// Logs all of the names of your labels var labels = GmailApp.getUserLabels(); for (var i = 0; i < labels.length; i++) { Logger.log("label: " + labels[i].getName()); }
Pulang pergi
GmailLabel[]
— array label yang dibuat pengguna
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
markMessageRead(message)
Menandai pesan ini telah dibaca dan memaksa pesan untuk dimuat ulang.
// Mark the first message in the first thread of your inbox as read var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageRead(message);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
message | GmailMessage | pesan untuk ditandai sebagai sudah dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markMessageUnread(message)
Menandai pesan ini sebagai belum dibaca dan memaksa pesan untuk dimuat ulang.
// Mark the first message in the first thread of your inbox as unread var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageUnread(message);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
message | GmailMessage | pesan untuk ditandai sebagai belum dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markMessagesRead(messages)
Menandai pesan ini telah dibaca dan memaksa pesan untuk dimuat ulang.
// Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(thread.getMessages());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
messages | GmailMessage[] | array pesan untuk ditandai sebagai telah dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markMessagesUnread(messages)
Menandai pesan ini sebagai belum dibaca dan memaksa pesan untuk dimuat ulang.
// Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(thread.getMessages());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
messages | GmailMessage[] | array pesan untuk ditandai sebagai belum dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadImportant(thread)
Menandai thread ini sebagai penting dan memaksa thread untuk dimuat ulang.
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | thread untuk ditandai sebagai penting |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadRead(thread)
Menandai thread ini sebagai telah dibaca dan memaksa thread untuk dimuat ulang.
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | thread untuk ditandai sebagai telah dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadUnimportant(thread)
Menandai rangkaian pesan ini sebagai tidak penting dan memaksa rangkaian pesan untuk dimuat ulang.
// Marks first inbox thread as unimportant var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | rangkaian pesan untuk ditandai sebagai tidak penting |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadUnread(thread)
Menandai rangkaian pesan ini sebagai belum dibaca dan memaksa rangkaian pesan untuk dimuat ulang.
// Marks first inbox thread as unread var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | rangkaian pesan untuk ditandai sebagai belum dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadsImportant(threads)
Menandai rangkaian pesan ini sebagai penting dan memaksa thread untuk dimuat ulang.
// Marks first two threads in inbox as important var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | array thread untuk ditandai sebagai penting |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadsRead(threads)
Menandai thread ini sebagai telah dibaca dan memaksa thread untuk dimuat ulang.
// Marks first two threads in inbox as read var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | array thread untuk ditandai sebagai telah dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadsUnimportant(threads)
Menandai rangkaian pesan ini sebagai tidak penting dan memaksa rangkaian pesan untuk dimuat ulang.
// Marks first two threads in inbox as unimportant var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | array thread untuk ditandai sebagai tidak penting |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
markThreadsUnread(threads)
Menandai rangkaian pesan ini sebagai belum dibaca dan memaksa rangkaian pesan untuk dimuat ulang.
// Marks first two threads in inbox as unread var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | array thread untuk ditandai sebagai belum dibaca |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveMessageToTrash(message)
Memindahkan pesan ke sampah dan memaksa pesan untuk dimuat ulang.
// Move the first message in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
message | GmailMessage | pesan akan dibuang |
Pulang pergi
GmailApp
— layanan Gmail (berguna untuk perantaian)
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveMessagesToTrash(messages)
Memindahkan pesan yang ditentukan ke sampah dan memaksa pesan untuk dimuat ulang.
// Move first two messages in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var messages = firstThread.getMessages(); var toDelete = [messages[0], messages[1]]; GmailApp.moveMessagesToTrash(toDelete);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
messages | GmailMessage[] | pesan akan dibuang |
Pulang pergi
GmailApp
— layanan Gmail (berguna untuk perantaian)
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadToArchive(thread)
Memindahkan rangkaian pesan ini ke arsip dan memaksa thread untuk dimuat ulang.
// Archive the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToArchive(firstThread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | rangkaian pesan untuk diarsipkan |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadToInbox(thread)
Memindahkan rangkaian pesan ini ke kotak masuk dan memaksa rangkaian pesan dimuat ulang.
// Find a thread not already in your inbox var thread = GmailApp.search("-in:inbox")[0]; // Get the first one GmailApp.moveThreadToInbox(thread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | rangkaian pesan akan dipindahkan ke kotak masuk |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadToSpam(thread)
Memindahkan rangkaian pesan ini ke spam dan memaksa rangkaian pesan dimuat ulang.
// Tag first thread in inbox as spam var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToSpam(firstThread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | rangkaian pesan akan dipindahkan ke spam |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadToTrash(thread)
Memindahkan rangkaian pesan ini ke sampah dan memaksa rangkaian pesan untuk dimuat ulang.
// Move first thread in inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToTrash(firstThread);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | utas akan dibuang |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadsToArchive(threads)
Memindahkan rangkaian pesan ini ke arsip dan memaksa thread untuk dimuat ulang.
// Move first two threads in your inbox to the archive var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToArchive(firstTwoThreads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | array thread yang akan diarsipkan |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadsToInbox(threads)
Memindahkan rangkaian pesan ini ke kotak masuk dan memaksa rangkaian pesan dimuat ulang.
// Find two threads not already in your inbox var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | array rangkaian pesan yang akan dipindahkan ke kotak masuk |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadsToSpam(threads)
Memindahkan rangkaian pesan ini ke spam dan memaksa rangkaian pesan dimuat ulang.
// Move first two threads in your inbox to spam var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToSpam(firstTwoThreads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | serangkaian rangkaian pesan yang akan dipindahkan ke spam |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
moveThreadsToTrash(threads)
Memindahkan rangkaian pesan ini ke sampah dan memaksa rangkaian pesan untuk dimuat ulang.
// Move first two threads in your inbox to trash var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToTrash(firstTwoThreads);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | array utas yang akan dibuang |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
refreshMessage(message)
Memuat ulang pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dan lain-lain, telah berubah).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; // ...Do something that may take a while here.... GmailApp.refreshMessage(firstMessage); // ...Do more stuff with firstMessage...
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
message | GmailMessage | pesan diperbarui |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
refreshMessages(messages)
Memuat ulang pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dan lain-lain, telah berubah).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 2); // ...Do something that may take a while here.... GmailApp.refreshMessages(coupleOfMessages); // ...Do more stuff with coupleOfMessages...
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
messages | GmailMessage[] | pesan untuk dimuat ulang |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
refreshThread(thread)
Memuat ulang rangkaian pesan dan status terkait dari Gmail (berguna jika label, status baca, dan lain-lain, telah berubah).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; // ...Do something that may take a while here.... GmailApp.refreshThread(firstThread); // ... Do more stuff with the thread ...
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
thread | GmailThread | thread yang akan dimuat ulang |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
refreshThreads(threads)
Memuat ulang thread dan status terkait dari Gmail (berguna jika label, status baca, dan lain-lain, telah berubah).
var threads = GmailApp.getInboxThreads(0, 3); // ...Do something that may take a while here.... GmailApp.refreshThreads(threads); // ... Do more stuff with threads ...
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
threads | GmailThread[] | thread yang akan dimuat ulang |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
search(query)
Menelusuri Gmail dengan kueri yang ditentukan.
Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan kemungkinan sangat besar, gunakan 'paged' panggilan, dan menentukan rentang thread yang akan diambil dalam setiap panggilan.
// Find starred messages with subject IMPORTANT var threads = GmailApp.search('is:starred subject:"IMPORTANT"');
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
query | String | kueri penelusuran, seperti yang Anda ketik di Gmail |
Pulang pergi
GmailThread[]
— array thread Gmail yang cocok dengan kueri ini
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
search(query, start, max)
Menelusuri Gmail dengan kueri yang ditentukan.
// Find starred messages with subject IMPORTANT and return second batch of 10. // Assumes there are at least 11 of them, otherwise this will return an empty array. var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
query | String | kueri penelusuran, seperti yang Anda ketik di Gmail |
start | Integer | indeks thread awal |
max | Integer | jumlah maksimum thread yang akan ditampilkan |
Pulang pergi
GmailThread[]
— array thread Gmail yang cocok dengan kueri ini
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
sendEmail(recipient, subject, body)
Mengirim pesan email. Ukuran email (termasuk header) terbatas kuota.
// The code below will send an email with the current date and time. var now = new Date(); GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
recipient | String | daftar alamat email yang dipisahkan koma |
subject | String | subjek email (maksimal 250 karakter) |
body | String | isi email |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
sendEmail(recipient, subject, body, options)
Mengirim pesan email dengan argumen opsional. Email dapat berisi teks biasa atau HTML {i>body <i}itu. Ukuran email (termasuk header, tetapi tidak termasuk lampiran) kuota terbatas.
// Send an email with a file from Google Drive attached as a PDF. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
recipient | String | alamat penerima |
subject | String | baris subjek (maksimal 250 karakter) |
body | String | isi email |
options | Object | objek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini |
Parameter lanjutan
Nama | Jenis | Deskripsi |
---|---|---|
attachments | BlobSource[] | sebuah rangkaian file untuk dikirim melalui email |
bcc | String | daftar alamat email yang dipisahkan koma ke BCC |
cc | String | daftar alamat email yang dipisahkan koma ke CC |
from | String | alamat asal email, yang harus satu
dari nilai yang ditampilkan oleh getAliases() |
htmlBody | String | jika disetel, perangkat yang dapat merender HTML akan menggunakannya
argumen body yang dibutuhkan; Anda dapat menambahkan kolom inlineImages opsional di HTML
body jika Anda memiliki gambar sisipan untuk email |
inlineImages | Object | objek JavaScript yang berisi pemetaan dari kunci gambar
(String ) ke data gambar (BlobSource ); hal ini mengasumsikan bahwa parameter htmlBody digunakan dan berisi referensi ke gambar ini dalam format <img src="cid:imageKey" /> |
name | String | nama pengirim email (default: nama pengguna) |
noReply | Boolean | true jika email harus dikirim dari email
alamat email yang tidak dibalas untuk mencegah penerima membalas email; opsi ini
hanya dapat dilakukan untuk akun Google Workspace, bukan pengguna Gmail |
replyTo | String | alamat email untuk digunakan sebagai alamat balas-ke default (default: alamat email pengguna) |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
setCurrentMessageAccessToken(accessToken)
Menyetel pesan saat ini
token akses yang memungkinkan skrip untuk mengakses properti GmailMessage
saat ini.
Hanya project Add-on Google Workspace yang menggunakan cakupan pesan saat ini Gmail memerlukan metode ini.
function handleAddonActionEvent(e) { var accessToken = e.messageMetadata.accessToken; var messageId = e.messageMetadata.messageId; GmailApp.setCurrentMessageAccessToken(accessToken); var mailMessage = GmailApp.getMessageById(messageId); // Do something with mailMessage }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
accessToken | String | token akses sementara yang diperoleh dari objek peristiwa tindakan add-on Gmail. |
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
starMessage(message)
Menambahkan bintang ke pesan ini dan memaksa pesan dimuat ulang.
// Stars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.starMessage(message);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
message | GmailMessage | pesan untuk dibintangi |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
starMessages(messages)
Menambahkan bintang pada pesan tersebut dan memaksa pesan untuk disegarkan.
// Stars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.starMessages(coupleOfMessages);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
messages | GmailMessage[] | susunan pesan yang harus dibintangi |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
unstarMessage(message)
Menghapus bintang dari pesan ini dan memaksa pesan dimuat ulang.
// Unstars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.unstarMessage(message);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
message | GmailMessage | pesan untuk dihapus bintangnya |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/
Lihat juga
unstarMessages(messages)
Menghapus bintang dari pesan ini dan memaksa pesan untuk dimuat ulang.
// Unstars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
messages | GmailMessage[] | array pesan untuk dihapus bintangnya |
Pulang pergi
GmailApp
— layanan Gmail, berguna untuk perantaian
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut atau cakupan yang sesuai dari REST API terkait:
-
https://mail.google.com/