Class GmailApp

GmailApp

Cấp quyền truy cập vào các chuỗi thư, thư và nhãn trong Gmail.

Phương thức

Phương thứcKiểu 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 thư email nháp bằng các đối số không bắt buộc.
createLabel(name)GmailLabelTạo nhãn người dùng mới của tên đã đặt.
deleteLabel(label)GmailAppXoá nhãn đã chỉ định.
getAliases()String[]Nhận danh sách các email được thiết lập làm email đại diện 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[]Nhận tất cả thư nháp trong Gmail.
getInboxThreads()GmailThread[]Truy xuất tất cả chuỗi trong Hộp thư đến, bất kể nhãn.
getInboxThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi trong Hộp thư đến, bất kể nhãn.
getInboxUnreadCount()IntegerXem số chuỗi thư chưa đọc trong hộp thư đến.
getMessageById(id)GmailMessageNhận tin nhắn theo mã nhận dạng.
getMessagesForThread(thread)GmailMessage[]Truy xuất tất cả thư trong chuỗi được chỉ định.
getMessagesForThreads(threads)GmailMessage[][]Truy xuất tất cả thông báo trong chuỗi được chỉ định.
getPriorityInboxThreads()GmailThread[]Truy xuất tất cả chuỗi trong Hộp thư ưu tiên, bất kể nhãn.
getPriorityInboxThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi trong Hộp thư ưu tiên, bất kể nhãn.
getPriorityInboxUnreadCount()IntegerXem số lượng chuỗi tin nhắn 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()IntegerXem số lượng chuỗi tin nhắn chưa đọc là tin nhắn rác.
getStarredThreads()GmailThread[]Truy xuất tất cả các chuỗi có gắn dấu sao, bất kể nhãn.
getStarredThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi có gắn dấu sao, bất kể nhãn.
getStarredUnreadCount()IntegerXem số lượng chuỗi tin nhắn chưa đọc được gắn dấu sao.
getThreadById(id)GmailThreadTìm một chuỗi theo mã nhận dạng.
getTrashThreads()GmailThread[]Truy xuất tất cả chuỗi thùng rác, bất kể nhãn.
getTrashThreads(start, max)GmailThread[]Truy xuất một loạt chuỗi thùng rác, bất kể nhãn.
getUserLabelByName(name)GmailLabelTruy xuất nhãn theo 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 thông báo này là đã đọc và buộc thông báo làm mới.
markMessageUnread(message)GmailAppĐánh dấu thông báo này là chưa đọc và buộc làm mới thông báo.
markMessagesRead(messages)GmailAppĐánh dấu các thông báo này là đã đọc và buộc làm mới thông báo.
markMessagesUnread(messages)GmailAppĐánh dấu các thông báo này là chưa đọc và buộc làm mới thông báo.
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 này là đã đọc và buộc chuỗi làm mới.
markThreadUnimportant(thread)GmailAppĐánh dấu luồng này là không quan trọng và buộc luồng làm mới.
markThreadUnread(thread)GmailAppĐánh dấu chuỗi này là chưa đọc và buộc chuỗi 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 luồng này là đã đọc và buộc các luồng 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 làm mới.
markThreadsUnread(threads)GmailAppĐánh dấu các chuỗi này là chưa đọc và buộc các chuỗi làm mới.
moveMessageToTrash(message)GmailAppChuyển thư vào thùng rác và buộc thư làm mới.
moveMessagesToTrash(messages)GmailAppChuyển các thư được 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 này sang mục lưu trữ và buộc chuỗi làm mới.
moveThreadToInbox(thread)GmailAppDi chuyển chuỗi này tới hộp thư đến và buộc chuỗi làm mới.
moveThreadToSpam(thread)GmailAppChuyển chuỗi này sang thư mục nội dung rác và buộc chuỗi làm mới.
moveThreadToTrash(thread)GmailAppChuyển chuỗi này vào thùng rác và buộc chuỗi làm mới.
moveThreadsToArchive(threads)GmailAppDi chuyển các luồng này tới mục lưu trữ và buộc các luồng làm mới.
moveThreadsToInbox(threads)GmailAppDi chuyển các chuỗi này tới hộp thư đến và buộc các chuỗi làm mới.
moveThreadsToSpam(threads)GmailAppChuyển những chuỗi này sang mục nội dung rác và buộc các chuỗi làm mới.
moveThreadsToTrash(threads)GmailAppChuyển các luồng này vào thùng rác và buộc các luồng làm mới.
refreshMessage(message)GmailAppTải lại thư và trạng thái liên kết từ Gmail (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 các thư và trạng thái liên kết từ Gmail (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 chuỗi và trạng thái liên kết từ Gmail (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 và trạng thái liên kết từ Gmail (hữu ích trong trường hợp 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 với các đối số không bắt buộc.
setCurrentMessageAccessToken(accessToken)voidĐặt mã truy cập thông báo 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 một dấu sao vào thư này và buộc làm mới thư.
starMessages(messages)GmailAppThêm dấu sao vào những thư này và buộc thư làm mới.
unstarMessage(message)GmailAppXoá một 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 đề) là hạn mức.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Thông số

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

Hai chiều

GmailDraft — GmailBản nháp mới được tạo

Ủy quyền

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

  • https://mail.google.com/

Xem thêm


createDraft(recipient, subject, body, options)

Tạo thư email nháp bằng 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 tiêu đề, nhưng không bao gồm tệp đính kèm) bị giới hạn trong hạn mức.

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Thông số

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

Thông số nâng cao

TênLoạiNội dung mô tả
attachmentsBlobSource[]một mảng tệp để gửi kèm theo email
bccStringdanh sách được phân tách bằng dấu phẩy gồm các địa chỉ email gửi tới BCC
ccStringdanh sách địa chỉ email được phân tách bằng dấu phẩy
fromStringđịa chỉ dùng để gửi email. Địa chỉ này phải là một trong những giá trị được getAliases() trả về
htmlBodyStringNếu được đặt, các thiết bị có khả năng hiển thị HTML sẽ sử dụng HTML đó thay vì đối số nội dung bắt buộc; bạn có thể thêm một trường inlineImages không bắt buộc trong nội dung HTML nếu bạn có hình ảnh cùng dòng cho email của mình
inlineImagesObjectmột đối tượng JavaScript chứa đường liên kết từ khoá hình ảnh (String) đến dữ liệu hình ảnh (BlobSource); thuộc tính này giả định rằng tham số htmlBody được sử dụng và chứa thông tin tham chiếu đến những 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)

Hai chiều

GmailDraft — GmailBản nháp mới được tạo

Ủy quyền

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

  • https://mail.google.com/

Xem thêm


createLabel(name)

Tạo nhãn người dùng mới của tên đã đặt.

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

Thông số

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

Hai chiều

GmailLabel – nhãn mới được tạo

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

Thông số

TênLoạiNội dung mô tả
labelGmailLabelnhãn cần xoá

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getAliases()

Nhận danh sách các email được thiết lập làm email đại diện cho tài khoản này trong Gmail.

Bạn có thể gửi thư từ bất kỳ bí danh nào trong số này bằng cách sử dụng đối số tùy chọn "từ".

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Hai chiều

String[] — một loạt 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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 mã này cùng với getId() trên thư nháp trong Gmail.

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

Thông số

TênLoạiNội dung mô tả
draftIdStringmã nhận dạng của bản nháp cần truy xuất

Hai chiều

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ã nhận dạng đã cho

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Hai chiều

GmailMessage[] – một loạt thư nháp trên Gmail

Ủy quyền

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

  • https://mail.google.com/

getDrafts()

Nhận tất cả thư nháp trong Gmail.

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

Hai chiều

GmailDraft[] – một loạt thư nháp trong Gmail

Ủy quyền

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

  • https://mail.google.com/

getInboxThreads()

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

Lệnh gọi này sẽ không thực hiện được khi kích thước của tất cả các luồng quá lớn để hệ thống có thể xử lý. 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 luồng để truy xuất trong mỗi lệnh gọi.

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

Hai chiều

GmailThread[] — một loạt 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getInboxThreads(start, max)

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

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

Thông số

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

Hai chiều

GmailThread[] — một loạt 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getInboxUnreadCount()

Xem số chuỗi thư chưa đọc trong hộp thư đến.

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

Hai chiều

Integer – số chuỗi thư 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getMessageById(id)

Nhận tin nhắn theo mã nhận dạng.

Sử dụng mã này cùng với getId() trên thư Gmail.

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

Thông số

TênLoạiNội dung mô tả
idStringmã nhận dạng của thư cần truy xuất

Hai chiều

GmailMessage – tin nhắn có mã nhận dạng đã cho

Gửi

Error — nếu không tìm thấy thư nào có mã nhận dạng đã cho

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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 được chỉ định.

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi thông báo cần truy xuất

Hai chiều

GmailMessage[] – mảng thông báo tương ứng với chuỗi này

Ủy quyền

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

  • https://mail.google.com/

Xem thêm


getMessagesForThreads(threads)

Truy xuất tất cả thông báo trong chuỗi được chỉ định.

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]chuỗi thông báo cần truy xuất

