Gmail Component

Properties   Methods   Events   Config Settings   Errors  

The Gmail component provides an easy way to manage sending and receiving mail in Gmail. The component also includes support for creating, listing, and managing contacts.

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 property 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 = CloudOAuthClientProfiles.cocpApplication; gmail.OAuth.GrantType = OAuthSettingsGrantTypes.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 https://www.googleapis.com/auth/contacts http://www.google.com/m8/feeds/contacts/default/full"; 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, RetrieveMessageInfo, 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.

Listing Contact Groups

To list the contact groups of a user use the ListContactGroups method. It populates the ContactGroups collection with the retrieved groups. For each retrieved group the ContactGroupList event is fired.

Example (List All Contact Groups):

gmail.ListContactGroups(); // List root groups. foreach(GLContactGroup group in gmail.ContactGroups){ group.Id; // Group id group.Name; // Group name }

Listing Contacts

Use the ListContacts to populate the Contacts collection with the the contacts that are in groups, including main group (Contacts). For each retrieved contact the ContactList event is fired.

Example (List all Contacts): gmail.ListContacts();

If the number of contacts exceeds the page size, the ListContactsMarker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the Contacts collection.

Example (List all Contact Pages): do{ gmail.ListContacts(); } while(!gmail.ListContactsMarker.isEmpty());

Creating and Updating Contacts

To create a new contact use the CreateContact method. The newly created contact is added at the end of the Contacts collection.

Example (Create a Contact in the main group (Contacts))

gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com"); // Create the contact in the main group (Contacts). After creating a contact with basic information, select the contact to be edited in the Contacts collection, edit its fields and make a call to the UpdateContact method. To edit the newly created contact select the last contact of the collection.

Example (Update The First Contact Of The List) gmail.Contacts[0].CompanyName = "nsoftware"; // Set notes gmail.Contacts[0].Notes = "notes"; // Set multiple phone numbers gmail.Contacts[0].PhonesCount = 2; gmail.Contacts[0].PhoneIndex = 0; gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptMobile; gmail.Contacts[0].PhoneNumber = "0123456789"; gmail.Contacts[0].PhoneIndex = 1; gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptWork; gmail.Contacts[0].PhoneNumber = "9876543210"; gmail.UpdateContact(0); The OLContact type used in the Contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add other fields, you can use the SetContactField method. For a complete list of fields a contact can have please refer to the official google documentation for the People API.

Example (Add Other Fields To A Contact) // Set birthday gmail.SetContactField(0, "/json/birthdays", "[{ date: { "year": 1999, "month": 12, "day": 1 }}]", 1); // The last argument is the type of the field. 1 (Array) // Set address gmail.SetContactField(0, "/json/addresses", "[{\"metadata\":{\"primary\":true,\"sourcePrimary\":true,\"verified\":true},\"formattedValue\":\"formattedValue\",\"type\":\"type\",\"formattedType\":\"type\"}]", 1); // The last argument is the type of the field. 1 (Array) // Update the contact gmail.UpdateContact(0);

