Class GmailApp

Ứng dụngGmail

Cho phép truy cập vào các chuỗi thư, thư và nhãn trong Gmail.

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
createDraft(recipient, subject, body)GmailDraftTạo thư email nháp.
createDraft(recipient, subject, body, options)GmailDraftTạo một thư email nháp có các đối số không bắt buộc.
createLabel(name)GmailLabelTạo một nhãn người dùng mới có tên đã cho.
deleteLabel(label)GmailAppXoá nhãn đã chỉ định.
getAliases()String[]Lấy danh sách email được thiết lập làm bí danh cho tài khoản này trong Gmail.
getDraft(draftId)GmailDraftTruy xuất thư nháp theo mã nhận dạng.
getDraftMessages()GmailMessage[]Truy xuất tất cả thư nháp.
getDrafts()GmailDraft[]Lấy tất cả thư nháp trong Gmail.
getInboxThreads()GmailThread[]Truy xuất tất cả chuỗi thư trong Hộp thư đến, bất kể nhãn.
getInboxThreads(start, max)GmailThread[]Truy xuất một dải chuỗi thư trong Hộp thư đến, bất kể nhãn.
getInboxUnreadCount()IntegerLấy số lượng chuỗi tin nhắn chưa đọc trong hộp thư đến.
getMessageById(id)GmailMessageLấy thông báo theo mã nhận dạng.
getMessagesForThread(thread)GmailMessage[]Truy xuất tất cả thư trong chuỗi thư đã chỉ định.
getMessagesForThreads(threads)GmailMessage[][]Truy xuất tất cả thư trong các chuỗi thư đã chỉ định.
getPriorityInboxThreads()GmailThread[]Truy xuất tất cả chuỗi thư trong Hộp thư đến ưu tiên, bất kể nhãn.
getPriorityInboxThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi thư trong Hộp thư ưu tiên, bất kể nhãn.
getPriorityInboxUnreadCount()IntegerLấy số lượng chuỗi thư chưa đọc trong Hộp thư ưu tiên.
getSpamThreads()GmailThread[]Truy xuất tất cả chuỗi thư rác bất kể nhãn.
getSpamThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi thư rác bất kể nhãn.
getSpamUnreadCount()IntegerLấy số lượng chuỗi tin nhắn chưa đọc là thư rác.
getStarredThreads()GmailThread[]Truy xuất tất cả chuỗi tin nhắn được gắn dấu sao, bất kể nhãn.
getStarredThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi tin nhắn được gắn dấu sao, bất kể nhãn.
getStarredUnreadCount()IntegerLấy số lượng chuỗi tin nhắn chưa đọc được gắn dấu sao.
getThreadById(id)GmailThreadLấy luồng theo mã nhận dạng.
getTrashThreads()GmailThread[]Truy xuất tất cả chuỗi thư rác bất kể nhãn.
getTrashThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi thư rác bất kể nhãn.
getUserLabelByName(name)GmailLabelTruy xuất một nhãn dựa trên tên nhãn.
getUserLabels()GmailLabel[]Truy xuất danh sách nhãn do người dùng tạo.
markMessageRead(message)GmailAppĐánh dấu tin nhắn này là đã đọc và buộc làm mới tin nhắn.
markMessageUnread(message)GmailAppĐánh dấu tin nhắn này là chưa đọc và buộc làm mới tin nhắn.
markMessagesRead(messages)GmailAppĐánh dấu các thư này là đã đọc và buộc làm mới các thư.
markMessagesUnread(messages)GmailAppĐánh dấu những thư này là chưa đọc và buộc thư làm mới.
markThreadImportant(thread)GmailAppĐánh dấu luồng này là quan trọng và buộc luồng làm mới.
markThreadRead(thread)GmailAppĐánh dấu chuỗi tin nhắn này là đã đọc và buộc chuỗi tin nhắn làm mới.
markThreadUnimportant(thread)GmailAppĐánh dấu chuỗi tin nhắn này là không quan trọng và buộc chuỗi tin nhắn làm mới.
markThreadUnread(thread)GmailAppĐánh dấu chuỗi tin nhắn này là chưa đọc và buộc chuỗi tin nhắn làm mới.
markThreadsImportant(threads)GmailAppĐánh dấu các luồng này là quan trọng và buộc các luồng làm mới.
markThreadsRead(threads)GmailAppĐánh dấu các chuỗi tin nhắn này là đã đọc và buộc các chuỗi tin nhắn làm mới.
markThreadsUnimportant(threads)GmailAppĐánh dấu các luồng này là không quan trọng và buộc các luồng này làm mới.
markThreadsUnread(threads)GmailAppĐánh dấu các chuỗi tin nhắn này là chưa đọc và buộc các chuỗi tin nhắn làm mới.
moveMessageToTrash(message)GmailAppDi chuyển thư vào thùng rác và buộc thư làm mới.
moveMessagesToTrash(messages)GmailAppDi chuyển các thư đã chỉ định vào thùng rác và buộc các thư đó làm mới.
moveThreadToArchive(thread)GmailAppDi chuyển chuỗi tin nhắn này vào kho lưu trữ và buộc chuỗi tin nhắn làm mới.
moveThreadToInbox(thread)GmailAppDi chuyển chuỗi thư này vào hộp thư đến và buộc chuỗi thư làm mới.
moveThreadToSpam(thread)GmailAppDi chuyển chuỗi thư này sang thư rác và buộc chuỗi thư làm mới.
moveThreadToTrash(thread)GmailAppDi chuyển chuỗi tin nhắn này vào thùng rác và buộc chuỗi tin nhắn làm mới.
moveThreadsToArchive(threads)GmailAppDi chuyển các luồng này vào bản lưu trữ và buộc các luồng làm mới.
moveThreadsToInbox(threads)GmailAppDi chuyển các chuỗi thư này vào hộp thư đến và buộc các chuỗi thư làm mới.
moveThreadsToSpam(threads)GmailAppDi chuyển các chuỗi tin nhắn này sang phần nội dung rác và buộc các chuỗi tin nhắn đó làm mới.
moveThreadsToTrash(threads)GmailAppDi chuyển các luồng này vào thùng rác và buộc các luồng này làm mới.
refreshMessage(message)GmailAppTải lại thư và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp nhãn, trạng thái đã đọc, v.v. đã thay đổi).
refreshMessages(messages)GmailAppTải lại thư và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp nhãn, trạng thái đã đọc, v.v. đã thay đổi).
refreshThread(thread)GmailAppTải lại luồng và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp nhãn, trạng thái đã đọc, v.v. đã thay đổi).
refreshThreads(threads)GmailAppTải lại các chuỗi thư và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp các nhãn, trạng thái đã đọc, v.v. đã thay đổi).
search(query)GmailThread[]Tìm kiếm trong Gmail bằng cụm từ tìm kiếm đã cho.
search(query, start, max)GmailThread[]Tìm kiếm trong Gmail bằng cụm từ tìm kiếm đã cho.
sendEmail(recipient, subject, body)GmailAppGửi email.
sendEmail(recipient, subject, body, options)GmailAppGửi email có đối số tuỳ chọn.
setCurrentMessageAccessToken(accessToken)voidĐặt mã thông báo truy cập hiện tại cho phép tập lệnh truy cập vào các thuộc tính GmailMessage hiện tại.
starMessage(message)GmailAppThêm dấu sao vào thư này và buộc thư làm mới.
starMessages(messages)GmailAppThêm dấu sao vào các thư này và buộc thư làm mới.
unstarMessage(message)GmailAppXoá dấu sao khỏi thư này và buộc thư làm mới.
unstarMessages(messages)GmailAppXoá dấu sao khỏi các thư này và buộc thư làm mới.

