Gmail Service

Gmail

Dịch vụ này cho phép bạn gửi email, soạn thảo, 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 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	Cho phép truy cập vào các chuỗi thư, thư và nhãn trong Gmail.
GmailAttachment	Tệp đính kèm trong 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	Một 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 thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
createDraft(recipient, subject, body)	GmailDraft	Tạo một nội dung email nháp.
createDraft(recipient, subject, body, options)	GmailDraft	Tạo nội dung email nháp với các đối số không bắt buộc.
createLabel(name)	GmailLabel	Tạo nhãn người dùng mới có tên đã cho.
deleteLabel(label)	GmailApp	Xoá nhãn đã chỉ định.
getAliases()	String[]	Lấy danh sách các email được thiết lập làm địa chỉ email thay thế cho tài khoản này trong Gmail.
getDraft(draftId)	GmailDraft	Truy xuất nội dung email 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ả các chuỗi trong Hộp thư đến, bất kể nhãn.
getInboxThreads(start, max)	GmailThread[]	Truy xuất một dải các chuỗi trong hộp thư đến, bất kể nhãn.
getInboxUnreadCount()	Integer	Lấy số lượng chuỗi tin nhắn chưa đọc trong hộp thư đến.
getMessageById(id)	GmailMessage	Nhận một 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ả các chuỗi trong Hộp thư ưu tiên, bất kể nhãn.
getPriorityInboxThreads(start, max)	GmailThread[]	Truy xuất một dải các chuỗi thư trong Hộp thư ưu tiên, bất kể nhãn.
getPriorityInboxUnreadCount()	Integer	Lấy 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 tin nhắn rác bất kể nhãn.
getSpamThreads(start, max)	GmailThread[]	Truy xuất một dải các chuỗi thư rác bất kể nhãn.
getSpamUnreadCount()	Integer	Lấy số lượng chuỗi tin nhắn chưa đọc là thư 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 dải các chuỗi có gắn dấu sao, bất kể nhãn.
getStarredUnreadCount()	Integer	Lấy số lượng chuỗi tin nhắn chưa đọc được gắn dấu sao.
getThreadById(id)	GmailThread|null	Lấy một luồng theo mã nhận dạng.
getTrashThreads()	GmailThread[]	Truy xuất tất cả các chuỗi trong thùng rác, bất kể nhãn.
getTrashThreads(start, max)	GmailThread[]	Truy xuất một dải các chuỗi trong thùng 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 tin nhắn này là đã đọc và buộc tin nhắn 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 những thư này là đã đọc và buộc thư làm mới.
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 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 chuỗi này là quan trọng và buộc các chuỗi 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 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 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	Di chuyển thư vào thùng rác và buộc thư làm mới.
moveMessagesToTrash(messages)	GmailApp	Di chuyển các thư được chỉ định vào thùng rác và buộc các thư này làm mới.
moveThreadToArchive(thread)	GmailApp	Di chuyển chuỗi này vào kho lưu trữ và buộc chuỗi làm mới.
moveThreadToInbox(thread)	GmailApp	Di chuyển chuỗi này vào hộp thư đến và buộc chuỗi làm mới.
moveThreadToSpam(thread)	GmailApp	Di 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	Di 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 chuỗi này vào kho lưu trữ và buộc các chuỗ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 làm mới.
moveThreadsToSpam(threads)	GmailApp	Di chuyển các chuỗi này vào thư mục thư rác và buộc các chuỗi này làm mới.
moveThreadsToTrash(threads)	GmailApp	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 quan 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 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).
refreshThreads(threads)	GmailApp	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).
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 nội dung email.
sendEmail(recipient, subject, body, options)	GmailApp	Gửi nội dung email 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 những thư này và buộc thư 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 các thư làm mới.

