Class GmailApp

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.
Aplikasi Gmail

Menyediakan akses ke rangkaian pesan, pesan, dan label Gmail.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
createDraft(recipient, subject, body)GmailDraftMembuat draf pesan email.
createDraft(recipient, subject, body, options)GmailDraftMembuat draf pesan email dengan argumen opsional.
createLabel(name)GmailLabelMembuat label pengguna baru dari nama yang diberikan.
deleteLabel(label)GmailAppMenghapus label yang ditentukan.
getAliases()String[]Mendapatkan daftar email yang disiapkan sebagai alias untuk akun ini di Gmail.
getDraft(draftId)GmailDraftAmbil 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()IntegerMendapatkan jumlah rangkaian pesan yang belum dibaca di kotak masuk.
getMessageById(id)GmailMessageMendapatkan 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()IntegerMendapatkan 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()IntegerMendapatkan 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()IntegerMendapatkan jumlah rangkaian pesan yang belum dibaca yang berbintang.
getThreadById(id)GmailThreadMendapatkan 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)GmailLabelMengambil label yang diberi nama label.
getUserLabels()GmailLabel[]Mengambil daftar label buatan pengguna.
markMessageRead(message)GmailAppMenandai pesan ini sebagai telah dibaca dan memaksa pesan tersebut untuk dimuat ulang.
markMessageUnread(message)GmailAppMenandai pesan ini sebagai belum dibaca dan memaksanya untuk dimuat ulang.
markMessagesRead(messages)GmailAppMenandai pesan ini sebagai telah dibaca dan memaksanya untuk dimuat ulang.
markMessagesUnread(messages)GmailAppMenandai pesan ini sebagai belum dibaca dan memaksanya untuk dimuat ulang.
markThreadImportant(thread)GmailAppMenandai thread ini sebagai penting dan memaksa thread untuk dimuat ulang.
markThreadRead(thread)GmailAppMenandai thread ini sebagai telah dibaca dan memaksa thread untuk dimuat ulang.
markThreadUnimportant(thread)GmailAppMenandai thread ini sebagai tidak penting dan memaksa thread untuk dimuat ulang.
markThreadUnread(thread)GmailAppMenandai thread ini belum dibaca dan memaksa thread untuk dimuat ulang.
markThreadsImportant(threads)GmailAppMenandai thread ini sebagai penting dan memaksa thread untuk dimuat ulang.
markThreadsRead(threads)GmailAppMenandai thread ini sebagai telah dibaca dan memaksa thread untuk dimuat ulang.
markThreadsUnimportant(threads)GmailAppMenandai thread ini sebagai tidak penting dan memaksa thread untuk dimuat ulang.
markThreadsUnread(threads)GmailAppMenandai thread ini sebagai belum dibaca dan memaksa thread untuk dimuat ulang.
moveMessageToTrash(message)GmailAppMemindahkan pesan ke sampah dan memaksa pesan dimuat ulang.
moveMessagesToTrash(messages)GmailAppMemindahkan pesan yang ditentukan ke sampah dan memaksa pesan untuk dimuat ulang.
moveThreadToArchive(thread)GmailAppMemindahkan thread ini ke arsip dan memaksa thread untuk dimuat ulang.
moveThreadToInbox(thread)GmailAppMemindahkan thread ini ke kotak masuk dan memaksa thread untuk dimuat ulang.
moveThreadToSpam(thread)GmailAppMemindahkan thread ini ke spam dan memaksa thread untuk dimuat ulang.
moveThreadToTrash(thread)GmailAppMemindahkan thread ini ke sampah dan memaksa thread untuk dimuat ulang.
moveThreadsToArchive(threads)GmailAppMemindahkan thread ini ke arsip dan memaksa thread untuk dimuat ulang.
moveThreadsToInbox(threads)GmailAppMemindahkan thread ini ke kotak masuk dan memaksa thread untuk dimuat ulang.
moveThreadsToSpam(threads)GmailAppMemindahkan thread ini ke spam dan memaksa thread untuk dimuat ulang.
moveThreadsToTrash(threads)GmailAppMemindahkan thread ini ke sampah dan memaksa thread untuk dimuat ulang.
refreshMessage(message)GmailAppMemuat ulang pesan dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah).
refreshMessages(messages)GmailAppMemuat ulang pesan dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah).
refreshThread(thread)GmailAppMemuat ulang thread dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah).
refreshThreads(threads)GmailAppMemuat 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)GmailAppMengirim pesan email.
sendEmail(recipient, subject, body, options)GmailAppMengirim pesan email dengan argumen opsional.
setCurrentMessageAccessToken(accessToken)voidMenetapkan token akses pesan saat ini yang memungkinkan skrip mengakses properti GmailMessage saat ini.
starMessage(message)GmailAppMenambahkan bintang ke pesan ini dan memaksa pesan dimuat ulang.
starMessages(messages)GmailAppMenambahkan bintang ke pesan ini dan memaksa pesan untuk dimuat ulang.
unstarMessage(message)GmailAppMenghapus bintang dari pesan ini dan memaksa pesan dimuat ulang.
unstarMessages(messages)GmailAppMenghapus bintang dari pesan ini dan memaksa pesan dimuat ulang.