Tài liệu chi tiết

createDraft(recipient, subject, body)

Tạo thư email nháp. Kích thước của email (bao gồm cả tiêu đề) bị giới hạn theo hạn mức.

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

Tham số

TênLoạiMô tả
recipientStringdanh sách địa chỉ email được phân tách bằng dấu phẩy
subjectStringtiêu đề email
bodyStringnội dung của email

Cầu thủ trả bóng

GmailDraft – GmailDraft mới tạo

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


createDraft(recipient, subject, body, options)

Tạo một thư email nháp có các đối số không bắt buộc. Email có thể chứa văn bản thuần tuý hoặc nội dung HTML. Kích thước của email (bao gồm cả phần đầu thư, nhưng không bao gồm tệp đính kèm) bị giới hạn theo hạn mức.

// 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',
    },
);

Tham số

TênLoạiMô tả
recipientStringđịa chỉ của người nhận
subjectStringdòng tiêu đề
bodyStringnội dung của email
optionsObjectmột đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới

Thông số nâng cao

TênLoạiMô tả
attachmentsBlobSource[]một آرایه tệp để gửi cùng email
bccStringdanh sách địa chỉ email được phân tách bằng dấu phẩy để gửi bcc
ccStringdanh sách địa chỉ email được phân tách bằng dấu phẩy để thêm vào phần Cc
fromStringđịa chỉ gửi email, phải là một trong các giá trị mà getAliases() trả về
htmlBodyStringnếu được đặt, các thiết bị có thể hiển thị HTML sẽ sử dụng trường này thay vì đối số nội dung bắt buộc; bạn có thể thêm trường inlineImages không bắt buộc trong nội dung HTML nếu đã thêm hình ảnh nội tuyến cho email
inlineImagesObjectmột đối tượng JavaScript chứa mối liên kết từ khoá hình ảnh (String) đến dữ liệu hình ảnh (BlobSource); giả định rằng tham số htmlBody được sử dụng và chứa các tệp tham chiếu đến các hình ảnh này ở định dạng <img src="cid:imageKey" />
nameStringtên của người gửi email (mặc định: tên của người dùng)
replyToStringđịa chỉ email để dùng làm địa chỉ trả lời mặc định (mặc định: địa chỉ email của người dùng)

