Class GmailApp

AplikasiGmail

Memberikan 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 pesan email draf dengan argumen opsional.
createLabel(name)GmailLabelBuat label pengguna baru dengan 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)GmailDraftMengambil draf pesan email berdasarkan ID.
getDraftMessages()GmailMessage[]Mengambil semua pesan draf.
getDrafts()GmailDraft[]Mendapatkan semua pesan draf Gmail.
getInboxThreads()GmailThread[]Mengambil semua rangkaian pesan di Kotak Masuk, terlepas dari labelnya.
getInboxThreads(start, max)GmailThread[]Mengambil rentang rangkaian pesan Kotak Masuk, terlepas dari labelnya.
getInboxUnreadCount()IntegerMendapatkan jumlah rangkaian pesan yang belum dibaca di kotak masuk.
getMessageById(id)GmailMessageMendapatkan 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, terlepas dari labelnya.
getPriorityInboxThreads(start, max)GmailThread[]Mengambil berbagai rangkaian pesan Kotak Prioritas, terlepas dari labelnya.
getPriorityInboxUnreadCount()IntegerMendapatkan jumlah rangkaian pesan yang belum dibaca di Kotak Prioritas.
getSpamThreads()GmailThread[]Mengambil semua rangkaian pesan spam, terlepas dari labelnya.
getSpamThreads(start, max)GmailThread[]Mengambil rentang rangkaian pesan spam, terlepas dari labelnya.
getSpamUnreadCount()IntegerMendapatkan jumlah rangkaian pesan yang belum dibaca dan merupakan spam.
getStarredThreads()GmailThread[]Mengambil semua rangkaian pesan berbintang, terlepas dari labelnya.
getStarredThreads(start, max)GmailThread[]Mengambil rentang rangkaian pesan berbintang, terlepas dari labelnya.
getStarredUnreadCount()IntegerMendapatkan jumlah rangkaian pesan yang belum dibaca dan diberi bintang.
getThreadById(id)GmailThreadMendapatkan rangkaian pesan berdasarkan ID.
getTrashThreads()GmailThread[]Mengambil semua rangkaian pesan sampah, terlepas dari labelnya.
getTrashThreads(start, max)GmailThread[]Mengambil rentang rangkaian pesan sampah, terlepas dari labelnya.
getUserLabelByName(name)GmailLabelMengambil label berdasarkan nama label.
getUserLabels()GmailLabel[]Mengambil daftar label buatan pengguna.
markMessageRead(message)GmailAppMenandai pesan ini telah dibaca dan memaksa pesan dimuat ulang.
markMessageUnread(message)GmailAppMenandai pesan ini sebagai belum dibaca dan memaksa pesan untuk dimuat ulang.
markMessagesRead(messages)GmailAppMenandai pesan ini telah dibaca dan memaksa pesan untuk dimuat ulang.
markMessagesUnread(messages)GmailAppMenandai pesan ini sebagai belum dibaca dan memaksa pesan untuk dimuat ulang.
markThreadImportant(thread)GmailAppMenandai rangkaian pesan ini sebagai penting dan memaksa rangkaian pesan untuk dimuat ulang.
markThreadRead(thread)GmailAppMenandai rangkaian pesan ini sebagai telah dibaca dan memaksa rangkaian pesan untuk dimuat ulang.
markThreadUnimportant(thread)GmailAppMenandai rangkaian pesan ini sebagai tidak penting dan memaksa rangkaian pesan untuk dimuat ulang.
markThreadUnread(thread)GmailAppMenandai rangkaian pesan ini sebagai belum dibaca dan memaksa rangkaian pesan untuk dimuat ulang.
markThreadsImportant(threads)GmailAppMenandai rangkaian pesan ini sebagai penting dan memaksa rangkaian pesan untuk dimuat ulang.
markThreadsRead(threads)GmailAppMenandai rangkaian pesan ini sebagai telah dibaca dan memaksa rangkaian pesan untuk dimuat ulang.
markThreadsUnimportant(threads)GmailAppMenandai rangkaian pesan ini sebagai tidak penting dan memaksa rangkaian pesan untuk dimuat ulang.
markThreadsUnread(threads)GmailAppMenandai rangkaian pesan ini sebagai belum dibaca dan memaksa rangkaian pesan untuk dimuat ulang.
moveMessageToTrash(message)GmailAppMemindahkan pesan ke sampah dan memaksa pesan untuk dimuat ulang.
moveMessagesToTrash(messages)GmailAppMemindahkan pesan yang ditentukan ke sampah dan memaksa pesan untuk dimuat ulang.
moveThreadToArchive(thread)GmailAppMemindahkan rangkaian pesan ini ke arsip dan memaksa rangkaian pesan untuk dimuat ulang.
moveThreadToInbox(thread)GmailAppMemindahkan rangkaian pesan ini ke kotak masuk dan memaksa rangkaian pesan untuk dimuat ulang.
moveThreadToSpam(thread)GmailAppMemindahkan rangkaian pesan ini ke spam dan memaksa rangkaian pesan untuk dimuat ulang.
moveThreadToTrash(thread)GmailAppMemindahkan rangkaian pesan ini ke sampah dan memaksa rangkaian pesan untuk dimuat ulang.
moveThreadsToArchive(threads)GmailAppMemindahkan rangkaian pesan ini ke arsip dan memaksa rangkaian pesan untuk dimuat ulang.
moveThreadsToInbox(threads)GmailAppMemindahkan rangkaian pesan ini ke kotak masuk dan memaksa rangkaian pesan untuk dimuat ulang.
moveThreadsToSpam(threads)GmailAppMemindahkan rangkaian pesan ini ke spam dan memaksa rangkaian pesan untuk dimuat ulang.
moveThreadsToTrash(threads)GmailAppMemindahkan rangkaian pesan ini ke sampah dan memaksa rangkaian pesan untuk dimuat ulang.
refreshMessage(message)GmailAppMemuat ulang pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dll., telah berubah).
refreshMessages(messages)GmailAppMemuat ulang pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dll., telah berubah).
refreshThread(thread)GmailAppMemuat ulang rangkaian pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dll., telah berubah).
refreshThreads(threads)GmailAppMemuat ulang rangkaian pesan dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah).
search(query)GmailThread[]Menelusuri Gmail dengan kueri yang diberikan.
search(query, start, max)GmailThread[]Menelusuri Gmail dengan kueri yang diberikan.
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 untuk 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 untuk dimuat ulang.
unstarMessages(messages)GmailAppMenghapus bintang dari pesan ini dan memaksa pesan untuk dimuat ulang.

