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, cũng như thực hiện nhiều thao tác khác để quản lý tài khoản Gmail. Hãy xem thêm 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 các chuỗi, thư và nhãn trong Gmail. |
GmailAttachment | Một 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 trong tài khoản Gmail của người dùng. |
GmailApp
Phương pháp
| Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
|---|---|---|
createDraft(recipient, subject, body) | GmailDraft | Tạo thư email nháp. |
createDraft(recipient, subject, body, options) | GmailDraft | Tạo một email nháp với các đối số tùy chọn. |
createLabel(name) | GmailLabel | Tạo nhãn người dùng mới của tên đã cho. |
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 bí danh cho tài khoản này trong Gmail. |
getDraft(draftId) | GmailDraft | Truy xuất thư nháp qua email 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 là gì. |
getInboxThreads(start, max) | GmailThread[] | Truy xuất một loạt các chuỗi Hộp thư đến bất kể nhãn. |
getInboxUnreadCount() | Integer | Nhận số lượng chuỗi chưa đọc trong hộp thư đến. |
getMessageById(id) | GmailMessage | Nhận được tin nhắn theo mã nhận dạng. |
getMessagesForThread(thread) | GmailMessage[] | Truy xuất tất cả thư trong chuỗi đã chỉ định. |
getMessagesForThreads(threads) | GmailMessage[][] | Truy xuất tất cả thư trong các chuỗi đã chỉ định. |
getPriorityInboxThreads() | GmailThread[] | Truy xuất tất cả các chuỗi trong Hộp thư ưu tiên, bất kể nhãn là gì. |
getPriorityInboxThreads(start, max) | GmailThread[] | Truy xuất một loạt các luồng trong Hộp thư ưu tiên, bất kể nhãn là gì. |
getPriorityInboxUnreadCount() | Integer | Nhận số lượng chuỗi chưa đọc trong Hộp thư ưu tiên. |
getSpamThreads() | GmailThread[] | Truy xuất tất cả các chuỗi thư rác bất kể nhãn. |
getSpamThreads(start, max) | GmailThread[] | Truy xuất một loạt các chuỗi spam bất kể nhãn. |
getSpamUnreadCount() | Integer | Nhận được số chuỗi cuộc trò chuyệ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 các chuỗi được gắn dấu sao bất kể nhãn. |
getStarredUnreadCount() | Integer | Nhận số lượng chuỗi 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 bất kể nhãn. |
getTrashThreads(start, max) | GmailThread[] | Truy xuất một loạt các chuỗi thùng rác bất kể nhãn. |
getUserLabelByName(name) | GmailLabel | Truy xuất nhãn dựa vào 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ư này là chưa đọc và buộc thư làm mới. |
markMessagesRead(messages) | GmailApp | Đánh dấu các thư này là đã đọc và buộc các thư phải làm mới. |
markMessagesUnread(messages) | GmailApp | Đánh dấu các thư này là chưa đọc và buộc làm mới thư. |
markThreadImportant(thread) | GmailApp | Đánh dấu chuỗi này là quan trọng và buộc luồng phải làm mới. |
markThreadRead(thread) | GmailApp | Đánh dấu chuỗi này là đã đọc và buộc luồng phải làm mới. |
markThreadUnimportant(thread) | GmailApp | Đánh dấu chuỗi này là không quan trọng và buộc luồng phải làm mới. |
markThreadUnread(thread) | GmailApp | Đánh dấu chuỗi này là chưa đọc và buộc luồng phải làm mới. |
markThreadsImportant(threads) | GmailApp | Đánh dấu các chuỗi này là quan trọng và buộc các chuỗi này làm mới. |
markThreadsRead(threads) | GmailApp | Đánh dấu các chuỗi này là đã đọc và buộc các chuỗi này phải làm mới. |
markThreadsUnimportant(threads) | GmailApp | Đánh dấu các chuỗi này là không quan trọng và buộc các chuỗi này phải 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 này phả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 thư được chỉ định vào thùng rác và buộc làm mới thư. |
moveThreadToArchive(thread) | GmailApp | Di chuyển chuỗi này sang kho lưu trữ và buộc luồng làm mới. |
moveThreadToInbox(thread) | GmailApp | Di chuyển chuỗi này vào hộp thư đến và buộc làm mới chuỗi. |
moveThreadToSpam(thread) | GmailApp | Di chuyển chuỗi này vào thư mục thư rác và buộc làm mới chuỗi này. |
moveThreadToTrash(thread) | GmailApp | Di chuyển chuỗi này vào thùng rác và buộc làm mới chuỗi. |
moveThreadsToArchive(threads) | GmailApp | Di chuyển các chuỗi này sang kho lưu trữ và buộc các chuỗi này phải làm mới. |
moveThreadsToInbox(threads) | GmailApp | Di chuyển các chuỗi này vào hộp thư đến và buộc các chuỗi này phải làm mới. |
moveThreadsToSpam(threads) | GmailApp | Di chuyển các chuỗi này sang thư mục thư rác và buộc các chuỗi này 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 làm mới các chuỗi này. |
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 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) | 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 chuỗi 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). |
search(query) | GmailThread[] | Tìm kiếm trong Gmail với cụm từ tìm kiếm nhất định. |
search(query, start, max) | GmailThread[] | Tìm kiếm trong Gmail với cụm từ tìm kiếm nhất định. |
sendEmail(recipient, subject, body) | GmailApp | Gửi email. |
sendEmail(recipient, subject, body, options) | GmailApp | Gửi thông báo qua email với các đối số tùy chọn. |
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 một dấu sao vào thông báo này và buộc thông báo làm mới. |
starMessages(messages) | GmailApp | Thêm dấu sao vào các thư này và buộc làm mới thư. |
unstarMessage(message) | GmailApp | Xóa một dấu sao khỏi thông báo này và buộc thông báo làm mới. |
unstarMessages(messages) | GmailApp | Xóa dấu sao khỏi những thư này và buộc thư làm mới. |
GmailAttachment
Phương pháp
| Phương thức | Loại 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 blob được chuyển đổi thành loại nội dung được chỉ định. |
getBytes() | Byte[] | Lấy dữ liệu lưu trữ trong blob này. |
getContentType() | String | Lấy loại nội dung của byte trong blob này. |
getDataAsString() | String | Lấy dữ liệu của blob này dưới dạng Chuỗi có mã hoá UTF-8. |
getDataAsString(charset) | String | Lấy dữ liệu của blob này dưới dạng chuỗi có 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 | Lấy kích thước của tệp đính kèm này. |
isGoogleType() | Boolean | Trả về liệu blob này có phải là tệp Google Workspace (Trang tính, Tài liệu, v.v.) hay không. |
setBytes(data) | Blob | Đặt dữ liệu được lưu trữ trong blob này. |
setContentType(contentType) | Blob | Đặt loại nội dung của 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 | Đặt dữ liệu của blob này từ một chuỗi có mã hóa UTF-8. |
setDataFromString(string, charset) | Blob | Đặt dữ liệu của blob này từ một chuỗi có mã hóa được chỉ định. |
setName(name) | Blob | Đặt tên cho blob này. |
GmailDraft
Phương pháp
| Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
|---|---|---|
deleteDraft() | void | Xóa 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ông báo nháp này bằng cách sử dụng các đối số tùy chọn. |
GmailLabel
Phương pháp
| Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
|---|---|---|
addToThread(thread) | GmailLabel | Thêm nhãn này vào chuỗi đã cho và buộc luồng phải làm mới (GmailThread.refresh()). |
addToThreads(threads) | GmailLabel | Thêm nhãn này vào các chuỗi đã cho và buộc các chuỗi này phải 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[] | Lấy một loạt các chuỗi được đánh dấu bằng nhãn này. |
getUnreadCount() | Integer | Nhận số lượng chuỗi chưa đọc được gắn thẻ bằng nhãn này. |
removeFromThread(thread) | GmailLabel | Xoá nhãn này khỏi chuỗi đã cho và buộc luồng phải làm mới. |
removeFromThreads(threads) | GmailLabel | Xoá nhãn này khỏi các chuỗi đã cho và buộc các chuỗi này phải làm mới. |
GmailMessage
Phương pháp
| Phương thức | Loại 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 cách sử dụ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, cùng với các đối số tùy chọn. |
createDraftReplyAll(body) | GmailDraft | Tạo thư nháp trả lời người gửi bằng cách 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 thư này bằng cách sử dụng địa chỉ trả lời và tất cả người nhận, với các đối số tùy chọn. |
forward(recipient) | GmailMessage | Chuyển tiếp thư này tới người nhận mới. |
forward(recipient, options) | GmailMessage | Chuyển tiếp thư này cho người nhận mới, với các đối số tùy chọn. |
getAttachments() | GmailAttachment[] | Lấy tất cả tệp đính kèm của thư này. |
getAttachments(options) | GmailAttachment[] | Lấy tất cả tệp đính kèm của thư này. |
getBcc() | String | Lấy người nhận được phân tách bằng dấu phẩy bcc\39;d trên thư này. |
getBody() | String | Lấy nội dung HTML của nội dung thư. |
getCc() | String | Nhận người nhận được phân tách bằng dấu phẩy cc\39;d trên thư này. |
getDate() | Date | Lấy ngày và giờ của thông báo này. |
getFrom() | String | Nhận người gửi tin nhắn này. |
getHeader(name) | String | Lấy giá trị của tiêu đề RFC 2822 dựa trên 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 của nội dung thư này mà không cần định dạng HTML. |
getRawContent() | String | Lấy nội dung thô của thông báo này. |
getReplyTo() | String | Nhận địa chỉ trả lời của thư này (thường là người gửi). |
getSubject() | String | Lấy chủ đề của thư này. |
getThread() | GmailThread | Lấy chuỗi chứa thông báo này. |
getTo() | String | Nhận người nhận được phân tách bằng dấu phẩy của thư này. |
isDraft() | Boolean | Nhận được thư này có phải là thư nháp hay không. |
isInChats() | Boolean | Nhận tin nhắn này có phải là tin nhắn trò chuyện hay không. |
isInInbox() | Boolean | Nhận thư này có nằm 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 | Nhận được thư này có trong thùng rác hay không. |
isStarred() | Boolean | Nhận biết thư này có được gắn dấu sao hay không. |
isUnread() | Boolean | Nhận được thông báo này có phải là chưa đọc hay không. |
markRead() | GmailMessage | Đánh dấu tin nhắn là đã đọc. |
markUnread() | GmailMessage | Đánh dấu tin nhắn là chưa đọc. |
moveToTrash() | GmailMessage | Di chuyển thư đó vào thùng rác. |
refresh() | GmailMessage | Tải lại thư 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). |
reply(body) | GmailMessage | Trả lời người gửi thư này bằng địa chỉ trả lời. |
reply(body, options) | GmailMessage | Trả lời người gửi thư này bằng cách sử dụng địa chỉ trả lời, với các đố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 cách sử dụng địa chỉ trả lời và tất cả người nhận, với các đối số tùy chọn. |
star() | GmailMessage | Gắn dấu sao cho tin nhắn. |
unstar() | GmailMessage | Bỏ gắn dấu sao thư. |
GmailThread
Phương pháp
| Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
|---|---|---|
addLabel(label) | GmailThread | Thêm nhãn này vào chuỗi. |
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 cách sử dụ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 cách sử dụng địa chỉ trả lời, với các đối số tùy chọn. |
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 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 các đối số tùy chọn. |
getFirstMessageSubject() | String | Lấy chủ đề của tin nhắn đầ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ề nhãn do người dùng tạo trên chuỗi này. |
getLastMessageDate() | Date | Lấy ngày của chuỗi thư gần đây nhất. |
getMessageCount() | Integer | Trả về số lượng bài viết 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ề kết quả là chuỗi này có tin nhắn được gắn dấu sao hay không. |
isImportant() | Boolean | Trả về thông tin cho biết luồng có được đánh dấu là quan trọng hay không. |
isInChats() | Boolean | Trả về kết quả cuộc trò chuyện được gắn nhãn là trò chuyện. |
isInInbox() | Boolean | Trả về thông tin luồng trong hộp thư đến. |
isInPriorityInbox() | Boolean | Trả về true nếu luồng này nằm trong hộp thư đến ưu tiên; nếu không thì trả về false. |
isInSpam() | Boolean | Trả về xem liệu chuỗi có bị đánh dấu là nội dung vi phạm hay không. |
isInTrash() | Boolean | Trả về xem chuỗi có nằm trong thùng rác hay không. |
isUnread() | Boolean | Trả về kết quả là chuỗi này có tin nhắn chưa đọc hay không. |
markImportant() | GmailThread | Đánh dấu chuỗi này là quan trọng. |
markRead() | GmailThread | Đánh dấu chuỗi này là đã đọc. |
markUnimportant() | GmailThread | Đánh dấu chuỗi này là không quan trọng. |
markUnread() | GmailThread | Đánh dấu chuỗi này là chưa đọc. |
moveToArchive() | GmailThread | Di chuyển chuỗi này sang kho lưu trữ. |
moveToInbox() | GmailThread | Chuyển chuỗi này sang hộp thư đến. |
moveToSpam() | GmailThread | Chuyển chuỗi này sang 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 này bằng cách sử dụng địa chỉ trả lời. |
reply(body, options) | GmailThread | Trả lời người gửi thư cuối cùng trong chuỗi này bằng cách sử dụng địa chỉ trả lời, với các đối số tùy chọn. |
replyAll(body) | GmailThread | Trả lời người gửi (bằng địa chỉ trả lời) và tất cả người nhận thư cuối cùng 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 của tin nhắn cuối cùng trong chuỗi này, với các đối số tùy chọn. |