Cầu thủ trả bóng

GmailDraft – GmailDraft mới tạo

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


createLabel(name)

Tạo một nhãn người dùng mới có tên đã cho.

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

Tham số

TênLoạiMô tả
nameStringtên của nhãn mới

Cầu thủ trả bóng

GmailLabel – nhãn mới tạo

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


deleteLabel(label)

Xoá nhãn đã chỉ định.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

Tham số

TênLoạiMô tả
labelGmailLabelnhãn cần xoá

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getAliases()

Lấy danh sách email được thiết lập làm bí danh cho tài khoản này trong Gmail.

Bạn có thể gửi tin nhắn từ bất kỳ bí danh nào trong số này bằng cách sử dụng đối số "from" (từ).

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

Cầu thủ trả bóng

String[] – một mảng gồm các bí danh cho tài khoản này

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getDraft(draftId)

Truy xuất thư nháp theo mã nhận dạng.

Sử dụng hàm này cùng với getId() trên thư nháp trong 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(),
);

Tham số

TênLoạiMô tả
draftIdStringmã của bản nháp cần truy xuất

Cầu thủ trả bóng

GmailDraft – bản nháp có mã nhận dạng đã cho

Gửi

Error – nếu không tìm thấy bản nháp nào có mã đã cung cấp

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getDraftMessages()

Truy xuất tất cả thư nháp.

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

Cầu thủ trả bóng

GmailMessage[] – một mảng gồm các thư nháp trên Gmail

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getDrafts()

Lấy tất cả thư nháp trong Gmail.

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Cầu thủ trả bóng

GmailDraft[] – một mảng gồm các thư nháp trên Gmail

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getInboxThreads()

Truy xuất tất cả chuỗi thư trong Hộp thư đến, bất kể nhãn.

Lệnh gọi này sẽ không thành công khi kích thước của tất cả các luồng quá lớn khiến hệ thống không xử lý được. Khi kích thước luồng không xác định và có thể rất lớn, vui lòng sử dụng lệnh gọi "đã phân trang" và chỉ định phạm vi của các luồng cần truy xuất trong mỗi lệnh gọi.

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

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư Gmail trong Hộp thư đến

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getInboxThreads(start, max)

Truy xuất một dải chuỗi thư trong Hộp thư đến, bất kể nhãn.

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

Tham số

TênLoạiMô tả
startIntegerchỉ mục của luồng đầu tiên cần truy xuất
maxIntegersố lượng luồng tối đa để truy xuất

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư Gmail trong Hộp thư đến

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getInboxUnreadCount()

Lấy số lượng chuỗi tin nhắn chưa đọc trong hộp thư đến.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

Cầu thủ trả bóng

Integer – số lượng chuỗi tin nhắn trong hộp thư đến có thư chưa đọc

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getMessageById(id)

Lấy thông báo theo mã nhận dạng.