Dokumentasi mendetail

createDraft(recipient, subject, body)

Membuat draf pesan email. Ukuran email (termasuk header) dibatasi kuota.

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

Parameter

NamaJenisDeskripsi
recipientStringdaftar alamat email yang dipisahkan koma
subjectStringsubjek email
bodyStringisi email

Pulang pergi

GmailDraft — GmailDraft 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 pesan email draf 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.
const 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

NamaJenisDeskripsi
recipientStringalamat penerima
subjectStringbaris subjek
bodyStringisi email
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah

Parameter lanjutan

NamaJenisDeskripsi
attachmentsBlobSource[]array file yang akan dikirim dengan email
bccStringdaftar alamat email yang dipisahkan koma untuk BCC
ccStringdaftar alamat email yang dipisahkan koma untuk disertakan dalam kolom Cc
fromStringalamat tempat email harus dikirim, yang harus berupa salah satu nilai yang ditampilkan oleh getAliases()
htmlBodyStringjika ditetapkan, perangkat yang dapat merender HTML akan menggunakannya sebagai pengganti argumen isi yang diperlukan; Anda dapat menambahkan kolom inlineImages opsional di isi HTML jika telah menyisipkan gambar untuk email
inlineImagesObjectobjek 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" />
nameStringnama pengirim email (default: nama pengguna)
replyToStringalamat email yang akan digunakan sebagai alamat balas-ke default (default: alamat email pengguna)

Pulang pergi

GmailDraft — GmailDraft 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 dengan nama yang diberikan.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Parameter

NamaJenisDeskripsi
nameStringnama 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
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

Parameter

NamaJenisDeskripsi
labelGmailLabellabel yang akan dihapus

Pulang pergi

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 salah satu alias ini menggunakan argumen opsional "dari".

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const 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[] — 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)

Mengambil draf pesan email berdasarkan ID.

Gunakan ini bersama dengan getId() pada draf Gmail.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

Parameter

NamaJenisDeskripsi
draftIdStringID draf yang akan diambil

Pulang pergi

GmailDraft — draf dengan ID yang diberikan

