Gmail Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudMail_Gmail

Procedural Interface

 cloudmail_gmail_open();
 cloudmail_gmail_close($res);
 cloudmail_gmail_register_callback($res, $id, $function);
 cloudmail_gmail_get_last_error($res);
 cloudmail_gmail_get_last_error_code($res);
 cloudmail_gmail_set($res, $id, $index, $value);
 cloudmail_gmail_get($res, $id, $index);
 cloudmail_gmail_do_addmessagelabels($res, $messageid, $labels);
 cloudmail_gmail_do_appendtomailbox($res);
 cloudmail_gmail_do_authorize($res);
 cloudmail_gmail_do_config($res, $configurationstring);
 cloudmail_gmail_do_countmessages($res);
 cloudmail_gmail_do_createcontact($res, $firstname, $lastname, $emailaddress);
 cloudmail_gmail_do_createdraft($res);
 cloudmail_gmail_do_delete($res, $messageid);
 cloudmail_gmail_do_deletecontact($res, $id);
 cloudmail_gmail_do_deletedraft($res, $draftid);
 cloudmail_gmail_do_deletepermanently($res, $messageids);
 cloudmail_gmail_do_getcontact($res, $id);
 cloudmail_gmail_do_getcontactfield($res, $index, $jsonpath);
 cloudmail_gmail_do_interrupt($res);
 cloudmail_gmail_do_listcontactgroups($res);
 cloudmail_gmail_do_listcontacts($res);
 cloudmail_gmail_do_listdrafts($res, $filter);
 cloudmail_gmail_do_listmessages($res, $filter, $threadid);
 cloudmail_gmail_do_removemessagelabels($res, $messageid, $labels);
 cloudmail_gmail_do_reset($res);
 cloudmail_gmail_do_restore($res, $id);
 cloudmail_gmail_do_retrieveattachment($res, $messageid, $attachmentid);
 cloudmail_gmail_do_retrievemessage($res, $messageid);
 cloudmail_gmail_do_retrievemessageheaders($res, $messageid);
 cloudmail_gmail_do_retrievemessageinfo($res, $messageid);
 cloudmail_gmail_do_retrievemessageraw($res, $messageid);
 cloudmail_gmail_do_search($res, $searchkey);
 cloudmail_gmail_do_sendcustomrequest($res, $httpmethod, $url, $postdata);
 cloudmail_gmail_do_senddraft($res, $draftid);
 cloudmail_gmail_do_sendmail($res);
 cloudmail_gmail_do_setcontactfield($res, $index, $jsonpath, $value, $valuetype);
 cloudmail_gmail_do_updatecontact($res, $index);

Remarks

This class provides an easy to use interface for Gmail using version 3 of the Gmail REST API. To use the class, first set the Authorization property to a valid OAuth token. The Gmail class 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 class 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 class has the following defaults:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this class. 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 class. 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 class 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 class 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 class 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 class will use an authorization code to get an access token. For this OAuthGrantType the class 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 class will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the class 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 class 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 class will request the authorization server to get an access token. For this OAuthGrantType the class 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 class 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 class 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 class 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Attachment Property (CloudMail_Gmail Class)

Provides the raw attachment content.

Object Oriented Interface

public function getAttachment();

Procedural Interface

cloudmail_gmail_get($res, 1 );

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

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

Data Type

Binary String

Authorization Property (CloudMail_Gmail Class)

An OAuth Authorization String.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

cloudmail_gmail_get($res, 2 );
cloudmail_gmail_set($res, 2, $value );

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 (CloudMail_Gmail Class)

Determines whether to automatically decode message parts.

Object Oriented Interface

public function getAutoDecodeParts();
public function setAutoDecodeParts($value);

Procedural Interface

cloudmail_gmail_get($res, 3 );
cloudmail_gmail_set($res, 3, $value );

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 (CloudMail_Gmail Class)

The number of records in the ContactGroup arrays.

Object Oriented Interface

public function getContactGroupCount();
public function setContactGroupCount($value);

Procedural Interface