Dokumentasi mendetail

createDraft(recipient, subject, body)

Membuat draf pesan email. Ukuran email (termasuk header) adalah kuota terbatas.

// 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

NameJenisDeskripsi
recipientStringdaftar alamat email yang dipisahkan koma
subjectStringsubjek email
bodyStringisi email

Return

GmailDraft — GmailDraf 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) dibatasi kuota.

// 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

NameJenisDeskripsi
recipientStringalamat penerima
subjectStringbaris subjek
bodyStringbagian isi email
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini

Parameter lanjutan

NameJenisDeskripsi
attachmentsBlobSource[]array file yang akan dikirim dengan email
bccStringdaftar alamat email yang dipisahkan koma ke BCC
ccStringdaftar alamat email yang dipisahkan koma untuk CC
fromStringalamat pengirim email, yang harus merupakan salah satu nilai yang ditampilkan oleh getAliases()
htmlBodyStringjika ditetapkan, perangkat yang mampu merender HTML akan menggunakannya sebagai ganti argumen isi yang diperlukan; Anda dapat menambahkan kolom inlineImages opsional di isi HTML jika Anda memiliki gambar inline untuk email
inlineImagesObjectobjek JavaScript yang berisi pemetaan dari kunci gambar (String) ke data gambar (BlobSource); ini mengasumsikan bahwa parameter htmlBody digunakan dan berisi referensi ke gambar ini dalam format <img src="cid:imageKey" />
nameStringnama pengirim email (default: nama pengguna)
replyToStringalamat email yang akan digunakan sebagai alamat balas-ke default (default: alamat email pengguna)

Return

GmailDraft — GmailDraf 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)

Membuat label pengguna baru dari nama yang diberikan.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

Parameter

NameJenisDeskripsi
nameStringnama label baru

Return

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

NameJenisDeskripsi
labelGmailLabellabel yang akan dihapus

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 tersebut 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.');
}

Return

String[] — array 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 kode 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

NameJenisDeskripsi
draftIdStringID draf yang akan diambil

Return

GmailDraft — draf dengan ID yang diberikan

Menampilkan

Error — jika tidak ada draf dengan ID 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/

getDraftMessages()

Mengambil semua pesan draf.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Return

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());
}

Return

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 terlepas dari label.

Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan berpotensi sangat besar, gunakan 'paged' panggil, dan tentukan rentang thread yang akan diambil di 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());
}

Return

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 rentang rangkaian pesan Kotak Masuk terlepas dari label.

// 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

NameJenisDeskripsi
startIntegerindeks thread pertama yang akan diambil
maxIntegerjumlah maksimum thread yang akan diambil

Return

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());

Return

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 menurut 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

NameJenisDeskripsi
idStringID pesan yang akan diambil

Return

GmailMessage — pesan dengan ID yang diberikan

Menampilkan

Error — jika pesan dengan ID yang ditentukan 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/

Lihat juga


getMessagesForThread(thread)

Mengambil semua pesan di 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

NameJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan diambil

Return

GmailMessage[] — array pesan yang sesuai dengan thread 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 di 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

NameJenisDeskripsi
threadsGmailThread[]rangkaian pesan yang akan diambil

Return

GmailMessage[][] — array pesan, di mana setiap item dalam array luar sesuai dengan thread 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 thread Kotak Prioritas terlepas dari labelnya.

Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan berpotensi sangat besar, gunakan 'paged' panggil, dan tentukan rentang thread yang akan diambil di setiap panggilan.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

Return

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 rentang rangkaian Kotak Prioritas, terlepas dari labelnya.

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

Parameter

NameJenisDeskripsi
startIntegerindeks thread pertama yang akan diambil
maxIntegerjumlah maksimum thread yang akan diambil

Return

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 dalam Kotak Prioritas.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

Return

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 terlepas dari labelnya.

Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan berpotensi sangat besar, gunakan 'paged' panggil, dan tentukan rentang thread yang akan diambil di setiap panggilan.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

Return

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 rangkaian thread spam terlepas dari label.

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

Parameter

NameJenisDeskripsi
startIntegerindeks thread pertama yang akan diambil
maxIntegerjumlah maksimum thread yang akan diambil

Return

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());

Return

Integer — jumlah rangkaian pesan spam yang memiliki pesan 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 thread berbintang terlepas dari label.

Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan berpotensi sangat besar, gunakan 'paged' panggil, dan tentukan rentang thread yang akan diambil di setiap panggilan.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

Return

GmailThread[] — array rangkaian pesan Gmail yang 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 rentang thread berbintang terlepas dari label.

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

Parameter

NameJenisDeskripsi
startIntegerindeks thread pertama yang akan diambil
maxIntegerjumlah maksimum thread yang akan diambil

Return

GmailThread[] — array rangkaian pesan Gmail yang 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 berbintang.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

Return

Integer — jumlah rangkaian pesan berbintang yang memiliki pesan 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 thread berdasarkan ID.

Gunakan ini bersama dengan getId() di thread Gmail.

// Thread IDs can also be found in the location bar when you have a thread open in Gmail
// get first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
// Get the same thread by ID
var threadById = GmailApp.getThreadById(firstThread.getId());
// Verify they are the same
Logger.log(firstThread.getFirstMessageSubject() == threadById.getFirstMessageSubject());

Parameter

NameJenisDeskripsi
idStringID thread yang akan diambil

Return

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 thread sampah terlepas dari labelnya.

Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran thread tidak diketahui, dan berpotensi sangat besar, gunakan 'paged' panggil, dan tentukan rentang thread yang akan diambil di setiap panggilan.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

Return

GmailThread[] — array rangkaian pesan 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 kumpulan thread sampah terlepas dari labelnya.

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

Parameter

NameJenisDeskripsi
startIntegerindeks thread pertama yang akan diambil
maxIntegerjumlah maksimum thread yang akan diambil

Return

GmailThread[] — array rangkaian pesan 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 yang diberi nama label.

var labelObject = GmailApp.getUserLabelByName("myLabel");

Parameter

NameJenisDeskripsi
nameStringnama label yang akan diambil

Return

GmailLabel — label Gmail dengan nama yang diberikan

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 buatan 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());
}

Return

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 sebagai telah dibaca dan memaksa pesan tersebut 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

NameJenisDeskripsi
messageGmailMessagepesan untuk ditandai sebagai telah dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 memaksanya 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

NameJenisDeskripsi
messageGmailMessagepesan untuk ditandai sebagai belum dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 sebagai telah dibaca dan memaksanya 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

NameJenisDeskripsi
messagesGmailMessage[]array pesan untuk ditandai sebagai telah dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 memaksanya 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

NameJenisDeskripsi
messagesGmailMessage[]array pesan untuk ditandai sebagai belum dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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

NameJenisDeskripsi
threadGmailThreadrangkaian pesan untuk ditandai sebagai penting

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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

NameJenisDeskripsi
threadGmailThreadrangkaian pesan untuk ditandai sebagai telah dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini sebagai tidak penting dan memaksa thread untuk dimuat ulang.

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Parameter

NameJenisDeskripsi
threadGmailThreadrangkaian pesan untuk ditandai sebagai tidak penting

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini belum dibaca dan memaksa thread untuk dimuat ulang.

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parameter

NameJenisDeskripsi
threadGmailThreadrangkaian pesan untuk ditandai sebagai belum dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread 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

NameJenisDeskripsi
threadsGmailThread[]array thread untuk ditandai sebagai penting

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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

NameJenisDeskripsi
threadsGmailThread[]array thread untuk ditandai sebagai telah dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini sebagai tidak penting dan memaksa thread untuk dimuat ulang.

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parameter

NameJenisDeskripsi
threadsGmailThread[]array thread untuk ditandai sebagai tidak penting

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini sebagai belum dibaca dan memaksa thread untuk dimuat ulang.

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parameter

NameJenisDeskripsi
threadsGmailThread[]array thread untuk ditandai sebagai belum dibaca

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 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

NameJenisDeskripsi
messageGmailMessagepesan ke sampah

Return

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

NameJenisDeskripsi
messagesGmailMessage[]pesan yang akan dibuang

Return

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 thread 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

NameJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan diarsipkan

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini ke kotak masuk dan memaksa thread untuk 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

NameJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan dipindahkan ke kotak masuk

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini ke spam dan memaksa thread untuk dimuat ulang.

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parameter