Menampilkan

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

getDraftMessages()

Mengambil semua pesan draf.

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

Pulang pergi

GmailMessage[] — 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/

getDrafts()

Mendapatkan semua pesan draf Gmail.

const drafts = GmailApp.getDrafts();
for (let 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 di Kotak Masuk, terlepas dari labelnya.

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

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let 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 rentang rangkaian pesan Kotak Masuk, terlepas dari labelnya.

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parameter

NamaJenisDeskripsi
startIntegerindeks rangkaian pesan pertama yang akan diambil
maxIntegerjumlah 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
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

Parameter

NamaJenisDeskripsi
idStringID pesan yang akan diambil

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
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan diambil

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
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

Parameter

NamaJenisDeskripsi
threadsGmailThread[]rangkaian pesan yang akan diambil

Pulang pergi

GmailMessage[][] — array array pesan, dengan setiap item dalam array luar sesuai dengan rangkaian pesan dan array dalam berisi pesan dalam rangkaian pesan 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, terlepas dari labelnya.

Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran rangkaian pesan tidak diketahui, dan berpotensi sangat besar, gunakan panggilan 'paged', dan tentukan rentang rangkaian pesan 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 rangkaian pesan 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

NamaJenisDeskripsi
startIntegerindeks rangkaian pesan pertama yang akan diambil
maxIntegerjumlah 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, terlepas dari labelnya.

Panggilan ini akan gagal jika ukuran semua thread terlalu besar untuk ditangani sistem. Jika ukuran rangkaian pesan tidak diketahui, dan berpotensi sangat besar, gunakan panggilan 'paged', dan tentukan rentang rangkaian pesan 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 rentang rangkaian pesan spam, terlepas dari labelnya.

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

Parameter

NamaJenisDeskripsi
startIntegerindeks rangkaian pesan pertama yang akan diambil
maxIntegerjumlah 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 dan 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, terlepas dari labelnya.

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

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

Pulang pergi

GmailThread[] — array rangkaian pesan 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 rentang rangkaian pesan berbintang, terlepas dari labelnya.

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

Parameter

NamaJenisDeskripsi
startIntegerindeks rangkaian pesan pertama yang akan diambil
maxIntegerjumlah maksimum thread yang akan diambil

Pulang pergi

GmailThread[] — array rangkaian pesan 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 dan 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() di rangkaian email 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

NamaJenisDeskripsi
idStringID thread yang akan diambil.

Pulang pergi

GmailThread — Rangkaian pesan 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, terlepas dari labelnya.

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

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

Pulang pergi

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 rentang rangkaian pesan sampah, terlepas dari labelnya.

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

Parameter

NamaJenisDeskripsi
startIntegerindeks rangkaian pesan pertama yang akan diambil
maxIntegerjumlah maksimum thread yang akan diambil

Pulang pergi

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 berdasarkan nama label.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Parameter

NamaJenisDeskripsi
nameStringnama label yang akan diambil

Pulang pergi

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
const labels = GmailApp.getUserLabels();
for (let 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 dimuat ulang.

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parameter

NamaJenisDeskripsi
messageGmailMessagepesan yang akan ditandai sebagai telah dibaca

Pulang pergi

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

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parameter

NamaJenisDeskripsi
messageGmailMessagepesan yang akan ditandai sebagai belum dibaca

Pulang pergi

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 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.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

Parameter

NamaJenisDeskripsi
messagesGmailMessage[]array pesan yang akan ditandai sebagai telah dibaca

Pulang pergi

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 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
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

Parameter

NamaJenisDeskripsi
messagesGmailMessage[]array pesan yang akan ditandai sebagai belum dibaca

Pulang pergi

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

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan ditandai sebagai penting

Pulang pergi

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 rangkaian pesan ini sebagai telah dibaca dan memaksa rangkaian pesan untuk dimuat ulang.

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan ditandai sebagai telah dibaca

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan ditandai sebagai tidak penting

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan ditandai sebagai belum dibaca

Pulang pergi

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

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan ditandai sebagai penting

Pulang pergi

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 rangkaian pesan ini sebagai telah dibaca dan memaksa rangkaian pesan untuk dimuat ulang.

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan ditandai sebagai telah dibaca

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan ditandai sebagai tidak penting

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan ditandai sebagai belum dibaca

Pulang pergi

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 untuk dimuat ulang.

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parameter

NamaJenisDeskripsi
messageGmailMessagepesan yang akan dihapus

Pulang pergi

GmailApp — layanan Gmail (berguna untuk penyambungan)

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parameter

NamaJenisDeskripsi
messagesGmailMessage[]pesan yang akan dihapus

Pulang pergi

GmailApp — layanan Gmail (berguna untuk penyambungan)

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 rangkaian pesan untuk dimuat ulang.

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan diarsipkan

Pulang pergi

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

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan dipindahkan ke kotak masuk

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan dipindahkan ke spam

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan dihapus

Pulang pergi

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

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan diarsipkan

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan dipindahkan ke kotak masuk

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan dipindahkan ke spam

Pulang pergi

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

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

Parameter

NamaJenisDeskripsi
threadsGmailThread[]array rangkaian pesan yang akan dihapus

Pulang pergi

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 dibaca, dll., telah berubah).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Parameter

NamaJenisDeskripsi
messageGmailMessagepesan yang akan dimuat ulang

Pulang pergi

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 dibaca, dll., telah berubah).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Parameter