cloudmail_gmail_get($res, 4 );
cloudmail_gmail_set($res, 4, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactGroupId($contactgroupindex);

Procedural Interface

cloudmail_gmail_get($res, 5 , $contactgroupindex);

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 (CloudMail_Gmail Class)

The display name of the contact group.

Object Oriented Interface

public function getContactGroupName($contactgroupindex);

Procedural Interface

cloudmail_gmail_get($res, 6 , $contactgroupindex);

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 (CloudMail_Gmail Class)

The number of records in the Contact arrays.

Object Oriented Interface

public function getContactsCount();
public function setContactsCount($value);

Procedural Interface

cloudmail_gmail_get($res, 7 );
cloudmail_gmail_set($res, 7, $value );

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 (CloudMail_Gmail Class)

The contact's display name.

Object Oriented Interface

public function getContactDisplayName($contactindex);
public function setContactDisplayName($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 8 , $contactindex);
cloudmail_gmail_set($res, 8, $value , $contactindex);

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 (CloudMail_Gmail Class)

The email address at the specified EmailAddressIndex.

Object Oriented Interface

public function getContactEmailAddress($contactindex);
public function setContactEmailAddress($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 9 , $contactindex);
cloudmail_gmail_set($res, 9, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactEmailAddressDisplayName($contactindex);
public function setContactEmailAddressDisplayName($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 10 , $contactindex);
cloudmail_gmail_set($res, 10, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactEmailAddressesCount($contactindex);
public function setContactEmailAddressesCount($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 11 , $contactindex);
cloudmail_gmail_set($res, 11, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactEmailAddressIndex($contactindex);
public function setContactEmailAddressIndex($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 12 , $contactindex);
cloudmail_gmail_set($res, 12, $value , $contactindex);

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 (CloudMail_Gmail Class)

Type of the E-mail address.

Object Oriented Interface

public function getContactEmailAddressType($contactindex);
public function setContactEmailAddressType($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 13 , $contactindex);
cloudmail_gmail_set($res, 13, $value , $contactindex);

Default Value

0

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactEmailAddressTypeCustom($contactindex);
public function setContactEmailAddressTypeCustom($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 14 , $contactindex);
cloudmail_gmail_set($res, 14, $value , $contactindex);

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 (CloudMail_Gmail Class)

The contact's first name.

Object Oriented Interface

public function getContactFirstName($contactindex);
public function setContactFirstName($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 15 , $contactindex);
cloudmail_gmail_set($res, 15, $value , $contactindex);

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 (CloudMail_Gmail Class)

The unique identifier of the contact (resource name).

Object Oriented Interface

public function getContactId($contactindex);

Procedural Interface

cloudmail_gmail_get($res, 16 , $contactindex);

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 (CloudMail_Gmail Class)

A JSON representation of the contact.

Object Oriented Interface

public function getContactJSON($contactindex);
public function setContactJSON($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 17 , $contactindex);
cloudmail_gmail_set($res, 17, $value , $contactindex);

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 (CloudMail_Gmail Class)

The contact's last name.

Object Oriented Interface

public function getContactLastName($contactindex);
public function setContactLastName($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 18 , $contactindex);
cloudmail_gmail_set($res, 18, $value , $contactindex);

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 (CloudMail_Gmail Class)

The user's notes about the contact.

Object Oriented Interface

public function getContactNotes($contactindex);
public function setContactNotes($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 19 , $contactindex);
cloudmail_gmail_set($res, 19, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactParentId($contactindex);
public function setContactParentId($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 20 , $contactindex);
cloudmail_gmail_set($res, 20, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactParentIdIndex($contactindex);
public function setContactParentIdIndex($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 21 , $contactindex);
cloudmail_gmail_set($res, 21, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactParentIdsCount($contactindex);
public function setContactParentIdsCount($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 22 , $contactindex);
cloudmail_gmail_set($res, 22, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactPhoneIndex($contactindex);
public function setContactPhoneIndex($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 23 , $contactindex);
cloudmail_gmail_set($res, 23, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactPhoneNumber($contactindex);
public function setContactPhoneNumber($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 24 , $contactindex);
cloudmail_gmail_set($res, 24, $value , $contactindex);

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 (CloudMail_Gmail Class)

Number of the contact's phone numbers.

Object Oriented Interface

public function getContactPhonesCount($contactindex);
public function setContactPhonesCount($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 25 , $contactindex);
cloudmail_gmail_set($res, 25, $value , $contactindex);

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 (CloudMail_Gmail Class)

The phone number type.

Object Oriented Interface

public function getContactPhoneType($contactindex);
public function setContactPhoneType($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 26 , $contactindex);
cloudmail_gmail_set($res, 26, $value , $contactindex);

Default Value

0

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getContactPhoneTypeCustom($contactindex);
public function setContactPhoneTypeCustom($contactindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 27 , $contactindex);
cloudmail_gmail_set($res, 27, $value , $contactindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudmail_gmail_get($res, 28 );
cloudmail_gmail_set($res, 28, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudMail_Gmail Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudmail_gmail_get($res, 29 );
cloudmail_gmail_set($res, 29, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudmail_gmail_get($res, 30 );
cloudmail_gmail_set($res, 30, $value );

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 class fails with an error.

Data Type

String

FirewallPassword Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudmail_gmail_get($res, 31 );
cloudmail_gmail_set($res, 31, $value );

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 class fails with an error.

Data Type

String

FirewallPort Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudmail_gmail_get($res, 32 );
cloudmail_gmail_set($res, 32, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudmail_gmail_get($res, 33 );
cloudmail_gmail_set($res, 33, $value );

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 class fails with an error.

Data Type

String

ListContactsMarker Property (CloudMail_Gmail Class)

The page marker for listing contacts.

Object Oriented Interface

public function getListContactsMarker();
public function setListContactsMarker($value);

Procedural Interface

cloudmail_gmail_get($res, 34 );
cloudmail_gmail_set($res, 34, $value );

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 (CloudMail_Gmail Class)

Provides the raw message content.

Object Oriented Interface

public function getMessage();

Procedural Interface

cloudmail_gmail_get($res, 35 );

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

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

Data Type

Binary String

MessageAttachments Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageAttachments();
public function setMessageAttachments($value);

Procedural Interface

cloudmail_gmail_get($res, 36 );
cloudmail_gmail_set($res, 36, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageBcc();
public function setMessageBcc($value);

Procedural Interface

cloudmail_gmail_get($res, 37 );
cloudmail_gmail_set($res, 37, $value );

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 (CloudMail_Gmail Class)

The body content for a message.

Object Oriented Interface

public function getMessageBodyContent();
public function setMessageBodyContent($value);

Procedural Interface

cloudmail_gmail_get($res, 38 );
cloudmail_gmail_set($res, 38, $value );

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 (CloudMail_Gmail Class)

The body content type for a message.

Object Oriented Interface

public function getMessageBodyContentType();
public function setMessageBodyContentType($value);

Procedural Interface

cloudmail_gmail_get($res, 39 );
cloudmail_gmail_set($res, 39, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageCc();
public function setMessageCc($value);

Procedural Interface

cloudmail_gmail_get($res, 40 );
cloudmail_gmail_set($res, 40, $value );

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 (CloudMail_Gmail Class)

The total number of messages on the mailbox.

Object Oriented Interface

public function getMessageCount();

Procedural Interface

cloudmail_gmail_get($res, 41 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

MessageFrom Property (CloudMail_Gmail Class)

The author of a message.

Object Oriented Interface

public function getMessageFrom();
public function setMessageFrom($value);

Procedural Interface

cloudmail_gmail_get($res, 42 );
cloudmail_gmail_set($res, 42, $value );

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 (CloudMail_Gmail Class)

The number of records in the MessageHeader arrays.

Object Oriented Interface

public function getMessageHeaderCount();
public function setMessageHeaderCount($value);

Procedural Interface

cloudmail_gmail_get($res, 43 );
cloudmail_gmail_set($res, 43, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageHeaderField($messageheaderindex);
public function setMessageHeaderField($messageheaderindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 44 , $messageheaderindex);
cloudmail_gmail_set($res, 44, $value , $messageheaderindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageHeaderValue($messageheaderindex);
public function setMessageHeaderValue($messageheaderindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 45 , $messageheaderindex);
cloudmail_gmail_set($res, 45, $value , $messageheaderindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageIndex();
public function setMessageIndex($value);

Procedural Interface

cloudmail_gmail_get($res, 46 );
cloudmail_gmail_set($res, 46, $value );

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 (CloudMail_Gmail Class)

The number of records in the MessageInfo arrays.

Object Oriented Interface

public function getMessageInfoCount();
public function setMessageInfoCount($value);

Procedural Interface

cloudmail_gmail_get($res, 47 );
cloudmail_gmail_set($res, 47, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageInfoBcc($messageinfoindex);
public function setMessageInfoBcc($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 48 , $messageinfoindex);
cloudmail_gmail_set($res, 48, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageInfoCc($messageinfoindex);
public function setMessageInfoCc($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 49 , $messageinfoindex);
cloudmail_gmail_set($res, 49, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

The sender of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoFrom($messageinfoindex);

Procedural Interface

cloudmail_gmail_get($res, 50 , $messageinfoindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageInfoHistoryId($messageinfoindex);

Procedural Interface

cloudmail_gmail_get($res, 51 , $messageinfoindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageInfoId($messageinfoindex);

Procedural Interface

cloudmail_gmail_get($res, 52 , $messageinfoindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageInfoInternalDate($messageinfoindex);

Procedural Interface

cloudmail_gmail_get($res, 53 , $messageinfoindex);

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 (CloudMail_Gmail Class)

Message labels in a message info listing.

Object Oriented Interface

public function getMessageInfoLabels($messageinfoindex);
public function setMessageInfoLabels($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 54 , $messageinfoindex);
cloudmail_gmail_set($res, 54, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

The size of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoSize($messageinfoindex);
public function setMessageInfoSize($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 55 , $messageinfoindex);
cloudmail_gmail_set($res, 55, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

The snippet of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoSnippet($messageinfoindex);
public function setMessageInfoSnippet($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 56 , $messageinfoindex);
cloudmail_gmail_set($res, 56, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

The subject of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoSubject($messageinfoindex);
public function setMessageInfoSubject($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 57 , $messageinfoindex);
cloudmail_gmail_set($res, 57, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessageInfoThreadId($messageinfoindex);
public function setMessageInfoThreadId($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 58 , $messageinfoindex);
cloudmail_gmail_set($res, 58, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

The recipients of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoTo($messageinfoindex);
public function setMessageInfoTo($messageinfoindex, $value);

Procedural Interface

cloudmail_gmail_get($res, 59 , $messageinfoindex);
cloudmail_gmail_set($res, 59, $value , $messageinfoindex);

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 (CloudMail_Gmail Class)

The additional message headers for a message.

Object Oriented Interface

public function getMessageOtherHeaders();
public function setMessageOtherHeaders($value);

Procedural Interface

cloudmail_gmail_get($res, 60 );
cloudmail_gmail_set($res, 60, $value );

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 (CloudMail_Gmail Class)

The number of records in the MessagePart arrays.

Object Oriented Interface

public function getMessagePartCount();

Procedural Interface

cloudmail_gmail_get($res, 61 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessagePartAttachmentId($messagepartindex);

Procedural Interface

cloudmail_gmail_get($res, 62 , $messagepartindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessagePartContentType($messagepartindex);

Procedural Interface

cloudmail_gmail_get($res, 63 , $messagepartindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessagePartData($messagepartindex);

Procedural Interface

cloudmail_gmail_get($res, 64 , $messagepartindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessagePartFileName($messagepartindex);

Procedural Interface

cloudmail_gmail_get($res, 65 , $messagepartindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessagePartId($messagepartindex);

Procedural Interface

cloudmail_gmail_get($res, 66 , $messagepartindex);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getMessagePartSize($messagepartindex);

Procedural Interface

cloudmail_gmail_get($res, 67 , $messagepartindex);

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 (CloudMail_Gmail Class)

The subject of a message.

Object Oriented Interface

public function getMessageSubject();
public function setMessageSubject($value);

Procedural Interface

cloudmail_gmail_get($res, 68 );
cloudmail_gmail_set($res, 68, $value );

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 (CloudMail_Gmail Class)

A comma separated list of recipients for a message.

Object Oriented Interface

public function getMessageTo();
public function setMessageTo($value);

Procedural Interface

cloudmail_gmail_get($res, 69 );
cloudmail_gmail_set($res, 69, $value );

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 (CloudMail_Gmail Class)

The token to retrieve the next page with data.

Object Oriented Interface

public function getNextPageToken();
public function setNextPageToken($value);

Procedural Interface

cloudmail_gmail_get($res, 70 );
cloudmail_gmail_set($res, 70, $value );

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 (CloudMail_Gmail Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();
public function setOAuthAccessToken($value);

Procedural Interface

cloudmail_gmail_get($res, 71 );
cloudmail_gmail_set($res, 71, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudMail_Gmail Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();
public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudmail_gmail_get($res, 72 );
cloudmail_gmail_set($res, 72, $value );

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 (CloudMail_Gmail Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();
public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudmail_gmail_get($res, 73 );
cloudmail_gmail_set($res, 73, $value );

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 (CloudMail_Gmail Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();
public function setOAuthClientId($value);

Procedural Interface

cloudmail_gmail_get($res, 74 );
cloudmail_gmail_set($res, 74, $value );

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 (CloudMail_Gmail Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();
public function setOAuthClientProfile($value);

Procedural Interface

cloudmail_gmail_get($res, 75 );
cloudmail_gmail_set($res, 75, $value );

Default Value

0

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getOAuthClientSecret();
public function setOAuthClientSecret($value);

Procedural Interface

cloudmail_gmail_get($res, 76 );
cloudmail_gmail_set($res, 76, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getOAuthGrantType();
public function setOAuthGrantType($value);

Procedural Interface

cloudmail_gmail_get($res, 77 );
cloudmail_gmail_set($res, 77, $value );

Default Value

0

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getOAuthRefreshToken();
public function setOAuthRefreshToken($value);

Procedural Interface

cloudmail_gmail_get($res, 78 );
cloudmail_gmail_set($res, 78, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getOAuthRequestRefreshToken();
public function setOAuthRequestRefreshToken($value);

Procedural Interface

cloudmail_gmail_get($res, 79 );
cloudmail_gmail_set($res, 79, $value );

Default Value

true

Remarks

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

When True, the class 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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getOAuthReturnURL();
public function setOAuthReturnURL($value);

Procedural Interface

cloudmail_gmail_get($res, 80 );
cloudmail_gmail_set($res, 80, $value );

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 class 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 (CloudMail_Gmail Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();
public function setOAuthServerAuthURL($value);

Procedural Interface

cloudmail_gmail_get($res, 81 );
cloudmail_gmail_set($res, 81, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getOAuthServerTokenURL();
public function setOAuthServerTokenURL($value);

Procedural Interface

cloudmail_gmail_get($res, 82 );
cloudmail_gmail_set($res, 82, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudmail_gmail_get($res, 83 );

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 (CloudMail_Gmail Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudmail_gmail_get($res, 84 );
cloudmail_gmail_set($res, 84, $value );

Default Value

0

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 class 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 class. Look at the configuration file for the class 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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudmail_gmail_get($res, 85 );
cloudmail_gmail_set($res, 85, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudmail_gmail_get($res, 86 );
cloudmail_gmail_set($res, 86, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudmail_gmail_get($res, 87 );
cloudmail_gmail_set($res, 87, $value );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudmail_gmail_get($res, 88 );
cloudmail_gmail_set($res, 88, $value );

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 (CloudMail_Gmail Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudmail_gmail_get($res, 89 );
cloudmail_gmail_set($res, 89, $value );

Default Value

0

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudmail_gmail_get($res, 90 );
cloudmail_gmail_set($res, 90, $value );

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 (CloudMail_Gmail Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudmail_gmail_get($res, 91 );

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 (CloudMail_Gmail Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudmail_gmail_get($res, 92 );

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 (CloudMail_Gmail Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudmail_gmail_get($res, 93 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudmail_gmail_get($res, 94 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudmail_gmail_get($res, 95 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudmail_gmail_get($res, 96 );

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 (CloudMail_Gmail Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudmail_gmail_get($res, 97 );

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 (CloudMail_Gmail Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudmail_gmail_get($res, 98 );

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 (CloudMail_Gmail Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudmail_gmail_get($res, 99 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudmail_gmail_get($res, 100 );

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 (CloudMail_Gmail Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudmail_gmail_get($res, 101 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_gmail_get($res, 102 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudmail_gmail_get($res, 103 );

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 (CloudMail_Gmail Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudmail_gmail_get($res, 104 );

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 (CloudMail_Gmail Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudmail_gmail_get($res, 105 );

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 (CloudMail_Gmail Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudmail_gmail_get($res, 106 );
cloudmail_gmail_set($res, 106, $value );

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

Binary String

SSLAcceptServerCertStorePassword Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudmail_gmail_get($res, 107 );
cloudmail_gmail_set($res, 107, $value );

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 (CloudMail_Gmail Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudmail_gmail_get($res, 108 );
cloudmail_gmail_set($res, 108, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudmail_gmail_get($res, 109 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudMail_Gmail Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudmail_gmail_get($res, 110 );

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 (CloudMail_Gmail Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudmail_gmail_get($res, 111 );

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 (CloudMail_Gmail Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudmail_gmail_get($res, 112 );

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 (CloudMail_Gmail Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudmail_gmail_get($res, 113 );

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 (CloudMail_Gmail Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudmail_gmail_get($res, 114 );

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 (CloudMail_Gmail Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudmail_gmail_get($res, 115 );

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 (CloudMail_Gmail Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudmail_gmail_get($res, 116 );
cloudmail_gmail_set($res, 116, $value );

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 (CloudMail_Gmail Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudmail_gmail_get($res, 117 );
cloudmail_gmail_set($res, 117, $value );

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

Binary String

SSLCertEffectiveDate Property (CloudMail_Gmail Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudmail_gmail_get($res, 118 );

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 (CloudMail_Gmail Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudmail_gmail_get($res, 119 );

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 (CloudMail_Gmail Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudmail_gmail_get($res, 120 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudmail_gmail_get($res, 121 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudmail_gmail_get($res, 122 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudmail_gmail_get($res, 123 );

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 (CloudMail_Gmail Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudmail_gmail_get($res, 124 );

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 (CloudMail_Gmail Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudmail_gmail_get($res, 125 );

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 (CloudMail_Gmail Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudmail_gmail_get($res, 126 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudmail_gmail_get($res, 127 );

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 (CloudMail_Gmail Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudmail_gmail_get($res, 128 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_gmail_get($res, 129 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudmail_gmail_get($res, 130 );

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 (CloudMail_Gmail Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudmail_gmail_get($res, 131 );

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 (CloudMail_Gmail Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudmail_gmail_get($res, 132 );

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 (CloudMail_Gmail Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudmail_gmail_get($res, 133 );
cloudmail_gmail_set($res, 133, $value );

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

Binary String

SSLCertStorePassword Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudmail_gmail_get($res, 134 );
cloudmail_gmail_set($res, 134, $value );

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 (CloudMail_Gmail Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudmail_gmail_get($res, 135 );
cloudmail_gmail_set($res, 135, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudmail_gmail_get($res, 136 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudMail_Gmail Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudmail_gmail_get($res, 137 );

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 (CloudMail_Gmail Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudmail_gmail_get($res, 138 );

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 (CloudMail_Gmail Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudmail_gmail_get($res, 139 );

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 (CloudMail_Gmail Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudmail_gmail_get($res, 140 );

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 (CloudMail_Gmail Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudmail_gmail_get($res, 141 );

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 (CloudMail_Gmail Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudmail_gmail_get($res, 142 );

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 (CloudMail_Gmail Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudmail_gmail_get($res, 143 );
cloudmail_gmail_set($res, 143, $value );

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 (CloudMail_Gmail Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudmail_gmail_get($res, 144 );
cloudmail_gmail_set($res, 144, $value );

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

Binary String

SSLProvider Property (CloudMail_Gmail Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudmail_gmail_get($res, 145 );
cloudmail_gmail_set($res, 145, $value );

Default Value

0

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 class 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 class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudMail_Gmail Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudmail_gmail_get($res, 146 );

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 (CloudMail_Gmail Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudmail_gmail_get($res, 147 );

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 (CloudMail_Gmail Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudmail_gmail_get($res, 148 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudmail_gmail_get($res, 149 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudmail_gmail_get($res, 150 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudmail_gmail_get($res, 151 );

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 (CloudMail_Gmail Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudmail_gmail_get($res, 152 );

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 (CloudMail_Gmail Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudmail_gmail_get($res, 153 );

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 (CloudMail_Gmail Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudmail_gmail_get($res, 154 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudmail_gmail_get($res, 155 );

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 (CloudMail_Gmail Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudmail_gmail_get($res, 156 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_gmail_get($res, 157 );

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudmail_gmail_get($res, 158 );

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 (CloudMail_Gmail Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudmail_gmail_get($res, 159 );

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 (CloudMail_Gmail Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudmail_gmail_get($res, 160 );

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 (CloudMail_Gmail Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudmail_gmail_get($res, 161 );

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

Binary String

SSLServerCertStorePassword Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudmail_gmail_get($res, 162 );

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 (CloudMail_Gmail Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudmail_gmail_get($res, 163 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudMail_Gmail Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudmail_gmail_get($res, 164 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudMail_Gmail Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudmail_gmail_get($res, 165 );

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 (CloudMail_Gmail Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudmail_gmail_get($res, 166 );

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 (CloudMail_Gmail Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudmail_gmail_get($res, 167 );

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 (CloudMail_Gmail Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudmail_gmail_get($res, 168 );

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 (CloudMail_Gmail Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudmail_gmail_get($res, 169 );

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 (CloudMail_Gmail Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudmail_gmail_get($res, 170 );

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 (CloudMail_Gmail Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudmail_gmail_get($res, 171 );

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 (CloudMail_Gmail Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudmail_gmail_get($res, 172 );

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

Binary String

AddMessageLabels Method (CloudMail_Gmail Class)

Adds the specified labels to the message specified by MessageId.

Object Oriented Interface

public function doAddMessageLabels($messageid, $labels);

Procedural Interface

cloudmail_gmail_do_addmessagelabels($res, $messageid, $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 (CloudMail_Gmail Class)

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.

Object Oriented Interface

public function doAppendToMailbox();

Procedural Interface

cloudmail_gmail_do_appendtomailbox($res);

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 (CloudMail_Gmail Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudmail_gmail_do_authorize($res);

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 (CloudMail_Gmail Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudmail_gmail_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (CloudMail_Gmail Class)

Get the total number of messages in the mailbox.

Object Oriented Interface

public function doCountMessages();

Procedural Interface

cloudmail_gmail_do_countmessages($res);

Remarks

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

CreateContact Method (CloudMail_Gmail Class)

Creates a contact.

Object Oriented Interface

public function doCreateContact($firstname, $lastname, $emailaddress);

Procedural Interface

cloudmail_gmail_do_createcontact($res, $firstname, $lastname, $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 (CloudMail_Gmail Class)

Creates a new email draft.

Object Oriented Interface

public function doCreateDraft();

Procedural Interface

cloudmail_gmail_do_createdraft($res);

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 (CloudMail_Gmail Class)

Deletes a message.

Object Oriented Interface

public function doDelete($messageid);

Procedural Interface

cloudmail_gmail_do_delete($res, $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 (CloudMail_Gmail Class)

Deletes a contact.

Object Oriented Interface

public function doDeleteContact($id);

Procedural Interface

cloudmail_gmail_do_deletecontact($res, $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 (CloudMail_Gmail Class)

Deletes a draft permanently.

Object Oriented Interface

public function doDeleteDraft($draftid);

Procedural Interface

cloudmail_gmail_do_deletedraft($res, $draftid);

Remarks

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

DeletePermanently Method (CloudMail_Gmail Class)

Deletes the specified messages permanently.

Object Oriented Interface

public function doDeletePermanently($messageids);

Procedural Interface

cloudmail_gmail_do_deletepermanently($res, $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 (CloudMail_Gmail Class)

Retrieves the contact by Id.

Object Oriented Interface

public function doGetContact($id);

Procedural Interface

cloudmail_gmail_do_getcontact($res, $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 (CloudMail_Gmail Class)

Retrieves the contact property value by JSONPath.

Object Oriented Interface

public function doGetContactField($index, $jsonpath);

Procedural Interface

cloudmail_gmail_do_getcontactfield($res, $index, $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 (CloudMail_Gmail Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudmail_gmail_do_interrupt($res);

Remarks

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

ListContactGroups Method (CloudMail_Gmail Class)

Lists the contact groups of the user.

Object Oriented Interface

public function doListContactGroups();

Procedural Interface

cloudmail_gmail_do_listcontactgroups($res);

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 (CloudMail_Gmail Class)

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

Object Oriented Interface

public function doListContacts();

Procedural Interface

cloudmail_gmail_do_listcontacts($res);

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 (CloudMail_Gmail Class)

Lists the drafts in a mailbox.

Object Oriented Interface

public function doListDrafts($filter);

Procedural Interface

cloudmail_gmail_do_listdrafts($res, $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 (CloudMail_Gmail Class)

Lists the messages in a mailbox.

Object Oriented Interface

public function doListMessages($filter, $threadid);

Procedural Interface

cloudmail_gmail_do_listmessages($res, $filter, $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 (CloudMail_Gmail Class)

Removes the specified labels from the message specified by MessageId.

Object Oriented Interface

public function doRemoveMessageLabels($messageid, $labels);

Procedural Interface

cloudmail_gmail_do_removemessagelabels($res, $messageid, $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 (CloudMail_Gmail Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudmail_gmail_do_reset($res);

Remarks

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

Restore Method (CloudMail_Gmail Class)

Restores a message.

Object Oriented Interface

public function doRestore($id);

Procedural Interface

cloudmail_gmail_do_restore($res, $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 (CloudMail_Gmail Class)

Retrieves a raw attachment.

Object Oriented Interface

public function doRetrieveAttachment($messageid, $attachmentid);

Procedural Interface

cloudmail_gmail_do_retrieveattachment($res, $messageid, $attachmentid);

Remarks

This method retrieves a message attachment in raw format.

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

RetrieveMessage Method (CloudMail_Gmail Class)

Retrieves a message including the message parts.

Object Oriented Interface

public function doRetrieveMessage($messageid);

Procedural Interface

cloudmail_gmail_do_retrievemessage($res, $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 (CloudMail_Gmail Class)

Retrieves the headers of a message.

Object Oriented Interface

public function doRetrieveMessageHeaders($messageid);

Procedural Interface

cloudmail_gmail_do_retrievemessageheaders($res, $messageid);

Remarks

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

RetrieveMessageInfo Method (CloudMail_Gmail Class)

Retrieves a message info.

Object Oriented Interface

public function doRetrieveMessageInfo($messageid);

Procedural Interface

cloudmail_gmail_do_retrievemessageinfo($res, $messageid);

Remarks

This method retrieves a message info.

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

RetrieveMessageRaw Method (CloudMail_Gmail Class)

Retrieves the raw message of the specified message ID.

Object Oriented Interface

public function doRetrieveMessageRaw($messageid);

Procedural Interface

cloudmail_gmail_do_retrievemessageraw($res, $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 (CloudMail_Gmail Class)

Search for messages.

Object Oriented Interface

public function doSearch($searchkey);

Procedural Interface

cloudmail_gmail_do_search($res, $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 (CloudMail_Gmail Class)

Send a custom HTTP request.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $url, $postdata);

Procedural Interface

cloudmail_gmail_do_sendcustomrequest($res, $httpmethod, $url, $postdata);

Remarks

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

SendDraft Method (CloudMail_Gmail Class)

Sends an existing Draft.

Object Oriented Interface

public function doSendDraft($draftid);

Procedural Interface

cloudmail_gmail_do_senddraft($res, $draftid);

Remarks

This method sends an existing draft.

SendMail Method (CloudMail_Gmail Class)

Sends a new email.

Object Oriented Interface

public function doSendMail();

Procedural Interface

cloudmail_gmail_do_sendmail($res);

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 (CloudMail_Gmail Class)

Sets the contact property value by JSONPath.

Object Oriented Interface

public function doSetContactField($index, $jsonpath, $value, $valuetype);

Procedural Interface

cloudmail_gmail_do_setcontactfield($res, $index, $jsonpath, $value, $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 (CloudMail_Gmail Class)

Updates a contact.

Object Oriented Interface

public function doUpdateContact($index);

Procedural Interface

cloudmail_gmail_do_updatecontact($res, $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 (CloudMail_Gmail Class)

Fired when a contact group is retrieved by the server.

Object Oriented Interface

public function fireContactGroupList($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 1, array($this, 'fireContactGroupList'));

Parameter List

 'id'
 'displayname'

Remarks

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

ContactList Event (CloudMail_Gmail Class)

Fired when a contact is retrieved from the server.

Object Oriented Interface

public function fireContactList($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 2, array($this, 'fireContactList'));

Parameter List

 'id'
 'displayname'
 'firstemail'

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 (CloudMail_Gmail Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 (CloudMail_Gmail Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 4, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired once for each log message generated by the class. 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 (CloudMail_Gmail Class)

Fired when a header is retrieved from the server.

Object Oriented Interface

public function fireMessageHeader($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 5, array($this, 'fireMessageHeader'));

Parameter List

 'field'
 'value'

Remarks

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

MessageInfo Event (CloudMail_Gmail Class)

Fired when a message is retrieved from the server.

Object Oriented Interface

public function fireMessageInfo($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 6, array($this, 'fireMessageInfo'));

Parameter List

 'id'
 'threadid'
 'historyid'
 'internaldate'
 'subject'
 'labels'
 'from'
 'sentto'
 'cc'
 'bcc'
 'snippet'
 'size'

Remarks

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

MessagePart Event (CloudMail_Gmail Class)

Fired when a message part is retrieved from the server.

Object Oriented Interface

public function fireMessagePart($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 7, array($this, 'fireMessagePart'));

Parameter List

 'id'
 'attachmentid'
 'filename'
 'contenttype'
 'size'
 'data'

Remarks

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

SSLServerAuthentication Event (CloudMail_Gmail Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 8, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (CloudMail_Gmail Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 9, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Transfer Event (CloudMail_Gmail Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudmail_gmail_register_callback($res, 10, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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

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