Dịch vụ này cho phép bạn gửi email, soạn thư nháp, quản lý nhãn, đánh dấu thư và chuỗi thư cũng như thực hiện nhiều tác vụ quản lý tài khoản Gmail khác. Xem thêm về Dịch vụ thư, một dịch vụ đơn giản hơn chỉ cho phép gửi email.
Lớp
| Tên | Mô tả ngắn |
|---|---|
GmailApp | Cấp quyền truy cập vào chuỗi thư, thư và nhãn trong Gmail. |
GmailAttachment | Tệp đính kèm từ Gmail. |
GmailDraft | Thư nháp do người dùng tạo trong tài khoản Gmail của người dùng. |
GmailLabel | Nhãn do người dùng tạo trong tài khoản Gmail của người dùng. |
GmailMessage | Thư trong tài khoản Gmail của người dùng. |
GmailThread | Một chuỗi tin nhắn trong tài khoản Gmail của người dùng. |
GmailApp
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
createDraft(recipient, subject, body) | GmailDraft | Tạo email nháp. |
createDraft(recipient, subject, body, options) | GmailDraft | Tạo email nháp có các đối số không bắt buộc. |
createLabel(name) | GmailLabel | Tạo một nhãn người dùng mới cho tên cụ thể. |
deleteLabel(label) | GmailApp | Xoá 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) | GmailDraft | Truy xuất thư nháp bằng 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 không phân biệt nhãn. |
getInboxUnreadCount() | Integer | Nhận số chuỗi tin nhắn chưa đọc trong hộp thư đến. |
getMessageById(id) | GmailMessage | Nhận tin nhắn theo mã nhận dạng. |
getMessagesForThread(thread) | GmailMessage[] | Truy xuất tất cả thông báo trong chuỗi được chỉ định. |
getMessagesForThreads(threads) | GmailMessage[][] | Truy xuất tất cả thông báo trong các luồng đã chỉ định. |
getPriorityInboxThreads() | GmailThread[] | Truy xuất tất cả chuỗi trong Hộp thư ưu tiên, không phân biệt nhãn. |
getPriorityInboxThreads(start, max) | GmailThread[] | Truy xuất một loạt chuỗi trong Hộp thư ưu tiên không phân biệt nhãn. |
getPriorityInboxUnreadCount() | Integer | Xem 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() | Integer | Xem số chuỗi tin nhắn chưa đọc bị coi là tin nhắn rác. |
getStarredThreads() | GmailThread[] | Truy xuất tất 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() | Integer | Xem số lượng chuỗi tin nhắn chưa đọc được gắn dấu sao. |
getThreadById(id) | GmailThread | Lấy một chuỗi theo mã nhận dạng. |
getTrashThreads() | GmailThread[] | Truy xuất tất cả các chuỗi thùng rác không phân biệt nhãn. |
getTrashThreads(start, max) | GmailThread[] | Truy xuất một loạt các chuỗi rác bất kể nhãn. |
getUserLabelByName(name) | GmailLabel | Truy 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 những thông báo này là đã đọc và buộc thông báo làm mới. |
markMessagesUnread(messages) | GmailApp | Đánh dấu những 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 chuỗi này là quan trọng và buộc chuỗi 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 chuỗi này là không quan trọng và buộc chuỗi 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) | GmailApp | Chuyển thư vào thùng rác và buộc làm mới thư. |
moveMessagesToTrash(messages) | GmailApp | Di 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) | GmailApp | Di chuyển chuỗi này đến mục lưu trữ và buộc chuỗi làm mới. |
moveThreadToInbox(thread) | GmailApp | Di chuyển chuỗi này tới hộp thư đến và buộc chuỗi làm mới. |
moveThreadToSpam(thread) | GmailApp | Chuyển chuỗi này vào thư mục thư rác và buộc chuỗi làm mới. |
moveThreadToTrash(thread) | GmailApp | Chuyển chuỗi này vào thùng rác và buộc chuỗi làm mới. |
moveThreadsToArchive(threads) | GmailApp | Di chuyển các luồng này vào mục lưu trữ và buộc các luồng làm mới. |
moveThreadsToInbox(threads) | GmailApp | 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. |
moveThreadsToSpam(threads) | GmailApp | Chuyển các chuỗi này vào thư mục thư rác và buộc các chuỗi làm mới. |
moveThreadsToTrash(threads) | GmailApp | Di chuyển các chuỗi này vào thùng rác và buộc các chuỗi làm mới. |
refreshMessage(message) | GmailApp | 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). |
refreshMessages(messages) | GmailApp | 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). |
refreshThread(thread) | GmailApp | 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). |
refreshThreads(threads) | GmailApp | Tải lại các luồng 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) | GmailApp | Gửi một email. |
sendEmail(recipient, subject, body, options) | GmailApp | Gửi email có 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) | GmailApp | Thêm dấu sao vào thư này và buộc thư làm mới. |
starMessages(messages) | GmailApp | Thêm dấu sao vào các thư này và buộc các thư phải làm mới. |
unstarMessage(message) | GmailApp | Xoá dấu sao khỏi thư này và buộc thư làm mới. |
unstarMessages(messages) | GmailApp | Xoá dấu sao khỏi những thư này và buộc làm mới thư. |
GmailAttachment
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
copyBlob() | Blob | Trả về bản sao của blob này. |
getAs(contentType) | Blob | Trả về dữ liệu bên trong đối tượng này dưới dạng một blob được chuyển đổi thành loại nội dung được chỉ định. |
getBytes() | Byte[] | Lấy dữ liệu được lưu trữ trong blob này. |
getContentType() | String | Lấy loại nội dung của các byte trong blob này. |
getDataAsString() | String | Nhận dữ liệu của blob này dưới dạng Chuỗi bằng phương thức mã hoá UTF-8. |
getDataAsString(charset) | String | Lấy dữ liệu của blob này dưới dạng chuỗi với mã hoá được chỉ định. |
getHash() | String | Lấy hàm băm nội dung SHA1 cho tệp đính kèm này. |
getName() | String | Lấy tên của blob này. |
getSize() | Integer | Xem kích thước của tệp đính kèm này. |
isGoogleType() | Boolean | Trả về việc blob này có phải là một tệp Google Workspace (Trang tính, Tài liệu, v.v.) hay không. |
setBytes(data) | Blob | Thiết lập dữ liệu được lưu trữ trong blob này. |
setContentType(contentType) | Blob | Thiết lập loại nội dung của các byte trong blob này. |
setContentTypeFromExtension() | Blob | Đặt loại nội dung của các byte trong blob này dựa trên đuôi tệp. |
setDataFromString(string) | Blob | Thiết lập dữ liệu của blob này từ một chuỗi bằng bộ mã hoá UTF-8. |
setDataFromString(string, charset) | Blob | Thiết lập dữ liệu của blob này từ một chuỗi có mã hoá được chỉ định. |
setName(name) | Blob | Đặt tên của blob này. |
GmailDraft
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
deleteDraft() | void | Xoá thư nháp này. |
getId() | String | Lấy mã nhận dạng của thư nháp này. |
getMessage() | GmailMessage | Trả về một GmailMessage đại diện cho thư nháp này. |
getMessageId() | String | Trả về mã nhận dạng của GmailMessage đại diện cho bản nháp này. |
send() | GmailMessage | Gửi email nháp này. |
update(recipient, subject, body) | GmailDraft | Thay thế nội dung của thư nháp này. |
update(recipient, subject, body, options) | GmailDraft | Thay thế nội dung của thư nháp này bằng các đối số không bắt buộc. |
GmailLabel
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
addToThread(thread) | GmailLabel | Thêm nhãn này vào luồng đã cho và buộc luồng làm mới (GmailThread.refresh()). |
addToThreads(threads) | GmailLabel | Thêm nhãn này vào các luồng đã cho và buộc các luồng làm mới. |
deleteLabel() | void | Xoá nhãn này. |
getName() | String | Lấy tên của nhãn này. |
getThreads() | GmailThread[] | Lấy các chuỗi được đánh dấu bằng nhãn này. |
getThreads(start, max) | GmailThread[] | Nhận một loạt chuỗi chuỗi được đánh dấu bằng nhãn này. |
getUnreadCount() | Integer | Lấy số chuỗi tin nhắn chưa đọc được gắn nhãn này. |
removeFromThread(thread) | GmailLabel | Xoá nhãn này khỏi luồng đã cho và buộc luồng làm mới. |
removeFromThreads(threads) | GmailLabel | Xoá nhãn này khỏi các luồng đã cho và buộc các luồng làm mới. |
GmailMessage
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
createDraftReply(body) | GmailDraft | Tạo thư nháp trả lời người gửi thư này bằng địa chỉ trả lời. |
createDraftReply(body, options) | GmailDraft | Tạo thư nháp trả lời người gửi thư này bằng địa chỉ trả lời, với đối số không bắt buộc. |
createDraftReplyAll(body) | GmailDraft | Tạo thư nháp trả lời người gửi bằng địa chỉ trả lời và tất cả người nhận của thư này. |
createDraftReplyAll(body, options) | GmailDraft | Tạo thư nháp trả lời người gửi thư này bằng địa chỉ trả lời và tất cả người nhận, với đối số không bắt buộc. |
forward(recipient) | GmailMessage | Chuyển tiếp thư này đến người nhận mới. |
forward(recipient, options) | GmailMessage | Chuyển tiếp thư này tới người nhận mới, với đối số không bắt buộc. |
getAttachments() | GmailAttachment[] | Tải tất cả tệp đính kèm cho thư này. |
getAttachments(options) | GmailAttachment[] | Tải tất cả tệp đính kèm cho thư này. |
getBcc() | String | Xem những người nhận được phân tách bằng dấu phẩy được bcc trên thư này. |
getBody() | String | Lấy nội dung HTML trong phần nội dung của thư này. |
getCc() | String | Nhận được những người nhận được phân tách bằng dấu phẩy được cc trên thư này. |
getDate() | Date | Xem ngày và giờ của tin nhắn này. |
getFrom() | String | Tìm người gửi tin nhắn này. |
getHeader(name) | String | Lấy giá trị của tiêu đề RFC 2822 đã đặt cho tên tiêu đề. |
getId() | String | Lấy mã nhận dạng của tin nhắn này. |
getPlainBody() | String | Lấy nội dung nội dung của thư này mà không cần định dạng HTML. |
getRawContent() | String | Nhận nội dung thô của thư này. |
getReplyTo() | String | Lấy địa chỉ trả lời của thư này (thường là người gửi). |
getSubject() | String | Lấy tiêu đề của thư này. |
getThread() | GmailThread | Lấy chuỗi có chứa tin nhắn này. |
getTo() | String | Xem những người nhận được phân tách bằng dấu phẩy của thư này. |
isDraft() | Boolean | Nhận thông báo xem thư này có phải là thư nháp hay không. |
isInChats() | Boolean | Nhận biết liệu tin nhắn này có phải là một cuộc trò chuyện hay không. |
isInInbox() | Boolean | Nhận thông báo xem thư này có trong hộp thư đến hay không. |
isInPriorityInbox() | Boolean | Trả về true nếu thư này nằm trong hộp thư đến ưu tiên; nếu không trả về false. |
isInTrash() | Boolean | Xem xem thư này có trong thùng rác hay không. |
isStarred() | Boolean | Nhận thông báo xem tin nhắn này có được gắn dấu sao hay không. |
isUnread() | Boolean | Nhận thông báo xem tin nhắn này có phải là chưa đọc hay không. |
markRead() | GmailMessage | Đánh dấu thư là đã đọc. |
markUnread() | GmailMessage | Đánh dấu thư là chưa đọc. |
moveToTrash() | GmailMessage | Chuyển thư vào thùng rác. |
refresh() | GmailMessage | Tải lại thư này 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). |
reply(body) | GmailMessage | Trả lời người gửi thư này bằng địa chỉ trả lời. |
reply(body, options) | GmailMessage | Thư trả lời cho người gửi thư này bằng địa chỉ trả lời, với đối số tùy chọn. |
replyAll(body) | GmailMessage | Trả lời người gửi bằng địa chỉ trả lời và tất cả người nhận thư này. |
replyAll(body, options) | GmailMessage | Trả lời người gửi thư này bằng địa chỉ trả lời và tất cả người nhận, với đối số không bắt buộc. |
star() | GmailMessage | Gắn dấu sao cho thư. |
unstar() | GmailMessage | Bỏ gắn dấu sao cho thư. |
GmailThread
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
addLabel(label) | GmailThread | Thêm nhãn này vào luồng. |
createDraftReply(body) | GmailDraft | Tạo thư nháp trả lời người gửi thư cuối cùng trong chuỗi này bằng địa chỉ trả lời. |
createDraftReply(body, options) | GmailDraft | Tạo thư nháp trả lời người gửi thư cuối cùng trong chuỗi này bằng địa chỉ trả lời, với các đối số không bắt buộc. |
createDraftReplyAll(body) | GmailDraft | Tạo thư nháp trả lời người gửi thư cuối cùng trong chuỗi này, sử dụng địa chỉ trả lời và tất cả người nhận thư này. |
createDraftReplyAll(body, options) | GmailDraft | Tạo thư nháp trả lời người gửi của thư cuối cùng trong chuỗi này, sử dụng địa chỉ trả lời và tất cả người nhận, với đối số không bắt buộc. |
getFirstMessageSubject() | String | Lấy tiêu đề của thư đầu tiên trong chuỗi. |
getId() | String | Lấy mã nhận dạng của chuỗi này. |
getLabels() | GmailLabel[] | Trả về các nhãn do người dùng tạo trên chuỗi này. |
getLastMessageDate() | Date | Xem ngày của tin nhắn gần đây nhất trong chuỗi tin nhắn này. |
getMessageCount() | Integer | Trả về số lượng thư trong chuỗi. |
getMessages() | GmailMessage[] | Nhận tin nhắn trong chuỗi này. |
getPermalink() | String | Nhận đường liên kết cố định cho chuỗi này. |
hasStarredMessages() | Boolean | Trả về việc chuỗi có tin nhắn được gắn dấu sao nào hay không. |
isImportant() | Boolean | Trả về việc luồng có được đánh dấu là quan trọng hay không. |
isInChats() | Boolean | Trả về việc chuỗi trò chuyện có được gắn nhãn là cuộc trò chuyện hay không. |
isInInbox() | Boolean | Trả về việc chuỗi có trong hộp thư đến hay không. |
isInPriorityInbox() | Boolean | Trả về true nếu chuỗi này nằm trong hộp thư đến ưu tiên; nếu không thì trả về false. |
isInSpam() | Boolean | Trả về việc chuỗi có bị đánh dấu là thư rác hay không. |
isInTrash() | Boolean | Trả về việc chuỗi có trong thùng rác hay không. |
isUnread() | Boolean | Trả về việc chuỗi có tin nhắn chưa đọc nào hay không. |
markImportant() | GmailThread | Đánh dấu chuỗi tin nhắn này là quan trọng. |
markRead() | GmailThread | Đánh dấu chuỗi tin nhắn này là đã đọc. |
markUnimportant() | GmailThread | Đánh dấu chuỗi thư này là không quan trọng. |
markUnread() | GmailThread | Đánh dấu chuỗi này là chưa đọc. |
moveToArchive() | GmailThread | Chuyển chuỗi này vào mục lưu trữ. |
moveToInbox() | GmailThread | Chuyển chuỗi này vào hộp thư đến. |
moveToSpam() | GmailThread | Chuyển chuỗi này vào thư mục thư rác. |
moveToTrash() | GmailThread | Chuyển chuỗi này vào thùng rác. |
refresh() | GmailThread | Tải lại chuỗi này và trạng thái được 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). |
removeLabel(label) | GmailThread | Xoá nhãn này khỏi chuỗi. |
reply(body) | GmailThread | Trả lời người gửi thư cuối cùng trên chuỗi thư này bằng địa chỉ ReplyTo. |
reply(body, options) | GmailThread | Trả lời người gửi thư cuối cùng trên chuỗi thư này bằng địa chỉ ReplyTo, với các đối số không bắt buộc. |
replyAll(body) | GmailThread | Trả lời người gửi (bằng địa chỉ ReplyTo) và tất cả người nhận của thư gần đây nhất trên chuỗi này. |
replyAll(body, options) | GmailThread | Trả lời người gửi (bằng địa chỉ replyTo) và tất cả người nhận thư cuối cùng trên chuỗi này, bằng các đối số không bắt buộc. |