Hai chiều

GmailMessage[][] – một mảng các thông điệp, trong đó mỗi mục ở mảng bên ngoài tương ứng với một luồng, còn mảng bên trong chứa các thông điệp trong luồng đó

Ủy quyền

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

  • https://mail.google.com/

Xem thêm


getPriorityInboxThreads()

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

Lệnh gọi này sẽ không thực hiện được khi kích thước của tất cả các luồng quá lớn để hệ thống có thể xử lý. 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 luồng để truy xuất trong mỗi lệnh gọi.

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

Hai chiều

GmailThread[] — một loạt các chuỗi thư 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

Truy xuất một loạt chuỗi 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);

Thông số

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

Hai chiều

GmailThread[] — một loạt các chuỗi thư 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getPriorityInboxUnreadCount()

Xem số lượng chuỗi tin nhắn chưa đọc trong Hộp thư ưu tiên.

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

Hai chiều

Integer — số 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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ực hiện được khi kích thước của tất cả các luồng quá lớn để hệ thống có thể xử lý. 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 luồng để truy xuất trong mỗi lệnh gọi.

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

Hai chiều

GmailThread[] – một mảng các chuỗi thư 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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);

Thông số

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

Hai chiều

GmailThread[] – một mảng các chuỗi thư 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getSpamUnreadCount()

Xem số lượng chuỗi tin nhắn chưa đọc là tin nhắn 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());

Hai chiều

Integer – số 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getStarredThreads()

Truy xuất tất cả các chuỗi có gắn dấu sao, bất kể nhãn.

Lệnh gọi này sẽ không thực hiện được khi kích thước của tất cả các luồng quá lớn để hệ thống có thể xử lý. 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 luồng để truy xuất trong mỗi lệnh gọi.

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

Hai chiều

GmailThread[] — một loạt 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getStarredThreads(start, max)

Truy xuất một loạt chuỗi 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);

Thông số

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

Hai chiều

GmailThread[] — một loạt 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getStarredUnreadCount()

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

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

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

getThreadById(id)

Tìm một chuỗi theo mã nhận dạng.

Sử dụng 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());

Thông số

TênLoạiNội dung mô tả
idStringMã nhận dạng của luồng cần truy xuất.

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


getTrashThreads()

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

Lệnh gọi này sẽ không thực hiện được khi kích thước của tất cả các luồng quá lớn để hệ thống có thể xử lý. 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 luồng để truy xuất trong mỗi lệnh gọi.

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

Hai chiều

GmailThread[] — một loạt các chuỗi thư Gmail trong thùng rác

Ủy quyền

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

  • https://mail.google.com/

getTrashThreads(start, max)

Truy xuất một loạt chuỗi thùng 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);

Thông số

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

Hai chiều

GmailThread[] — một loạt các chuỗi thư Gmail trong thùng rác

Ủy quyền

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

  • https://mail.google.com/

getUserLabelByName(name)

Truy xuất nhãn theo tên nhãn.

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

Thông số

TênLoạiNội dung mô tả
nameStringtên của nhãn cần truy xuất

Hai chiều

GmailLabel — nhãn Gmail có tên cụ thể

Ủy quyền

Các tập lệnh sử dụng phương thức này cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

Hai chiều

GmailLabel[] – mảng 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

markMessageRead(message)

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

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

Thông số

TênLoạiNội dung mô tả
messageGmailMessagetin nhắn cần đánh dấu là đã đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markMessageUnread(message)

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

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

Thông số

TênLoạiNội dung mô tả
messageGmailMessagetin nhắn để đánh dấu là chưa đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markMessagesRead(messages)

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

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

Thông số

TênLoạiNội dung mô tả
messagesGmailMessage[]một loạt thông báo để đánh dấu là đã đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markMessagesUnread(messages)

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

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

Thông số

TênLoạiNội dung mô tả
messagesGmailMessage[]một loạt các thông báo để đánh dấu là chưa đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Thông số

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

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadRead(thread)

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

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi cần đánh dấu là đã đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadUnimportant(thread)

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

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi thư để đánh dấu là không quan trọng

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadUnread(thread)

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

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi tin nhắn cần đánh dấu là chưa đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]một loạt các luồng để đánh dấu là quan trọng

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadsRead(threads)

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

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

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]một mảng chuỗi để đánh dấu là đã đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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 làm mới.

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

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]một loạt chuỗi để đánh dấu là không quan trọng

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


markThreadsUnread(threads)

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

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

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]một mảng chuỗi để đánh dấu là chưa đọc

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveMessageToTrash(message)

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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Thông số

TênLoạiNội dung mô tả
messageGmailMessagethư đưa vào thùng rác

Hai chiều

GmailApp — dịch vụ Gmail (hữu ích cho chuỗi)

Ủy quyền

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

  • https://mail.google.com/

Xem thêm


moveMessagesToTrash(messages)

Chuyển các thư được 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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Thông số

TênLoạiNội dung mô tả
messagesGmailMessage[]thư đưa vào thùng rác

Hai chiều

GmailApp — dịch vụ Gmail (hữu ích cho chuỗi)

Ủy quyền

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

  • https://mail.google.com/

Xem thêm


moveThreadToArchive(thread)

Di chuyển chuỗi này sang mục lưu trữ và buộc chuỗi làm mới.

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi cần lưu trữ

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadToInbox(thread)

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

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi thư cần chuyển tới hộp thư đến

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadToSpam(thread)

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

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi cuộc trò chuyện cần chuyển vào thư mục nội dung làm phiền

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadToTrash(thread)

Chuyển chuỗi này vào thùng rác và buộc chuỗi làm mới.

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi thư đã được chuyển vào thùng rác

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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 tới mục lưu trữ và buộc các luồng làm mới.

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

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]một mảng chuỗi sẽ được lưu trữ

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadsToInbox(threads)

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

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

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]một loạt chuỗi thư cần được chuyển vào hộp thư đến

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadsToSpam(threads)

Chuyển những chuỗi này sang mục nội dung rác và buộc các chuỗi làm mới.

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

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]một mảng chuỗi sẽ được chuyển vào thư mục nội dung rác

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


moveThreadsToTrash(threads)

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

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

Thông số

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

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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 (hữu ích trong trường hợp nhãn, trạng thái đọc, v.v. đã thay đổi).

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

Thông số

TênLoạiNội dung mô tả
messageGmailMessagetin nhắn cần làm mới

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


refreshMessages(messages)

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

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

Thông số

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

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


refreshThread(thread)

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

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

Thông số

TênLoạiNội dung mô tả
threadGmailThreadchuỗi cần làm mới

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


refreshThreads(threads)

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

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

Thông số

TênLoạiNội dung mô tả
threadsGmailThread[]chuỗi cần làm mới

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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ực hiện được khi kích thước của tất cả các luồng quá lớn để hệ thống có thể xử lý. 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 luồng để truy xuất trong mỗi lệnh gọi.

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

Thông số

TênLoạiNội dung mô tả
queryStringcụm từ tìm kiếm, giống như khi bạn nhập vào Gmail

Hai chiều

GmailThread[] — một mảng các chuỗi 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Thông số

TênLoạiNội dung mô tả
queryStringcụm từ tìm kiếm, giống 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ề

Hai chiều

GmailThread[] — một mảng các chuỗi 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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 đề) là hạn mức.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Thông số

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

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


sendEmail(recipient, subject, body, options)

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

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Thông số

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

Thông số nâng cao

TênLoạiNội dung mô tả
attachmentsBlobSource[]một mảng tệp để gửi kèm theo email
bccStringdanh sách được phân tách bằng dấu phẩy gồm các địa chỉ email gửi tới BCC
ccStringdanh sách địa chỉ email được phân tách bằng dấu phẩy
fromStringđịa chỉ dùng để gửi email. Địa chỉ này phải là một trong những giá trị được getAliases() trả về
htmlBodyStringNếu được đặt, các thiết bị có khả năng hiển thị HTML sẽ sử dụng HTML đó thay vì đối số nội dung bắt buộc; bạn có thể thêm một trường inlineImages không bắt buộc trong nội dung HTML nếu bạn có hình ảnh cùng dòng cho email của mình
inlineImagesObjectmột đối tượng JavaScript chứa đường liên kết từ khoá hình ảnh (String) đến dữ liệu hình ảnh (BlobSource); thuộc tính này giả định rằng tham số htmlBody được sử dụng và chứa thông tin tham chiếu đến những 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 phải được gửi từ một địa chỉ email chung không trả lời để ngăn người nhận trả lời email. Lựa chọn này chỉ áp dụng cho tài khoản Google Workspace, không phải 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)

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


setCurrentMessageAccessToken(accessToken)

Đặt mã truy cập thông báo 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ỉ các 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) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

Thông số

TênLoạiNội dung mô tả
accessTokenStringmã truy cập tạm thời 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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

starMessage(message)

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

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

Thông số

TênLoạiNội dung mô tả
messageGmailMessagetin nhắn cần gắn dấu sao

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


starMessages(messages)

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

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

Thông số

TênLoạiNội dung mô tả
messagesGmailMessage[]một loạt thư để gắn dấu sao

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây từ API REST có liên quan:

  • https://mail.google.com/

Xem thêm


unstarMessage(message)

Xoá một 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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Thông số

TênLoạiNội dung mô tả
messageGmailMessagethư cần bỏ gắn dấu sao

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Thông số

TênLoạiNội dung mô tả
messagesGmailMessage[]một loạt các thư để bỏ gắn dấu sao

Hai chiều

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 cần được uỷ quyền với một hoặc nhiều phạm vi hoặc phạm vi thích hợp sau đây 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