Office365 Class

Properties   Methods   Events   Config Settings   Errors  

The Office365 class provides an easy way to manage sending and receiving mail in Microsoft 365.

Syntax

Office365

Remarks

This class provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the class, first set the Authorization property to a valid OAuth token. The Office365 class can be used for sending or creating new messages; retrieving, moving, or copying existing messages; creating, deleting, or copying folders; and several other functionalities supported by the Microsoft Graph 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:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what GrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the ServerAuthURL and ServerTokenURL fields. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes:

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: Office365 office365 = new Office365(); office365.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365.OAuth.ClientId = CLIENT_ID; office365.OAuth.ClientSecret = CLIENT_SECRET; office365.Authorize();

Client Credentials

When using the Client Credentials grant type, the class will act as a service instead of authorizing and authenticating as a user. This allows for the class to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this GrantType the class expects a ClientId, ClientSecret, and ServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

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.

Password

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

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this GrantType the class requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

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.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.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 new messages using the Office365 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: office365.MessageSubject = "Subject Text"; office365.MessageImportance = "Low"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text."; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); string messageId = office365.MessageInfo[0].Id; office365.SendDraft(messageId);

There are also methods for replying or forwarding messages using the Office365 component. The Reply, ReplyAll, and Forward method will send a reply or forward directly. Similarly, you can create a reply or forward draft and then send an existing draft using the SendDraft method. Unlike creating a new message, only the direct methods use the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.). When using CreateDraft, the draft must first be made then updated using the MessageInfo properties and Update method.

Sending a Reply with SendDraft: //Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, oringialMessageId); //Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; //Update the draft office365.Update(office365.MessageInfo[0].Id); //Send the draft office365.SendDraft(office365.MessageInfo[0].Id);

Receiving Messages

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

The ListMessages and ListChanges methods will respectively list the messages or changed messages in a folder specified by a folderId. To get the ID of a folder, folders can be traversed and read using the ListFolders method and the Folders properties.

Listing Messages in a Folder: // Get the folder ID string folderId = ""; office365.ListFolders(""); // Lists the root child folders. for (int i = 0; i < office365.Folders.Count; i++) { if (office365.Folders[i].DisplayName.Equals("SpecificFolderName")) { folderId = office365.Folders[i].Id; break; } } // List folder messages office365.ListMessages(folderId, "");

By default, the component will fetch one page of 100 messages when ListMessages is called. If additional messages remain in the folder, the ListMessagesMarker 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 MessageInfo properties with all the messages in a particular folder. do { office365.ListMessages(folderId); } while (office365.ListMessagesMarker.Length > 0);

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

Property List

The following is the full list of the properties of the 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.

Attachments Property (Office365 Class)

Collection of attachments listed by the server.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailOLAttachment>* GetAttachments();
int SetAttachments(CloudMailList<CloudMailOLAttachment>* val);

int cloudmail_office365_getattachmentcount(void* lpObj);
int cloudmail_office365_setattachmentcount(void* lpObj, int iAttachmentCount);

char* cloudmail_office365_getattachmentattachmenttype(void* lpObj, int attachmentindex);

char* cloudmail_office365_getattachmentcontentid(void* lpObj, int attachmentindex);
int cloudmail_office365_setattachmentcontentid(void* lpObj, int attachmentindex, const char* lpszAttachmentContentId);

char* cloudmail_office365_getattachmentcontentlocation(void* lpObj, int attachmentindex);

char* cloudmail_office365_getattachmentcontenttype(void* lpObj, int attachmentindex);

int cloudmail_office365_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int cloudmail_office365_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);

char* cloudmail_office365_getattachmentfilename(void* lpObj, int attachmentindex);
int cloudmail_office365_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFileName);

char* cloudmail_office365_getattachmentid(void* lpObj, int attachmentindex);

int cloudmail_office365_setattachmentinputstream(void* lpObj, int attachmentindex, CloudMailStream* sAttachmentInputStream);

int cloudmail_office365_getattachmentisinline(void* lpObj, int attachmentindex);
int cloudmail_office365_setattachmentisinline(void* lpObj, int attachmentindex, int bAttachmentIsInline);

char* cloudmail_office365_getattachmentlastmodifieddate(void* lpObj, int attachmentindex);
int cloudmail_office365_setattachmentlastmodifieddate(void* lpObj, int attachmentindex, const char* lpszAttachmentLastModifiedDate);

char* cloudmail_office365_getattachmentname(void* lpObj, int attachmentindex);
int cloudmail_office365_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);

char* cloudmail_office365_getattachmentparentindex(void* lpObj, int attachmentindex);

int cloudmail_office365_getattachmentsize(void* lpObj, int attachmentindex);
int cloudmail_office365_setattachmentsize(void* lpObj, int attachmentindex, int iAttachmentSize);

int GetAttachmentCount();
int SetAttachmentCount(int iAttachmentCount);

QString GetAttachmentAttachmentType(int iAttachmentIndex);

QString GetAttachmentContentId(int iAttachmentIndex);
int SetAttachmentContentId(int iAttachmentIndex, QString qsAttachmentContentId);

QString GetAttachmentContentLocation(int iAttachmentIndex);

QString GetAttachmentContentType(int iAttachmentIndex);

QByteArray GetAttachmentData(int iAttachmentIndex);
int SetAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData);

QString GetAttachmentFileName(int iAttachmentIndex);
int SetAttachmentFileName(int iAttachmentIndex, QString qsAttachmentFileName);

QString GetAttachmentId(int iAttachmentIndex);

int SetAttachmentInputStream(int iAttachmentIndex, CloudMailStream* sAttachmentInputStream);

bool GetAttachmentIsInline(int iAttachmentIndex);
int SetAttachmentIsInline(int iAttachmentIndex, bool bAttachmentIsInline);

QString GetAttachmentLastModifiedDate(int iAttachmentIndex);
int SetAttachmentLastModifiedDate(int iAttachmentIndex, QString qsAttachmentLastModifiedDate);

QString GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, QString qsAttachmentName);

QString GetAttachmentParentIndex(int iAttachmentIndex);

int GetAttachmentSize(int iAttachmentIndex);
int SetAttachmentSize(int iAttachmentIndex, int iAttachmentSize);

Remarks

This collection contains a list of attachments returned by the server when ListAttachments is called.

This property is not available at design time.

Data Type

CloudMailOLAttachment

Authorization Property (Office365 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_office365_getauthorization(void* lpObj);
int cloudmail_office365_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 = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "user.read mail.readwrite mail.send mailboxsettings.readwrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

Categories Property (Office365 Class)

Collection of attachments listed by the server.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailOLCategory>* GetCategories();
int SetCategories(CloudMailList<CloudMailOLCategory>* val);

int cloudmail_office365_getcategorycount(void* lpObj);
int cloudmail_office365_setcategorycount(void* lpObj, int iCategoryCount);

char* cloudmail_office365_getcategorycolor(void* lpObj, int categoryindex);

char* cloudmail_office365_getcategorydisplayname(void* lpObj, int categoryindex);

char* cloudmail_office365_getcategoryid(void* lpObj, int categoryindex);

int GetCategoryCount();
int SetCategoryCount(int iCategoryCount);

QString GetCategoryColor(int iCategoryIndex);

QString GetCategoryDisplayName(int iCategoryIndex);

QString GetCategoryId(int iCategoryIndex);

Remarks

This collection contains a list of categories returned by the server when ListCategories is called.

This property is not available at design time.

Data Type

CloudMailOLCategory

ChangeMarker Property (Office365 Class)

The page marker for listing changed messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChangeMarker();
int SetChangeMarker(const char* lpszChangeMarker);

Unicode (Windows)
LPWSTR GetChangeMarker();
INT SetChangeMarker(LPCWSTR lpszChangeMarker);

char* cloudmail_office365_getchangemarker(void* lpObj);
int cloudmail_office365_setchangemarker(void* lpObj, const char* lpszChangeMarker);

QString GetChangeMarker();
int SetChangeMarker(QString qsChangeMarker);

Default Value

""

Remarks

This property is populated if there are still unlisted messages after ListChanges is called. It contains the nextLink that will be included as an OData parameter if ListChanges is called again on the same folder. This will cause the next page of changed messages to be listed.

Example (List All Changes of a Message)

do { office365.ListChanges(id, "", 100); } while (office365.ChangeMarker.Length > 0);

This property is not available at design time.

Data Type

String

ContactFolders Property (Office365 Class)

The collection of contact folders listed by the server.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailOLContactFolder>* GetContactFolders();
int SetContactFolders(CloudMailList<CloudMailOLContactFolder>* val);

int cloudmail_office365_getcontactfoldercount(void* lpObj);
int cloudmail_office365_setcontactfoldercount(void* lpObj, int iContactFolderCount);

char* cloudmail_office365_getcontactfolderid(void* lpObj, int contactfolderindex);

char* cloudmail_office365_getcontactfoldername(void* lpObj, int contactfolderindex);

char* cloudmail_office365_getcontactfolderparentfolderid(void* lpObj, int contactfolderindex);

int GetContactFolderCount();
int SetContactFolderCount(int iContactFolderCount);

QString GetContactFolderId(int iContactFolderIndex);

QString GetContactFolderName(int iContactFolderIndex);

QString GetContactFolderParentFolderId(int iContactFolderIndex);

Remarks

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

This property is not available at design time.

Data Type

CloudMailOLContactFolder

Contacts Property (Office365 Class)

The collection of contacts listed by the server.

Syntax

• C++
• C
• Qt

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

int cloudmail_office365_getcontactscount(void* lpObj);
int cloudmail_office365_setcontactscount(void* lpObj, int iContactsCount);

char* cloudmail_office365_getcontactcompanyname(void* lpObj, int contactindex);
int cloudmail_office365_setcontactcompanyname(void* lpObj, int contactindex, const char* lpszContactCompanyName);

char* cloudmail_office365_getcontactdisplayname(void* lpObj, int contactindex);
int cloudmail_office365_setcontactdisplayname(void* lpObj, int contactindex, const char* lpszContactDisplayName);

char* cloudmail_office365_getcontactemailaddress(void* lpObj, int contactindex);
int cloudmail_office365_setcontactemailaddress(void* lpObj, int contactindex, const char* lpszContactEmailAddress);

int cloudmail_office365_getcontactemailaddressescount(void* lpObj, int contactindex);
int cloudmail_office365_setcontactemailaddressescount(void* lpObj, int contactindex, int iContactEmailAddressesCount);

int cloudmail_office365_getcontactemailaddressindex(void* lpObj, int contactindex);
int cloudmail_office365_setcontactemailaddressindex(void* lpObj, int contactindex, int iContactEmailAddressIndex);

char* cloudmail_office365_getcontactfirstname(void* lpObj, int contactindex);
int cloudmail_office365_setcontactfirstname(void* lpObj, int contactindex, const char* lpszContactFirstName);

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

char* cloudmail_office365_getcontactjson(void* lpObj, int contactindex);
int cloudmail_office365_setcontactjson(void* lpObj, int contactindex, const char* lpszContactJSON);

char* cloudmail_office365_getcontactlastname(void* lpObj, int contactindex);
int cloudmail_office365_setcontactlastname(void* lpObj, int contactindex, const char* lpszContactLastName);

char* cloudmail_office365_getcontactnotes(void* lpObj, int contactindex);
int cloudmail_office365_setcontactnotes(void* lpObj, int contactindex, const char* lpszContactNotes);

char* cloudmail_office365_getcontactparentid(void* lpObj, int contactindex);
int cloudmail_office365_setcontactparentid(void* lpObj, int contactindex, const char* lpszContactParentId);

int cloudmail_office365_getcontactphoneindex(void* lpObj, int contactindex);
int cloudmail_office365_setcontactphoneindex(void* lpObj, int contactindex, int iContactPhoneIndex);

char* cloudmail_office365_getcontactphonenumber(void* lpObj, int contactindex);
int cloudmail_office365_setcontactphonenumber(void* lpObj, int contactindex, const char* lpszContactPhoneNumber);

int cloudmail_office365_getcontactphonescount(void* lpObj, int contactindex);
int cloudmail_office365_setcontactphonescount(void* lpObj, int contactindex, int iContactPhonesCount);

int cloudmail_office365_getcontactphonetype(void* lpObj, int contactindex);
int cloudmail_office365_setcontactphonetype(void* lpObj, int contactindex, int iContactPhoneType);

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

QString GetContactCompanyName(int iContactIndex);
int SetContactCompanyName(int iContactIndex, QString qsContactCompanyName);

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

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

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

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

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

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 contacts of the default Contacts folder of the user office365.ListContacts(""); // Data for each Contact foreach (OLContact contact in office365.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

CloudMailOLContact

Firewall Property (Office365 Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int cloudmail_office365_getfirewallautodetect(void* lpObj);
int cloudmail_office365_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudmail_office365_getfirewalltype(void* lpObj);
int cloudmail_office365_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudmail_office365_getfirewallhost(void* lpObj);
int cloudmail_office365_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudmail_office365_getfirewallpassword(void* lpObj);
int cloudmail_office365_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudmail_office365_getfirewallport(void* lpObj);
int cloudmail_office365_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudmail_office365_getfirewalluser(void* lpObj);
int cloudmail_office365_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

Folders Property (Office365 Class)

Collection of folders listed by the server.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailOLFolder>* GetFolders();
int SetFolders(CloudMailList<CloudMailOLFolder>* val);

int cloudmail_office365_getfoldercount(void* lpObj);
int cloudmail_office365_setfoldercount(void* lpObj, int iFolderCount);

int cloudmail_office365_getfolderchildfoldercount(void* lpObj, int folderindex);

char* cloudmail_office365_getfolderchildfolders(void* lpObj, int folderindex);

char* cloudmail_office365_getfolderdisplayname(void* lpObj, int folderindex);

char* cloudmail_office365_getfolderid(void* lpObj, int folderindex);

char* cloudmail_office365_getfoldermessagerules(void* lpObj, int folderindex);

char* cloudmail_office365_getfoldermessages(void* lpObj, int folderindex);

char* cloudmail_office365_getfoldermultivalueextendedproperties(void* lpObj, int folderindex);

char* cloudmail_office365_getfolderparentfolderid(void* lpObj, int folderindex);

char* cloudmail_office365_getfoldersinglevalueextendedproperties(void* lpObj, int folderindex);

int cloudmail_office365_getfoldertotalitemcount(void* lpObj, int folderindex);

int cloudmail_office365_getfolderunreaditemcount(void* lpObj, int folderindex);

int GetFolderCount();
int SetFolderCount(int iFolderCount);

int GetFolderChildFolderCount(int iFolderIndex);

QString GetFolderChildFolders(int iFolderIndex);

QString GetFolderDisplayName(int iFolderIndex);

QString GetFolderId(int iFolderIndex);

QString GetFolderMessageRules(int iFolderIndex);

QString GetFolderMessages(int iFolderIndex);

QString GetFolderMultiValueExtendedProperties(int iFolderIndex);

QString GetFolderParentFolderId(int iFolderIndex);

QString GetFolderSingleValueExtendedProperties(int iFolderIndex);

int GetFolderTotalItemCount(int iFolderIndex);

int GetFolderUnreadItemCount(int iFolderIndex);

Remarks

This collection contains a list of folders returned by the server. It is populated when ListFolders or GetFolder is called.

This property is not available at design time.

Data Type

CloudMailOLFolder

ListContactsMarker Property (Office365 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_office365_getlistcontactsmarker(void* lpObj);
int cloudmail_office365_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 an OData parameter if ListContacts is called again on the same folder. This will cause the next page of contacts to be listed and added to the end of the Contacts collection.

Example (List All Contacts in a Folder):

do { office365.ListContacts(folderId); } while (!office365.ListContactsMarker.isEmpty());

This property is not available at design time.

Data Type

String

ListFoldersMarker Property (Office365 Class)

The page marker for listing folders.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetListFoldersMarker();
int SetListFoldersMarker(const char* lpszListFoldersMarker);

Unicode (Windows)
LPWSTR GetListFoldersMarker();
INT SetListFoldersMarker(LPCWSTR lpszListFoldersMarker);

char* cloudmail_office365_getlistfoldersmarker(void* lpObj);
int cloudmail_office365_setlistfoldersmarker(void* lpObj, const char* lpszListFoldersMarker);

QString GetListFoldersMarker();
int SetListFoldersMarker(QString qsListFoldersMarker);

Default Value

""

Remarks

This property is populated if there are still unlisted changes after ListFolders is called. It contains the nextLink that will be included as an OData parameter if ListFolders is called again on the same parent folder. This will cause the next page of folders to be listed.

Example (List All Folders in the Root Directory)

do { office365.ListFolders(""); } while (office365.ListFoldersMarker.Length > 0);

This property is not available at design time.

Data Type

String

ListMessagesMarker Property (Office365 Class)

The page marker for listing messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetListMessagesMarker();
int SetListMessagesMarker(const char* lpszListMessagesMarker);

Unicode (Windows)
LPWSTR GetListMessagesMarker();
INT SetListMessagesMarker(LPCWSTR lpszListMessagesMarker);

char* cloudmail_office365_getlistmessagesmarker(void* lpObj);
int cloudmail_office365_setlistmessagesmarker(void* lpObj, const char* lpszListMessagesMarker);

QString GetListMessagesMarker();
int SetListMessagesMarker(QString qsListMessagesMarker);

Default Value

""

Remarks

This property is populated if there are still unlisted messages after ListMessages is called. It contains the nextLink that will be included as an OData parameter if ListMessages is called again on the same folder. This will cause the next page of messages to be listed.

Example (List All Messages in a Folder)

do { office365.ListMessages(folderId, filter); } while (office365.ListMessagesMarker.Length > 0);

This property is not available at design time.

Data Type

String

Message Property (Office365 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_office365_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 (Office365 Class)

A collection of attachments to add to a message.

Syntax

• C++
• C
• Qt

CloudMailList<CloudMailOLAttachment>* GetMessageAttachments();
int SetMessageAttachments(CloudMailList<CloudMailOLAttachment>* val);

int cloudmail_office365_getmessageattachmentcount(void* lpObj);
int cloudmail_office365_setmessageattachmentcount(void* lpObj, int iMessageAttachmentCount);

char* cloudmail_office365_getmessageattachmentattachmenttype(void* lpObj, int messageattachmentindex);

char* cloudmail_office365_getmessageattachmentcontentid(void* lpObj, int messageattachmentindex);
int cloudmail_office365_setmessageattachmentcontentid(void* lpObj, int messageattachmentindex, const char* lpszMessageAttachmentContentId);

char* cloudmail_office365_getmessageattachmentcontentlocation(void* lpObj, int messageattachmentindex);

char* cloudmail_office365_getmessageattachmentcontenttype(void* lpObj, int messageattachmentindex);

int cloudmail_office365_getmessageattachmentdata(void* lpObj, int messageattachmentindex, char** lpMessageAttachmentData, int* lenMessageAttachmentData);
int cloudmail_office365_setmessageattachmentdata(void* lpObj, int messageattachmentindex, const char* lpMessageAttachmentData, int lenMessageAttachmentData);

char* cloudmail_office365_getmessageattachmentfilename(void* lpObj, int messageattachmentindex);
int cloudmail_office365_setmessageattachmentfilename(void* lpObj, int messageattachmentindex, const char* lpszMessageAttachmentFileName);

char* cloudmail_office365_getmessageattachmentid(void* lpObj, int messageattachmentindex);

int cloudmail_office365_setmessageattachmentinputstream(void* lpObj, int messageattachmentindex, CloudMailStream* sMessageAttachmentInputStream);

int cloudmail_office365_getmessageattachmentisinline(void* lpObj, int messageattachmentindex);
int cloudmail_office365_setmessageattachmentisinline(void* lpObj, int messageattachmentindex, int bMessageAttachmentIsInline);

char* cloudmail_office365_getmessageattachmentlastmodifieddate(void* lpObj, int messageattachmentindex);
int cloudmail_office365_setmessageattachmentlastmodifieddate(void* lpObj, int messageattachmentindex, const char* lpszMessageAttachmentLastModifiedDate);

char* cloudmail_office365_getmessageattachmentname(void* lpObj, int messageattachmentindex);
int cloudmail_office365_setmessageattachmentname(void* lpObj, int messageattachmentindex, const char* lpszMessageAttachmentName);

char* cloudmail_office365_getmessageattachmentparentindex(void* lpObj, int messageattachmentindex);

int cloudmail_office365_getmessageattachmentsize(void* lpObj, int messageattachmentindex);
int cloudmail_office365_setmessageattachmentsize(void* lpObj, int messageattachmentindex, int iMessageAttachmentSize);

int GetMessageAttachmentCount();
int SetMessageAttachmentCount(int iMessageAttachmentCount);

QString GetMessageAttachmentAttachmentType(int iMessageAttachmentIndex);

QString GetMessageAttachmentContentId(int iMessageAttachmentIndex);
int SetMessageAttachmentContentId(int iMessageAttachmentIndex, QString qsMessageAttachmentContentId);

QString GetMessageAttachmentContentLocation(int iMessageAttachmentIndex);

QString GetMessageAttachmentContentType(int iMessageAttachmentIndex);

QByteArray GetMessageAttachmentData(int iMessageAttachmentIndex);
int SetMessageAttachmentData(int iMessageAttachmentIndex, QByteArray qbaMessageAttachmentData);

QString GetMessageAttachmentFileName(int iMessageAttachmentIndex);
int SetMessageAttachmentFileName(int iMessageAttachmentIndex, QString qsMessageAttachmentFileName);

QString GetMessageAttachmentId(int iMessageAttachmentIndex);

int SetMessageAttachmentInputStream(int iMessageAttachmentIndex, CloudMailStream* sMessageAttachmentInputStream);

bool GetMessageAttachmentIsInline(int iMessageAttachmentIndex);
int SetMessageAttachmentIsInline(int iMessageAttachmentIndex, bool bMessageAttachmentIsInline);

QString GetMessageAttachmentLastModifiedDate(int iMessageAttachmentIndex);
int SetMessageAttachmentLastModifiedDate(int iMessageAttachmentIndex, QString qsMessageAttachmentLastModifiedDate);

QString GetMessageAttachmentName(int iMessageAttachmentIndex);
int SetMessageAttachmentName(int iMessageAttachmentIndex, QString qsMessageAttachmentName);

QString GetMessageAttachmentParentIndex(int iMessageAttachmentIndex);

int GetMessageAttachmentSize(int iMessageAttachmentIndex);
int SetMessageAttachmentSize(int iMessageAttachmentIndex, int iMessageAttachmentSize);

Remarks

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

*This applies only to drafts made with the DRAFTTYPE_MESSAGE type. For other types of drafts see AddAttachment.

Example office365.MessageAttachments.Add(new OLAttachment("./text.txt"));

This property is not available at design time.

Data Type

CloudMailOLAttachment

MessageBcc Property (Office365 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_office365_getmessagebcc(void* lpObj);
int cloudmail_office365_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)

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

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

office365.MessageBcc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com"; office365.SendMail(True);

This property is not available at design time.

Data Type

String

MessageBodyContent Property (Office365 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_office365_getmessagebodycontent(void* lpObj);
int cloudmail_office365_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 (Office365 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_office365_getmessagebodycontenttype(void* lpObj);
int cloudmail_office365_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 (Office365 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_office365_getmessagecc(void* lpObj);
int cloudmail_office365_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)

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

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

office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com"; office365.SendMail(True);

This property is not available at design time.

Data Type

String

MessageDeliveryReceipt Property (Office365 Class)

Whether or not a message will request a Delivery Receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageDeliveryReceipt();
int SetMessageDeliveryReceipt(int bMessageDeliveryReceipt);

Unicode (Windows)
BOOL GetMessageDeliveryReceipt();
INT SetMessageDeliveryReceipt(BOOL bMessageDeliveryReceipt);

int cloudmail_office365_getmessagedeliveryreceipt(void* lpObj);
int cloudmail_office365_setmessagedeliveryreceipt(void* lpObj, int bMessageDeliveryReceipt);

bool GetMessageDeliveryReceipt();
int SetMessageDeliveryReceipt(bool bMessageDeliveryReceipt);

Default Value

FALSE

Remarks

This property determines whether or not messages created with CreateDraft or messages sent with SendMail will request a Delivery Receipt.

Data Type

Boolean

MessageFrom Property (Office365 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_office365_getmessagefrom(void* lpObj);
int cloudmail_office365_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 is left blank, the message's author will be the Microsoft account used in Authorization.

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

Example (Specify Message Author)

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

Example (Specify Message Author - Name Included)

office365.MessageFrom = "\"Stephen Withavee\" stephen@company.com"; office365.SendMail(True);

This property is not available at design time.

Data Type

String

MessageImportance Property (Office365 Class)

The importance of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageImportance();
int SetMessageImportance(const char* lpszMessageImportance);

Unicode (Windows)
LPWSTR GetMessageImportance();
INT SetMessageImportance(LPCWSTR lpszMessageImportance);

char* cloudmail_office365_getmessageimportance(void* lpObj);
int cloudmail_office365_setmessageimportance(void* lpObj, const char* lpszMessageImportance);

QString GetMessageImportance();
int SetMessageImportance(QString qsMessageImportance);

Default Value

""

Remarks

This property determines the importance of messages created with CreateDraft or messages sent with SendMail. Valid values are Low, Normal, and High.

This property is not available at design time.

Data Type

String

MessageInfo Property (Office365 Class)

Collection of information about retrieved messages.

Syntax

• C++
• C
• Qt

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

int cloudmail_office365_getmessageinfocount(void* lpObj);
int cloudmail_office365_setmessageinfocount(void* lpObj, int iMessageInfoCount);

char* cloudmail_office365_getmessageinfobcc(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfobcc(void* lpObj, int messageinfoindex, const char* lpszMessageInfoBcc);

char* cloudmail_office365_getmessageinfobodycontent(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfobodycontent(void* lpObj, int messageinfoindex, const char* lpszMessageInfoBodyContent);

char* cloudmail_office365_getmessageinfobodycontenttype(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfobodycontenttype(void* lpObj, int messageinfoindex, const char* lpszMessageInfoBodyContentType);

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

char* cloudmail_office365_getmessageinfocategories(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfocategories(void* lpObj, int messageinfoindex, const char* lpszMessageInfoCategories);

char* cloudmail_office365_getmessageinfocc(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfocc(void* lpObj, int messageinfoindex, const char* lpszMessageInfoCc);

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

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

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

int cloudmail_office365_getmessageinfodeliveryreceiptrequested(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfodeliveryreceiptrequested(void* lpObj, int messageinfoindex, int bMessageInfoDeliveryReceiptRequested);

char* cloudmail_office365_getmessageinfoflagstatus(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfoflagstatus(void* lpObj, int messageinfoindex, const char* lpszMessageInfoFlagStatus);

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

int cloudmail_office365_getmessageinfohasattachments(void* lpObj, int messageinfoindex);

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

char* cloudmail_office365_getmessageinfoimportance(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfoimportance(void* lpObj, int messageinfoindex, const char* lpszMessageInfoImportance);

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

int cloudmail_office365_getmessageinfoisdraft(void* lpObj, int messageinfoindex);

int cloudmail_office365_getmessageinfoisread(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfoisread(void* lpObj, int messageinfoindex, int bMessageInfoIsRead);

char* cloudmail_office365_getmessageinfojson(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfojson(void* lpObj, int messageinfoindex, const char* lpszMessageInfoJSON);

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

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

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

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

int cloudmail_office365_getmessageinforeadreceiptrequested(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinforeadreceiptrequested(void* lpObj, int messageinfoindex, int bMessageInfoReadReceiptRequested);

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

char* cloudmail_office365_getmessageinforeplyto(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinforeplyto(void* lpObj, int messageinfoindex, const char* lpszMessageInfoReplyTo);

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

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

char* cloudmail_office365_getmessageinfosubject(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfosubject(void* lpObj, int messageinfoindex, const char* lpszMessageInfoSubject);

char* cloudmail_office365_getmessageinfoto(void* lpObj, int messageinfoindex);
int cloudmail_office365_setmessageinfoto(void* lpObj, int messageinfoindex, const char* lpszMessageInfoTo);

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

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

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

QString GetMessageInfoBodyContent(int iMessageInfoIndex);
int SetMessageInfoBodyContent(int iMessageInfoIndex, QString qsMessageInfoBodyContent);

QString GetMessageInfoBodyContentType(int iMessageInfoIndex);
int SetMessageInfoBodyContentType(int iMessageInfoIndex, QString qsMessageInfoBodyContentType);

QString GetMessageInfoBodyPreview(int iMessageInfoIndex);

QString GetMessageInfoCategories(int iMessageInfoIndex);
int SetMessageInfoCategories(int iMessageInfoIndex, QString qsMessageInfoCategories);

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

QString GetMessageInfoConversationId(int iMessageInfoIndex);

QString GetMessageInfoConversationIndex(int iMessageInfoIndex);

QString GetMessageInfoCreatedDate(int iMessageInfoIndex);

bool GetMessageInfoDeliveryReceiptRequested(int iMessageInfoIndex);
int SetMessageInfoDeliveryReceiptRequested(int iMessageInfoIndex, bool bMessageInfoDeliveryReceiptRequested);

QString GetMessageInfoFlagStatus(int iMessageInfoIndex);
int SetMessageInfoFlagStatus(int iMessageInfoIndex, QString qsMessageInfoFlagStatus);

QString GetMessageInfoFrom(int iMessageInfoIndex);

bool GetMessageInfoHasAttachments(int iMessageInfoIndex);

QString GetMessageInfoId(int iMessageInfoIndex);

QString GetMessageInfoImportance(int iMessageInfoIndex);
int SetMessageInfoImportance(int iMessageInfoIndex, QString qsMessageInfoImportance);

QString GetMessageInfoInferenceClassification(int iMessageInfoIndex);

bool GetMessageInfoIsDraft(int iMessageInfoIndex);

bool GetMessageInfoIsRead(int iMessageInfoIndex);
int SetMessageInfoIsRead(int iMessageInfoIndex, bool bMessageInfoIsRead);

QString GetMessageInfoJSON(int iMessageInfoIndex);
int SetMessageInfoJSON(int iMessageInfoIndex, QString qsMessageInfoJSON);

QString GetMessageInfoLastModifiedDate(int iMessageInfoIndex);

QString GetMessageInfoMessageHeaders(int iMessageInfoIndex);

QString GetMessageInfoMessageId(int iMessageInfoIndex);

QString GetMessageInfoParentFolderId(int iMessageInfoIndex);

bool GetMessageInfoReadReceiptRequested(int iMessageInfoIndex);
int SetMessageInfoReadReceiptRequested(int iMessageInfoIndex, bool bMessageInfoReadReceiptRequested);

QString GetMessageInfoReceivedDate(int iMessageInfoIndex);

QString GetMessageInfoReplyTo(int iMessageInfoIndex);
int SetMessageInfoReplyTo(int iMessageInfoIndex, QString qsMessageInfoReplyTo);

QString GetMessageInfoSender(int iMessageInfoIndex);

QString GetMessageInfoSentDate(int iMessageInfoIndex);

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

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

QString GetMessageInfoWebLink(int iMessageInfoIndex);

Remarks

This collection contains a list of OLMessageInfo for messages fetched by the server. This property is populated when ListMessages, RetrieveMessage, Search, or ListChanges is called.

This property is not available at design time.

Data Type

CloudMailOLMessageInfo

MessageOtherHeaders Property (Office365 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_office365_getmessageotherheaders(void* lpObj);
int cloudmail_office365_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

MessageReadReceipt Property (Office365 Class)

Whether or not a message will request a Read Receipt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageReadReceipt();
int SetMessageReadReceipt(int bMessageReadReceipt);

Unicode (Windows)
BOOL GetMessageReadReceipt();
INT SetMessageReadReceipt(BOOL bMessageReadReceipt);

int cloudmail_office365_getmessagereadreceipt(void* lpObj);
int cloudmail_office365_setmessagereadreceipt(void* lpObj, int bMessageReadReceipt);

bool GetMessageReadReceipt();
int SetMessageReadReceipt(bool bMessageReadReceipt);

Default Value

FALSE

Remarks

This property determines whether or not messages created with CreateDraft or messages sent with SendMail will request a Read Receipt.

Data Type

Boolean

MessageReplyTo Property (Office365 Class)

A mail address to reply to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageReplyTo();
int SetMessageReplyTo(const char* lpszMessageReplyTo);

Unicode (Windows)
LPWSTR GetMessageReplyTo();
INT SetMessageReplyTo(LPCWSTR lpszMessageReplyTo);

char* cloudmail_office365_getmessagereplyto(void* lpObj);
int cloudmail_office365_setmessagereplyto(void* lpObj, const char* lpszMessageReplyTo);

QString GetMessageReplyTo();
int SetMessageReplyTo(QString qsMessageReplyTo);

Default Value

""

Remarks

This property contains a comma separated list of destinations for the ReplyTo property of a message. This property is optional. This property is useful when replies should be sent to addresses other than those in MessageFrom. These recipients are added to a message created with CreateDraft or messages sent with SendMail.

This property is not available at design time.

Data Type

String

MessageSubject Property (Office365 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_office365_getmessagesubject(void* lpObj);
int cloudmail_office365_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 (Office365 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_office365_getmessageto(void* lpObj);
int cloudmail_office365_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)

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

Example (Add a Recipient with a Name and Address)

office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com"; office365.SendMail(True);

This property is not available at design time.

Data Type

String

NextChangeMarker Property (Office365 Class)

A marker indicating which page of changes to return in the future.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNextChangeMarker();
int SetNextChangeMarker(const char* lpszNextChangeMarker);

Unicode (Windows)
LPWSTR GetNextChangeMarker();
INT SetNextChangeMarker(LPCWSTR lpszNextChangeMarker);

char* cloudmail_office365_getnextchangemarker(void* lpObj);
int cloudmail_office365_setnextchangemarker(void* lpObj, const char* lpszNextChangeMarker);

QString GetNextChangeMarker();
int SetNextChangeMarker(QString qsNextChangeMarker);

Default Value

""

Remarks

This property will be populated when ListChanges is called if there are no more changes to list. Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

OAuth Property (Office365 Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudMailOAuthSettings* GetOAuth();

char* cloudmail_office365_getoauthaccesstoken(void* lpObj);
int cloudmail_office365_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudmail_office365_getoauthauthorizationcode(void* lpObj);
int cloudmail_office365_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudmail_office365_getoauthauthorizationscope(void* lpObj);
int cloudmail_office365_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudmail_office365_getoauthclientid(void* lpObj);
int cloudmail_office365_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudmail_office365_getoauthclientprofile(void* lpObj);
int cloudmail_office365_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudmail_office365_getoauthclientsecret(void* lpObj);
int cloudmail_office365_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudmail_office365_getoauthgranttype(void* lpObj);
int cloudmail_office365_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudmail_office365_getoauthrefreshtoken(void* lpObj);
int cloudmail_office365_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudmail_office365_getoauthrequestrefreshtoken(void* lpObj);
int cloudmail_office365_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudmail_office365_getoauthreturnurl(void* lpObj);
int cloudmail_office365_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudmail_office365_getoauthserverauthurl(void* lpObj);
int cloudmail_office365_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudmail_office365_getoauthservertokenurl(void* lpObj);
int cloudmail_office365_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudmail_office365_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 (Office365 Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

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

int cloudmail_office365_getproxyauthscheme(void* lpObj);
int cloudmail_office365_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudmail_office365_getproxyautodetect(void* lpObj);
int cloudmail_office365_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudmail_office365_getproxypassword(void* lpObj);
int cloudmail_office365_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudmail_office365_getproxyport(void* lpObj);
int cloudmail_office365_setproxyport(void* lpObj, int iProxyPort);

char* cloudmail_office365_getproxyserver(void* lpObj);
int cloudmail_office365_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudmail_office365_getproxyssl(void* lpObj);
int cloudmail_office365_setproxyssl(void* lpObj, int iProxySSL);

char* cloudmail_office365_getproxyuser(void* lpObj);
int cloudmail_office365_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

Select Property (Office365 Class)

The parts of a message that should be retrieved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSelect();
int SetSelect(const char* lpszSelect);

Unicode (Windows)
LPWSTR GetSelect();
INT SetSelect(LPCWSTR lpszSelect);

char* cloudmail_office365_getselect(void* lpObj);
int cloudmail_office365_setselect(void* lpObj, const char* lpszSelect);

QString GetSelect();
int SetSelect(QString qsSelect);

Default Value

""

Remarks

This property can be used to select specific message or attachment properties to retrieve when calling ListMessages RetrieveMessage, ListAttachments, or RetrieveAttachment. Specify the message or attachment properties to be selected as a comma separated list.

When this property is an empty string, all message or attachment properties will be selected.

Messages

Selectable properties for messages include:

Example (Get the Subject and Sender of a Message)

office365.Select = "subject, sender"; office365.GetMessage(messageId);

Attachments

Due to limitations in the OData parameters, item attachments will always contain the entire list of properties.

Selectable properties for attachments include:

Example (Get the Name and Size of an attachment)

office365.Select = "name, size"; office365.ListAttachments(messageId);

This property is not available at design time.

Data Type

String

SSLAcceptServerCert Property (Office365 Class)

This property 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_office365_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudmail_office365_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudmail_office365_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudmail_office365_getsslacceptservercertfingerprint(void* lpObj);

char* cloudmail_office365_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudmail_office365_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudmail_office365_getsslacceptservercertissuer(void* lpObj);

char* cloudmail_office365_getsslacceptservercertprivatekey(void* lpObj);

int cloudmail_office365_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudmail_office365_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudmail_office365_getsslacceptservercertpublickey(void* lpObj);

char* cloudmail_office365_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudmail_office365_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudmail_office365_getsslacceptservercertserialnumber(void* lpObj);

char* cloudmail_office365_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudmail_office365_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudmail_office365_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudmail_office365_getsslacceptservercertstorepassword(void* lpObj);
int cloudmail_office365_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudmail_office365_getsslacceptservercertstoretype(void* lpObj);
int cloudmail_office365_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudmail_office365_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudmail_office365_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudmail_office365_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudmail_office365_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudmail_office365_getsslacceptservercertusage(void* lpObj);

int cloudmail_office365_getsslacceptservercertusageflags(void* lpObj);

char* cloudmail_office365_getsslacceptservercertversion(void* lpObj);

char* cloudmail_office365_getsslacceptservercertsubject(void* lpObj);
int cloudmail_office365_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudmail_office365_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudmail_office365_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 (Office365 Class)

This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

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

char* cloudmail_office365_getsslcerteffectivedate(void* lpObj);

char* cloudmail_office365_getsslcertexpirationdate(void* lpObj);

char* cloudmail_office365_getsslcertextendedkeyusage(void* lpObj);

char* cloudmail_office365_getsslcertfingerprint(void* lpObj);

char* cloudmail_office365_getsslcertfingerprintsha1(void* lpObj);

char* cloudmail_office365_getsslcertfingerprintsha256(void* lpObj);

char* cloudmail_office365_getsslcertissuer(void* lpObj);

char* cloudmail_office365_getsslcertprivatekey(void* lpObj);

int cloudmail_office365_getsslcertprivatekeyavailable(void* lpObj);

char* cloudmail_office365_getsslcertprivatekeycontainer(void* lpObj);

char* cloudmail_office365_getsslcertpublickey(void* lpObj);

char* cloudmail_office365_getsslcertpublickeyalgorithm(void* lpObj);

int cloudmail_office365_getsslcertpublickeylength(void* lpObj);

char* cloudmail_office365_getsslcertserialnumber(void* lpObj);

char* cloudmail_office365_getsslcertsignaturealgorithm(void* lpObj);

int cloudmail_office365_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudmail_office365_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudmail_office365_getsslcertstorepassword(void* lpObj);
int cloudmail_office365_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudmail_office365_getsslcertstoretype(void* lpObj);
int cloudmail_office365_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudmail_office365_getsslcertsubjectaltnames(void* lpObj);

char* cloudmail_office365_getsslcertthumbprintmd5(void* lpObj);

char* cloudmail_office365_getsslcertthumbprintsha1(void* lpObj);

char* cloudmail_office365_getsslcertthumbprintsha256(void* lpObj);

char* cloudmail_office365_getsslcertusage(void* lpObj);

int cloudmail_office365_getsslcertusageflags(void* lpObj);

char* cloudmail_office365_getsslcertversion(void* lpObj);

char* cloudmail_office365_getsslcertsubject(void* lpObj);
int cloudmail_office365_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudmail_office365_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudmail_office365_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 (Office365 Class)

This property specifies 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_office365_getsslprovider(void* lpObj);
int cloudmail_office365_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 (Office365 Class)

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

Syntax

• C++
• C
• Qt

CloudMailCertificate* GetSSLServerCert();

char* cloudmail_office365_getsslservercerteffectivedate(void* lpObj);

char* cloudmail_office365_getsslservercertexpirationdate(void* lpObj);

char* cloudmail_office365_getsslservercertextendedkeyusage(void* lpObj);

char* cloudmail_office365_getsslservercertfingerprint(void* lpObj);

char* cloudmail_office365_getsslservercertfingerprintsha1(void* lpObj);

char* cloudmail_office365_getsslservercertfingerprintsha256(void* lpObj);

char* cloudmail_office365_getsslservercertissuer(void* lpObj);

char* cloudmail_office365_getsslservercertprivatekey(void* lpObj);

int cloudmail_office365_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudmail_office365_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudmail_office365_getsslservercertpublickey(void* lpObj);

char* cloudmail_office365_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudmail_office365_getsslservercertpublickeylength(void* lpObj);

char* cloudmail_office365_getsslservercertserialnumber(void* lpObj);

char* cloudmail_office365_getsslservercertsignaturealgorithm(void* lpObj);

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

char* cloudmail_office365_getsslservercertstorepassword(void* lpObj);

int cloudmail_office365_getsslservercertstoretype(void* lpObj);

char* cloudmail_office365_getsslservercertsubjectaltnames(void* lpObj);

char* cloudmail_office365_getsslservercertthumbprintmd5(void* lpObj);

char* cloudmail_office365_getsslservercertthumbprintsha1(void* lpObj);

char* cloudmail_office365_getsslservercertthumbprintsha256(void* lpObj);

char* cloudmail_office365_getsslservercertusage(void* lpObj);

int cloudmail_office365_getsslservercertusageflags(void* lpObj);

char* cloudmail_office365_getsslservercertversion(void* lpObj);

char* cloudmail_office365_getsslservercertsubject(void* lpObj);

int cloudmail_office365_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

SSLServerCert 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

AddAttachment Method (Office365 Class)

Adds a file attachment to an existing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddAttachment(const char* lpszMessageId, const char* lpszName, const char* lpszLocalFile);

Unicode (Windows)
INT AddAttachment(LPCWSTR lpszMessageId, LPCWSTR lpszName, LPCWSTR lpszLocalFile);

int cloudmail_office365_addattachment(void* lpObj, const char* lpszMessageId, const char* lpszName, const char* lpszLocalFile);

int AddAttachment(const QString& qsMessageId, const QString& qsName, const QString& qsLocalFile);

Remarks

This method adds a file attachment to an existing message, specified by the MessageId parameter. To add a more complex attachment, set the Name and LocalFile parameters and the class will use the first attachment in the MessageAttachments properties. As a note, this will not clear the MessageAttachments properties. If the file is larger than the value set in the AttachmentSimpleUploadLimit configuration, then the class will use an upload session to upload the attachment in fragments. The size of the fragments are specified in the AttachmentFragmentSize configuration.

This method is not used to add attachments to messages that are sent with the SendMail method.

Example (Adding a Simple Attachment to a New Draft)

office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip"); Example (Adding a Simple Attachment to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "html"; office365.MessageBodyContent = "<p>Body</p><img src='cid:test1'>"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip"); Example (Adding a Complex Attachment to a New Draft) office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); office365.CreateDraft(0,""); office365.SetMessageAttachmentCount(1); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); office365.AddAttachment(office365.GetMessageInfoId(0), "", ""); office365.SendDraft(office365.GetMessageInfoId(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.)

AddItemAttachment Method (Office365 Class)

Adds an item attachment to an existing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddItemAttachment(const char* lpszMessageId, const char* lpszmsgToAttachId, const char* lpszItemJSON);

Unicode (Windows)
INT AddItemAttachment(LPCWSTR lpszMessageId, LPCWSTR lpszmsgToAttachId, LPCWSTR lpszItemJSON);

int cloudmail_office365_additemattachment(void* lpObj, const char* lpszMessageId, const char* lpszmsgToAttachId, const char* lpszItemJSON);

int AddItemAttachment(const QString& qsMessageId, const QString& qsmsgToAttachId, const QString& qsItemJSON);

Remarks

Adds an item attachment to an existing message, specified by the MessageId parameter. Item attachments are non-file attachments, such as Outlook messages, events, and contacts. To add another message as an attachment, set the msgToAttachId parameter to its ID. To add an event or contact as an attachment, leave the msgToAttachId parameter empty and provide the full JSON.

This method is not used to add attachments to messages that are sent with the SendMail method.

Example (Adding an Existing Message to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "text"; office365.MessageBodyContent = "Body"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddItemAttachment(messageId, "AAMkADNkNJp5JVnQIe9r0=", ""); Example (Adding an Event to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "text"; office365.MessageBodyContent = "Body"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddItemAttachment(messageId, "", "{\"@odata.type\": \"#microsoft.graph.itemAttachment\", \"name\": \"Holiday event\", \"item\":{ \"@odata.type\": \"microsoft.graph.event\", \"subject\": \"Discuss gifts for children\", \"body\":{ \"content\": \"Let's look for funding!\"}, \"start\": {\"dateTime\": \"2016-12-02T18:00:00\"}, \"end\": {\"dateTime\": \"2016-12-02T19:00:00\"}}}");

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 (Office365 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_office365_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 (Office365 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_office365_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.

Copy Method (Office365 Class)

Creates a copy of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Copy(const char* lpszid, const char* lpszdestinationId);

Unicode (Windows)
INT Copy(LPCWSTR lpszid, LPCWSTR lpszdestinationId);

int cloudmail_office365_copy(void* lpObj, const char* lpszid, const char* lpszdestinationId);

int Copy(const QString& qsid, const QString& qsdestinationId);

Remarks

This method copies a message to a folder. id takes the ID of the message to be copied, and destinationId takes the ID of the folder the message will be copied to.

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

CopyFolder Method (Office365 Class)

Copies a folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CopyFolder(const char* lpszid, const char* lpszdestFolderID);

Unicode (Windows)
INT CopyFolder(LPCWSTR lpszid, LPCWSTR lpszdestFolderID);

int cloudmail_office365_copyfolder(void* lpObj, const char* lpszid, const char* lpszdestFolderID);

int CopyFolder(const QString& qsid, const QString& qsdestFolderID);

Remarks

This method copies a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder. Since this method does not change the name of a folder, it is not possible to directly create a copy of a folder in the original folder's location.

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

CreateCategory Method (Office365 Class)

Creates a new category.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateCategory(const char* lpszDisplayName, const char* lpszColor);

Unicode (Windows)
INT CreateCategory(LPCWSTR lpszDisplayName, LPCWSTR lpszColor);

int cloudmail_office365_createcategory(void* lpObj, const char* lpszDisplayName, const char* lpszColor);

int CreateCategory(const QString& qsDisplayName, const QString& qsColor);

Remarks

This method creates a new Office365 category. The created category is added to the end of the Categories properties.

Example

office365.CreateCategory(categoryName, "preset9");

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

Creates a contact.

Syntax

• C++
• C
• Qt

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

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

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

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

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 contact is added to the parent folder specified by ParentId. Set ParentId to empty string or null to create the contact in the default Contacts folder of the signed-in user. 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 Default Contacts Folder of the User)

office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Create the contact in the main contacts folder.

Example (Create a Contact in a Folder)

office365.ListContactFolders(""); //This method lists all contact folders in the root folder and populates the ContactFolder collection. office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", office365.ContactFolders[0].Id); // Created the contact in the first folder in the ContactFolders collection.

Note that additional operations on a newly created contact may not be successful if performed immediately after creation. It is recommended to wait two or more second after creation before attempting further operations on the contact resource.

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

Creates a new email draft.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateDraft(int iDraftType, const char* lpszid);

Unicode (Windows)
INT CreateDraft(INT iDraftType, LPCWSTR lpszid);

int cloudmail_office365_createdraft(void* lpObj, int iDraftType, const char* lpszid);

int CreateDraft(int iDraftType, const QString& qsid);

Remarks

This method creates a new draft in the Drafts folder. The created message's information, including the draft's message id, is also added to the MessageInfo properties. As a note, this will not clear the properties but will add it to the end.

Valid values for DraftType :

Important Notes

When using DRAFTTYPE_MESSAGE, pass in an empty string as the id. The created draft will be built using the Message* properties (i.e. MessageTo, MessageSubject, MessageFrom, etc.).

When using DRAFTTYPE_REPLY, DRAFTTYPE_REPLYALL, or DRAFTTYPE_FORWARD the id parameter can be used to specify the message that is being replied to or forwarded. Also, the created draft will NOT be built with the Message* properties. Instead, the created draft will be empty (except for the From field). The Update method can be used instead to fill in the different parts of the message.

Example (New Draft)

// Create a draft message office365.MessageSubject = "Subject Text"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); office365.SendDraft(office365.MessageInfo[0].Id); Example (Reply)

// Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, originalMessageId); // Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; // Update the draft office365.Update(office365.MessageInfo[0].Id); // Send the draft office365.SendDraft(office365.MessageInfo[0].Id);

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

CreateFolder Method (Office365 Class)

Creates a new folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateFolder(const char* lpszfolderName, const char* lpszparentFolderId);

Unicode (Windows)
INT CreateFolder(LPCWSTR lpszfolderName, LPCWSTR lpszparentFolderId);

int cloudmail_office365_createfolder(void* lpObj, const char* lpszfolderName, const char* lpszparentFolderId);

int CreateFolder(const QString& qsfolderName, const QString& qsparentFolderId);

Remarks

This method creates a new folder. To create a folder in the root directory set parentFolderId to an empty string.

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

Deletes a message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Delete(LPCWSTR lpszid);

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

int Delete(const QString& qsid);

Remarks

This method is used to delete both drafts and messages in other folders. Deleted messages will be moved to the Deleted folder. id takes the message ID of the message to be deleted. This will not remove the message from the 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.)

DeleteAttachment Method (Office365 Class)

Deletes an attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteAttachment(const char* lpszid, const char* lpszattachmentId);

Unicode (Windows)
INT DeleteAttachment(LPCWSTR lpszid, LPCWSTR lpszattachmentId);

int cloudmail_office365_deleteattachment(void* lpObj, const char* lpszid, const char* lpszattachmentId);

int DeleteAttachment(const QString& qsid, const QString& qsattachmentId);

Remarks

This method deletes an attachment. id takes the ID of the message the attachment is attached to. attachmentId takes the attachment ID of an existing attachment. This will not delete the attachment from the Attachments 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.)

DeleteCategory Method (Office365 Class)

Deletes a mail category.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT DeleteCategory(LPCWSTR lpszid);

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

int DeleteCategory(const QString& qsid);

Remarks

This method deletes a mail category from the current mailbox. This method will not update the Categories 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.)

DeleteContact Method (Office365 Class)

Deletes a contact.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT DeleteContact(LPCWSTR lpszid);

int cloudmail_office365_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" office365.ListContacts("folder_id"); for (int i = 0; i < office365.Contacts.Count; i++) { if (office365.Contacts[i].DisplayName == "John Doe") { //Delete the contact office365.DeleteContact(office365.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.)

DeleteFolder Method (Office365 Class)

Deletes a folder.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT DeleteFolder(LPCWSTR lpszid);

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

int DeleteFolder(const QString& qsid);

Remarks

This method deletes a folder from the current mailbox. id takes the ID of an existing folder. This method will not update the Folders 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.)

Forward Method (Office365 Class)

Forward a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Forward(const char* lpszid, const char* lpszmessageHTML, const char* lpsztoRecipients);

Unicode (Windows)
INT Forward(LPCWSTR lpszid, LPCWSTR lpszmessageHTML, LPCWSTR lpsztoRecipients);

int cloudmail_office365_forward(void* lpObj, const char* lpszid, const char* lpszmessageHTML, const char* lpsztoRecipients);

int Forward(const QString& qsid, const QString& qsmessageHTML, const QString& qstoRecipients);

Remarks

This method can be used to quickly forward a message specified by id to the recipients specified by toRecipients. The toRecipients parameter accepts a comma separated list of emails to forward the message to. The messageHTML parameter is the message body to include with the forward. If messageHTML is an empty string, then the following properties are used:

Example (Simple):

office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");

Example (Advanced):

office365.MessageSubject = "Subject for the reply"; office365.MessageImportance = "Low"; office365.MessageCc = "Example@email.com"; office365.MessageBcc = "Example@email.com"; office365.MessageBodyContent = "Reply Message body"; office365.Forward(messageId, "", "example@email.com, exampletwo@email.com"); This method forwards a message specified by id. toRecipients accepts a comma separated list of emails to forward the message to.

Example (Forwarding a Message to Two Addresses)

office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");

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

GetCategory Method (Office365 Class)

Retrieves a mail category.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetCategory(LPCWSTR lpszid);

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

int GetCategory(const QString& qsid);

Remarks

This method retrieves a mail category.

The fetched category can be accessed through the Categories properties. As a note, the class does not clear the properties and will append the category to the end of it.

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 (Office365 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_office365_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 office365.GetContact(contactId); // Access the retrieved contact var retrievedContact = office365.Contacts[office365.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 office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name 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 (Office365 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_office365_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)

office365.GetContact("ContactId"); office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/homePhones/[1]"); //first home phone number of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/businessPhones/[2]"); //second business phone number of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/postalCode"); //postal code of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/street"); //street name 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.

GetFolder Method (Office365 Class)

Retrieves a folder.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetFolder(LPCWSTR lpszid);

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

int GetFolder(const QString& qsid);

Remarks

This method retrieves a folder.

The fetched folder can be accessed through the Folders properties. As a note, the class does not clear the properties and will append the folder to the end of it.

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

Interrupt Method (Office365 Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

ListAttachments Method (Office365 Class)

Lists all of a message's attachments.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ListAttachments(LPCWSTR lpszid);

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

int ListAttachments(const QString& qsid);

Remarks

This method lists all of a message's attachments. This method clears and populates the Attachments properties. If the RequestNestedItemAttachments configuration setting is set to true (default false), the method will also list any nested attachments found within item attachments. //List messages with attachments office365.ListMessage("inbox", "hasAttachments eq true"); //List attachments of the first message office365.ListAttachments(office365.MessageInfo[0].Id);

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

ListCategories Method (Office365 Class)

Lists all mail categories.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListCategories();

Unicode (Windows)
INT ListCategories();

int cloudmail_office365_listcategories(void* lpObj);

int ListCategories();

Remarks

This method lists all of the mail categories in the current mailbox. This method clears and populates the Categories 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.)

ListChanges Method (Office365 Class)

Lists messages that have been changed within a specified folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListChanges(const char* lpszid, int imaxPageSize);

Unicode (Windows)
INT ListChanges(LPCWSTR lpszid, INT imaxPageSize);

int cloudmail_office365_listchanges(void* lpObj, const char* lpszid, int imaxPageSize);

int ListChanges(const QString& qsid, int imaxPageSize);

Remarks

This method lists changed messages within the folder specified by id.

Starting from a Baseline State

For most use-cases, it is necessary to obtain a baseline state first in order to only list messages that have been changed after the baseline state was established.

To obtain a baseline state, ensure that both ChangeMarker and NextChangeMarker are empty, and then call ListChanges. Then follow the process described in the "General Usage" section (below) until ChangeMarker is empty to list all the changed messages.

General Usage

When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the MessageList event to fire once for each change, and will also populate the MessageInfo properties.

If there are still more messages available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the MessageInfo properties (Once there aren't any more changed messages available to list, the NextChangeMarker property will be populated instead).

When NextChangeMarker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)

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

ListContactFolders Method (Office365 Class)

Lists the contact folders found in the parent folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListContactFolders(const char* lpszparentFolderId);

Unicode (Windows)
INT ListContactFolders(LPCWSTR lpszparentFolderId);

int cloudmail_office365_listcontactfolders(void* lpObj, const char* lpszparentFolderId);

int ListContactFolders(const QString& qsparentFolderId);

Remarks

This method retrieves and lists the contact folders within the specified parent folder. It clears and then populates the ContactFolders collection with the retrieved folders.

To list all contact folders in the root folder, set the parentFolderId parameter to an empty string.

Example (List All Contact Folders in the Root Folder):

office365.ListContactFolders(""); // List root folders. foreach(OLContactFolder folder in office365.ContactFolders){ folder.Id; // Folder id folder.Name; // Folder name folder.ParentFolderId; // Folder parent id } Example (List all Contact Sub Folders in a Folder):

office365.ListContactFolders(""); office365.ListContactFolders(office365.ContactFolders[0].Id); //List the sub folders of the first root folder. office365.ContactFolders[0]; // The first sub folder of the first root folder.

If the number of contact folders exceeds the page size, the ListContactFoldersMarker config value will be populated. You can call ListContactFolders again to retrieve the next page of folders. These folders will be added to the end of the ContactFolders collection.

Example (List All Contact Folders Pages in the Root Folder):

do{ office365.ListContactFolders(""); // List root folders. } while (!office365.Config("ListContactFoldersMarker").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 (Office365 Class)

Lists the contacts in a folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListContacts(const char* lpszfolderId);

Unicode (Windows)
INT ListContacts(LPCWSTR lpszfolderId);

int cloudmail_office365_listcontacts(void* lpObj, const char* lpszfolderId);

int ListContacts(const QString& qsfolderId);

Remarks

This method retrieves and lists the contacts within the specified folder. It clears and then populates the Contacts collection with the retrieved contacts. Providing an empty string as folderId retrieves the contacts from the default Contacts folder of the signed-in user.

Example (List All Contacts in a Folder) office365.ListContactFolders(""); // List root folders (no need to do this if you already have a Folder Id) office365.ListContacts(office365.ContactFolders[0].Id); //Lists contacts

Example (List all Contacts in the default Contacts folder): office365.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 Pages in the default Contacts folder): do{ office365.ListContacts(""); } while(!office365.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.)

ListFolders Method (Office365 Class)

Lists the folders found in the parent folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListFolders(const char* lpszparentFolderId);

Unicode (Windows)
INT ListFolders(LPCWSTR lpszparentFolderId);

int cloudmail_office365_listfolders(void* lpObj, const char* lpszparentFolderId);

int ListFolders(const QString& qsparentFolderId);

Remarks

This method lists the folders found in the parent folder. This method clears populates the Folders properties.

Set parentFolderId to be an empty string to list all folders in the root folder.

If the number of folders is greater than the folder page size, ListFoldersMarker will be populated and calling ListFolders again will list the next page of folders.

Example (List All Folders in the Root Folder)

office365.ListFolders("");

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

Lists the messages in a folder.

Syntax

• C++
• C
• Qt

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

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

int cloudmail_office365_listmessages(void* lpObj, const char* lpszfolderId, const char* lpszfilter);

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

Remarks

This method lists the messages found in the specified folder. This method clears and populates the MessageInfo properties.

If the number of messages is greater than the message page size, ListMessagesMarker 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 folder. filter follows the OData protocol syntax.

Example (List All Messages in a Folder)

office365.ListMessages(folderId, "");

Example (List Unread Messages in a Folder)

office365.ListMessages(folderId, "isRead eq false");

Example (List Messages from a Specific Address)

office365.ListMessages(folderId, "from/emailAddress/address eq 'specific@address.com'");

Example (List Unread Messages from a Specific Address)

office365.ListMessages(folderId, "isRead eq false and from/emailAddress/address eq 'specific@address.com'");

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

MoveFolder Method (Office365 Class)

Moves a folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveFolder(const char* lpszid, const char* lpszdestFolderId);

Unicode (Windows)
INT MoveFolder(LPCWSTR lpszid, LPCWSTR lpszdestFolderId);

int cloudmail_office365_movefolder(void* lpObj, const char* lpszid, const char* lpszdestFolderId);

int MoveFolder(const QString& qsid, const QString& qsdestFolderId);

Remarks

This method moves a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder.

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

MoveMessage Method (Office365 Class)

Moves a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveMessage(const char* lpszid, const char* lpszdestinationId);

Unicode (Windows)
INT MoveMessage(LPCWSTR lpszid, LPCWSTR lpszdestinationId);

int cloudmail_office365_movemessage(void* lpObj, const char* lpszid, const char* lpszdestinationId);

int MoveMessage(const QString& qsid, const QString& qsdestinationId);

Remarks

This method moves a message. destinationId refers to the folder ID where the message will be moved to.

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

RenameFolder Method (Office365 Class)

Renames a folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RenameFolder(const char* lpszfolderId, const char* lpsznewName);

Unicode (Windows)
INT RenameFolder(LPCWSTR lpszfolderId, LPCWSTR lpsznewName);

int cloudmail_office365_renamefolder(void* lpObj, const char* lpszfolderId, const char* lpsznewName);

int RenameFolder(const QString& qsfolderId, const QString& qsnewName);

Remarks

This method renames a folder. This method will not update the Folders 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.)

Reply Method (Office365 Class)

Reply to a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reply(const char* lpszid, const char* lpszmessageHTML);

Unicode (Windows)
INT Reply(LPCWSTR lpszid, LPCWSTR lpszmessageHTML);

int cloudmail_office365_reply(void* lpObj, const char* lpszid, const char* lpszmessageHTML);

int Reply(const QString& qsid, const QString& qsmessageHTML);

Remarks

This method can be used to quickly reply to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:

Example (Simple):

office365.ReplyAll(messageId, "Reply messageHTML");

Example (Advanced):

office365.MessageSubject = "Subject for the reply"; office365.MessageImportance = "Low"; office365.MessageCc = "Example@email.com"; office365.MessageBcc = "Example@email.com"; office365.MessageBodyContent = "Reply Message body"; office365.ReplyAll(messageId, "");

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

ReplyAll Method (Office365 Class)

ReplyAll to a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReplyAll(const char* lpszid, const char* lpszmessageHTML);

Unicode (Windows)
INT ReplyAll(LPCWSTR lpszid, LPCWSTR lpszmessageHTML);

int cloudmail_office365_replyall(void* lpObj, const char* lpszid, const char* lpszmessageHTML);

int ReplyAll(const QString& qsid, const QString& qsmessageHTML);

Remarks

This method can be used to quickly reply all to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:

Example (Simple):

office365.ReplyAll(messageId, "ReplyAll messageHTML");

Example (Advanced):

office365.MessageSubject = "Subject for the reply"; office365.MessageImportance = "Low"; office365.MessageCc = "Example@email.com"; office365.MessageBcc = "Example@email.com"; office365.MessageBodyContent = "Reply Message body"; office365.ReplyAll(messageId, "");

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

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

RetrieveAttachment Method (Office365 Class)

Retrieves a message attachment.

Syntax

• C++
• C
• Qt

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

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

int cloudmail_office365_retrieveattachment(void* lpObj, const char* lpszid, const char* lpszattachmentId);

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

Remarks

This method retrieves an attachment. id specifies the message ID for the message the attachment is attached to.

The fetched attachment can be accessed through the Attachments properties. If the RequestNestedItemAttachments configuration setting is set to true (default false) and the attachment to be retrieved is an item attachment, the method will provide any nested attachments as well.

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

Retrieves a message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT RetrieveMessage(LPCWSTR lpszid);

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

int RetrieveMessage(const QString& qsid);

Remarks

This method retrieves a message.

Information about the retrieved message can be accessed through the 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 (Office365 Class)

Retrieves the raw message of the specified message ID.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT RetrieveMessageRaw(LPCWSTR lpszid);

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

int RetrieveMessageRaw(const QString& qsid);

Remarks

This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the Message 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.)

Search Method (Office365 Class)

Search for messages.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Search(LPCWSTR lpszsearchKey);

int cloudmail_office365_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 (Office365 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_office365_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 (Office365 Class)

Sends an existing draft.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendDraft(LPCWSTR lpszid);

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

int SendDraft(const QString& qsid);

Remarks

This method sends an existing draft. The id parameter takes the ID of the draft that is going to be sent. To create a draft see the CreateDraft method. As a note, the relevant properties are not cleared after the method is called. It is recommend to do so after calling this method.

Example (New Draft)

//Create a draft message office365.MessageSubject = "Subject Text"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); office365.SendDraft(office365.MessageInfo[0].Id); Example (Reply)

// Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, originalMessageId); // Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; // Update the draft office365.Update(office365.MessageInfo[0].Id); // Send the draft office365.SendDraft(office365.MessageInfo[0].Id); Example (HTML with Attachments) office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); office365.CreateDraft(0,""); office365.SetMessageAttachmentCount(1); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); office365.AddAttachment(office365.GetMessageInfoId(0), "", ""); office365.SendDraft(office365.GetMessageInfoId(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.)

SendMail Method (Office365 Class)

Sends a new email.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendMail(int bsaveToSentItems);

Unicode (Windows)
INT SendMail(BOOL bsaveToSentItems);

int cloudmail_office365_sendmail(void* lpObj, int bsaveToSentItems);

int SendMail(bool bsaveToSentItems);

Remarks

This method sends a new message. Use the Message* (excluding MessageInfo properties and Message) to set the fields of the message that will be sent. To add an attachment, use the MessageAttachments properties to add the attachment information. As a note, the relevant properties are not cleared after the method is called. It is recommend to do so after calling this method.

Example: Simple Email

office365.MessageSubject = "I saw a Tree"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked."; office365.MessageTo = "TreeLookOut@gmail.com"; office365.SendMail(True); Example: HTML email with Attachments office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); //Set up attachments //Inline: office365.SetMessageAttachmentCount(2); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentName(0, "test picture"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); //Normal office365.SetMessageAttachmentFile(1, "./test.txt"); office365.SetMessageAttachmentName(1, "test file"); office365.SendMail(true);

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

SetAttachmentInStream Method (Office365 Class)

Sets an attachment using a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetAttachmentInStream(int iIndex, CloudMailStream* sInputStream);

Unicode (Windows)
INT SetAttachmentInStream(INT iIndex, CloudMailStream* sInputStream);

int cloudmail_office365_setattachmentinstream(void* lpObj, int iIndex, CloudMailStream* sInputStream);

int SetAttachmentInStream(int iIndex, CloudMailStream* sInputStream);

Remarks

This method allows for setting an attachment in the MessageAttachments properties through a stream using the InputStream parameter. The Index parameter specifies which attachment in the MessageAttachments properties the stream will affect.

Note: When multiple attachment sources are provided, the class prioritizes the input stream first, followed by the file path and finally the raw data.

Example (Adding an Attachment via Input Stream to a New Draft)

office365.MessageSubject = "Subject Text"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.MessageAttachments.Add(new OLAttachment("attachment1.txt")); office365.SetAttachmentInStream(0, new FileStream("C:\attachment1.txt", FileMode.Open)); office365.AddAttachment(messageId, "", ""); office365.SendDraft(messageId); Example (Adding an Attachment via Input Stream to a Message)

office365.MessageSubject = "I saw a Tree"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked."; office365.MessageTo = "TreeLookOut@gmail.com"; office365.MessageAttachments.Add(new OLAttachment("attachment1.txt")); office365.SetAttachmentInStream(0, new FileStream("C:\attachment1.txt", FileMode.Open)); office365.SendMail(true);

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

Sets the contact field 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_office365_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): // Create a contact in the main contacts folder. office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Set company name office365.SetContactField(0, "/json/companyName", "nsoftware", 2); // 2 (String) // Set home address office365.SetContactField(0, "/json/businessAddress", "{ \"city\": \"string\", \"countryOrRegion\": \"string\", \"postalCode\": \"string\", \"state\": \"string\", \"street\": \"string\" }", 0); // 0 (Object) office365.SetContactField(0, "/json/emailAddresses", "[{"name": "Garth", "address": "garth@contoso.com"}, {"name": "Garth", "address": "garth1@contoso.com"}]", 1); // 1 (Array) // Update the contact office365.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.)

Update Method (Office365 Class)

Updates a message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Update(LPCWSTR lpszid);

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

int Update(const QString& qsid);

Remarks

This property updates a message that has been edited in the MessageInfo properties. The id takes the message's ID that should be updated. The following values can be updated from the OLMessageInfo type:

*Changing the JSON data will change the message as a whole.

Example (Reply Draft)

// Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, originalMessageId); // Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; // Update the draft office365.Update(office365.MessageInfo[0].Id); // Send the draft office365.SendDraft(office365.MessageInfo[0].Id);

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

UpdateCategory Method (Office365 Class)

Updates a category.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateCategory(const char* lpszid, const char* lpszcolor);

Unicode (Windows)
INT UpdateCategory(LPCWSTR lpszid, LPCWSTR lpszcolor);

int cloudmail_office365_updatecategory(void* lpObj, const char* lpszid, const char* lpszcolor);

int UpdateCategory(const QString& qsid, const QString& qscolor);

Remarks

This method changes an existing category's color. This method will not update the Categories 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.)

UpdateContact Method (Office365 Class)

Updates a contact.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT UpdateContact(INT iindex);

int cloudmail_office365_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.

Example: office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");// Create a contact in the main contacts folder. // Set a company name office365.Contacts[0].CompanyName = "Volkswagen"; // Set notes office365.Contacts[0].Notes = "testNotes"; // Set multiple phone numbers office365.Contacts[0].PhonesCount = 2; office365.Contacts[0].PhoneIndex = 0; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptMobile; office365.Contacts[0].PhoneNumber = "0123456789"; office365.Contacts[0].PhoneIndex = 1; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptBusiness; office365.Contacts[0].PhoneNumber = "9876543210"; // Set birthday office365.SetContactField(0, "/json/birthday", "2024-05-21", 2); // The last argument is the type of the field. 2 (String) // Set home address office365.SetContactField(0, "/json/businessAddress", "{ \"city\": \"string\", \"countryOrRegion\": \"string\", \"postalCode\": \"string\", \"state\": \"string\", \"street\": \"string\" }", 0); // The last argument is the type of the field. 0 (Object) // Update the contact office365.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.)

AttachmentList Event (Office365 Class)

Fired when an attachment is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAttachmentList(Office365AttachmentListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  const char *ContentType;
  const char *ContentLocation;
  const char *ContentBytes;
  int lenContentBytes;
  const char *ContentId;
  const char *LastModifiedDateTime;
  int IsInline;
  int Size;
  int reserved;
} Office365AttachmentListEventParams;


Unicode (Windows)
virtual INT FireAttachmentList(Office365AttachmentListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  LPCWSTR ContentType;
  LPCWSTR ContentLocation;
  LPCSTR ContentBytes;
  INT lenContentBytes;
  LPCWSTR ContentId;
  LPCWSTR LastModifiedDateTime;
  BOOL IsInline;
  INT Size;
  INT reserved;
} Office365AttachmentListEventParams;

#define EID_OFFICE365_ATTACHMENTLIST 1

virtual INT CLOUDMAIL_CALL FireAttachmentList(LPSTR &lpszId, LPSTR &lpszName, LPSTR &lpszContentType, LPSTR &lpszContentLocation, LPSTR &lpContentBytes, INT &lenContentBytes, LPSTR &lpszContentId, LPSTR &lpszLastModifiedDateTime, BOOL &bIsInline, INT &iSize);

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

  const QString &Name();

  const QString &ContentType();

  const QString &ContentLocation();

  const QByteArray &ContentBytes();

  const QString &ContentId();

  const QString &LastModifiedDateTime();

  bool IsInline();

  int Size();

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

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

// Or, subclass Office365 and override this emitter function.
virtual int FireAttachmentList(Office365AttachmentListEventParams *e) {...}

Remarks

The AttachmentList event is fired for each attachment retrieved from the server when ListAttachments is called.

CategoryList Event (Office365 Class)

Fired when an attachment is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCategoryList(Office365CategoryListEventParams *e);

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


Unicode (Windows)
virtual INT FireCategoryList(Office365CategoryListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR DisplayName;
  LPCWSTR Color;
  INT reserved;
} Office365CategoryListEventParams;

#define EID_OFFICE365_CATEGORYLIST 2

virtual INT CLOUDMAIL_CALL FireCategoryList(LPSTR &lpszId, LPSTR &lpszDisplayName, LPSTR &lpszColor);

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

  const QString &DisplayName();

  const QString &Color();

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

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

// Or, subclass Office365 and override this emitter function.
virtual int FireCategoryList(Office365CategoryListEventParams *e) {...}

Remarks

The CategoryList event is fired for each attachment retrieved from the server when ListCategories is called.

ContactFolderList Event (Office365 Class)

Fired when a contact folder is retrieved by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireContactFolderList(Office365ContactFolderListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  const char *ParentFolderId;
  int reserved;
} Office365ContactFolderListEventParams;


Unicode (Windows)
virtual INT FireContactFolderList(Office365ContactFolderListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  LPCWSTR ParentFolderId;
  INT reserved;
} Office365ContactFolderListEventParams;