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.

Syntax

Gmail

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 ClientProfile and GrantType.

The class has the following defaults:

Below is a brief description of the different ClientProfile and GrantType 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 AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field 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 AccessToken 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 AccessToken. 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 GrantType field. 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 GrantType field 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 GrantType the class expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL 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 AuthorizationCode field, 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 RefreshToken field 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 GrantType the class expects a ClientId, ClientSecret, and ServerAuthURL 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 (Gmail Class)

Provides the raw attachment content.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachment(char* &lpAttachment, int &lenAttachment);

Unicode (Windows)
INT GetAttachment(LPSTR &lpAttachment, INT &lenAttachment);

int cloudmail_gmail_getattachment(void* lpObj, char** lpAttachment, int* lenAttachment);

QByteArray GetAttachment();

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

An OAuth Authorization String.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudmail_gmail_getauthorization(void* lpObj);
int cloudmail_gmail_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

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

Example

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

This property is not available at design time.

Data Type

String

AutoDecodeParts Property (Gmail Class)

Determines whether to automatically decode message parts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAutoDecodeParts();
int SetAutoDecodeParts(int bAutoDecodeParts);

Unicode (Windows)
BOOL GetAutoDecodeParts();
INT SetAutoDecodeParts(BOOL bAutoDecodeParts);

int cloudmail_gmail_getautodecodeparts(void* lpObj);
int cloudmail_gmail_setautodecodeparts(void* lpObj, int bAutoDecodeParts);

bool GetAutoDecodeParts();
int SetAutoDecodeParts(bool bAutoDecodeParts);

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

ContactGroups Property (Gmail Class)

Collection of contact groups listed by the server.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailGLContactGroup>* GetContactGroups();
int SetContactGroups(CloudMailList<CloudMailGLContactGroup>* val);

int cloudmail_gmail_getcontactgroupcount(void* lpObj);
int cloudmail_gmail_setcontactgroupcount(void* lpObj, int iContactGroupCount);

char* cloudmail_gmail_getcontactgroupid(void* lpObj, int contactgroupindex);

char* cloudmail_gmail_getcontactgroupname(void* lpObj, int contactgroupindex);

int GetContactGroupCount();
int SetContactGroupCount(int iContactGroupCount);

QString GetContactGroupId(int iContactGroupIndex);

QString GetContactGroupName(int iContactGroupIndex);

Remarks

This collection contains a list of contact groups returned by the server. It is populated when ListContactGroups is called.

This property is not available at design time.

Data Type

CloudMailGLContactGroup

Contacts Property (Gmail Class)

The collection of contacts listed by the server.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailGLContact>* GetContacts();
int SetContacts(CloudMailList<CloudMailGLContact>* val);

int cloudmail_gmail_getcontactscount(void* lpObj);
int cloudmail_gmail_setcontactscount(void* lpObj, int iContactsCount);