GmailAttachment

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
copyBlob()	Blob	Trả về một 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 sang loại nội dung đã chỉ định.
getBytes()	Byte[]	Lấy dữ liệu được lưu trữ trong blob này.
getContentType()	String|null	Lấy loại nội dung của các byte trong blob này.
getDataAsString()	String	Lấy dữ liệu của blob này dưới dạng một Chuỗi có 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 một chuỗi có phương thứ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|null	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 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	Đặt dữ liệu của blob này từ một chuỗi có phương thức mã hoá UTF-8.
setDataFromString(string, charset)	Blob	Đặt dữ liệu của blob này từ một chuỗi có phương thức mã hoá được chỉ định.
setName(name)	Blob	Đặt tên cho 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á bản nháp tin nhắn 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 bản 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 nội dung email nháp này.
update(recipient, subject, body)	GmailDraft	Thay thế nội dung của tin nhắn 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 chuỗi đã cho và buộc chuỗi 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.
getId()	String	Lấy mã nhận dạng của nhãn này.
getName()	String	Lấy tên của nhãn này.
getThreads()	GmailThread[]	Lấy các luồng được đánh dấu bằng nhãn này.
getThreads(start, max)	GmailThread[]	Lấy một dải các chuỗi được đánh dấu bằng nhãn này.
getUnreadCount()	Integer	Lấy số lượng chuỗi 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 chuỗi đã cho và buộc các chuỗi 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, kèm theo các đối số không bắt buộc.
createDraftReplyAll(body)	GmailDraft	Tạo một 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 một 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, kèm theo các đố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 đến người nhận mới, có thể kèm theo đối số.
getAttachments()	GmailAttachment[]	Lấy tất cả tệp đính kèm cho thư này.
getAttachments(options)	GmailAttachment[]	Lấy tất cả tệp đính kèm cho thư này.
getBcc()	String	Lấy danh sách người nhận được gửi bcc cho thư này, phân tách bằng dấu phẩy.
getBody()	String	Lấy nội dung HTML của phần nội dung thư này.
getCc()	String	Lấy danh sách người nhận được cc trong thư này, phân tách bằng dấu phẩy.
getDate()	Date	Lấy ngày và giờ của thông báo này.
getFrom()	String	Lấy người gửi của thư này.
getHeader(name)	String	Lấy giá trị của một tiêu đề RFC 2822 dựa trên tên tiêu đề.
getId()	String	Lấy mã nhận dạng của thông báo này.
getPlainBody()	String	Lấy nội dung của phần nội dung thư này mà không có định dạng HTML.
getRawContent()	String	Lấy 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 chứa thông báo này.
getTo()	String	Lấy danh sách người nhận được phân tách bằng dấu phẩy của thư này.
isDraft()	Boolean	Cho biết thư này có phải là thư nháp hay không.
isInChats()	Boolean	Cho biết liệu thông báo này có phải là tin nhắn trò chuyện hay không.
isInInbox()	Boolean	Cho biết 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; trả về false nếu không.
isInTrash()	Boolean	Cho biết thư này có nằm trong thùng rác hay không.
isStarred()	Boolean	Cho biết tin nhắn này có được gắn dấu sao hay không.
isUnread()	Boolean	Cho biết liệu thư này chưa đọc hay chưa.
markRead()	GmailMessage	Đánh dấu thư là đã đọc.
markUnread()	GmailMessage	Đánh dấu thư 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 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 địa chỉ trả lời, kèm theo các đối số không bắt buộc.
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 các đối số không bắt buộc.
star()	GmailMessage	Gắn dấu sao cho tin nhắn.
unstar()	GmailMessage	Bỏ gắn dấu sao cho tin nhắn.

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 chuỗi.
createDraftReply(body)	GmailDraft	Tạo một thư nháp để trả lời người gửi thư gần đây nhất trong chuỗi này bằng địa chỉ trả lời.
createDraftReply(body, options)	GmailDraft	Tạo một thư nháp để trả lời người gửi tin nhắn gần đây nhất trong chuỗi này bằng địa chỉ trả lời, kèm theo các đối số không bắt buộc.
createDraftReplyAll(body)	GmailDraft	Tạo một thư nháp để trả lời người gửi thư gần đây nhất trong chuỗi thư này, bằng cách sử dụ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ư cuối cùng trong chuỗi thư này, sử dụng địa chỉ trả lời và tất cả người nhận, có đối số không bắt buộc.
getFirstMessageSubject()	String	Lấy tiêu đề của tin nhắn đầu tiên trong chuỗi.
getId()	String	Lấy mã nhận dạng của luồng này.
getLabels()	GmailLabel[]	Trả về các nhãn do người dùng tạo trên luồng này.
getLastMessageDate()	Date	Lấy ngày của tin nhắn gần đây nhất trong chuỗi này.
getMessageCount()	Integer	Trả về số lượng tin nhắn trong chuỗi trò chuyện.
getMessages()	GmailMessage[]	Lấy các tin nhắn trong chuỗi này.
getPermalink()	String	Lấy một đường liên kết cố định cho chuỗi này.
hasStarredMessages()	Boolean	Trả về liệu chuỗi có tin nhắn được gắn dấu sao hay không.
isImportant()	Boolean	Trả về cho dù chuỗi có được đánh dấu là quan trọng hay không.
isInChats()	Boolean	Trả về cho dù chuỗi có được gắn nhãn là cuộc trò chuyện hay không.
isInInbox()	Boolean	Trả về việc chuỗi thư có nằm trong hộp thư đến hay không.
isInPriorityInbox()	Boolean	Trả về true nếu chuỗi thư này nằm trong hộp thư đến ưu tiên; trả về false trong trường hợp ngược lại.
isInSpam()	Boolean	Trả về xem chuỗi có bị đánh dấu là nội dung rác hay không.
isInTrash()	Boolean	Trả về cho dù chuỗi có nằm trong thùng rác hay không.
isUnread()	Boolean	Trả về liệu chuỗi 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 vào kho lưu trữ.
moveToInbox()	GmailThread	Chuyển chuỗi này vào hộp thư đến.
moveToSpam()	GmailThread	Chuyển chuỗi tin nhắn này vào thư mục thư rác.
moveToTrash()	GmailThread	Chuyển chuỗi tin nhắn này vào thùng rác.
refresh()	GmailThread	Tải lại chuỗi 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).
removeLabel(label)	GmailThread	Xoá nhãn này khỏi chuỗi thư.
reply(body)	GmailThread	Trả lời người gửi tin nhắn gần đây nhất trong chuỗi này bằng địa chỉ replyTo.
reply(body, options)	GmailThread	Trả lời người gửi thư cuối cùng trong chuỗi thư này bằng địa chỉ replyTo, có thể có các đối số.
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ư cuối cùng trong chuỗi thư 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 thư cuối cùng trong chuỗi thư này, có thể kèm theo các đối số không bắt buộc.