NamaJenisDeskripsi
messagesGmailMessage[]pesan yang akan dimuat ulang

Pulang pergi

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 rangkaian pesan dan status terkait dari Gmail (berguna jika label, status dibaca, dll., telah berubah).

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Parameter

NamaJenisDeskripsi
threadGmailThreadrangkaian pesan yang akan dimuat ulang

Pulang pergi

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 rangkaian pesan dan status terkait dari Gmail (berguna jika label, status baca, dll., telah berubah).

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parameter

NamaJenisDeskripsi
threadsGmailThread[]thread yang akan dimuat ulang

Pulang pergi

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

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

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

Parameter

NamaJenisDeskripsi
queryStringkueri penelusuran, seperti yang Anda ketik di Gmail

Pulang pergi

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

// 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.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parameter

NamaJenisDeskripsi
queryStringkueri penelusuran, seperti yang Anda ketik di Gmail
startIntegerindeks thread awal
maxIntegerjumlah maksimum thread yang akan ditampilkan

Pulang pergi

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

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

Parameter

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

Pulang pergi

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

// Send an email with a file from Google Drive attached as a PDF.
const 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

NamaJenisDeskripsi
recipientStringalamat penerima
subjectStringbaris subjek (maksimal 250 karakter)
bodyStringisi email
optionsObjectobjek JavaScript yang menentukan parameter lanjutan, seperti yang tercantum di bawah

Parameter lanjutan

NamaJenisDeskripsi
attachmentsBlobSource[]array file yang akan dikirim dengan email
bccStringdaftar alamat email yang dipisahkan koma untuk BCC
ccStringdaftar alamat email yang dipisahkan koma untuk disertakan dalam kolom Cc
fromStringalamat tempat email harus dikirim, yang harus berupa salah satu nilai yang ditampilkan oleh getAliases()
htmlBodyStringjika ditetapkan, perangkat yang dapat merender HTML akan menggunakannya sebagai pengganti argumen isi yang diperlukan; Anda dapat menambahkan kolom inlineImages opsional di isi HTML jika telah menyisipkan gambar untuk email
inlineImagesObjectobjek 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" />
nameStringnama pengirim email (default: nama pengguna)
noReplyBooleantrue jika email harus dikirim dari alamat email umum yang tidak dapat membalas untuk mencegah penerima merespons email; opsi ini hanya dapat dilakukan untuk akun Google Workspace, bukan pengguna Gmail
replyToStringalamat email yang akan digunakan sebagai alamat balas-ke default (default: alamat email pengguna)

Pulang pergi

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 Gmail yang memerlukan metode ini.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

Parameter

NamaJenisDeskripsi
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 untuk dimuat ulang.

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parameter

NamaJenisDeskripsi
messageGmailMessagepesan yang akan diberi bintang

Pulang pergi

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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parameter

NamaJenisDeskripsi
messagesGmailMessage[]array pesan yang akan diberi bintang

Pulang pergi

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 untuk dimuat ulang.

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parameter

NamaJenisDeskripsi
messageGmailMessagepesan yang akan dihapus bintangnya

Pulang pergi

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 untuk dimuat ulang.

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parameter

NamaJenisDeskripsi
messagesGmailMessage[]array pesan yang akan dihapus bintangnya

Pulang pergi

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