char* cloudmail_gmail_getcontactdisplayname(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactdisplayname(void* lpObj, int contactindex, const char* lpszContactDisplayName);

char* cloudmail_gmail_getcontactemailaddress(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactemailaddress(void* lpObj, int contactindex, const char* lpszContactEmailAddress);

char* cloudmail_gmail_getcontactemailaddressdisplayname(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactemailaddressdisplayname(void* lpObj, int contactindex, const char* lpszContactEmailAddressDisplayName);

int cloudmail_gmail_getcontactemailaddressescount(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactemailaddressescount(void* lpObj, int contactindex, int iContactEmailAddressesCount);

int cloudmail_gmail_getcontactemailaddressindex(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactemailaddressindex(void* lpObj, int contactindex, int iContactEmailAddressIndex);

int cloudmail_gmail_getcontactemailaddresstype(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactemailaddresstype(void* lpObj, int contactindex, int iContactEmailAddressType);

char* cloudmail_gmail_getcontactemailaddresstypecustom(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactemailaddresstypecustom(void* lpObj, int contactindex, const char* lpszContactEmailAddressTypeCustom);

char* cloudmail_gmail_getcontactfirstname(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactfirstname(void* lpObj, int contactindex, const char* lpszContactFirstName);

char* cloudmail_gmail_getcontactid(void* lpObj, int contactindex);

char* cloudmail_gmail_getcontactjson(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactjson(void* lpObj, int contactindex, const char* lpszContactJSON);

char* cloudmail_gmail_getcontactlastname(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactlastname(void* lpObj, int contactindex, const char* lpszContactLastName);

char* cloudmail_gmail_getcontactnotes(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactnotes(void* lpObj, int contactindex, const char* lpszContactNotes);

char* cloudmail_gmail_getcontactparentid(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactparentid(void* lpObj, int contactindex, const char* lpszContactParentId);

int cloudmail_gmail_getcontactparentidindex(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactparentidindex(void* lpObj, int contactindex, int iContactParentIdIndex);

int cloudmail_gmail_getcontactparentidscount(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactparentidscount(void* lpObj, int contactindex, int iContactParentIdsCount);

int cloudmail_gmail_getcontactphoneindex(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactphoneindex(void* lpObj, int contactindex, int iContactPhoneIndex);

char* cloudmail_gmail_getcontactphonenumber(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactphonenumber(void* lpObj, int contactindex, const char* lpszContactPhoneNumber);

int cloudmail_gmail_getcontactphonescount(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactphonescount(void* lpObj, int contactindex, int iContactPhonesCount);

int cloudmail_gmail_getcontactphonetype(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactphonetype(void* lpObj, int contactindex, int iContactPhoneType);

char* cloudmail_gmail_getcontactphonetypecustom(void* lpObj, int contactindex);
int cloudmail_gmail_setcontactphonetypecustom(void* lpObj, int contactindex, const char* lpszContactPhoneTypeCustom);

int GetContactsCount();
int SetContactsCount(int iContactsCount);

QString GetContactDisplayName(int iContactIndex);
int SetContactDisplayName(int iContactIndex, QString qsContactDisplayName);

QString GetContactEmailAddress(int iContactIndex);
int SetContactEmailAddress(int iContactIndex, QString qsContactEmailAddress);

QString GetContactEmailAddressDisplayName(int iContactIndex);
int SetContactEmailAddressDisplayName(int iContactIndex, QString qsContactEmailAddressDisplayName);

int GetContactEmailAddressesCount(int iContactIndex);
int SetContactEmailAddressesCount(int iContactIndex, int iContactEmailAddressesCount);

int GetContactEmailAddressIndex(int iContactIndex);
int SetContactEmailAddressIndex(int iContactIndex, int iContactEmailAddressIndex);

int GetContactEmailAddressType(int iContactIndex);
int SetContactEmailAddressType(int iContactIndex, int iContactEmailAddressType);

QString GetContactEmailAddressTypeCustom(int iContactIndex);
int SetContactEmailAddressTypeCustom(int iContactIndex, QString qsContactEmailAddressTypeCustom);

QString GetContactFirstName(int iContactIndex);
int SetContactFirstName(int iContactIndex, QString qsContactFirstName);

QString GetContactId(int iContactIndex);

QString GetContactJSON(int iContactIndex);
int SetContactJSON(int iContactIndex, QString qsContactJSON);

QString GetContactLastName(int iContactIndex);
int SetContactLastName(int iContactIndex, QString qsContactLastName);

QString GetContactNotes(int iContactIndex);
int SetContactNotes(int iContactIndex, QString qsContactNotes);

QString GetContactParentId(int iContactIndex);
int SetContactParentId(int iContactIndex, QString qsContactParentId);

int GetContactParentIdIndex(int iContactIndex);
int SetContactParentIdIndex(int iContactIndex, int iContactParentIdIndex);

int GetContactParentIdsCount(int iContactIndex);
int SetContactParentIdsCount(int iContactIndex, int iContactParentIdsCount);

int GetContactPhoneIndex(int iContactIndex);
int SetContactPhoneIndex(int iContactIndex, int iContactPhoneIndex);

QString GetContactPhoneNumber(int iContactIndex);
int SetContactPhoneNumber(int iContactIndex, QString qsContactPhoneNumber);

int GetContactPhonesCount(int iContactIndex);
int SetContactPhonesCount(int iContactIndex, int iContactPhonesCount);

int GetContactPhoneType(int iContactIndex);
int SetContactPhoneType(int iContactIndex, int iContactPhoneType);

QString GetContactPhoneTypeCustom(int iContactIndex);
int SetContactPhoneTypeCustom(int iContactIndex, QString qsContactPhoneTypeCustom);

Remarks

This collection contains a list of contacts returned by the server. It is populated when ListContacts or GetContact is called. A GetContact call adds the retrieved contact to the end of the list. If the contact already exists in the Contacts collection, it will be removed and then added to the end, preventing duplication.

Example (Retrieve Contacts from a Folder)

//List user's personal contacts that are in groups, including main group (Contacts) gmail.ListContacts(); // Data for each Contact foreach (GLContact contact in gmail.Contacts) { contact.FirstName; contact.LastName; contact.EmailAddressIndex=0; contact.EmailAddress; //first email address contact.PhoneIndex=0; contact.PhoneNumber; //first phone number }

This property is not available at design time.

Data Type

CloudMailGLContact

Firewall Property (Gmail Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

CloudMailFirewall* GetFirewall();
int SetFirewall(CloudMailFirewall* val);

int cloudmail_gmail_getfirewallautodetect(void* lpObj);
int cloudmail_gmail_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudmail_gmail_getfirewalltype(void* lpObj);
int cloudmail_gmail_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudmail_gmail_getfirewallhost(void* lpObj);
int cloudmail_gmail_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudmail_gmail_getfirewallpassword(void* lpObj);
int cloudmail_gmail_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudmail_gmail_getfirewallport(void* lpObj);
int cloudmail_gmail_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudmail_gmail_getfirewalluser(void* lpObj);
int cloudmail_gmail_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

CloudMailFirewall

ListContactsMarker Property (Gmail Class)

The page marker for listing contacts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetListContactsMarker();
int SetListContactsMarker(const char* lpszListContactsMarker);

Unicode (Windows)
LPWSTR GetListContactsMarker();
INT SetListContactsMarker(LPCWSTR lpszListContactsMarker);

char* cloudmail_gmail_getlistcontactsmarker(void* lpObj);
int cloudmail_gmail_setlistcontactsmarker(void* lpObj, const char* lpszListContactsMarker);

QString GetListContactsMarker();
int SetListContactsMarker(QString qsListContactsMarker);

Default Value

""

Remarks

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

Example (List All Contacts)

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

This property is not available at design time.

Data Type

String

Message Property (Gmail Class)

Provides the raw message content.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessage(char* &lpMessage, int &lenMessage);

Unicode (Windows)
INT GetMessage(LPSTR &lpMessage, INT &lenMessage);

int cloudmail_gmail_getmessage(void* lpObj, char** lpMessage, int* lenMessage);

QByteArray GetMessage();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageAttachments();
int SetMessageAttachments(const char* lpszMessageAttachments);

Unicode (Windows)
LPWSTR GetMessageAttachments();
INT SetMessageAttachments(LPCWSTR lpszMessageAttachments);

char* cloudmail_gmail_getmessageattachments(void* lpObj);
int cloudmail_gmail_setmessageattachments(void* lpObj, const char* lpszMessageAttachments);

QString GetMessageAttachments();
int SetMessageAttachments(QString qsMessageAttachments);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageBcc Property (Gmail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageBcc();
int SetMessageBcc(const char* lpszMessageBcc);

Unicode (Windows)
LPWSTR GetMessageBcc();
INT SetMessageBcc(LPCWSTR lpszMessageBcc);

char* cloudmail_gmail_getmessagebcc(void* lpObj);
int cloudmail_gmail_setmessagebcc(void* lpObj, const char* lpszMessageBcc);

QString GetMessageBcc();
int SetMessageBcc(QString qsMessageBcc);

Default Value

""

Remarks

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

Example (Add a BCC Recipient)

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

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

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

This property is not available at design time.

Data Type

String

MessageBodyContent Property (Gmail Class)

The body content for a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageBodyContent();
int SetMessageBodyContent(const char* lpszMessageBodyContent);

Unicode (Windows)
LPWSTR GetMessageBodyContent();
INT SetMessageBodyContent(LPCWSTR lpszMessageBodyContent);

char* cloudmail_gmail_getmessagebodycontent(void* lpObj);
int cloudmail_gmail_setmessagebodycontent(void* lpObj, const char* lpszMessageBodyContent);

QString GetMessageBodyContent();
int SetMessageBodyContent(QString qsMessageBodyContent);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageBodyContentType Property (Gmail Class)

The body content type for a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageBodyContentType();
int SetMessageBodyContentType(const char* lpszMessageBodyContentType);

Unicode (Windows)
LPWSTR GetMessageBodyContentType();
INT SetMessageBodyContentType(LPCWSTR lpszMessageBodyContentType);

char* cloudmail_gmail_getmessagebodycontenttype(void* lpObj);
int cloudmail_gmail_setmessagebodycontenttype(void* lpObj, const char* lpszMessageBodyContentType);

QString GetMessageBodyContentType();
int SetMessageBodyContentType(QString qsMessageBodyContentType);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageCc Property (Gmail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageCc();
int SetMessageCc(const char* lpszMessageCc);

Unicode (Windows)
LPWSTR GetMessageCc();
INT SetMessageCc(LPCWSTR lpszMessageCc);

char* cloudmail_gmail_getmessagecc(void* lpObj);
int cloudmail_gmail_setmessagecc(void* lpObj, const char* lpszMessageCc);

QString GetMessageCc();
int SetMessageCc(QString qsMessageCc);

Default Value

""

Remarks

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

Example (Add a CC Recipient)

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

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

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

This property is not available at design time.

Data Type

String

MessageCount Property (Gmail Class)

The total number of messages on the mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageCount();

Unicode (Windows)
INT GetMessageCount();

int cloudmail_gmail_getmessagecount(void* lpObj);

int GetMessageCount();

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

The author of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageFrom();
int SetMessageFrom(const char* lpszMessageFrom);

Unicode (Windows)
LPWSTR GetMessageFrom();
INT SetMessageFrom(LPCWSTR lpszMessageFrom);

char* cloudmail_gmail_getmessagefrom(void* lpObj);
int cloudmail_gmail_setmessagefrom(void* lpObj, const char* lpszMessageFrom);

QString GetMessageFrom();
int SetMessageFrom(QString qsMessageFrom);

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

MessageHeaders Property (Gmail Class)

Collection of the headers of the message.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailGLMessageHeader>* GetMessageHeaders();
int SetMessageHeaders(CloudMailList<CloudMailGLMessageHeader>* val);

int cloudmail_gmail_getmessageheadercount(void* lpObj);
int cloudmail_gmail_setmessageheadercount(void* lpObj, int iMessageHeaderCount);

char* cloudmail_gmail_getmessageheaderfield(void* lpObj, int messageheaderindex);
int cloudmail_gmail_setmessageheaderfield(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderField);

char* cloudmail_gmail_getmessageheadervalue(void* lpObj, int messageheaderindex);
int cloudmail_gmail_setmessageheadervalue(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderValue);

int GetMessageHeaderCount();
int SetMessageHeaderCount(int iMessageHeaderCount);

QString GetMessageHeaderField(int iMessageHeaderIndex);
int SetMessageHeaderField(int iMessageHeaderIndex, QString qsMessageHeaderField);

QString GetMessageHeaderValue(int iMessageHeaderIndex);
int SetMessageHeaderValue(int iMessageHeaderIndex, QString qsMessageHeaderValue);

Remarks

This property contains the full headers of the message. The headers are retrieved by calling the RetrieveMessageHeaders method.

This property is not available at design time.

Data Type

CloudMailGLMessageHeader

MessageIndex Property (Gmail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageIndex();
int SetMessageIndex(int iMessageIndex);

Unicode (Windows)
INT GetMessageIndex();
INT SetMessageIndex(INT iMessageIndex);

int cloudmail_gmail_getmessageindex(void* lpObj);
int cloudmail_gmail_setmessageindex(void* lpObj, int iMessageIndex);

int GetMessageIndex();
int SetMessageIndex(int iMessageIndex);

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

MessageInfo Property (Gmail Class)

Collection of information about retrieved messages.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailGLMessageInfo>* GetMessageInfo();
int SetMessageInfo(CloudMailList<CloudMailGLMessageInfo>* val);

int cloudmail_gmail_getmessageinfocount(void* lpObj);
int cloudmail_gmail_setmessageinfocount(void* lpObj, int iMessageInfoCount);

char* cloudmail_gmail_getmessageinfobcc(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfobcc(void* lpObj, int messageinfoindex, const char* lpszMessageInfoBcc);

char* cloudmail_gmail_getmessageinfocc(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfocc(void* lpObj, int messageinfoindex, const char* lpszMessageInfoCc);

char* cloudmail_gmail_getmessageinfofrom(void* lpObj, int messageinfoindex);

char* cloudmail_gmail_getmessageinfohistoryid(void* lpObj, int messageinfoindex);

char* cloudmail_gmail_getmessageinfoid(void* lpObj, int messageinfoindex);

char* cloudmail_gmail_getmessageinfointernaldate(void* lpObj, int messageinfoindex);

char* cloudmail_gmail_getmessageinfolabels(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfolabels(void* lpObj, int messageinfoindex, const char* lpszMessageInfoLabels);

int cloudmail_gmail_getmessageinfosize(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfosize(void* lpObj, int messageinfoindex, int iMessageInfoSize);

char* cloudmail_gmail_getmessageinfosnippet(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfosnippet(void* lpObj, int messageinfoindex, const char* lpszMessageInfoSnippet);

char* cloudmail_gmail_getmessageinfosubject(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfosubject(void* lpObj, int messageinfoindex, const char* lpszMessageInfoSubject);

char* cloudmail_gmail_getmessageinfothreadid(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfothreadid(void* lpObj, int messageinfoindex, const char* lpszMessageInfoThreadId);

char* cloudmail_gmail_getmessageinfoto(void* lpObj, int messageinfoindex);
int cloudmail_gmail_setmessageinfoto(void* lpObj, int messageinfoindex, const char* lpszMessageInfoTo);

int GetMessageInfoCount();
int SetMessageInfoCount(int iMessageInfoCount);

QString GetMessageInfoBcc(int iMessageInfoIndex);
int SetMessageInfoBcc(int iMessageInfoIndex, QString qsMessageInfoBcc);

QString GetMessageInfoCc(int iMessageInfoIndex);
int SetMessageInfoCc(int iMessageInfoIndex, QString qsMessageInfoCc);

QString GetMessageInfoFrom(int iMessageInfoIndex);

QString GetMessageInfoHistoryId(int iMessageInfoIndex);

QString GetMessageInfoId(int iMessageInfoIndex);

QString GetMessageInfoInternalDate(int iMessageInfoIndex);

QString GetMessageInfoLabels(int iMessageInfoIndex);
int SetMessageInfoLabels(int iMessageInfoIndex, QString qsMessageInfoLabels);

int GetMessageInfoSize(int iMessageInfoIndex);
int SetMessageInfoSize(int iMessageInfoIndex, int iMessageInfoSize);

QString GetMessageInfoSnippet(int iMessageInfoIndex);
int SetMessageInfoSnippet(int iMessageInfoIndex, QString qsMessageInfoSnippet);

QString GetMessageInfoSubject(int iMessageInfoIndex);
int SetMessageInfoSubject(int iMessageInfoIndex, QString qsMessageInfoSubject);

QString GetMessageInfoThreadId(int iMessageInfoIndex);
int SetMessageInfoThreadId(int iMessageInfoIndex, QString qsMessageInfoThreadId);

QString GetMessageInfoTo(int iMessageInfoIndex);
int SetMessageInfoTo(int iMessageInfoIndex, QString qsMessageInfoTo);

Remarks

This collection contains a list of GLMessageInfo for messages fetched by the server. This property is populated when ListMessages, ListDrafts RetrieveMessageInfo, or Search is called.

This property is not available at design time.

Data Type

CloudMailGLMessageInfo

MessageOtherHeaders Property (Gmail Class)

The additional message headers for a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageOtherHeaders();
int SetMessageOtherHeaders(const char* lpszMessageOtherHeaders);

Unicode (Windows)
LPWSTR GetMessageOtherHeaders();
INT SetMessageOtherHeaders(LPCWSTR lpszMessageOtherHeaders);

char* cloudmail_gmail_getmessageotherheaders(void* lpObj);
int cloudmail_gmail_setmessageotherheaders(void* lpObj, const char* lpszMessageOtherHeaders);

QString GetMessageOtherHeaders();
int SetMessageOtherHeaders(QString qsMessageOtherHeaders);

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

MessageParts Property (Gmail Class)

Collection of message parts listed by the server.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailGLMessagePart>* GetMessageParts();

int cloudmail_gmail_getmessagepartcount(void* lpObj);

char* cloudmail_gmail_getmessagepartattachmentid(void* lpObj, int messagepartindex);

char* cloudmail_gmail_getmessagepartcontenttype(void* lpObj, int messagepartindex);

char* cloudmail_gmail_getmessagepartdata(void* lpObj, int messagepartindex);

char* cloudmail_gmail_getmessagepartfilename(void* lpObj, int messagepartindex);

char* cloudmail_gmail_getmessagepartid(void* lpObj, int messagepartindex);

int cloudmail_gmail_getmessagepartsize(void* lpObj, int messagepartindex);

int GetMessagePartCount();

QString GetMessagePartAttachmentId(int iMessagePartIndex);

QString GetMessagePartContentType(int iMessagePartIndex);

QString GetMessagePartData(int iMessagePartIndex);

QString GetMessagePartFileName(int iMessagePartIndex);

QString GetMessagePartId(int iMessagePartIndex);

int GetMessagePartSize(int iMessagePartIndex);

Remarks

This collection contains a list of message parts returned by the server when ListMessages or ListDrafts is called.

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

Data Type

CloudMailGLMessagePart

MessageSubject Property (Gmail Class)

The subject of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSubject();
int SetMessageSubject(const char* lpszMessageSubject);

Unicode (Windows)
LPWSTR GetMessageSubject();
INT SetMessageSubject(LPCWSTR lpszMessageSubject);

char* cloudmail_gmail_getmessagesubject(void* lpObj);
int cloudmail_gmail_setmessagesubject(void* lpObj, const char* lpszMessageSubject);

QString GetMessageSubject();
int SetMessageSubject(QString qsMessageSubject);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageTo Property (Gmail Class)

A comma separated list of recipients for a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageTo();
int SetMessageTo(const char* lpszMessageTo);

Unicode (Windows)
LPWSTR GetMessageTo();
INT SetMessageTo(LPCWSTR lpszMessageTo);

char* cloudmail_gmail_getmessageto(void* lpObj);
int cloudmail_gmail_setmessageto(void* lpObj, const char* lpszMessageTo);

QString GetMessageTo();
int SetMessageTo(QString qsMessageTo);

Default Value

""

Remarks

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

Example (Add a Recipient)

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

Example (Add a Recipient with a Name and Address)

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

This property is not available at design time.

Data Type

String

NextPageToken Property (Gmail Class)

The token to retrieve the next page with data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNextPageToken();
int SetNextPageToken(const char* lpszNextPageToken);

Unicode (Windows)
LPWSTR GetNextPageToken();
INT SetNextPageToken(LPCWSTR lpszNextPageToken);

char* cloudmail_gmail_getnextpagetoken(void* lpObj);
int cloudmail_gmail_setnextpagetoken(void* lpObj, const char* lpszNextPageToken);

QString GetNextPageToken();
int SetNextPageToken(QString qsNextPageToken);

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

OAuth Property (Gmail Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudMailOAuthSettings* GetOAuth();

char* cloudmail_gmail_getoauthaccesstoken(void* lpObj);
int cloudmail_gmail_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudmail_gmail_getoauthauthorizationcode(void* lpObj);
int cloudmail_gmail_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudmail_gmail_getoauthauthorizationscope(void* lpObj);
int cloudmail_gmail_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudmail_gmail_getoauthclientid(void* lpObj);
int cloudmail_gmail_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudmail_gmail_getoauthclientprofile(void* lpObj);
int cloudmail_gmail_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudmail_gmail_getoauthclientsecret(void* lpObj);
int cloudmail_gmail_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudmail_gmail_getoauthgranttype(void* lpObj);
int cloudmail_gmail_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudmail_gmail_getoauthrefreshtoken(void* lpObj);
int cloudmail_gmail_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudmail_gmail_getoauthrequestrefreshtoken(void* lpObj);
int cloudmail_gmail_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudmail_gmail_getoauthreturnurl(void* lpObj);
int cloudmail_gmail_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudmail_gmail_getoauthserverauthurl(void* lpObj);
int cloudmail_gmail_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudmail_gmail_getoauthservertokenurl(void* lpObj);
int cloudmail_gmail_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudmail_gmail_getoauthwebauthurl(void* lpObj);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

bool GetOAuthRequestRefreshToken();
int SetOAuthRequestRefreshToken(bool bOAuthRequestRefreshToken);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

QString GetOAuthWebAuthURL();

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

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

Data Type

CloudMailOAuthSettings

Proxy Property (Gmail Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

CloudMailProxy* GetProxy();
int SetProxy(CloudMailProxy* val);

int cloudmail_gmail_getproxyauthscheme(void* lpObj);
int cloudmail_gmail_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudmail_gmail_getproxyautodetect(void* lpObj);
int cloudmail_gmail_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudmail_gmail_getproxypassword(void* lpObj);
int cloudmail_gmail_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudmail_gmail_getproxyport(void* lpObj);
int cloudmail_gmail_setproxyport(void* lpObj, int iProxyPort);

char* cloudmail_gmail_getproxyserver(void* lpObj);
int cloudmail_gmail_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudmail_gmail_getproxyssl(void* lpObj);
int cloudmail_gmail_setproxyssl(void* lpObj, int iProxySSL);

char* cloudmail_gmail_getproxyuser(void* lpObj);
int cloudmail_gmail_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

CloudMailProxy

SSLAcceptServerCert Property (Gmail Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

CloudMailCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudMailCertificate* val);

char* cloudmail_gmail_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertfingerprint(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertissuer(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertprivatekey(void* lpObj);

int cloudmail_gmail_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertpublickey(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudmail_gmail_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertserialnumber(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudmail_gmail_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudmail_gmail_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudmail_gmail_getsslacceptservercertstorepassword(void* lpObj);
int cloudmail_gmail_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudmail_gmail_getsslacceptservercertstoretype(void* lpObj);
int cloudmail_gmail_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudmail_gmail_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertusage(void* lpObj);

int cloudmail_gmail_getsslacceptservercertusageflags(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertversion(void* lpObj);

char* cloudmail_gmail_getsslacceptservercertsubject(void* lpObj);
int cloudmail_gmail_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudmail_gmail_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudmail_gmail_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

CloudMailCertificate

SSLCert Property (Gmail Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

CloudMailCertificate* GetSSLCert();
int SetSSLCert(CloudMailCertificate* val);

char* cloudmail_gmail_getsslcerteffectivedate(void* lpObj);

char* cloudmail_gmail_getsslcertexpirationdate(void* lpObj);

char* cloudmail_gmail_getsslcertextendedkeyusage(void* lpObj);

char* cloudmail_gmail_getsslcertfingerprint(void* lpObj);

char* cloudmail_gmail_getsslcertfingerprintsha1(void* lpObj);

char* cloudmail_gmail_getsslcertfingerprintsha256(void* lpObj);

char* cloudmail_gmail_getsslcertissuer(void* lpObj);

char* cloudmail_gmail_getsslcertprivatekey(void* lpObj);

int cloudmail_gmail_getsslcertprivatekeyavailable(void* lpObj);

char* cloudmail_gmail_getsslcertprivatekeycontainer(void* lpObj);

char* cloudmail_gmail_getsslcertpublickey(void* lpObj);

char* cloudmail_gmail_getsslcertpublickeyalgorithm(void* lpObj);

int cloudmail_gmail_getsslcertpublickeylength(void* lpObj);

char* cloudmail_gmail_getsslcertserialnumber(void* lpObj);

char* cloudmail_gmail_getsslcertsignaturealgorithm(void* lpObj);

int cloudmail_gmail_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudmail_gmail_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudmail_gmail_getsslcertstorepassword(void* lpObj);
int cloudmail_gmail_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudmail_gmail_getsslcertstoretype(void* lpObj);
int cloudmail_gmail_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudmail_gmail_getsslcertsubjectaltnames(void* lpObj);

char* cloudmail_gmail_getsslcertthumbprintmd5(void* lpObj);

char* cloudmail_gmail_getsslcertthumbprintsha1(void* lpObj);

char* cloudmail_gmail_getsslcertthumbprintsha256(void* lpObj);

char* cloudmail_gmail_getsslcertusage(void* lpObj);

int cloudmail_gmail_getsslcertusageflags(void* lpObj);

char* cloudmail_gmail_getsslcertversion(void* lpObj);

char* cloudmail_gmail_getsslcertsubject(void* lpObj);
int cloudmail_gmail_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudmail_gmail_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudmail_gmail_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

CloudMailCertificate

SSLProvider Property (Gmail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudmail_gmail_getsslprovider(void* lpObj);
int cloudmail_gmail_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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

SSLServerCert Property (Gmail Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudMailCertificate* GetSSLServerCert();

char* cloudmail_gmail_getsslservercerteffectivedate(void* lpObj);

char* cloudmail_gmail_getsslservercertexpirationdate(void* lpObj);

char* cloudmail_gmail_getsslservercertextendedkeyusage(void* lpObj);

char* cloudmail_gmail_getsslservercertfingerprint(void* lpObj);

char* cloudmail_gmail_getsslservercertfingerprintsha1(void* lpObj);

char* cloudmail_gmail_getsslservercertfingerprintsha256(void* lpObj);

char* cloudmail_gmail_getsslservercertissuer(void* lpObj);

char* cloudmail_gmail_getsslservercertprivatekey(void* lpObj);

int cloudmail_gmail_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudmail_gmail_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudmail_gmail_getsslservercertpublickey(void* lpObj);

char* cloudmail_gmail_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudmail_gmail_getsslservercertpublickeylength(void* lpObj);

char* cloudmail_gmail_getsslservercertserialnumber(void* lpObj);

char* cloudmail_gmail_getsslservercertsignaturealgorithm(void* lpObj);

int cloudmail_gmail_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* cloudmail_gmail_getsslservercertstorepassword(void* lpObj);

int cloudmail_gmail_getsslservercertstoretype(void* lpObj);

char* cloudmail_gmail_getsslservercertsubjectaltnames(void* lpObj);

char* cloudmail_gmail_getsslservercertthumbprintmd5(void* lpObj);

char* cloudmail_gmail_getsslservercertthumbprintsha1(void* lpObj);

char* cloudmail_gmail_getsslservercertthumbprintsha256(void* lpObj);

char* cloudmail_gmail_getsslservercertusage(void* lpObj);

int cloudmail_gmail_getsslservercertusageflags(void* lpObj);

char* cloudmail_gmail_getsslservercertversion(void* lpObj);

char* cloudmail_gmail_getsslservercertsubject(void* lpObj);

int cloudmail_gmail_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudMailCertificate

AddMessageLabels Method (Gmail Class)

Adds the specified labels to the message specified by MessageId.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddMessageLabels(const char* lpszMessageId, const char* lpszLabels);

Unicode (Windows)
INT AddMessageLabels(LPCWSTR lpszMessageId, LPCWSTR lpszLabels);

int cloudmail_gmail_addmessagelabels(void* lpObj, const char* lpszMessageId, const char* lpszLabels);

int AddMessageLabels(const QString& qsMessageId, const QString& qsLabels);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AppendToMailbox Method (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.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AppendToMailbox();

Unicode (Windows)
INT AppendToMailbox();

int cloudmail_gmail_appendtomailbox(void* lpObj);

int AppendToMailbox();

Remarks

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

Example (Append Message to Mailbox)

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Authorize Method (Gmail Class)

Get the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int cloudmail_gmail_authorize(void* lpObj);

int Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile field and the GrantType field. 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Gmail Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudmail_gmail_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CountMessages Method (Gmail Class)

Get the total number of messages in the mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CountMessages();

Unicode (Windows)
INT CountMessages();

int cloudmail_gmail_countmessages(void* lpObj);

int CountMessages();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateContact Method (Gmail Class)

Creates a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateContact(const char* lpszFirstName, const char* lpszLastName, const char* lpszEmailAddress);

Unicode (Windows)
INT CreateContact(LPCWSTR lpszFirstName, LPCWSTR lpszLastName, LPCWSTR lpszEmailAddress);

int cloudmail_gmail_createcontact(void* lpObj, const char* lpszFirstName, const char* lpszLastName, const char* lpszEmailAddress);

int CreateContact(const QString& qsFirstName, const QString& qsLastName, const QString& qsEmailAddress);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateDraft Method (Gmail Class)

Creates a new email draft.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateDraft();

Unicode (Windows)
INT CreateDraft();

int cloudmail_gmail_createdraft(void* lpObj);

int CreateDraft();

Remarks

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

Example

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Delete Method (Gmail Class)

Deletes a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete(const char* lpszmessageId);

Unicode (Windows)
INT Delete(LPCWSTR lpszmessageId);

int cloudmail_gmail_delete(void* lpObj, const char* lpszmessageId);

int Delete(const QString& qsmessageId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteContact Method (Gmail Class)

Deletes a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteContact(const char* lpszid);

Unicode (Windows)
INT DeleteContact(LPCWSTR lpszid);

int cloudmail_gmail_deletecontact(void* lpObj, const char* lpszid);

int DeleteContact(const QString& qsid);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteDraft Method (Gmail Class)

Deletes a draft permanently.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteDraft(const char* lpszdraftId);

Unicode (Windows)
INT DeleteDraft(LPCWSTR lpszdraftId);

int cloudmail_gmail_deletedraft(void* lpObj, const char* lpszdraftId);

int DeleteDraft(const QString& qsdraftId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeletePermanently Method (Gmail Class)

Deletes the specified messages permanently.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeletePermanently(const char* lpszmessageIds);

Unicode (Windows)
INT DeletePermanently(LPCWSTR lpszmessageIds);

int cloudmail_gmail_deletepermanently(void* lpObj, const char* lpszmessageIds);

int DeletePermanently(const QString& qsmessageIds);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetContact Method (Gmail Class)

Retrieves the contact by Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContact(const char* lpszId);

Unicode (Windows)
INT GetContact(LPCWSTR lpszId);

int cloudmail_gmail_getcontact(void* lpObj, const char* lpszId);

int GetContact(const QString& qsId);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetContactField Method (Gmail Class)

Retrieves the contact property value by JSONPath.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContactField(int iindex, const char* lpszJsonPath);

Unicode (Windows)
LPWSTR GetContactField(INT iindex, LPCWSTR lpszJsonPath);

char* cloudmail_gmail_getcontactfield(void* lpObj, int iindex, const char* lpszJsonPath);

QString GetContactField(int iindex, const QString& qsJsonPath);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (Gmail Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudmail_gmail_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListContactGroups Method (Gmail Class)

Lists the contact groups of the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListContactGroups();

Unicode (Windows)
INT ListContactGroups();

int cloudmail_gmail_listcontactgroups(void* lpObj);

int ListContactGroups();

Remarks

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

Example (List All Contact Groups):

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

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

Example (List All Contact Groups):

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListContacts Method (Gmail Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListContacts();

Unicode (Windows)
INT ListContacts();

int cloudmail_gmail_listcontacts(void* lpObj);

int ListContacts();

Remarks

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

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListDrafts Method (Gmail Class)

Lists the drafts in a mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListDrafts(const char* lpszfilter);

Unicode (Windows)
INT ListDrafts(LPCWSTR lpszfilter);

int cloudmail_gmail_listdrafts(void* lpObj, const char* lpszfilter);

int ListDrafts(const QString& qsfilter);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListMessages Method (Gmail Class)

Lists the messages in a mailbox.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMessages(const char* lpszfilter, const char* lpszthreadId);

Unicode (Windows)
INT ListMessages(LPCWSTR lpszfilter, LPCWSTR lpszthreadId);

int cloudmail_gmail_listmessages(void* lpObj, const char* lpszfilter, const char* lpszthreadId);

int ListMessages(const QString& qsfilter, const QString& qsthreadId);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveMessageLabels Method (Gmail Class)

Removes the specified labels from the message specified by MessageId.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveMessageLabels(const char* lpszMessageId, const char* lpszLabels);

Unicode (Windows)
INT RemoveMessageLabels(LPCWSTR lpszMessageId, LPCWSTR lpszLabels);

int cloudmail_gmail_removemessagelabels(void* lpObj, const char* lpszMessageId, const char* lpszLabels);

int RemoveMessageLabels(const QString& qsMessageId, const QString& qsLabels);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Gmail Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudmail_gmail_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Restore Method (Gmail Class)

Restores a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Restore(const char* lpszid);

Unicode (Windows)
INT Restore(LPCWSTR lpszid);

int cloudmail_gmail_restore(void* lpObj, const char* lpszid);

int Restore(const QString& qsid);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveAttachment Method (Gmail Class)

Retrieves a raw attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveAttachment(const char* lpszmessageId, const char* lpszattachmentId);

Unicode (Windows)
INT RetrieveAttachment(LPCWSTR lpszmessageId, LPCWSTR lpszattachmentId);

int cloudmail_gmail_retrieveattachment(void* lpObj, const char* lpszmessageId, const char* lpszattachmentId);

int RetrieveAttachment(const QString& qsmessageId, const QString& qsattachmentId);

Remarks

This method retrieves a message attachment in raw format.

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveMessage Method (Gmail Class)

Retrieves a message including the message parts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessage(const char* lpszmessageId);

Unicode (Windows)
INT RetrieveMessage(LPCWSTR lpszmessageId);

int cloudmail_gmail_retrievemessage(void* lpObj, const char* lpszmessageId);

int RetrieveMessage(const QString& qsmessageId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveMessageHeaders Method (Gmail Class)

Retrieves the headers of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessageHeaders(const char* lpszmessageId);

Unicode (Windows)
INT RetrieveMessageHeaders(LPCWSTR lpszmessageId);

int cloudmail_gmail_retrievemessageheaders(void* lpObj, const char* lpszmessageId);

int RetrieveMessageHeaders(const QString& qsmessageId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveMessageInfo Method (Gmail Class)

Retrieves a message info.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessageInfo(const char* lpszmessageId);

Unicode (Windows)
INT RetrieveMessageInfo(LPCWSTR lpszmessageId);

int cloudmail_gmail_retrievemessageinfo(void* lpObj, const char* lpszmessageId);

int RetrieveMessageInfo(const QString& qsmessageId);

Remarks

This method retrieves a message info.

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveMessageRaw Method (Gmail Class)

Retrieves the raw message of the specified message ID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessageRaw(const char* lpszmessageId);

Unicode (Windows)
INT RetrieveMessageRaw(LPCWSTR lpszmessageId);

int cloudmail_gmail_retrievemessageraw(void* lpObj, const char* lpszmessageId);

int RetrieveMessageRaw(const QString& qsmessageId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Search Method (Gmail Class)

Search for messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Search(const char* lpszsearchKey);

Unicode (Windows)
INT Search(LPCWSTR lpszsearchKey);

int cloudmail_gmail_search(void* lpObj, const char* lpszsearchKey);

int Search(const QString& qssearchKey);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (Gmail Class)

Send a custom HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHTTPMethod, const char* lpszURL, const char* lpszPostData);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHTTPMethod, LPCWSTR lpszURL, LPCWSTR lpszPostData);

int cloudmail_gmail_sendcustomrequest(void* lpObj, const char* lpszHTTPMethod, const char* lpszURL, const char* lpszPostData);

int SendCustomRequest(const QString& qsHTTPMethod, const QString& qsURL, const QString& qsPostData);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendDraft Method (Gmail Class)

Sends an existing Draft.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendDraft(const char* lpszdraftId);

Unicode (Windows)
INT SendDraft(LPCWSTR lpszdraftId);

int cloudmail_gmail_senddraft(void* lpObj, const char* lpszdraftId);

int SendDraft(const QString& qsdraftId);

Remarks

This method sends an existing draft.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendMail Method (Gmail Class)

Sends a new email.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendMail();

Unicode (Windows)
INT SendMail();

int cloudmail_gmail_sendmail(void* lpObj);

int SendMail();

Remarks

This method sends a new message.

Example

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetContactField Method (Gmail Class)

Sets the contact property value by JSONPath.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetContactField(int iindex, const char* lpszJsonPath, const char* lpszValue, int iValueType);

Unicode (Windows)
INT SetContactField(INT iindex, LPCWSTR lpszJsonPath, LPCWSTR lpszValue, INT iValueType);

int cloudmail_gmail_setcontactfield(void* lpObj, int iindex, const char* lpszJsonPath, const char* lpszValue, int iValueType);

int SetContactField(int iindex, const QString& qsJsonPath, const QString& qsValue, int iValueType);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateContact Method (Gmail Class)

Updates a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateContact(int iindex);

Unicode (Windows)
INT UpdateContact(INT iindex);

int cloudmail_gmail_updatecontact(void* lpObj, int iindex);

int UpdateContact(int iindex);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ContactGroupList Event (Gmail Class)

Fired when a contact group is retrieved by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireContactGroupList(GmailContactGroupListEventParams *e);

typedef struct {
  const char *Id;
  const char *DisplayName;
  int reserved;
} GmailContactGroupListEventParams;


Unicode (Windows)
virtual INT FireContactGroupList(GmailContactGroupListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR DisplayName;
  INT reserved;
} GmailContactGroupListEventParams;

#define EID_GMAIL_CONTACTGROUPLIST 1

virtual INT CLOUDMAIL_CALL FireContactGroupList(LPSTR &lpszId, LPSTR &lpszDisplayName);

class GmailContactGroupListEventParams {
public:
  const QString &Id();

  const QString &DisplayName();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ContactGroupList(GmailContactGroupListEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireContactGroupList(GmailContactGroupListEventParams *e) {...}

Remarks

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

ContactList Event (Gmail Class)

Fired when a contact is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireContactList(GmailContactListEventParams *e);

typedef struct {
  const char *Id;
  const char *DisplayName;
  const char *FirstEmail;
  int reserved;
} GmailContactListEventParams;


Unicode (Windows)
virtual INT FireContactList(GmailContactListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR DisplayName;
  LPCWSTR FirstEmail;
  INT reserved;
} GmailContactListEventParams;

#define EID_GMAIL_CONTACTLIST 2

virtual INT CLOUDMAIL_CALL FireContactList(LPSTR &lpszId, LPSTR &lpszDisplayName, LPSTR &lpszFirstEmail);

class GmailContactListEventParams {
public:
  const QString &Id();

  const QString &DisplayName();

  const QString &FirstEmail();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ContactList(GmailContactListEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireContactList(GmailContactListEventParams *e) {...}

Remarks

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

Error Event (Gmail Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(GmailErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} GmailErrorEventParams;


Unicode (Windows)
virtual INT FireError(GmailErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} GmailErrorEventParams;

#define EID_GMAIL_ERROR 3

virtual INT CLOUDMAIL_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class GmailErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(GmailErrorEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireError(GmailErrorEventParams *e) {...}

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

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(GmailLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} GmailLogEventParams;


Unicode (Windows)
virtual INT FireLog(GmailLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} GmailLogEventParams;

#define EID_GMAIL_LOG 4

virtual INT CLOUDMAIL_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class GmailLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(GmailLogEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireLog(GmailLogEventParams *e) {...}

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

Fired when a header is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageHeader(GmailMessageHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} GmailMessageHeaderEventParams;


Unicode (Windows)
virtual INT FireMessageHeader(GmailMessageHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} GmailMessageHeaderEventParams;

#define EID_GMAIL_MESSAGEHEADER 5

virtual INT CLOUDMAIL_CALL FireMessageHeader(LPSTR &lpszField, LPSTR &lpszValue);

class GmailMessageHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageHeader(GmailMessageHeaderEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireMessageHeader(GmailMessageHeaderEventParams *e) {...}

Remarks

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

MessageInfo Event (Gmail Class)

Fired when a message is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageInfo(GmailMessageInfoEventParams *e);

typedef struct {
  const char *Id;
  const char *ThreadId;
  const char *HistoryId;
  const char *InternalDate;
  const char *Subject;
  const char *Labels;
  const char *From;
  const char *SentTo;
  const char *Cc;
  const char *Bcc;
  const char *Snippet;
  int Size;
  int reserved;
} GmailMessageInfoEventParams;


Unicode (Windows)
virtual INT FireMessageInfo(GmailMessageInfoEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR ThreadId;
  LPCWSTR HistoryId;
  LPCWSTR InternalDate;
  LPCWSTR Subject;
  LPCWSTR Labels;
  LPCWSTR From;
  LPCWSTR SentTo;
  LPCWSTR Cc;
  LPCWSTR Bcc;
  LPCWSTR Snippet;
  INT Size;
  INT reserved;
} GmailMessageInfoEventParams;

#define EID_GMAIL_MESSAGEINFO 6

virtual INT CLOUDMAIL_CALL FireMessageInfo(LPSTR &lpszId, LPSTR &lpszThreadId, LPSTR &lpszHistoryId, LPSTR &lpszInternalDate, LPSTR &lpszSubject, LPSTR &lpszLabels, LPSTR &lpszFrom, LPSTR &lpszSentTo, LPSTR &lpszCc, LPSTR &lpszBcc, LPSTR &lpszSnippet, INT &iSize);

class GmailMessageInfoEventParams {
public:
  const QString &Id();

  const QString &ThreadId();

  const QString &HistoryId();

  const QString &InternalDate();

  const QString &Subject();

  const QString &Labels();

  const QString &From();

  const QString &SentTo();

  const QString &Cc();

  const QString &Bcc();

  const QString &Snippet();

  int Size();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageInfo(GmailMessageInfoEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireMessageInfo(GmailMessageInfoEventParams *e) {...}

Remarks

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

MessagePart Event (Gmail Class)

Fired when a message part is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessagePart(GmailMessagePartEventParams *e);

typedef struct {
  const char *Id;
  const char *AttachmentId;
  const char *Filename;
  const char *ContentType;
  int Size;
  const char *Data;
  int reserved;
} GmailMessagePartEventParams;


Unicode (Windows)
virtual INT FireMessagePart(GmailMessagePartEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR AttachmentId;
  LPCWSTR Filename;
  LPCWSTR ContentType;
  INT Size;
  LPCWSTR Data;
  INT reserved;
} GmailMessagePartEventParams;

#define EID_GMAIL_MESSAGEPART 7

virtual INT CLOUDMAIL_CALL FireMessagePart(LPSTR &lpszId, LPSTR &lpszAttachmentId, LPSTR &lpszFilename, LPSTR &lpszContentType, INT &iSize, LPSTR &lpszData);

class GmailMessagePartEventParams {
public:
  const QString &Id();

  const QString &AttachmentId();

  const QString &Filename();

  const QString &ContentType();

  int Size();

  const QString &Data();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessagePart(GmailMessagePartEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireMessagePart(GmailMessagePartEventParams *e) {...}

Remarks

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

SSLServerAuthentication Event (Gmail Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(GmailSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} GmailSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(GmailSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} GmailSSLServerAuthenticationEventParams;

#define EID_GMAIL_SSLSERVERAUTHENTICATION 8

virtual INT CLOUDMAIL_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class GmailSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(GmailSSLServerAuthenticationEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireSSLServerAuthentication(GmailSSLServerAuthenticationEventParams *e) {...}

Remarks

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

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

SSLStatus Event (Gmail Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(GmailSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} GmailSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(GmailSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} GmailSSLStatusEventParams;

#define EID_GMAIL_SSLSTATUS 9

virtual INT CLOUDMAIL_CALL FireSSLStatus(LPSTR &lpszMessage);

class GmailSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(GmailSSLStatusEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireSSLStatus(GmailSSLStatusEventParams *e) {...}

Remarks

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

Transfer Event (Gmail Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(GmailTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} GmailTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(GmailTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} GmailTransferEventParams;

#define EID_GMAIL_TRANSFER 10

virtual INT CLOUDMAIL_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class GmailTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(GmailTransferEventParams *e);

// Or, subclass Gmail and override this emitter function.
virtual int FireTransfer(GmailTransferEventParams *e) {...}

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.

Certificate Type

This is the digital certificate being used.

Syntax

CloudMailCertificate (declared in cloudmail.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

CloudMailFirewall (declared in cloudmail.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

GLContact Type

Holds information about a contact.

Syntax

CloudMailGLContact (declared in cloudmail.h)

Remarks

Holds information about a contact.

Fields

Constructors

GLContact()

GLContactGroup Type

Holds information about a contact group.

Syntax

CloudMailGLContactGroup (declared in cloudmail.h)

Remarks

Holds information about a contact group.

Fields

Constructors

GLContactGroup()

GLMessageHeader Type

Holds information about a message headers.

Syntax

CloudMailGLMessageHeader (declared in cloudmail.h)

Remarks

Holds information about a message headers.

Fields

Constructors

GLMessageHeader()

GLMessageInfo Type

Holds information about a message.

Syntax

CloudMailGLMessageInfo (declared in cloudmail.h)

Remarks

Holds information about a message.

Fields

Constructors

GLMessageInfo()

GLMessagePart Type

Holds information about a message part.

Syntax

CloudMailGLMessagePart (declared in cloudmail.h)

Remarks

Holds information about a message part.

Fields

Constructors

GLMessagePart()

OAuthSettings Type

The settings to use to authenticate with the service provider.

Syntax

CloudMailOAuthSettings (declared in cloudmail.h)

Remarks

Used to set give the class the necessary information needed to complete OAuth authentication.

Fields

Constructors

OAuthSettings()

Proxy Type

The proxy the component will connect to.

Syntax

CloudMailProxy (declared in cloudmail.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields