GMail Component

Properties   Methods   Events   Config Settings   Errors  

The Gmail component provides an easy way to manage sending and receiving mail in Gmail.

Syntax

TcmGMail

Remarks

This component provides an easy to use interface for Gmail using version 3 of the Gmail REST API. To use the component, first set the Authorization property to a valid OAuth token. The Gmail component can be used for sending or creating new messages; retrieving existing messages; creating, deleting, or sending drafts; and several other functionalities supported by the Gmail API.

This component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The component has the following defaults:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this component. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the component. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the component will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the component will use an authorization code to get an access token. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the component will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the component will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: Gmail gmail = new Gmail(); gmail.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; gmail.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; gmail.OAuth.ClientId = CLIENT_ID; gmail.OAuth.ClientSecret = CLIENT_SECRET; gmail.Authorize();

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the component will request the authorization server to get an access token. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the component will not be able to automatically get a fresh token once it expires.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the component to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; gmail.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Sending Messages

There are two methods for sending messages using the Gmail component. The SendMail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the SendDraft method. In both cases the properties of the new message are assigned through the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.).

Sending a Message with SendDraft: gmail.MessageSubject = "I am sending an email."; gmail.MessageBodyContentType = "TEXT"; gmail.MessageBodyContent = "Just wanted to let you know."; gmail.MessageTo = "reader@tautology.org"; gmail.CreateDraft(); string messageId = gmail.MessageInfo[0].Id; gmail.SendDraft(messageId);

Receiving Messages

Information about messages fetched by the component can be accessed through the MessageInfo* properties. The MessageInfo* properties is populated when the ListMessages, FetchMessageInfo, or Search methods are called.

The ListMessages method will list the messages.

By default, the component will fetch one page of 100 messages when ListMessages is called. If additional messages remain in the folder, the NextPageToken property will be populated. If ListMessages is then called again on the same folder the next page of messages will be fetched. The example below populates the MessageInfo* properties with all the messages in the mailbox. do { gmail.ListMessages("", ""); } while (gmail.NextPageToken.Length > 0);

The message page size may also be changed by using the MessagePageSize configuration setting.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Attachment Property (GMail Component)

Provides the raw attachment content.

Syntax

__property String Attachment = { read=FAttachment };
__property DynamicArray<Byte> AttachmentB = { read=FAttachmentB };

Default Value

""

Remarks

This property is populated after calling FetchAttachment and holds the raw attachment content. This can be used to access the data before any processing is done by the component.

This property is read-only and not available at design time.

Data Type

Byte Array

Authorization Property (GMail Component)

An OAuth Authorization String.

Syntax

__property String Authorization = { read=FAuthorization, write=FSetAuthorization };

Default Value

""

Remarks

This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.

Example

Oauth oauth = new Oauth(); oauth.ClientId = ""; oauth.ClientSecret = ""; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; gmail.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

AutoDecodeParts Property (GMail Component)

Determines whether to automatically decode message parts.

Syntax

__property bool AutoDecodeParts = { read=FAutoDecodeParts, write=FSetAutoDecodeParts };

Default Value

true

Remarks

This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is False, the parts will not be automatically decoded.

Data Type

Boolean

FirewallAutoDetect Property (GMail Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (GMail Component)

This property determines the type of firewall to connect through.

Syntax

__property TcmGMailFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TcmGMailFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (GMail Component)

This property contains the name or IP address of firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (GMail Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (GMail Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (GMail Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

Message Property (GMail Component)

Provides the raw message content.

Syntax

__property String Message = { read=FMessage };
__property DynamicArray<Byte> MessageB = { read=FMessageB };

Default Value

""

Remarks

This property is populated after calling FetchMessageRaw and holds the raw message content. This can be used to access the data before any processing is done by the component.

This property is read-only and not available at design time.

Data Type

Byte Array

MessageAttachments Property (GMail Component)

A semicolon separated list of files to attach to a message.

Syntax

__property String MessageAttachments = { read=FMessageAttachments, write=FSetMessageAttachments };

Default Value

""

Remarks

This property contains a semicolon separated list of files to attach to a message. These files are added to a message created with CreateDraft or messages sent with SendMail.

This property is not available at design time.

Data Type

String

MessageBcc Property (GMail Component)

A comma separated list of recipients for blind carbon copies for a message.

Syntax

__property String MessageBcc = { read=FMessageBcc, write=FSetMessageBcc };

Default Value

""

Remarks

This property contains a comma separated list of destinations for blind carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.

Example (Add a BCC Recipient)

gmail.MessageBcc = "bbobbertson@bobmail.com"; gmail.SendMail();

Example (Add a BCC Recipient with a Name and Address)

gmail.MessageBcc = "Brandrew Bobbertson < bbobbertson@bobmail.com >"; gmail.SendMail();

This property is not available at design time.

Data Type

String

MessageBodyContent Property (GMail Component)

The body content for a message.

Syntax

__property String MessageBodyContent = { read=FMessageBodyContent, write=FSetMessageBodyContent };

Default Value

""

Remarks

This property contains the content of a message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.

This property is not available at design time.

Data Type

String

MessageBodyContentType Property (GMail Component)

The body content type for a message.

Syntax

__property String MessageBodyContentType = { read=FMessageBodyContentType, write=FSetMessageBodyContentType };

Default Value

""

Remarks

This property contains the content type of a message. Valid values include text or html. These addresses are added to a message created with CreateDraft or messages sent with SendMail.

This property is not available at design time.

Data Type

String

MessageCc Property (GMail Component)

A comma separated list of recipients for carbon copies for a message.

Syntax

__property String MessageCc = { read=FMessageCc, write=FSetMessageCc };

Default Value

""

Remarks

This property contains a comma separated list of destinations for carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.

Example (Add a CC Recipient)

office365.MessageCc = "bbobbertson@bobmail.com"; office365.SendMail();

Example (Add a CC Recipient with a Name and Address)

office365.MessageCc = "Brandrew Bobbertson < bbobbertson@bobmail.com >"; office365.SendMail();

This property is not available at design time.

Data Type

String

MessageCount Property (GMail Component)

The total number of messages on the mailbox.

Syntax

__property int MessageCount = { read=FMessageCount };

Default Value

0

Remarks

This property contains the total number of messages on the mailbox. The component fills out MessageCount after calling the CountMessages method.

This property is read-only.

Data Type

Integer

MessageFrom Property (GMail Component)

The author of a message.

Syntax

__property String MessageFrom = { read=FMessageFrom, write=FSetMessageFrom };

Default Value

""

Remarks

This property contains the author of a message. This property is optional. If it left blank, the message's author will be the Google account used in Authorization.

This property is applied to a message created with CreateDraft or messages sent with SendMail.

Example (Define who a Message is From)

gmail.MessageFrom = "stephen@company.com"; gmail.SendMail();

Example (Define who a Message is From with a Name and Address)

gmail.MessageFrom = "Stephen Withavee < stephen@company.com >"; gmail.SendMail();

This property is not available at design time.

Data Type

String

MessageHeaderCount Property (GMail Component)

The number of records in the MessageHeader arrays.

Syntax

__property int MessageHeaderCount = { read=FMessageHeaderCount, write=FSetMessageHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

The array indices start at 0 and end at MessageHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (GMail Component)

The property of a message header in a message info listing.

Syntax

__property String MessageHeaderField[int MessageHeaderIndex] = { read=FMessageHeaderField, write=FSetMessageHeaderField };

Default Value

""

Remarks

The field of a message header in a message info listing.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeaderValue Property (GMail Component)

The value of a message header in a message info listing.

Syntax

__property String MessageHeaderValue[int MessageHeaderIndex] = { read=FMessageHeaderValue, write=FSetMessageHeaderValue };

Default Value

""

Remarks

The value of a message header in a message info listing.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageIndex Property (GMail Component)

The index of the MessageInfo that should be used to populate the MessageHeaders and MessageParts collections.

Syntax

__property int MessageIndex = { read=FMessageIndex, write=FSetMessageIndex };

Default Value

0

Remarks

The index of the MessageInfo that should be used to populate the MessageHeaders and MessageParts collections.

This property is not available at design time.

Data Type

Integer

MessageInfoCount Property (GMail Component)

The number of records in the MessageInfo arrays.

Syntax

__property int MessageInfoCount = { read=FMessageInfoCount, write=FSetMessageInfoCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageInfoBcc
• MessageInfoCc
• MessageInfoFrom
• MessageInfoHistoryId
• MessageInfoId
• MessageInfoInternalDate
• MessageInfoLabels
• MessageInfoSize
• MessageInfoSnippet
• MessageInfoSubject
• MessageInfoThreadId
• MessageInfoTo

The array indices start at 0 and end at MessageInfoCount - 1.

This property is not available at design time.

Data Type

Integer

MessageInfoBcc Property (GMail Component)

The blind carbon copy recipient of a message in a message info listing.

Syntax

__property String MessageInfoBcc[int MessageInfoIndex] = { read=FMessageInfoBcc, write=FSetMessageInfoBcc };

Default Value

""

Remarks

The blind carbon copy recipient of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

String

MessageInfoCc Property (GMail Component)

The carbon copy recipient of a message in a message info listing.

Syntax

__property String MessageInfoCc[int MessageInfoIndex] = { read=FMessageInfoCc, write=FSetMessageInfoCc };

Default Value

""

Remarks

The carbon copy recipient of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

String

MessageInfoFrom Property (GMail Component)

The sender of a message in a message info listing.

Syntax

__property String MessageInfoFrom[int MessageInfoIndex] = { read=FMessageInfoFrom };

Default Value

""

Remarks

The sender of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is read-only and not available at design time.

Data Type

String

MessageInfoHistoryId Property (GMail Component)

The history identifier of a message in a message info listing.

Syntax

__property String MessageInfoHistoryId[int MessageInfoIndex] = { read=FMessageInfoHistoryId };

Default Value

""

Remarks

The history identifier of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is read-only and not available at design time.

Data Type

String

MessageInfoId Property (GMail Component)

The unique identifier of a message in a message info listing.

Syntax

__property String MessageInfoId[int MessageInfoIndex] = { read=FMessageInfoId };

Default Value

""

Remarks

The unique identifier of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is read-only and not available at design time.

Data Type

String

MessageInfoInternalDate Property (GMail Component)

The internal date of a message in a message info listing.

Syntax

__property String MessageInfoInternalDate[int MessageInfoIndex] = { read=FMessageInfoInternalDate };

Default Value

""

Remarks

The internal date of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is read-only and not available at design time.

Data Type

String

MessageInfoLabels Property (GMail Component)

Message labels in a message info listing.

Syntax

__property String MessageInfoLabels[int MessageInfoIndex] = { read=FMessageInfoLabels, write=FSetMessageInfoLabels };

Default Value

""

Remarks

Message labels in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

String

MessageInfoSize Property (GMail Component)

The size of a message in a message info listing.

Syntax

__property int MessageInfoSize[int MessageInfoIndex] = { read=FMessageInfoSize, write=FSetMessageInfoSize };

Default Value

0

Remarks

The size of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

Integer

MessageInfoSnippet Property (GMail Component)

The snippet of a message in a message info listing.

Syntax

__property String MessageInfoSnippet[int MessageInfoIndex] = { read=FMessageInfoSnippet, write=FSetMessageInfoSnippet };

Default Value

""

Remarks

The snippet of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

String

MessageInfoSubject Property (GMail Component)

The subject of a message in a message info listing.

Syntax

__property String MessageInfoSubject[int MessageInfoIndex] = { read=FMessageInfoSubject, write=FSetMessageInfoSubject };

Default Value

""

Remarks

The subject of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

String

MessageInfoThreadId Property (GMail Component)

The thread ID of a message in a message info listing.

Syntax

__property String MessageInfoThreadId[int MessageInfoIndex] = { read=FMessageInfoThreadId, write=FSetMessageInfoThreadId };

Default Value

""

Remarks

The thread ID of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

String

MessageInfoTo Property (GMail Component)

The recipients of a message in a message info listing.

Syntax

__property String MessageInfoTo[int MessageInfoIndex] = { read=FMessageInfoTo, write=FSetMessageInfoTo };

Default Value

""

Remarks

The recipients of a message in a message info listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

This property is not available at design time.

Data Type

String

MessageOtherHeaders Property (GMail Component)

The additional message headers for a message.

Syntax

__property String MessageOtherHeaders = { read=FMessageOtherHeaders, write=FSetMessageOtherHeaders };

Default Value

""

Remarks

This property contains additional message headers to the sent or created message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.

This property is not available at design time.

Data Type

String

MessagePartCount Property (GMail Component)

The number of records in the MessagePart arrays.

Syntax

__property int MessagePartCount = { read=FMessagePartCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessagePartAttachmentId
• MessagePartContentType
• MessagePartData
• MessagePartFilename
• MessagePartId
• MessagePartSize

The array indices start at 0 and end at MessagePartCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MessagePartAttachmentId Property (GMail Component)

The attachment ID of a message part in a message info listing.

Syntax

__property String MessagePartAttachmentId[int MessagePartIndex] = { read=FMessagePartAttachmentId };

Default Value

""

Remarks

The attachment ID of a message part in a message info listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

This property is read-only and not available at design time.

Data Type

String

MessagePartContentType Property (GMail Component)

The content type of a message part in a message info listing.

Syntax

__property String MessagePartContentType[int MessagePartIndex] = { read=FMessagePartContentType };

Default Value

""

Remarks

The content type of a message part in a message info listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

This property is read-only and not available at design time.

Data Type

String

MessagePartData Property (GMail Component)

The data of a message part in a message info listing.

Syntax

__property String MessagePartData[int MessagePartIndex] = { read=FMessagePartData };

Default Value

""

Remarks

The data of a message part in a message info listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

This property is read-only and not available at design time.

Data Type

String

MessagePartFilename Property (GMail Component)

The filename of a message part in a message info listing.

Syntax

__property String MessagePartFilename[int MessagePartIndex] = { read=FMessagePartFilename };

Default Value

""

Remarks

The filename of a message part in a message info listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

This property is read-only and not available at design time.

Data Type

String

MessagePartId Property (GMail Component)

The unique identifier of a message part in a message info listing.

Syntax

__property String MessagePartId[int MessagePartIndex] = { read=FMessagePartId };

Default Value

""

Remarks

The unique identifier of a message part in a message info listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

This property is read-only and not available at design time.

Data Type

String

MessagePartSize Property (GMail Component)

The size of a message part in a message info listing.

Syntax

__property int MessagePartSize[int MessagePartIndex] = { read=FMessagePartSize };

Default Value

0

Remarks

The size of a message part in a message info listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

This property is read-only and not available at design time.

Data Type

Integer

MessageSubject Property (GMail Component)

The subject of a message.

Syntax

__property String MessageSubject = { read=FMessageSubject, write=FSetMessageSubject };

Default Value

""

Remarks

This property contains the subject of a message. This property will be applied to a message created with CreateDraft or messages sent with SendMail.

This property is not available at design time.

Data Type

String

MessageTo Property (GMail Component)

A comma separated list of recipients for a message.

Syntax

__property String MessageTo = { read=FMessageTo, write=FSetMessageTo };

Default Value

""

Remarks

This property contains a comma separated list of destinations for a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.

Example (Add a Recipient)

gmail.MessageTo = "bbobbertson@bobmail.com"; gmail.SendMail();

Example (Add a Recipient with a Name and Address)

gmail.MessageTo = "Brandrew Bobbertson < bbobbertson@bobmail.com >"; gmail.SendMail();

This property is not available at design time.

Data Type

String

NextPageToken Property (GMail Component)

The token to retrieve the next page with data.

Syntax

__property String NextPageToken = { read=FNextPageToken, write=FSetNextPageToken };

Default Value

""

Remarks

This property contains the token that will be used to retrieve the next page with information. This field will become available when using the ListMessages or ListDrafts method.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (GMail Component)

The access token returned by the authorization server.

Syntax

__property String OAuthAccessToken = { read=FOAuthAccessToken, write=FSetOAuthAccessToken };

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the component makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (GMail Component)

The authorization code that is exchanged for an access token.

Syntax

__property String OAuthAuthorizationCode = { read=FOAuthAuthorizationCode, write=FSetOAuthAuthorizationCode };

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (GMail Component)

The scope request or response parameter used during authorization.

Syntax

__property String OAuthAuthorizationScope = { read=FOAuthAuthorizationScope, write=FSetOAuthAuthorizationScope };

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (GMail Component)

The id of the client assigned when registering the application.

Syntax

__property String OAuthClientId = { read=FOAuthClientId, write=FSetOAuthClientId };

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (GMail Component)

The type of client that is requesting authorization.

Syntax

__property TcmGMailOAuthClientProfiles OAuthClientProfile = { read=FOAuthClientProfile, write=FSetOAuthClientProfile };

enum TcmGMailOAuthClientProfiles {
  cocpApplication=0,
  cocpWeb=1
};

Default Value

cocpApplication

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (GMail Component)

The secret value for the client assigned when registering the application.

Syntax

__property String OAuthClientSecret = { read=FOAuthClientSecret, write=FSetOAuthClientSecret };

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (GMail Component)

The OAuth grant type used to acquire an OAuth access token.

Syntax

__property TcmGMailOAuthGrantTypes OAuthGrantType = { read=FOAuthGrantType, write=FSetOAuthGrantType };

enum TcmGMailOAuthGrantTypes {
  cogtAuthorizationCode=0,
  cogtImplicit=1,
  cogtPassword=2,
  cogtClientCredentials=3
};

Default Value

cogtAuthorizationCode

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (GMail Component)

Specifies the refresh token received from or sent to the authorization server.

Syntax

__property String OAuthRefreshToken = { read=FOAuthRefreshToken, write=FSetOAuthRefreshToken };

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (GMail Component)

The URL where the user (browser) returns after authenticating.

Syntax

__property String OAuthReturnURL = { read=FOAuthReturnURL, write=FSetOAuthReturnURL };

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (GMail Component)

The URL of the authorization server.

Syntax

__property String OAuthServerAuthURL = { read=FOAuthServerAuthURL, write=FSetOAuthServerAuthURL };

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (GMail Component)

The URL of the token server used to obtain the access token.

Syntax

__property String OAuthServerTokenURL = { read=FOAuthServerTokenURL, write=FSetOAuthServerTokenURL };

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (GMail Component)

The URL to which the user should be re-directed for authorization.

Syntax

__property String OAuthWebAuthURL = { read=FOAuthWebAuthURL };

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (GMail Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TcmGMailProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TcmGMailProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (GMail Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (GMail Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (GMail Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (GMail Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (GMail Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TcmGMailProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TcmGMailProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (GMail Component)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SSLAcceptServerCertEncoded Property (GMail Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (GMail Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (GMail Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (GMail Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (GMail Component)

This is the type of certificate store for this certificate.

Syntax

__property TcmGMailSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TcmGMailSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (GMail Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (GMail Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TcmGMailSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TcmGMailSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (GMail Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

AddMessageLabels Method (GMail Component)

Adds the specified labels to the message specified by MessageId.

Syntax

void __fastcall AddMessageLabels(String MessageId, String Labels);

Remarks

This method adds the specified labels to the message specified by the MessageId. The labels parameter should be set to a semicolon separated list of labels. Labels which contain spaces should be surrounded by quotes.

AppendToMailbox Method (GMail Component)

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.

Syntax

void __fastcall AppendToMailbox();

Remarks

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message.

Example (Append Message to Mailbox)

gmail.MessageSubject = "I saw a Tree"; gmail.MessageBodyContentType = "TEXT"; gmail.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked."; gmail.MessageTo = "TreeLookOut@gmail.com"; gmail.MessageCc = "TreeLookOut@gmail.com"; gmail.AppendToMailbox();

Authorize Method (GMail Component)

Get the authorization string required to access the protected resource.

Syntax

void __fastcall Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth* properties.

For more information, see the introduction section.

Config Method (GMail Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CountMessages Method (GMail Component)

Get the total number of messages in the mailbox.

Syntax

void __fastcall CountMessages();

Remarks

This method gets the total number of messages. This method populates the MessageCount property.

CreateDraft Method (GMail Component)

Creates a new email draft.

Syntax

void __fastcall CreateDraft();

Remarks

This method creates a new draft in the Drafts folder. The created message's id is also added to the rpMessageInfo* properties.

Example

gmail.MessageSubject = "Subject Text"; gmail.MessageBodyContentType = "TEXT"; gmail.MessageBodyContent = "Body Text"; gmail.MessageTo = "email@example.com"; gmail.CreateDraft();

Delete Method (GMail Component)

Deletes a message.

Syntax

void __fastcall Delete(String messageId);

Remarks

This method deletes a message. Deleted messages will be moved to the Trash folder. messageId takes the message ID of the message to be deleted.

DeleteDraft Method (GMail Component)

Deletes a draft permanently.

Syntax

void __fastcall DeleteDraft(String draftId);

Remarks

This method deletes a draft permanently. draftId takes the draft ID of the draft to be deleted.

DeletePermanently Method (GMail Component)

Deletes the specified messages permanently.

Syntax

void __fastcall DeletePermanently(String messageIds);

Remarks

This method permanently deletes the specified messages by the MessageId. The messageIds parameter should be set to a semicolon separate list of message IDs.

FetchAttachment Method (GMail Component)

Retrieves a raw attachment.

Syntax

void __fastcall FetchAttachment(String messageId, String attachmentId);

Remarks

This method retrieves a message attachment in raw format.

Information about the retrieved message attachment can be accessed through Attachment.

FetchMessage Method (GMail Component)

Retrieves a message including the message parts.

Syntax

void __fastcall FetchMessage(String messageId);

Remarks

This method retrieves a message including its parts. messageId specifies the message ID for the message.

The fetched part can be accessed through the MessageParts property.

FetchMessageHeaders Method (GMail Component)

Retrieves the headers of a message.

Syntax

void __fastcall FetchMessageHeaders(String messageId);

Remarks

This method retrieves headers of a message and stores them in the MessageHeaders* properties.

FetchMessageInfo Method (GMail Component)

Retrieves a message info.

Syntax

void __fastcall FetchMessageInfo(String messageId);

Remarks

This method retrieves a message info.

Information about the retrieved message can be accessed through MessageInfo* properties.

FetchMessageRaw Method (GMail Component)

Retrieves the raw message of the specified message ID.

Syntax

void __fastcall FetchMessageRaw(String messageId);

Remarks

This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the Message property, as well as provided through the Transfer event.

Interrupt Method (GMail Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDrafts Method (GMail Component)

Lists the drafts in a mailbox.

Syntax

void __fastcall ListDrafts(String filter);

Remarks

This method lists the drafts found in the mailbox. This method populates the MessageInfo* properties.

If the number of drafts is greater than the message page size, NextPageToken will be populated and calling ListDrafts again will list the next page of drafts.

filter can be used to retrieve a specific subset of drafts, or it can be left as an empty string to retrieve all drafts in a mailbox.

Example (List all drafts in a mailbox)

gmail.ListDrafts("");

Example (List drafts from a specific address)

gmail.ListDrafts("from:someuser@example.com");

Example (List drafts with the 'Unread' label)

gmail.ListDrafts("is:unread");

Example (List drafts with a specific message ID)

gmail.ListDrafts("rfc822msgid:123456");

ListMessages Method (GMail Component)

Lists the messages in a mailbox.

Syntax

void __fastcall ListMessages(String filter, String threadId);

Remarks

This method lists the messages found in the mailbox. This method populates the MessageInfo* properties.

If the number of messages is greater than the message page size, NextPageToken will be populated and calling ListMessages again will list the next page of messages.

filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a mailbox.

threadId can be used to retrieve a specific subset of messages from a specific thread, or it can be left as an empty string to retrieve all messages in a mailbox.

Example (List all messages in a mailbox)

gmail.ListMessages("", "");

Example (List messages from a specific address)

gmail.ListMessages("from:someuser@example.com", "");

Example (List messages with the 'Unread' label)

gmail.ListMessages("is:unread", "");

Example (List messages with a specific message ID)

gmail.ListMessages("rfc822msgid:123456", "");

Example (List Messages from a specific thread)

gmail.ListMessages("", "123456789");

RemoveMessageLabels Method (GMail Component)

Removes the specified labels from the message specified by MessageId.

Syntax

void __fastcall RemoveMessageLabels(String MessageId, String Labels);

Remarks

This method removes the specified labels from the message specified by the MessageId property. The labels parameter should be set to a semicolon separate list of labels. Labels which contain spaces should be surrounded by quotes.

Reset Method (GMail Component)

Reset the component.

Syntax

void __fastcall Reset();

Remarks

This method will reset the component's properties to their default values.

Restore Method (GMail Component)

Restores a message.

Syntax

void __fastcall Restore(String id);

Remarks

This method restores a deleted message. Messages that are located in the Trash folder can be restored. id takes the message ID of the message to be restored.

Search Method (GMail Component)

Search for messages.

Syntax

void __fastcall Search(String searchKey);

Remarks

This method can be used to search for messages. Results are returned through the MessageInfo* properties. searchKey specifies a string to be searched for.

SendCustomRequest Method (GMail Component)

Send a custom HTTP request.

Syntax

void __fastcall SendCustomRequest(String HTTPMethod, String URL, String PostData);

Remarks

This method can be used to send a custom HTTP request to the server.

SendDraft Method (GMail Component)

Sends an existing Draft.

Syntax

void __fastcall SendDraft(String draftId);

Remarks

This method sends an existing draft.

SendMail Method (GMail Component)

Sends a new email.

Syntax

void __fastcall SendMail();

Remarks

This method sends a new message.

Example

gmail.MessageSubject = "I saw a Tree"; gmail.MessageBodyContentType = "TEXT"; gmail.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked."; gmail.MessageTo = "TreeLookOut@gmail.com"; gmail.MessageCc = "TreeLookOut@gmail.com"; gmail.SendMail();

Error Event (GMail Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TcmGMailErrorEventParams;
typedef void __fastcall (__closure *TcmGMailErrorEvent)(System::TObject* Sender, TcmGMailErrorEventParams *e);
__property TcmGMailErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (GMail Component)

This event fires once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TcmGMailLogEventParams;
typedef void __fastcall (__closure *TcmGMailLogEvent)(System::TObject* Sender, TcmGMailLogEventParams *e);
__property TcmGMailLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MessageHeader Event (GMail Component)

Fired when a header is retrieved from the server.

Syntax

typedef struct {
  String Field;
  String Value;
} TcmGMailMessageHeaderEventParams;
typedef void __fastcall (__closure *TcmGMailMessageHeaderEvent)(System::TObject* Sender, TcmGMailMessageHeaderEventParams *e);
__property TcmGMailMessageHeaderEvent OnMessageHeader = { read=FOnMessageHeader, write=FOnMessageHeader };

Remarks

The MessageHeaderList event is fired for each header retrieved from the server when FetchMessageHeaders is called.

MessageInfo Event (GMail Component)

Fired when a message is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String ThreadId;
  String HistoryId;
  String InternalDate;
  String Subject;
  String Labels;
  String From;
  String SentTo;
  String Cc;
  String Bcc;
  String Snippet;
  int Size;
} TcmGMailMessageInfoEventParams;
typedef void __fastcall (__closure *TcmGMailMessageInfoEvent)(System::TObject* Sender, TcmGMailMessageInfoEventParams *e);
__property TcmGMailMessageInfoEvent OnMessageInfo = { read=FOnMessageInfo, write=FOnMessageInfo };

Remarks

The MessageList event is fired for each message retrieved from the server when ListMessages or ListDrafts is called.

MessagePart Event (GMail Component)

Fired when a message part is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String AttachmentId;
  String Filename;
  String ContentType;
  int Size;
  String Data;
} TcmGMailMessagePartEventParams;
typedef void __fastcall (__closure *TcmGMailMessagePartEvent)(System::TObject* Sender, TcmGMailMessagePartEventParams *e);
__property TcmGMailMessagePartEvent OnMessagePart = { read=FOnMessagePart, write=FOnMessagePart };

Remarks

The MessagePartList event is fired for each message part retrieved from the server when ListMessages or ListDrafts is called.

SSLServerAuthentication Event (GMail Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TcmGMailSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TcmGMailSSLServerAuthenticationEvent)(System::TObject* Sender, TcmGMailSSLServerAuthenticationEventParams *e);
__property TcmGMailSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (GMail Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TcmGMailSSLStatusEventParams;
typedef void __fastcall (__closure *TcmGMailSSLStatusEvent)(System::TObject* Sender, TcmGMailSSLStatusEventParams *e);
__property TcmGMailSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Transfer Event (GMail Component)

This event is fired while a document transfers (delivers document).

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
} TcmGMailTransferEventParams;
typedef void __fastcall (__closure *TcmGMailTransferEvent)(System::TObject* Sender, TcmGMailTransferEventParams *e);
__property TcmGMailTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (GMail Component)

Gmail Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (GMail Component)

Gmail Errors