NameJenisDeskripsi
threadGmailThreadthread untuk dipindahkan ke spam

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini ke sampah dan memaksa thread untuk dimuat ulang.

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parameter

NameJenisDeskripsi
threadGmailThreadthread untuk dibuang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread 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

NameJenisDeskripsi
threadsGmailThread[]array thread yang akan diarsipkan

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini ke kotak masuk dan memaksa thread untuk dimuat ulang.

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parameter

NameJenisDeskripsi
threadsGmailThread[]array thread yang akan dipindahkan ke kotak masuk

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini ke spam dan memaksa thread untuk dimuat ulang.

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parameter

NameJenisDeskripsi
threadsGmailThread[]array thread yang akan dipindahkan ke spam

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread ini ke sampah dan memaksa thread untuk dimuat ulang.

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parameter

NameJenisDeskripsi
threadsGmailThread[]array thread yang akan dibuang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 baca, dll., 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

NameJenisDeskripsi
messageGmailMessagepesan untuk dimuat ulang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 baca, dll., 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

NameJenisDeskripsi
messagesGmailMessage[]pesan yang akan dimuat ulang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 thread dan status terkait dari Gmail (berguna jika label, status baca, dll., 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

NameJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan dimuat ulang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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, dll., 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

NameJenisDeskripsi
threadsGmailThread[]rangkaian pesan yang akan dimuat ulang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 berpotensi sangat besar, gunakan 'paged' panggil, dan tentukan rentang thread yang akan diambil di setiap panggilan.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parameter

NameJenisDeskripsi
queryStringkueri penelusuran, seperti yang dapat Anda ketik ke Gmail

Return

GmailThread[] — array rangkaian pesan 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

NameJenisDeskripsi
queryStringkueri penelusuran, seperti yang dapat Anda ketik ke Gmail
startIntegerindeks thread awal
maxIntegerjumlah maksimum thread yang akan ditampilkan

Return

GmailThread[] — array rangkaian pesan 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) adalah kuota terbatas.

// 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

NameJenisDeskripsi
recipientStringdaftar alamat email yang dipisahkan koma
subjectStringsubjek email (maksimum 250 karakter)
bodyStringisi email

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 teks HTML. Ukuran email (termasuk header, tetapi tidak termasuk lampiran) dibatasi kuota.

// 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

NameJenisDeskripsi
recipientStringalamat penerima
subjectStringbaris subjek (maksimum 250 karakter)
bodyStringbagian isi email
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah ini

Parameter lanjutan

NameJenisDeskripsi
attachmentsBlobSource[]array file yang akan dikirim dengan email
bccStringdaftar alamat email yang dipisahkan koma ke BCC
ccStringdaftar alamat email yang dipisahkan koma untuk CC
fromStringalamat pengirim email, yang harus merupakan salah satu nilai yang ditampilkan oleh getAliases()
htmlBodyStringjika ditetapkan, perangkat yang mampu merender HTML akan menggunakannya sebagai ganti argumen isi yang diperlukan; Anda dapat menambahkan kolom inlineImages opsional di isi HTML jika Anda memiliki gambar inline untuk email
inlineImagesObjectobjek JavaScript yang berisi pemetaan dari kunci gambar (String) ke data gambar (BlobSource); ini mengasumsikan bahwa parameter htmlBody digunakan dan berisi referensi ke gambar ini dalam format <img src="cid:imageKey" />
nameStringnama pengirim email (default: nama pengguna)
noReplyBooleantrue jika email harus dikirim dari alamat email no-reply generik untuk mencegah penerima merespons email; opsi ini hanya memungkinkan untuk akun Google Workspace, bukan pengguna Gmail
replyToStringalamat email yang akan digunakan sebagai alamat balas-ke default (default: alamat email pengguna)

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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)

Menetapkan token akses pesan saat ini yang memungkinkan skrip mengakses properti GmailMessage saat ini.

Hanya project Add-on Google Workspace yang menggunakan cakupan pesan saat ini di Gmail yang 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

NameJenisDeskripsi
accessTokenStringtoken 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

NameJenisDeskripsi
messageGmailMessagepesan untuk membintangi

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 ke pesan ini dan memaksa pesan untuk dimuat ulang.

// 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

NameJenisDeskripsi
messagesGmailMessage[]array pesan yang berbintang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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

NameJenisDeskripsi
messageGmailMessagehapus bintang pesan

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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 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

NameJenisDeskripsi
messagesGmailMessage[]array pesan untuk menghapus bintang

Return

GmailApp — layanan Gmail, berguna untuk membuat rantai

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

Metode yang tidak digunakan lagi