Example (Create A Contact In A Specific Group) Notice that when creating a contact, the group/label is not specified. This can be added through the memberships field using SetContactField. gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com"); //Notice that no group is specified for this contact gmail.SetContactField(0, "/json/memberships", "[{\"contactGroupMembership\": { \"contactGroupId\": \"" + gmail.ContactGroups[0].Id + "\" }}]", 1); gmail.UpdateContact(0);

Retrieving Contacts

Example (Retrieve a Contact)

// Retrieve a contact by its ID string contactId = "12345"; // Replace with the actual contact ID gmail.GetContact(contactId); // Access the retrieved contact var retrievedContact = gmail.Contacts[gmail.Contacts.Count - 1]; retrievedContact.FirstName; //first name retrievedContact.LastName; //last name retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address retrievedContact.EmailAddress; //first email address value retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number retrievedContact.PhoneNumber; //first phone number value gmail.GetContactField(gmail.Contacts.Count - 1, "/json/birthdays/[1]/date"); //birthday of the contact gmail.GetContactField(gmail.Contacts.Count - 1, "/json/nicknames/[1]"); //nickname of the contact

Deleting Contacts

To delete a contact use the DeleteContact method and provide the Id of the contact as the argument. The contact is also removed from the Contacts collection.

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" gmail.ListContacts(); for (int i = 0; i < gmail.Contacts.Count; i++) { if (gmail.Contacts[i].DisplayName == "John Doe") { //Delete the contact gmail.DeleteContact(gmail.Contacts[i].Id); break; } }

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 RetrieveAttachment 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 = "cd3ac0b7-c936-4b69-a958-ba45a4fb7963"; 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

ContactGroupCount Property (Gmail Component)

The number of records in the ContactGroup arrays.

Syntax

__property int ContactGroupCount = { read=FContactGroupCount, write=FSetContactGroupCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContactGroupId
• ContactGroupName

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

This property is not available at design time.

Data Type

Integer

ContactGroupId Property (Gmail Component)

The unique identifier (resource name) of the contact group.

Syntax

__property String ContactGroupId[int ContactGroupIndex] = { read=FContactGroupId };

Default Value

""

Remarks

The unique identifier (resource name) of the contact group.

The ContactGroupIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactGroupCount property.

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

Data Type

String

ContactGroupName Property (Gmail Component)

The display name of the contact group.

Syntax

__property String ContactGroupName[int ContactGroupIndex] = { read=FContactGroupName };

Default Value

""

Remarks

The display name of the contact group.

The ContactGroupIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactGroupCount property.

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

Data Type

String

ContactsCount Property (Gmail Component)

The number of records in the Contact arrays.

Syntax

__property int ContactsCount = { read=FContactsCount, write=FSetContactsCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContactDisplayName
• ContactEmailAddress
• ContactEmailAddressDisplayName
• ContactEmailAddressesCount
• ContactEmailAddressIndex
• ContactEmailAddressType
• ContactEmailAddressTypeCustom
• ContactFirstName
• ContactGroupId
• ContactGroupName
• ContactId
• ContactJSON
• ContactLastName
• ContactNotes
• ContactParentId
• ContactParentIdIndex
• ContactParentIdsCount
• ContactPhoneIndex
• ContactPhoneNumber
• ContactPhonesCount
• ContactPhoneType
• ContactPhoneTypeCustom

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

This property is not available at design time.

Data Type

Integer

ContactDisplayName Property (Gmail Component)

The contact's display name.

Syntax

__property String ContactDisplayName[int ContactIndex] = { read=FContactDisplayName, write=FSetContactDisplayName };

Default Value

""

Remarks

The contact's display name.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactEmailAddress Property (Gmail Component)

The email address at the specified EmailAddressIndex.

Syntax

__property String ContactEmailAddress[int ContactIndex] = { read=FContactEmailAddress, write=FSetContactEmailAddress };

Default Value

""

Remarks

The email address at the specified EmailAddressIndex. For example, when updating a contact, setting EmailAddressIndex to 0 and then assigning "example@example.com" to this property will set the first email address of the contact. Similarly, when retrieving a contact, setting EmailAddressIndex to 0 allows you to read the first email address of the contact.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactEmailAddressDisplayName Property (Gmail Component)

The display name of the E-mail address selected by EmailAddressIndex.

Syntax

__property String ContactEmailAddressDisplayName[int ContactIndex] = { read=FContactEmailAddressDisplayName, write=FSetContactEmailAddressDisplayName };

Default Value

""

Remarks

The display name of the E-mail address selected by EmailAddressIndex. For example, when updating a contact, setting EmailAddressIndex to 0 and then assigning "example@example.com" to this property will set the display name of the first email address. Similarly, when retrieving a contact, setting EmailAddressIndex to 0 allows you to read the display name of the first email address of the contact.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactEmailAddressesCount Property (Gmail Component)

When retrieving contacts, it indicates the number of email addresses linked to the contact.

Syntax

__property int ContactEmailAddressesCount[int ContactIndex] = { read=FContactEmailAddressesCount, write=FSetContactEmailAddressesCount };

Default Value

0

Remarks

When retrieving contacts, it indicates the number of email addresses linked to the contact. When creating or updating a contact, this property is set to the number of email addresses the contact will have.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactEmailAddressIndex Property (Gmail Component)

Index of email address to get or set in the EmailAddress property.

Syntax

__property int ContactEmailAddressIndex[int ContactIndex] = { read=FContactEmailAddressIndex, write=FSetContactEmailAddressIndex };

Default Value

0

Remarks

Index of email address to get or set in the EmailAddress property. For example, setting EmailAddressIndex to 0 and then assigning a value to this field sets the first email address of a contact. If you are retrieving a contact, setting EmailAddressIndex to 0, will populate EmailAddress with the first email address.

Example (Set the email addresses before updating a contact) gmail.Contacts[0].EmailAddressesCount = 2; gmail.Contacts[0].EmailAddressIndex = 0; gmail.Contacts[0].EmailAddress = "email1@domain1.com"; // set the first email address of the contact gmail.Contacts[0].EmailAddressIndex = 1; gmail.Contacts[0].EmailAddress = "email2@domain2.com"; // set the second email address of the contact gmail.UpdateContact(0);

Example (Read email addresses of a retrieved contact) gmail.GetContact(contactId); GLContact lastContact = gmail.Contacts[gmail.Contacts.Count - 1]; for(int i = 0; i < lastContact.EmailAddressesCount; i++){ lastContact.EmailAddressIndex = i; // set the index of the next email to read lastContact.EmailAddress; // read the next email address of the contact }

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactEmailAddressType Property (Gmail Component)

Type of the E-mail address.

Syntax

__property TcmGmailContactEmailAddressTypes ContactEmailAddressType[int ContactIndex] = { read=FContactEmailAddressType, write=FSetContactEmailAddressType };

enum TcmGmailContactEmailAddressTypes {
  eatHome=0,
  eatWork=1,
  eatOther=2
};

Default Value

eatHome

Remarks

Type of the E-mail address.

This property indicates the type of a contact's phone number selected by PhoneIndex.

Possible values are:

• 0 (eatHome)
• 1 (eatWork)
• 2 (eatOther)

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactEmailAddressTypeCustom Property (Gmail Component)

Custom type name of the E-mail address selected by EmailAddressIndex.

Syntax

__property String ContactEmailAddressTypeCustom[int ContactIndex] = { read=FContactEmailAddressTypeCustom, write=FSetContactEmailAddressTypeCustom };

Default Value

""

Remarks

Custom type name of the E-mail address selected by EmailAddressIndex.

Example (Adding an email address with a custom type): gmail.Contacts[0].EmailAddressesCount = 1; gmail.Contacts[0].EmailAddressIndex = 0; gmail.Contacts[0].EmailAddressTypeCustom = "customType"; gmail.Contacts[0].EmailAddress = "email@address.com" //Update the contact gmail.UpdateContact(0);

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactFirstName Property (Gmail Component)

The contact's first name.

Syntax

__property String ContactFirstName[int ContactIndex] = { read=FContactFirstName, write=FSetContactFirstName };

Default Value

""

Remarks

The contact's first name.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactId Property (Gmail Component)

The unique identifier of the contact (resource name).

Syntax

__property String ContactId[int ContactIndex] = { read=FContactId };

Default Value

""

Remarks

The unique identifier of the contact (resource name)

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

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

Data Type

String

ContactJSON Property (Gmail Component)

A JSON representation of the contact.

Syntax

__property String ContactJSON[int ContactIndex] = { read=FContactJSON, write=FSetContactJSON };

Default Value

""

Remarks

A JSON representation of the contact. Change this field to set raw JSON content to send on next update. Other fields values will be ignored in this case.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactLastName Property (Gmail Component)

The contact's last name.

Syntax

__property String ContactLastName[int ContactIndex] = { read=FContactLastName, write=FSetContactLastName };

Default Value

""

Remarks

The contact's last name.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactNotes Property (Gmail Component)

The user's notes about the contact.

Syntax

__property String ContactNotes[int ContactIndex] = { read=FContactNotes, write=FSetContactNotes };

Default Value

""

Remarks

The user's notes about the contact. (biographies field)

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactParentId Property (Gmail Component)

The ID of the contact's group selected by ParentIdIndex.

Syntax

__property String ContactParentId[int ContactIndex] = { read=FContactParentId, write=FSetContactParentId };

Default Value

""

Remarks

The ID of the contact's group selected by ParentIdIndex. For example, when updating a contact, setting ParentIdIndex to 0 and then assigning a group id to this property will set the first group a contact belongs to. Similarly, when retrieving a contact, setting ParentIdIndex to 0 allows you to read the first contact group of the contact. Set this property to an empty string to remove a contact from the group.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactParentIdIndex Property (Gmail Component)

Index of group ID to get or set in the ParentId property.

Syntax

__property int ContactParentIdIndex[int ContactIndex] = { read=FContactParentIdIndex, write=FSetContactParentIdIndex };

Default Value

0

Remarks

Index of group ID to get or set in the ParentId property.

Example (Set the groups before updating a contact) gmail.Contacts[0].ParentIdsCount = 2; gmail.Contacts[0].ParentIdIndex = 0; gmail.Contacts[0].ParentId = gmail.ContactGroups[0].Id; // set the first group the contact belongs to gmail.Contacts[0].ParentIdIndex = 1; gmail.Contacts[0].ParentId = gmail.ContactGroups[1].Id; // set the first group the contact belongs to gmail.UpdateContact(0);

Example (Read groups of a retrieved contact) gmail.GetContact(contactId); GLContact lastContact = gmail.Contacts[gmail.Contacts.Count - 1]; for(int i = 0; i < lastContact.ParentIdsCount; i++){ lastContact.ParentIdIndex = i; // set the index of the next group to read lastContact.ParentId; // read the next group of the contact }

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactParentIdsCount Property (Gmail Component)

When retrieving contacts, it indicates the number groups the contact belongs to.

Syntax

__property int ContactParentIdsCount[int ContactIndex] = { read=FContactParentIdsCount, write=FSetContactParentIdsCount };

Default Value

0

Remarks

When retrieving contacts, it indicates the number groups the contact belongs to. When creating or updating a contact, this property should be set to the number of groups the contact will belong to.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactPhoneIndex Property (Gmail Component)

Index of phone number to get or set in the PhoneNumber property.

Syntax

__property int ContactPhoneIndex[int ContactIndex] = { read=FContactPhoneIndex, write=FSetContactPhoneIndex };

Default Value

0

Remarks

Index of phone number to get or set in the PhoneNumber property. For example, setting PhoneIndex to 0 and then assigning a value to this field sets the first phone number of a contact. If you are retrieving a contact, setting PhoneIndex to 0, will populate PhoneNumber with the first phone number.

Example (Set the phone numbers before updating a contact): gmail.Contacts[0].PhonesCount = 2; gmail.Contacts[0].PhoneIndex = 0; gmail.Contacts[0].PhoneNumber = "0123456789"; // set the first email address of the contact gmail.Contacts[0].PhoneIndex = 1; gmail.Contacts[0].PhoneNumber = "9876543210"; // set the second email address of the contact gmail.UpdateContact(0);

Example (Read phone numbers of a retrieved contact): gmail.GetContact(contactId); GLContact lastContact = gmail.Contacts[gmail.Contacts.Count - 1]; for(int i = 0; i < lastContact.PhonesCount; i++){ lastContact.PhoneIndex = i; // set the index of the next phone number to read lastContact.PhoneNumber; // read the next phone number of the contact }

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactPhoneNumber Property (Gmail Component)

This property is used to get or set a phone number at the index specified by PhoneIndex.

Syntax

__property String ContactPhoneNumber[int ContactIndex] = { read=FContactPhoneNumber, write=FSetContactPhoneNumber };

Default Value

""

Remarks

This property is used to get or set a phone number at the index specified by PhoneIndex. For example, when updating a contact, setting PhoneIndex to 0 and then assigning "0123456789" to this property will set the first phone number of the contact. Similarly, when retrieving a contact, setting PhoneIndex to 0 allows you to read the first phone number of the contact.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

ContactPhonesCount Property (Gmail Component)

Number of the contact's phone numbers.

Syntax

__property int ContactPhonesCount[int ContactIndex] = { read=FContactPhonesCount, write=FSetContactPhonesCount };

Default Value

0

Remarks

Number of the contact's phone numbers.

When retrieving contacts, this property indicates the number of phone numbers linked to the contact. When updating a contact, this property is set to the number of phone numbers to be linked to the contact.

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactPhoneType Property (Gmail Component)

The phone number type.

Syntax

__property TcmGmailContactPhoneTypes ContactPhoneType[int ContactIndex] = { read=FContactPhoneType, write=FSetContactPhoneType };

enum TcmGmailContactPhoneTypes {
  ptHome=0,
  ptWork=1,
  ptMobile=2,
  ptHomeFax=3,
  ptWorkFax=4,
  ptOtherFax=5,
  ptPager=6,
  ptWorkMobile=7,
  ptWorkPager=8,
  ptMain=9,
  ptGoogleVoice=10,
  ptOther=11
};

Default Value

ptHome

Remarks

The phone number type.

This property indicates the type of a contact's phone number selected by PhoneIndex. Possible values are:

• 0 (ptHome)
• 1 (ptWork)
• 2 (ptMobile)
• 3 (ptHomeFax)
• 4 (ptWorkFax)
• 5 (ptOtherFax)
• 6 (ptPager)
• 7 (ptWorkMobile)
• 8 (ptWorkPager)
• 9 (ptMain)
• 10 (ptGoogleVoice)
• 11 (ptOther)

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

Integer

ContactPhoneTypeCustom Property (Gmail Component)

The custom type of a contact's phone number selected by PhoneIndex.

Syntax

__property String ContactPhoneTypeCustom[int ContactIndex] = { read=FContactPhoneTypeCustom, write=FSetContactPhoneTypeCustom };

Default Value

""

Remarks

The custom type of a contact's phone number selected by PhoneIndex.

Example (Adding a phone number with a custom type): gmail.Contacts[0].PhoneCount = 1; gmail.Contacts[0].PhoneIndex = 0; gmail.Contacts[0].PhoneTypeCustom = "customType"; gmail.Contacts[0].PhoneNumber = "0123456789"; //Update the contact gmail.UpdateContact(0);

The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (Gmail Component)

Whether to automatically detect and use firewall system settings, if available.

Syntax

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

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (Gmail Component)

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

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (Gmail Component)

The name or IP address of the firewall (optional).

Syntax

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

Default Value

""

Remarks

The name or IP address of the 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)

A password if authentication is to be used when connecting through the firewall.

Syntax

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

Default Value

""

Remarks

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)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

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

Default Value

0

Remarks

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)

A username if authentication is to be used when connecting through a firewall.

Syntax

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

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

ListContactsMarker Property (Gmail Component)

The page marker for listing contacts.

Syntax

__property String ListContactsMarker = { read=FListContactsMarker, write=FSetListContactsMarker };

Default Value

""

Remarks

This property is populated if there are still unlisted contacts after ListContacts is called. It contains the nextLink that will be included as a parameter if ListContacts is called again. This will cause the next page of contacts to be listed.

Example (List All Contacts)

do { gMail.ListContacts(); } while (!gmail.ListContactsMarker.IsEmpty());

This property is not available at design time.

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 RetrieveMessageRaw 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)

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

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

gmail.MessageCc = "Brandrew Bobbertson < bbobbertson@bobmail.com >"; gmail.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

OAuthRequestRefreshToken Property (Gmail Component)

Specifies whether the component will request a refresh token during authorization.

Syntax

__property bool OAuthRequestRefreshToken = { read=FOAuthRequestRefreshToken, write=FSetOAuthRequestRefreshToken };

Default Value

true

Remarks

Specifies whether the component will request a refresh token during authorization. By default, this value is True.

When True, the component will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

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)

The 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

The 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)