Sử dụng hàm này cùng với getId() trên thư 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());

Tham số

TênLoạiMô tả
idStringmã nhận dạng của thư cần truy xuất

Cầu thủ trả bóng

GmailMessage – thông báo có mã nhận dạng đã cho

Gửi

Error – nếu không tìm thấy thư có mã nhận dạng đã cung cấp

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getMessagesForThread(thread)

Truy xuất tất cả thư trong chuỗi thư đã chỉ định.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi tin nhắn cần truy xuất

Cầu thủ trả bóng

GmailMessage[] – mảng tin nhắn tương ứng với chuỗi tin nhắn này

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getMessagesForThreads(threads)

Truy xuất tất cả thư trong các chuỗi thư đã chỉ định.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]chuỗi tin nhắn cần truy xuất

Cầu thủ trả bóng

GmailMessage[][] – một mảng các mảng tin nhắn, trong đó mỗi mục trong mảng bên ngoài tương ứng với một luồng và mảng bên trong chứa các tin nhắn trong luồng đó

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getPriorityInboxThreads()

Truy xuất tất cả chuỗi thư trong Hộp thư đến ưu tiên, bất kể nhãn.

Lệnh gọi này sẽ không thành công khi kích thước của tất cả các luồng quá lớn khiến hệ thống không xử lý được. Khi kích thước luồng không xác định và có thể rất lớn, vui lòng sử dụng lệnh gọi "đã phân trang" và chỉ định phạm vi của các luồng cần truy xuất trong mỗi lệnh gọi.

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư trong Gmail trong Hộp thư ưu tiên

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

Truy xuất một loạt chuỗi thư trong Hộp thư ưu tiên, bất kể nhãn.

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

Tham số

TênLoạiMô tả
startIntegerchỉ mục của luồng đầu tiên cần truy xuất
maxIntegersố lượng luồng tối đa để truy xuất

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư trong Gmail trong Hộp thư ưu tiên

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getPriorityInboxUnreadCount()

Lấy số lượng chuỗi thư chưa đọc trong Hộp thư ưu tiên.

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

Cầu thủ trả bóng

Integer – số lượng chuỗi thư trong Hộp thư ưu tiên có thư chưa đọc

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getSpamThreads()

Truy xuất tất cả chuỗi thư rác bất kể nhãn.

Lệnh gọi này sẽ không thành công khi kích thước của tất cả các luồng quá lớn khiến hệ thống không xử lý được. Khi kích thước luồng không xác định và có thể rất lớn, vui lòng sử dụng lệnh gọi "đã phân trang" và chỉ định phạm vi của các luồng cần truy xuất trong mỗi lệnh gọi.

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

Cầu thủ trả bóng

GmailThread[] – một mảng các chuỗi thư trên Gmail trong thư mục thư rác

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getSpamThreads(start, max)

Truy xuất một loạt chuỗi thư rác bất kể nhãn.

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

Tham số

TênLoạiMô tả
startIntegerchỉ mục của luồng đầu tiên cần truy xuất
maxIntegersố lượng luồng tối đa để truy xuất

Cầu thủ trả bóng

GmailThread[] – một mảng các chuỗi thư trên Gmail trong thư mục thư rác

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getSpamUnreadCount()

Lấy số lượng chuỗi tin nhắn chưa đọc là thư rác.

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

Cầu thủ trả bóng

Integer – số lượng chuỗi thư rác có tin nhắn chưa đọc

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getStarredThreads()

Truy xuất tất cả chuỗi tin nhắn được gắn dấu sao, bất kể nhãn.

Lệnh gọi này sẽ không thành công khi kích thước của tất cả các luồng quá lớn khiến hệ thống không xử lý được. Khi kích thước luồng không xác định và có thể rất lớn, vui lòng sử dụng lệnh gọi "đã phân trang" và chỉ định phạm vi của các luồng cần truy xuất trong mỗi lệnh gọi.

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

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư có gắn dấu sao trong Gmail

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getStarredThreads(start, max)

Truy xuất một loạt chuỗi tin nhắn được gắn dấu sao, bất kể nhãn.

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

Tham số

TênLoạiMô tả
startIntegerchỉ mục của luồng đầu tiên cần truy xuất
maxIntegersố lượng luồng tối đa để truy xuất

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư có gắn dấu sao trong Gmail

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getStarredUnreadCount()

Lấy số lượng chuỗi tin nhắn chưa đọc được gắn dấu sao.

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

Cầu thủ trả bóng

Integer – số lượng chuỗi tin nhắn được gắn dấu sao có tin nhắn chưa đọc

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getThreadById(id)

Lấy luồng theo mã nhận dạng.

Sử dụng hàm này cùng với getId() trên các chuỗi thư trong 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(),
);

Tham số

TênLoạiMô tả
idStringMã của luồng cần truy xuất.

Cầu thủ trả bóng

GmailThread – Luồng có mã nhận dạng đã cho hoặc null nếu không tìm thấy.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getTrashThreads()

Truy xuất tất cả chuỗi thư rác bất kể nhãn.

Lệnh gọi này sẽ không thành công khi kích thước của tất cả các luồng quá lớn khiến hệ thống không xử lý được. Khi kích thước luồng không xác định và có thể rất lớn, vui lòng sử dụng lệnh gọi "đã phân trang" và chỉ định phạm vi của các luồng cần truy xuất trong mỗi lệnh gọi.

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

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư trong Gmail ở thùng rác

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getTrashThreads(start, max)

Truy xuất một loạt chuỗi thư rác bất kể nhãn.

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

Tham số

TênLoạiMô tả
startIntegerchỉ mục của luồng đầu tiên cần truy xuất
maxIntegersố lượng luồng tối đa để truy xuất

Cầu thủ trả bóng

GmailThread[] – một mảng gồm các chuỗi thư trong Gmail ở thùng rác

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getUserLabelByName(name)

Truy xuất một nhãn dựa trên tên nhãn.

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

Tham số

TênLoạiMô tả
nameStringtên của nhãn cần truy xuất

Cầu thủ trả bóng

GmailLabel – nhãn Gmail có tên đã cho

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

getUserLabels()

Truy xuất danh sách nhãn do người dùng tạo.

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

Cầu thủ trả bóng

GmailLabel[] – mảng các nhãn do người dùng tạo

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

markMessageRead(message)

Đánh dấu tin nhắn này là đã đọc và buộc làm mới tin nhắn.

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

Tham số

TênLoạiMô tả
messageGmailMessagethư cần đánh dấu là đã đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markMessageUnread(message)

Đánh dấu tin nhắn này là chưa đọc và buộc làm mới tin nhắn.

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

Tham số

TênLoạiMô tả
messageGmailMessagethư cần đánh dấu là chưa đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markMessagesRead(messages)

Đánh dấu các thư này là đã đọc và buộc làm mới các thư.

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

Tham số

TênLoạiMô tả
messagesGmailMessage[]một mảng thư cần đánh dấu là đã đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markMessagesUnread(messages)

Đánh dấu những thư này là chưa đọc và buộc thư làm mới.

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

Tham số

TênLoạiMô tả
messagesGmailMessage[]một mảng thông báo cần đánh dấu là chưa đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadImportant(thread)

Đánh dấu luồng này là quan trọng và buộc luồng làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi thư cần đánh dấu là quan trọng

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadRead(thread)

Đánh dấu chuỗi tin nhắn này là đã đọc và buộc chuỗi tin nhắn làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi tin nhắn cần đánh dấu là đã đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadUnimportant(thread)

Đánh dấu chuỗi tin nhắn này là không quan trọng và buộc chuỗi tin nhắn làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadluồng cần đánh dấu là không quan trọng

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadUnread(thread)

Đánh dấu chuỗi tin nhắn này là chưa đọc và buộc chuỗi tin nhắn làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi thư cần đánh dấu là chưa đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadsImportant(threads)

Đánh dấu các luồng này là quan trọng và buộc các luồng làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các luồng cần đánh dấu là quan trọng

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadsRead(threads)

Đánh dấu các chuỗi tin nhắn này là đã đọc và buộc các chuỗi tin nhắn làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các luồng cần đánh dấu là đã đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadsUnimportant(threads)

Đánh dấu các luồng này là không quan trọng và buộc các luồng này làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các luồng cần đánh dấu là không quan trọng

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadsUnread(threads)

Đánh dấu các chuỗi tin nhắn này là chưa đọc và buộc các chuỗi tin nhắn làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các chuỗi tin nhắn cần đánh dấu là chưa đọc

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveMessageToTrash(message)

Di chuyển thư vào thùng rác và buộc thư làm mới.

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

Tham số

TênLoạiMô tả
messageGmailMessagethư cần chuyển vào thùng rác

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail (hữu ích cho việc tạo chuỗi)

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveMessagesToTrash(messages)

Di chuyển các thư đã chỉ định vào thùng rác và buộc các thư đó làm mới.

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

Tham số

TênLoạiMô tả
messagesGmailMessage[]thư cần chuyển vào thùng rác

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail (hữu ích cho việc tạo chuỗi)

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadToArchive(thread)

Di chuyển chuỗi tin nhắn này vào kho lưu trữ và buộc chuỗi tin nhắn làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi cần lưu trữ

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadToInbox(thread)

Di chuyển chuỗi thư này vào hộp thư đến và buộc chuỗi thư làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi thư cần chuyển vào hộp thư đến

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadToSpam(thread)

Di chuyển chuỗi thư này sang thư rác và buộc chuỗi thư làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi tin nhắn cần chuyển vào mục nội dung rác

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadToTrash(thread)

Di chuyển chuỗi tin nhắn này vào thùng rác và buộc chuỗi tin nhắn làm mới.

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

Tham số

TênLoạiMô tả
threadGmailThreadchuỗi tin nhắn cần chuyển vào thùng rác

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadsToArchive(threads)

Di chuyển các luồng này vào bản lưu trữ và buộc các luồng làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các chuỗi cần lưu trữ

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadsToInbox(threads)

Di chuyển các chuỗi thư này vào hộp thư đến và buộc các chuỗi thư làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các luồng cần được chuyển vào hộp thư đến

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadsToSpam(threads)

Di chuyển các chuỗi tin nhắn này sang phần nội dung rác và buộc các chuỗi tin nhắn đó làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các luồng sẽ được chuyển sang thư rác

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadsToTrash(threads)

Di chuyển các luồng này vào thùng rác và buộc các luồng này làm mới.

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

Tham số

TênLoạiMô tả
threadsGmailThread[]một mảng các luồng cần chuyển vào thùng rác

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


refreshMessage(message)

Tải lại thư và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp nhãn, trạng thái đã đọc, v.v. đã thay đổi).

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

Tham số

TênLoạiMô tả
messageGmailMessagethông báo cần làm mới

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


refreshMessages(messages)

Tải lại thư và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp nhãn, trạng thái đã đọc, v.v. đã thay đổi).

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

Tham số

TênLoạiMô tả
messagesGmailMessage[]các tin nhắn cần làm mới

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


refreshThread(thread)

Tải lại luồng và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp nhãn, trạng thái đã đọc, v.v. đã thay đổi).

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

Tham số

TênLoạiMô tả
threadGmailThreadluồng cần làm mới

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


refreshThreads(threads)

Tải lại các chuỗi thư và trạng thái liên kết từ Gmail (rất hữu ích trong trường hợp các nhãn, trạng thái đã đọc, v.v. đã thay đổi).

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

Tham số

TênLoạiMô tả
threadsGmailThread[]các luồng cần làm mới

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


search(query)

Tìm kiếm trong Gmail bằng cụm từ tìm kiếm đã cho.

Lệnh gọi này sẽ không thành công khi kích thước của tất cả các luồng quá lớn khiến hệ thống không xử lý được. Khi kích thước luồng không xác định và có thể rất lớn, vui lòng sử dụng lệnh gọi "đã phân trang" và chỉ định phạm vi của các luồng cần truy xuất trong mỗi lệnh gọi.

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

Tham số

TênLoạiMô tả
queryStringcụm từ tìm kiếm, như khi bạn nhập vào Gmail

Cầu thủ trả bóng

GmailThread[] – một mảng các chuỗi thư trên Gmail khớp với truy vấn này

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

search(query, start, max)

Tìm kiếm trong Gmail bằng cụm từ tìm kiếm đã cho.

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

Tham số

TênLoạiMô tả
queryStringcụm từ tìm kiếm, như khi bạn nhập vào Gmail
startIntegerchỉ mục của luồng bắt đầu
maxIntegersố lượng luồng tối đa cần trả về

Cầu thủ trả bóng

GmailThread[] – một mảng các chuỗi thư trên Gmail khớp với truy vấn này

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

sendEmail(recipient, subject, body)

Gửi email. Kích thước của email (bao gồm cả tiêu đề) bị giới hạn theo hạn mức.

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

Tham số

TênLoạiMô tả
recipientStringdanh sách địa chỉ email được phân tách bằng dấu phẩy
subjectStringtiêu đề email (tối đa 250 ký tự)
bodyStringnội dung của email

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


sendEmail(recipient, subject, body, options)

Gửi email có đối số tuỳ chọn. Email có thể chứa văn bản thuần tuý hoặc nội dung HTML. Kích thước của email (bao gồm cả phần đầu thư, nhưng không bao gồm tệp đính kèm) bị giới hạn theo hạn mức.

// 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',
    },
);

Tham số

TênLoạiMô tả
recipientStringđịa chỉ của người nhận
subjectStringdòng tiêu đề (tối đa 250 ký tự)
bodyStringnội dung của email
optionsObjectmột đối tượng JavaScript chỉ định các tham số nâng cao, như được liệt kê bên dưới

Thông số nâng cao

TênLoạiMô tả
attachmentsBlobSource[]một آرایه tệp để gửi cùng email
bccStringdanh sách địa chỉ email được phân tách bằng dấu phẩy để gửi bcc
ccStringdanh sách địa chỉ email được phân tách bằng dấu phẩy để thêm vào phần Cc
fromStringđịa chỉ gửi email, phải là một trong các giá trị mà getAliases() trả về
htmlBodyStringnếu được đặt, các thiết bị có thể hiển thị HTML sẽ sử dụng trường này thay vì đối số nội dung bắt buộc; bạn có thể thêm trường inlineImages không bắt buộc trong nội dung HTML nếu đã thêm hình ảnh nội tuyến cho email
inlineImagesObjectmột đối tượng JavaScript chứa mối liên kết từ khoá hình ảnh (String) đến dữ liệu hình ảnh (BlobSource); giả định rằng tham số htmlBody được sử dụng và chứa các tệp tham chiếu đến các hình ảnh này ở định dạng <img src="cid:imageKey" />
nameStringtên của người gửi email (mặc định: tên của người dùng)
noReplyBooleantrue nếu email được gửi từ một địa chỉ email chung không trả lời để người nhận không trả lời email; tuỳ chọn này chỉ dành cho tài khoản Google Workspace, chứ không dành cho người dùng Gmail
replyToStringđịa chỉ email để dùng làm địa chỉ trả lời mặc định (mặc định: địa chỉ email của người dùng)

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


setCurrentMessageAccessToken(accessToken)

Đặt mã thông báo truy cập hiện tại cho phép tập lệnh truy cập vào các thuộc tính GmailMessage hiện tại.

Chỉ những dự án Tiện ích bổ sung của Google Workspace sử dụng phạm vi thư hiện tại của Gmail mới yêu cầu phương thức này.

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

Tham số

TênLoạiMô tả
accessTokenStringmã thông báo truy cập tạm thời được lấy từ đối tượng sự kiện hành động của tiện ích bổ sung Gmail.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

starMessage(message)

Thêm dấu sao vào thư này và buộc thư làm mới.

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

Tham số

TênLoạiMô tả
messageGmailMessagetin nhắn cần gắn dấu sao

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


starMessages(messages)

Thêm dấu sao vào các thư này và buộc thư làm mới.

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

Tham số

TênLoạiMô tả
messagesGmailMessage[]một mảng tin nhắn cần gắn dấu sao

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


unstarMessage(message)

Xoá dấu sao khỏi thư này và buộc thư làm mới.

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

Tham số

TênLoạiMô tả
messageGmailMessagetin nhắn cần bỏ gắn dấu sao

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


unstarMessages(messages)

Xoá dấu sao khỏi các thư này và buộc thư làm mới.

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

Tham số

TênLoạiMô tả
messagesGmailMessage[]một mảng tin nhắn cần bỏ gắn dấu sao

Cầu thủ trả bóng

GmailApp – dịch vụ Gmail, hữu ích cho việc tạo chuỗi

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền bằng một hoặc nhiều phạm vi sau đây hoặc các phạm vi thích hợp từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm

Các phương thức ngừng hoạt động