TTMSFNCCloudGoogleGmail Class

Component that provides access to a Gmail account, exposing the public collections and events to retrieve labels and messages, send mail, manage message labels and download attachments.

API unit family: TMSFNCCloudGoogleGmail Inherits from: TTMSFNCCustomCloudGoogleGmail

Syntax

TTMSFNCCloudGoogleGmail = class(TTMSFNCCustomCloudGoogleGmail)

Properties

Name	Description
Files	Read-only collection of files to send with a message, as regular attachments or inline images. (inherited from TTMSFNCCustomCloudGoogleGmail)
Labels	Read-only collection of labels available in the account. (inherited from TTMSFNCCustomCloudGoogleGmail)
Mails	Collection of messages retrieved from the account by the last list or message request. (inherited from TTMSFNCCustomCloudGoogleGmail)
PageToken	Token that identifies the next page of results to retrieve when listing messages. (inherited from TTMSFNCCustomCloudGoogleGmail)

Methods

Name	Description
DeleteMessage	Deletes the specified message from the account. (inherited from TTMSFNCCustomCloudGoogleGmail)
GetAttachment	Starts an asynchronous request that downloads the data of the specified attachment into its Data property. (inherited from TTMSFNCCustomCloudGoogleGmail)
GetAttachmentPromise	Downloads the data of the specified attachment and returns a promise that resolves when the request completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
GetLabels	Starts an asynchronous request that retrieves the labels available in the account into the Labels collection. (inherited from TTMSFNCCustomCloudGoogleGmail)
GetLabelsPromise	Retrieves the labels available in the account and returns a promise that resolves when the request completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
GetMails	Starts an asynchronous request that lists the messages of the specified labels into the Mails collection. (inherited from TTMSFNCCustomCloudGoogleGmail)
GetMailsPromise	Lists the messages of the specified labels and returns a promise that resolves when all matching messages have been retrieved. (inherited from TTMSFNCCustomCloudGoogleGmail)
GetTestTokensResult	Inspects a request result to determine whether the configured access tokens are valid. (inherited from TTMSFNCCustomCloudGoogleGmail)
ImageToBase64	Reads an image file and returns its base64-encoded data, optionally wrapped in an HTML img tag so it can be embedded inline in a message body. (inherited from TTMSFNCCustomCloudGoogleGmail)
RemoveMessageLabels	Removes one or more labels from the specified message. (inherited from TTMSFNCCustomCloudGoogleGmail)
SendMailMessage	Sends the specified message through the account. (inherited from TTMSFNCCustomCloudGoogleGmail)
SendMessage	Sends the specified message through the account. (inherited from TTMSFNCCustomCloudGoogleGmail)
UpdateMessageLabels	Adds one or more labels to the specified message. (inherited from TTMSFNCCustomCloudGoogleGmail)

Events

Name	Description
OnDeleteMessage	Occurs when a delete message request completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnGetAttachment	Occurs when an attachment download request completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnGetLabels	Occurs when the request to retrieve the account labels completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnGetMails	Occurs when the request to list the messages of a label completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnGetMailsComplete	Occurs when all messages of a list request have been retrieved and parsed. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnGetMessage	Occurs each time a single message has been retrieved and parsed. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnRemoveMessageLabels	Occurs when a request to remove labels from a message completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnSendMessage	Occurs when a send message request completes. (inherited from TTMSFNCCustomCloudGoogleGmail)
OnUpdateMessageLabels	Occurs when a request to add labels to a message completes. (inherited from TTMSFNCCustomCloudGoogleGmail)