Whether to automatically detect and use proxy system settings, if available.

Syntax

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

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (Gmail Component)

A password if authentication is to be used for the proxy.

Syntax

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

Default Value

""

Remarks

A password 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

ProxyPort Property (Gmail Component)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

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

Default Value

80

Remarks

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)

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

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)

A username if authentication is to be used for the proxy.

Syntax

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

Default Value

""

Remarks

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

SSLAcceptServerCertEffectiveDate Property (Gmail Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (Gmail Component)

The date on which the certificate expires.

Syntax

__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (Gmail Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (Gmail Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (Gmail Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (Gmail Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (Gmail Component)

The issuer of the certificate.

Syntax

__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (Gmail Component)

The private key of the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (Gmail Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (Gmail Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (Gmail Component)

The public key of the certificate.

Syntax

__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (Gmail Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (Gmail Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (Gmail Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (Gmail Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (Gmail Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore };
__property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLAcceptServerCertStorePassword 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 SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };

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

SSLAcceptServerCertStoreType Property (Gmail Component)

The type of certificate store for this certificate.

Syntax

__property TcmGmailSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };

enum TcmGmailSSLAcceptServerCertStoreTypes {
  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

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

SSLAcceptServerCertSubjectAltNames Property (Gmail Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (Gmail Component)

The MD5 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (Gmail Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (Gmail Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (Gmail Component)

The text description of UsageFlags .

Syntax

__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (Gmail Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (Gmail Component)

The certificate's version number.

Syntax

__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (Gmail Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };

Default Value

""

Remarks

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

SSLAcceptServerCertEncoded Property (Gmail Component)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

SSLCertEffectiveDate Property (Gmail Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (Gmail Component)

The date on which the certificate expires.

Syntax

__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (Gmail Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (Gmail Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprint = { read=FSSLCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (Gmail Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (Gmail Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (Gmail Component)

The issuer of the certificate.

Syntax

__property String SSLCertIssuer = { read=FSSLCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (Gmail Component)

The private key of the certificate (if available).

Syntax

__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (Gmail Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (Gmail Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (Gmail Component)

The public key of the certificate.

Syntax

__property String SSLCertPublicKey = { read=FSSLCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (Gmail Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (Gmail Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (Gmail Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (Gmail Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (Gmail Component)

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

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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)

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

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

SSLCertSubjectAltNames Property (Gmail Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (Gmail Component)

The MD5 hash of the certificate.

Syntax

__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (Gmail Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (Gmail Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (Gmail Component)

The text description of UsageFlags .

Syntax

__property String SSLCertUsage = { read=FSSLCertUsage };

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (Gmail Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (Gmail Component)

The certificate's version number.

Syntax

__property String SSLCertVersion = { read=FSSLCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (Gmail Component)

The subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

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

SSLCertEncoded Property (Gmail Component)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

SSLProvider Property (Gmail Component)

The Secure Sockets Layer/Transport Layer Security (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 as follows:

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

SSLServerCertEffectiveDate Property (Gmail Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (Gmail Component)

The date on which the certificate expires.

Syntax

__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (Gmail Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (Gmail Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (Gmail Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (Gmail Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (Gmail Component)

The issuer of the certificate.

Syntax

__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (Gmail Component)

The private key of the certificate (if available).

Syntax

__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (Gmail Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (Gmail Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (Gmail Component)

The public key of the certificate.

Syntax

__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (Gmail Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (Gmail Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (Gmail Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (Gmail Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (Gmail Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLServerCertStore = { read=FSSLServerCertStore };
__property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Byte Array

SSLServerCertStorePassword 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 SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (Gmail Component)

The type of certificate store for this certificate.

Syntax

__property TcmGmailSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };

enum TcmGmailSSLServerCertStoreTypes {
  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

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (Gmail Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (Gmail Component)

The MD5 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (Gmail Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (Gmail Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (Gmail Component)

The text description of UsageFlags .

Syntax

__property String SSLServerCertUsage = { read=FSSLServerCertUsage };

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (Gmail Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (Gmail Component)

The certificate's version number.

Syntax

__property String SSLServerCertVersion = { read=FSSLServerCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (Gmail Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLServerCertSubject = { read=FSSLServerCertSubject };

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (Gmail Component)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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 property.

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.

CreateContact Method (Gmail Component)

Creates a contact.

Syntax

void __fastcall CreateContact(String FirstName, String LastName, String EmailAddress);

Remarks

This method creates a new contact with the specified first name, last name, and email address. At least one of the arguments must be provided. If all parameters are null or empty, an error is thrown. The new contact is added to the end of the Contacts list.

After creating a contact with basic information, you can update it and set additional fields by editing the contact in the Contacts collection and calling the UpdateContact method. For more details, refer to the UpdateContact method.

Example (Create a Contact in the main group (Contacts))

gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com"); // Create the contact in the main group (Contacts).

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 MessageInfo 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.

DeleteContact Method (Gmail Component)

Deletes a contact.

Syntax

void __fastcall DeleteContact(String id);

Remarks

This method deletes a contact specified by its ID. The id parameter takes the contact ID of the contact to be deleted. The contact is also removed from the Contacts collection.

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" gmail.ListContacts(); for (int i = 0; i < gmail.Contacts.Count; i++) { if (gmail.Contacts[i].DisplayName == "John Doe") { //Delete the contact gmail.DeleteContact(gmail.Contacts[i].Id); break; } }

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.

GetContact Method (Gmail Component)

Retrieves the contact by Id.

Syntax

void __fastcall GetContact(String Id);

Remarks

This method retrieves a contact specified by its ID and adds the contact to the end of the Contacts list. If the contact already exists in the Contacts collection, it will be removed and then added to the end, preventing duplication.

Example (Get a Contact)

// Retrieve a contact by its ID string contactId = "12345"; // Replace with the actual contact ID gmail.GetContact(contactId); // Access the retrieved contact var retrievedContact = gmail.Contacts[gmail.Contacts.Count - 1]; retrievedContact.FirstName; //first name retrievedContact.LastName; //last name retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address retrievedContact.EmailAddress; //first email address value retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number retrievedContact.PhoneNumber; //first phone number value gmail.GetContactField(gmail.Contacts.Count - 1, "/json/birthdays/[1]/date"); //birthday of the contact gmail.GetContactField(gmail.Contacts.Count - 1, "/json/nicknames/[1]"); //nickname of the contact

GetContactField Method (Gmail Component)

Retrieves the contact property value by JSONPath.

Syntax

String __fastcall GetContactField(int index, String JsonPath);

Remarks

This method retrieves a specific field within the contact's JSON field. The first parameter, index, is an integer representing the index of the contact in the Contacts collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.

Example (Access Fields of a Contact)

gmail.GetContact("ContactId"); gmail.GetContactField(gmail.Contacts.Count - 1, "/json/birthdays[1]/date"); //birthday of the contact gmail.GetContactField(gmail.Contacts.Count - 1, "/json/nickNames/[1]/value"); //middle name of the contact gmail.GetContactField(gmail.Contacts.Count - 1, "/json/phoneNumbers/[1]/value"); //first phone number of the contact gmail.GetContactField(gmail.Contacts.Count - 1, "/json/Addresses/[1]/extendedAddress"); //address of the contact gmail.GetContactField(gmail.Contacts.Count - 1, "/json/Addresses/[1]/type"); //type of address of the contact

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.

ListContactGroups Method (Gmail Component)

Lists the contact groups of the user.

Syntax

void __fastcall ListContactGroups();

Remarks

This method retrieves and lists the contact groups of the user. It clears and then populates the ContactGroups collection with the retrieved groups. Also, for every listed contact group, the ContactGroupList event is fired.

Example (List All Contact Groups):

gmail.ListContactGroups(); // List root groups. foreach(GLContactGroup group in gmail.ContactGroups){ group.Id; // Group id group.Name; // Group name }

If the number of contact groups exceeds the page size, the ListContactGroupsMarker config value will be populated. You can call ListContactGroups again to retrieve the next page of groups. These groups will be added to the end of the ContactGroups collection.

Example (List All Contact Groups):

do{ gmail.ListContactGroups(); // List root groups. } while (!gmail.Config("ListContactGroupsMarker").IsEmpty());

ListContacts Method (Gmail Component)

Lists all user's personal contact that are in groups, including main group (Contacts).

Syntax

void __fastcall ListContacts();

Remarks

This method retrieves and lists the contacts that are in groups, including main group (Contacts). It clears and then populates the Contacts collection with the retrieved contacts. Also, for every listed contact, the ContactList event is fired.

Example (List all Contacts): gmail.ListContacts();

If the number of contacts exceeds the page size, the ListContactsMarker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the Contacts collection.

Example (List All Contacts In All Contact Pages): do{ gmail.ListContacts(); } while(!gmail.ListContactsMarker.isEmpty());

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)

This method will 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.

RetrieveAttachment Method (Gmail Component)

Retrieves a raw attachment.

Syntax

void __fastcall RetrieveAttachment(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.

RetrieveMessage Method (Gmail Component)

Retrieves a message including the message parts.

Syntax

void __fastcall RetrieveMessage(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.

RetrieveMessageHeaders Method (Gmail Component)

Retrieves the headers of a message.

Syntax

void __fastcall RetrieveMessageHeaders(String messageId);

Remarks

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

RetrieveMessageInfo Method (Gmail Component)

Retrieves a message info.

Syntax

void __fastcall RetrieveMessageInfo(String messageId);

Remarks

This method retrieves a message info.

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

RetrieveMessageRaw Method (Gmail Component)

Retrieves the raw message of the specified message ID.

Syntax

void __fastcall RetrieveMessageRaw(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.

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();

SetContactField Method (Gmail Component)

Sets the contact property value by JSONPath.

Syntax

void __fastcall SetContactField(int index, String JsonPath, String Value, int ValueType);

Remarks

This method updates a specific field within the contact's JSON representation. The parameters for this method are as follows: the first parameter, index, is an integer representing the index of the contact in the Contacts collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)
• 6 (Raw)

Example (Set/Edit Fields of a Contact before Updating): gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com");// Create a contact in the main group. // Set address gmail.SetContactField(0, "/json/addresses", "[{\"metadata\":{\"primary\":true,\"sourcePrimary\":true,\"verified\":true},\"formattedValue\":\"formattedValue\",\"type\":\"type\",\"formattedType\":\"type\"}]", 1); // The last argument is the type of the field. 1 (Array) //Set skills gmail.SetContactField(0, "/json/skills", "[{\"metadata\" : {}, \"value\": \"shell scripting\"}, {\"metadata\" : {}, \"value\": \"java\"}]", 1); // The last argument is the type of the field. 0 (Object) gmail.SetContactField(0, "/json/skills/[1]/metadata", {\"primary\": false, \"verified\": true}, 0); // The last argument is the type of the field. 0 (Object) gmail.SetContactField(0, "/json/skills/[2]/metadata", {\"primary\": true, \"verified\": true}, 0); // Update the contact gmail.UpdateContact(0);

UpdateContact Method (Gmail Component)

Updates a contact.

Syntax

void __fastcall UpdateContact(int index);

Remarks

This method allows you to update an existing contact. The index parameter specifies the position of the contact in the Contacts collection. The method uses this index to take all the data from the specified contact and update the corresponding contact on the server.

To update a contact, edit the desired contact fields within the Contacts collection. Then, call the UpdateContact method with the index of the contact. Note that changing the JSON data will overwrite the entire contact, ignoring other field edits made before setting the JSON.

The OLContact type used in the Contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add another field, you can use the SetContactField method. For a complete list of fields a contact can have please refer to the official google documentation for the People API.

Example: // Create a contact in the main contacts folder. gmail.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Set a company name gmail.Contacts[0].CompanyName = "Volkswagen"; // Set notes gmail.Contacts[0].Notes = "testNotes"; // Set multiple phone numbers gmail.Contacts[0].PhonesCount = 2; gmail.Contacts[0].PhoneIndex = 0; gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptMobile; gmail.Contacts[0].PhoneNumber = "0123456789"; gmail.Contacts[0].PhoneIndex = 1; gmail.Contacts[0].PhoneType = TGLPhoneTypes.ptWork; gmail.Contacts[0].PhoneNumber = "9876543210"; // Set birthday gmail.SetContactField(0, "/json/birthdays", "[{ date: { "year": 1999, "month": 12, "day": 1 }}]", 1); // The last argument is the type of the field. 1 (Array) // Set address gmail.SetContactField(0, "/json/addresses", "[{\"metadata\":{\"primary\":true,\"sourcePrimary\":true,\"verified\":true},\"formattedValue\":\"formattedValue\",\"type\":\"type\",\"formattedType\":\"type\"}]", 1); // The last argument is the type of the field. 1 (Array) // Update the contact gmail.UpdateContact(0);

ContactGroupList Event (Gmail Component)

Fired when a contact group is retrieved by the server.

Syntax

typedef struct {
  String Id;
  String DisplayName;
} TcmGmailContactGroupListEventParams;
typedef void __fastcall (__closure *TcmGmailContactGroupListEvent)(System::TObject* Sender, TcmGmailContactGroupListEventParams *e);
__property TcmGmailContactGroupListEvent OnContactGroupList = { read=FOnContactGroupList, write=FOnContactGroupList };

Remarks

The ContactGroupList event is fired for each contact group retrieved from the server when ListContactGroups is called.

ContactList Event (Gmail Component)

Fired when a contact is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String DisplayName;
  String FirstEmail;
} TcmGmailContactListEventParams;
typedef void __fastcall (__closure *TcmGmailContactListEvent)(System::TObject* Sender, TcmGmailContactListEventParams *e);
__property TcmGmailContactListEvent OnContactList = { read=FOnContactList, write=FOnContactList };

Remarks

The ContactList event is fired for each contact retrieved from the server when ListContacts is called. This event provides the Id, DisplayName and FirstEmail address of the contact.

Error Event (Gmail Component)

Fired when information is available 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)

Fired 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 is fired 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 RetrieveMessageHeaders 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)

Fired when secure connection progress messages are available.

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)

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"
  }
}

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings