Office365 Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudMail_Office365

Procedural Interface

 cloudmail_office365_open();
 cloudmail_office365_close($res);
 cloudmail_office365_register_callback($res, $id, $function);
 cloudmail_office365_get_last_error($res);
 cloudmail_office365_get_last_error_code($res);
 cloudmail_office365_set($res, $id, $index, $value);
 cloudmail_office365_get($res, $id, $index);
 cloudmail_office365_do_addattachment($res, $messageid, $name, $localfile);
 cloudmail_office365_do_additemattachment($res, $messageid, $msgtoattachid, $itemjson);
 cloudmail_office365_do_authorize($res);
 cloudmail_office365_do_config($res, $configurationstring);
 cloudmail_office365_do_copy($res, $id, $destinationid);
 cloudmail_office365_do_copyfolder($res, $id, $destfolderid);
 cloudmail_office365_do_createcategory($res, $displayname, $color);
 cloudmail_office365_do_createcontact($res, $firstname, $lastname, $emailaddress, $parentid);
 cloudmail_office365_do_createdraft($res, $drafttype, $id);
 cloudmail_office365_do_createfolder($res, $foldername, $parentfolderid);
 cloudmail_office365_do_delete($res, $id);
 cloudmail_office365_do_deleteattachment($res, $id, $attachmentid);
 cloudmail_office365_do_deletecategory($res, $id);
 cloudmail_office365_do_deletecontact($res, $id);
 cloudmail_office365_do_deletefolder($res, $id);
 cloudmail_office365_do_forward($res, $id, $messagehtml, $torecipients);
 cloudmail_office365_do_getcategory($res, $id);
 cloudmail_office365_do_getcontact($res, $id);
 cloudmail_office365_do_getcontactfield($res, $index, $jsonpath);
 cloudmail_office365_do_getfolder($res, $id);
 cloudmail_office365_do_interrupt($res);
 cloudmail_office365_do_listattachments($res, $id);
 cloudmail_office365_do_listcategories($res);
 cloudmail_office365_do_listchanges($res, $id, $maxpagesize);
 cloudmail_office365_do_listcontactfolders($res, $parentfolderid);
 cloudmail_office365_do_listcontacts($res, $folderid);
 cloudmail_office365_do_listfolders($res, $parentfolderid);
 cloudmail_office365_do_listmessages($res, $folderid, $filter);
 cloudmail_office365_do_movefolder($res, $id, $destfolderid);
 cloudmail_office365_do_movemessage($res, $id, $destinationid);
 cloudmail_office365_do_renamefolder($res, $folderid, $newname);
 cloudmail_office365_do_reply($res, $id, $messagehtml);
 cloudmail_office365_do_replyall($res, $id, $messagehtml);
 cloudmail_office365_do_reset($res);
 cloudmail_office365_do_retrieveattachment($res, $id, $attachmentid);
 cloudmail_office365_do_retrievemessage($res, $id);
 cloudmail_office365_do_retrievemessageraw($res, $id);
 cloudmail_office365_do_search($res, $searchkey);
 cloudmail_office365_do_sendcustomrequest($res, $httpmethod, $url, $postdata);
 cloudmail_office365_do_senddraft($res, $id);
 cloudmail_office365_do_sendmail($res, $savetosentitems);
 cloudmail_office365_do_setcontactfield($res, $index, $jsonpath, $value, $valuetype);
 cloudmail_office365_do_update($res, $id);
 cloudmail_office365_do_updatecategory($res, $id, $color);
 cloudmail_office365_do_updatecontact($res, $index);

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 OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what OAuthGrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL and OAuthServerTokenURL properties. 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 OAuthClientProfile and OAuthGrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

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

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

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

Authorization Code

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

Example: 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerTokenURL 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

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

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 OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId 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

This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

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 user.readwrite Contacts.Read Contacts.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.

Listing Contact Folders

To list the contact folders of a user use the ListContactFolders method. It populates the ContactFolders collection with the retrieved folders. For each retrieved folder the ContactFolderList event is fired.

Example (List All Contact Folders):

office365.ListContactFolders(); // List root folders. foreach(OLContactFolder folder in office365.ContactFolders){ folder.Id; // Folder id folder.Name; // Folder name }

Listing Contacts

Use the ListContacts to populate the Contacts collection with the the contacts that are in a specified folder. Providing an empty string as folderId retrieves the contacts from the default Contacts folder of the signed-in user. For each retrieved contact the ContactList event is fired.

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

Creating and Updating Contacts

To create a new contact use the CreateContact method and specify the first name, last name, email address and the id of the folder, where the contact will be created. The newly created contact is added at the end of the Contacts collection.

Example (Create a Contact in the default folder (Contacts))

office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");

Example (Create a Contact in a Folder)

office365.ListContactFolders(""); //This method populates the ContactFolder collection with the contact folders under the root folder. office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", office365.ContactFolders[0].Id); // Created the contact in the first folder in the ContactFolders collection. After creating a contact with basic information, select the contact to be edited in the Contacts collection, edit its fields and make a call to the UpdateContact method. To edit the newly created contact select the last contact of the collection.

Example (Update a contact)

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"; // Update the contact office365.UpdateContact(0); The OLContact type used in the Contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add other fields, you can use the SetContactField method. For a complete list of fields a contact can have please refer to the Microsoft Graph API documentation.

Example (Add Other Fields To A Contact) // Set birthday office365.SetContactField(0, "/json/birthday", "2024-05-21", 2); // The last argument is the type of the field. 2 (String) // Set business address office365.SetContactField(0, "/json/businessAddress", "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"string\"}", 0); // 0 (Object) // Update the contact office365.UpdateContact(0);

Retrieving Contacts

To retrieve a contact use the GetContact method and provide the Id of the contact as the argument. The contact is added to the end of the Contacts collection.

Example (Retrieve 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

Deleting Contacts

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

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" 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; } }

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.

AttachmentCount Property (CloudMail_Office365 Class)

The number of records in the Attachment arrays.

Object Oriented Interface

public function getAttachmentCount();
public function setAttachmentCount($value);

Procedural Interface

cloudmail_office365_get($res, 1 );
cloudmail_office365_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentAttachmentType
• AttachmentContentId
• AttachmentContentLocation
• AttachmentContentType
• AttachmentData
• AttachmentFileName
• AttachmentId
• AttachmentIsInline
• AttachmentLastModifiedDate
• AttachmentName
• AttachmentParentIndex
• AttachmentSize

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

This property is not available at design time.

Data Type

Integer

AttachmentAttachmentType Property (CloudMail_Office365 Class)

This property contains the attachment type of the attachment.

Object Oriented Interface

public function getAttachmentAttachmentType($attachmentindex);

Procedural Interface

cloudmail_office365_get($res, 2 , $attachmentindex);

Default Value

''

Remarks

This field contains the attachment type of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

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

Data Type

String

AttachmentContentId Property (CloudMail_Office365 Class)

This property contains the value of the unique content identifier of the attachment.

Object Oriented Interface

public function getAttachmentContentId($attachmentindex);
public function setAttachmentContentId($attachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 3 , $attachmentindex);
cloudmail_office365_set($res, 3, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the value of the unique content identifier of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentContentLocation Property (CloudMail_Office365 Class)

This property contains the content location of the attachment.

Object Oriented Interface

public function getAttachmentContentLocation($attachmentindex);

Procedural Interface

cloudmail_office365_get($res, 4 , $attachmentindex);

Default Value

''

Remarks

This field contains the content location of the attachment. It is generally null, as it is no longer supported in the Microsoft Graph API.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

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

Data Type

String

AttachmentContentType Property (CloudMail_Office365 Class)

This property contains the content type of the attachment.

Object Oriented Interface

public function getAttachmentContentType($attachmentindex);

Procedural Interface

cloudmail_office365_get($res, 5 , $attachmentindex);

Default Value

''

Remarks

This field contains the content type of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

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

Data Type

String

AttachmentData Property (CloudMail_Office365 Class)

This property contains the raw data of the attachment.

Object Oriented Interface

public function getAttachmentData($attachmentindex);
public function setAttachmentData($attachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 6 , $attachmentindex);
cloudmail_office365_set($res, 6, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the raw data of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

Binary String

AttachmentFileName Property (CloudMail_Office365 Class)

This property contains the local file name associated with the attachment.

Object Oriented Interface

public function getAttachmentFileName($attachmentindex);
public function setAttachmentFileName($attachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 7 , $attachmentindex);
cloudmail_office365_set($res, 7, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the local file name associated with the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentId Property (CloudMail_Office365 Class)

This property contains the attachment identifier of the attachment.

Object Oriented Interface

public function getAttachmentId($attachmentindex);

Procedural Interface

cloudmail_office365_get($res, 8 , $attachmentindex);

Default Value

''

Remarks

This field contains the attachment identifier of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

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

Data Type

String

AttachmentIsInline Property (CloudMail_Office365 Class)

This property is true if the attachment is an inline attachment.

Object Oriented Interface

public function getAttachmentIsInline($attachmentindex);
public function setAttachmentIsInline($attachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 10 , $attachmentindex);
cloudmail_office365_set($res, 10, $value , $attachmentindex);

Default Value

false

Remarks

This field is true if the attachment is an inline attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

Boolean

AttachmentLastModifiedDate Property (CloudMail_Office365 Class)

This property contains the date and time when the attachment was last modified.

Object Oriented Interface

public function getAttachmentLastModifiedDate($attachmentindex);
public function setAttachmentLastModifiedDate($attachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 11 , $attachmentindex);
cloudmail_office365_set($res, 11, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the date and time when the attachment was last modified.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (CloudMail_Office365 Class)

This property contains the name of the attachment.

Object Oriented Interface

public function getAttachmentName($attachmentindex);
public function setAttachmentName($attachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 12 , $attachmentindex);
cloudmail_office365_set($res, 12, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the name of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

String

AttachmentParentIndex Property (CloudMail_Office365 Class)

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled.

Object Oriented Interface

public function getAttachmentParentIndex($attachmentindex);

Procedural Interface

cloudmail_office365_get($res, 13 , $attachmentindex);

Default Value

''

Remarks

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. This index is generated by the class rather than by Microsoft and is designed to provide an intuitive mapping of the attachment structure.

If the attachment is a root attachment, then this index will be a single integer starting at 1. For the following intermediate and leaf attachments, the index will add a new integer separated by a . char.

For example, a message may contain the following attachments.

• RootFileAttachment.txt (1)
• RootItemAttachment (2)
  • IntermediateFileAttachment.txt (2.1)
  • IntermediateItemAttachment (2.2)
    • LeafFileAttachment.txt (2.2.1)

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

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

Data Type

String

AttachmentSize Property (CloudMail_Office365 Class)

This property contains the size in bytes of the attachment.

Object Oriented Interface

public function getAttachmentSize($attachmentindex);
public function setAttachmentSize($attachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 14 , $attachmentindex);
cloudmail_office365_set($res, 14, $value , $attachmentindex);

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is not available at design time.

Data Type

Integer

Authorization Property (CloudMail_Office365 Class)

An OAuth Authorization String.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 15 );
cloudmail_office365_set($res, 15, $value );

Default Value

''

Remarks

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

Example

Oauth oauth = new Oauth(); oauth.ClientId = "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

CategoryCount Property (CloudMail_Office365 Class)

The number of records in the Category arrays.

Object Oriented Interface

public function getCategoryCount();
public function setCategoryCount($value);

Procedural Interface

cloudmail_office365_get($res, 16 );
cloudmail_office365_set($res, 16, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CategoryColor
• CategoryDisplayName
• CategoryId

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

This property is not available at design time.

Data Type

Integer

CategoryColor Property (CloudMail_Office365 Class)

This property contains the color of the category.

Object Oriented Interface

public function getCategoryColor($categoryindex);

Procedural Interface

cloudmail_office365_get($res, 17 , $categoryindex);

Default Value

''

Remarks

This field contains the color of the category.

The $categoryindex parameter specifies the index of the item in the array. The size of the array is controlled by the CategoryCount property.

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

Data Type

String

CategoryDisplayName Property (CloudMail_Office365 Class)

This property contains the display name of the category.

Object Oriented Interface

public function getCategoryDisplayName($categoryindex);

Procedural Interface

cloudmail_office365_get($res, 18 , $categoryindex);

Default Value

''

Remarks

This field contains the display name of the category.

The $categoryindex parameter specifies the index of the item in the array. The size of the array is controlled by the CategoryCount property.

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

Data Type

String

CategoryId Property (CloudMail_Office365 Class)

This property contains the unique identifier of the category.

Object Oriented Interface

public function getCategoryId($categoryindex);

Procedural Interface

cloudmail_office365_get($res, 19 , $categoryindex);

Default Value

''

Remarks

This field contains the unique identifier of the category.

The $categoryindex parameter specifies the index of the item in the array. The size of the array is controlled by the CategoryCount property.

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

Data Type

String

ChangeMarker Property (CloudMail_Office365 Class)

The page marker for listing changed messages.

Object Oriented Interface

public function getChangeMarker();
public function setChangeMarker($value);

Procedural Interface

cloudmail_office365_get($res, 20 );
cloudmail_office365_set($res, 20, $value );

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

ContactFolderCount Property (CloudMail_Office365 Class)

The number of records in the ContactFolder arrays.

Object Oriented Interface

public function getContactFolderCount();
public function setContactFolderCount($value);

Procedural Interface

cloudmail_office365_get($res, 21 );
cloudmail_office365_set($res, 21, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContactFolderId
• ContactFolderName
• ContactFolderParentFolderId

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

This property is not available at design time.

Data Type

Integer

ContactFolderId Property (CloudMail_Office365 Class)

The unique identifier of the contact folder.

Object Oriented Interface

public function getContactFolderId($contactfolderindex);

Procedural Interface

cloudmail_office365_get($res, 22 , $contactfolderindex);

Default Value

''

Remarks

The unique identifier of the contact folder.

The $contactfolderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactFolderCount property.

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

Data Type

String

ContactFolderName Property (CloudMail_Office365 Class)

The display name of the contact folder.

Object Oriented Interface

public function getContactFolderName($contactfolderindex);

Procedural Interface

cloudmail_office365_get($res, 23 , $contactfolderindex);

Default Value

''

Remarks

The display name of the contact folder.

The $contactfolderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactFolderCount property.

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

Data Type

String

ContactFolderParentFolderId Property (CloudMail_Office365 Class)

The unique identifier for the folder's parent.

Object Oriented Interface

public function getContactFolderParentFolderId($contactfolderindex);

Procedural Interface

cloudmail_office365_get($res, 24 , $contactfolderindex);

Default Value

''

Remarks

The unique identifier for the folder's parent.

The $contactfolderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactFolderCount property.

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

Data Type

String

ContactsCount Property (CloudMail_Office365 Class)

The number of records in the Contact arrays.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 25 );
cloudmail_office365_set($res, 25, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContactCompanyName
• ContactDisplayName
• ContactEmailAddress
• ContactEmailAddressesCount
• ContactEmailAddressIndex
• ContactFirstName
• ContactFolderId
• ContactFolderName
• ContactFolderParentFolderId
• ContactId
• ContactJSON
• ContactLastName
• ContactNotes
• ContactParentId
• ContactPhoneIndex
• ContactPhoneNumber
• ContactPhonesCount
• ContactPhoneType

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

This property is not available at design time.

Data Type

Integer

ContactCompanyName Property (CloudMail_Office365 Class)

The name of the contact's company.

Object Oriented Interface

public function getContactCompanyName($contactindex);
public function setContactCompanyName($contactindex, $value);

Procedural Interface

cloudmail_office365_get($res, 26 , $contactindex);
cloudmail_office365_set($res, 26, $value , $contactindex);

Default Value

''

Remarks

The name of the contact's company.

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

This property is not available at design time.

Data Type

String

ContactDisplayName Property (CloudMail_Office365 Class)

The contact's display name.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 27 , $contactindex);
cloudmail_office365_set($res, 27, $value , $contactindex);

Default Value

''

Remarks

The contact's display name.

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

This property is not available at design time.

Data Type

String

ContactEmailAddress Property (CloudMail_Office365 Class)

The email address at the specified EmailAddressIndex.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 28 , $contactindex);
cloudmail_office365_set($res, 28, $value , $contactindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

ContactEmailAddressesCount Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 29 , $contactindex);
cloudmail_office365_set($res, 29, $value , $contactindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

ContactEmailAddressIndex Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 30 , $contactindex);
cloudmail_office365_set($res, 30, $value , $contactindex);

Default Value

0

Remarks

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

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

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

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

This property is not available at design time.

Data Type

Integer

ContactFirstName Property (CloudMail_Office365 Class)

The contact's first name.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 31 , $contactindex);
cloudmail_office365_set($res, 31, $value , $contactindex);

Default Value

''

Remarks

The contact's first name.

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

This property is not available at design time.

Data Type

String

ContactId Property (CloudMail_Office365 Class)

The unique identifier of the contact.

Object Oriented Interface

public function getContactId($contactindex);

Procedural Interface

cloudmail_office365_get($res, 32 , $contactindex);

Default Value

''

Remarks

The unique identifier of the contact.

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

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

Data Type

String

ContactJSON Property (CloudMail_Office365 Class)

A JSON representation of the contact.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 33 , $contactindex);
cloudmail_office365_set($res, 33, $value , $contactindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

ContactLastName Property (CloudMail_Office365 Class)

The contact's last name.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 34 , $contactindex);
cloudmail_office365_set($res, 34, $value , $contactindex);

Default Value

''

Remarks

The contact's last name.

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

This property is not available at design time.

Data Type

String

ContactNotes Property (CloudMail_Office365 Class)

The user's notes about the contact.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 35 , $contactindex);
cloudmail_office365_set($res, 35, $value , $contactindex);

Default Value

''

Remarks

The user's notes about the contact.

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

This property is not available at design time.

Data Type

String

ContactParentId Property (CloudMail_Office365 Class)

The ID of the contact's parent folder.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 36 , $contactindex);
cloudmail_office365_set($res, 36, $value , $contactindex);

Default Value

''

Remarks

The ID of the contact's parent folder.

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

This property is not available at design time.

Data Type

String

ContactPhoneIndex Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 37 , $contactindex);
cloudmail_office365_set($res, 37, $value , $contactindex);

Default Value

0

Remarks

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

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

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

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

This property is not available at design time.

Data Type

Integer

ContactPhoneNumber Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 38 , $contactindex);
cloudmail_office365_set($res, 38, $value , $contactindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

ContactPhonesCount Property (CloudMail_Office365 Class)

Number of the contact's phone numbers.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 39 , $contactindex);
cloudmail_office365_set($res, 39, $value , $contactindex);

Default Value

0

Remarks

Number of the contact's phone numbers.

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

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

This property is not available at design time.

Data Type

Integer

ContactPhoneType Property (CloudMail_Office365 Class)

The phone number type.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 40 , $contactindex);
cloudmail_office365_set($res, 40, $value , $contactindex);

Default Value

0

Remarks

The phone number type.

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

• 0 (optHome)
• 1 (optBusiness)
• 2 (optMobile)

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

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 41 );
cloudmail_office365_set($res, 41, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudMail_Office365 Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 42 );
cloudmail_office365_set($res, 42, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 43 );
cloudmail_office365_set($res, 43, $value );

Default Value

''

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 44 );
cloudmail_office365_set($res, 44, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 45 );
cloudmail_office365_set($res, 45, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 46 );
cloudmail_office365_set($res, 46, $value );

Default Value

''

Remarks

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

Data Type

String

FolderCount Property (CloudMail_Office365 Class)

The number of records in the Folder arrays.

Object Oriented Interface

public function getFolderCount();
public function setFolderCount($value);

Procedural Interface

cloudmail_office365_get($res, 47 );
cloudmail_office365_set($res, 47, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• FolderChildFolderCount
• FolderChildFolders
• FolderDisplayName
• FolderId
• FolderMessageRules
• FolderMessages
• FolderMultiValueExtendedProperties
• FolderParentFolderId
• FolderSingleValueExtendedProperties
• FolderTotalItemCount
• FolderUnreadItemCount

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

This property is not available at design time.

Data Type

Integer

FolderChildFolderCount Property (CloudMail_Office365 Class)

The number of child folders the folder has.

Object Oriented Interface

public function getFolderChildFolderCount($folderindex);

Procedural Interface

cloudmail_office365_get($res, 48 , $folderindex);

Default Value

0

Remarks

The number of child folders the folder has.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

Integer

FolderChildFolders Property (CloudMail_Office365 Class)

The child folders of the folder.

Object Oriented Interface

public function getFolderChildFolders($folderindex);

Procedural Interface

cloudmail_office365_get($res, 49 , $folderindex);

Default Value

''

Remarks

The child folders of the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderDisplayName Property (CloudMail_Office365 Class)

The display name of the folder.

Object Oriented Interface

public function getFolderDisplayName($folderindex);

Procedural Interface

cloudmail_office365_get($res, 50 , $folderindex);

Default Value

''

Remarks

The display name of the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderId Property (CloudMail_Office365 Class)

The unique identifier of the folder.

Object Oriented Interface

public function getFolderId($folderindex);

Procedural Interface

cloudmail_office365_get($res, 51 , $folderindex);

Default Value

''

Remarks

The unique identifier of the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderMessageRules Property (CloudMail_Office365 Class)

The message rules of the folder.

Object Oriented Interface

public function getFolderMessageRules($folderindex);

Procedural Interface

cloudmail_office365_get($res, 52 , $folderindex);

Default Value

''

Remarks

The message rules of the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderMessages Property (CloudMail_Office365 Class)

The messages contained in the folder.

Object Oriented Interface

public function getFolderMessages($folderindex);

Procedural Interface

cloudmail_office365_get($res, 53 , $folderindex);

Default Value

''

Remarks

The messages contained in the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderMultiValueExtendedProperties Property (CloudMail_Office365 Class)

The multi-value extended properties defined for the folder.

Object Oriented Interface

public function getFolderMultiValueExtendedProperties($folderindex);

Procedural Interface

cloudmail_office365_get($res, 54 , $folderindex);

Default Value

''

Remarks

The multi-value extended properties defined for the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderParentFolderId Property (CloudMail_Office365 Class)

The unique identifier for the folder's parent.

Object Oriented Interface

public function getFolderParentFolderId($folderindex);

Procedural Interface

cloudmail_office365_get($res, 55 , $folderindex);

Default Value

''

Remarks

The unique identifier for the folder's parent.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderSingleValueExtendedProperties Property (CloudMail_Office365 Class)

The single-value extended properties defined for the folder.

Object Oriented Interface

public function getFolderSingleValueExtendedProperties($folderindex);

Procedural Interface

cloudmail_office365_get($res, 56 , $folderindex);

Default Value

''

Remarks

The single-value extended properties defined for the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

String

FolderTotalItemCount Property (CloudMail_Office365 Class)

The number of total items in the folder.

Object Oriented Interface

public function getFolderTotalItemCount($folderindex);

Procedural Interface

cloudmail_office365_get($res, 57 , $folderindex);

Default Value

0

Remarks

The number of total items in the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

Integer

FolderUnreadItemCount Property (CloudMail_Office365 Class)

The number of unread items in the folder.

Object Oriented Interface

public function getFolderUnreadItemCount($folderindex);

Procedural Interface

cloudmail_office365_get($res, 58 , $folderindex);

Default Value

0

Remarks

The number of unread items in the folder.

The $folderindex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.

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

Data Type

Integer

ListContactsMarker Property (CloudMail_Office365 Class)

The page marker for listing contacts.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 59 );
cloudmail_office365_set($res, 59, $value );

Default Value

''

Remarks

This property is populated if there are still unlisted contacts after ListContacts is called. It contains the nextLink that will be included as 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 (CloudMail_Office365 Class)

The page marker for listing folders.

Object Oriented Interface

public function getListFoldersMarker();
public function setListFoldersMarker($value);

Procedural Interface

cloudmail_office365_get($res, 60 );
cloudmail_office365_set($res, 60, $value );

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

The page marker for listing messages.

Object Oriented Interface

public function getListMessagesMarker();
public function setListMessagesMarker($value);

Procedural Interface

cloudmail_office365_get($res, 61 );
cloudmail_office365_set($res, 61, $value );

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

Provides the raw message content.

Object Oriented Interface

public function getMessage();

Procedural Interface

cloudmail_office365_get($res, 62 );

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

MessageAttachmentCount Property (CloudMail_Office365 Class)

The number of records in the MessageAttachment arrays.

Object Oriented Interface

public function getMessageAttachmentCount();
public function setMessageAttachmentCount($value);

Procedural Interface

cloudmail_office365_get($res, 63 );
cloudmail_office365_set($res, 63, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageAttachmentAttachmentType
• MessageAttachmentContentId
• MessageAttachmentContentLocation
• MessageAttachmentContentType
• MessageAttachmentData
• MessageAttachmentFileName
• MessageAttachmentId
• MessageAttachmentIsInline
• MessageAttachmentLastModifiedDate
• MessageAttachmentName
• MessageAttachmentParentIndex
• MessageAttachmentSize

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

This property is not available at design time.

Data Type

Integer

MessageAttachmentAttachmentType Property (CloudMail_Office365 Class)

This property contains the attachment type of the attachment.

Object Oriented Interface

public function getMessageAttachmentAttachmentType($messageattachmentindex);

Procedural Interface

cloudmail_office365_get($res, 64 , $messageattachmentindex);

Default Value

''

Remarks

This field contains the attachment type of the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

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

Data Type

String

MessageAttachmentContentId Property (CloudMail_Office365 Class)

This property contains the value of the unique content identifier of the attachment.

Object Oriented Interface

public function getMessageAttachmentContentId($messageattachmentindex);
public function setMessageAttachmentContentId($messageattachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 65 , $messageattachmentindex);
cloudmail_office365_set($res, 65, $value , $messageattachmentindex);

Default Value

''

Remarks

This field contains the value of the unique content identifier of the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

This property is not available at design time.

Data Type

String

MessageAttachmentContentLocation Property (CloudMail_Office365 Class)

This property contains the content location of the attachment.

Object Oriented Interface

public function getMessageAttachmentContentLocation($messageattachmentindex);

Procedural Interface

cloudmail_office365_get($res, 66 , $messageattachmentindex);

Default Value

''

Remarks

This field contains the content location of the attachment. It is generally null, as it is no longer supported in the Microsoft Graph API.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

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

Data Type

String

MessageAttachmentContentType Property (CloudMail_Office365 Class)

This property contains the content type of the attachment.

Object Oriented Interface

public function getMessageAttachmentContentType($messageattachmentindex);

Procedural Interface

cloudmail_office365_get($res, 67 , $messageattachmentindex);

Default Value

''

Remarks

This field contains the content type of the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

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

Data Type

String

MessageAttachmentData Property (CloudMail_Office365 Class)

This property contains the raw data of the attachment.

Object Oriented Interface

public function getMessageAttachmentData($messageattachmentindex);
public function setMessageAttachmentData($messageattachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 68 , $messageattachmentindex);
cloudmail_office365_set($res, 68, $value , $messageattachmentindex);

Default Value

''

Remarks

This field contains the raw data of the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

This property is not available at design time.

Data Type

Binary String

MessageAttachmentFileName Property (CloudMail_Office365 Class)

This property contains the local file name associated with the attachment.

Object Oriented Interface

public function getMessageAttachmentFileName($messageattachmentindex);
public function setMessageAttachmentFileName($messageattachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 69 , $messageattachmentindex);
cloudmail_office365_set($res, 69, $value , $messageattachmentindex);

Default Value

''

Remarks

This field contains the local file name associated with the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

This property is not available at design time.

Data Type

String

MessageAttachmentId Property (CloudMail_Office365 Class)

This property contains the attachment identifier of the attachment.

Object Oriented Interface

public function getMessageAttachmentId($messageattachmentindex);

Procedural Interface

cloudmail_office365_get($res, 70 , $messageattachmentindex);

Default Value

''

Remarks

This field contains the attachment identifier of the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

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

Data Type

String

MessageAttachmentIsInline Property (CloudMail_Office365 Class)

This property is true if the attachment is an inline attachment.

Object Oriented Interface

public function getMessageAttachmentIsInline($messageattachmentindex);
public function setMessageAttachmentIsInline($messageattachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 72 , $messageattachmentindex);
cloudmail_office365_set($res, 72, $value , $messageattachmentindex);

Default Value

false

Remarks

This field is true if the attachment is an inline attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

This property is not available at design time.

Data Type

Boolean

MessageAttachmentLastModifiedDate Property (CloudMail_Office365 Class)

This property contains the date and time when the attachment was last modified.

Object Oriented Interface

public function getMessageAttachmentLastModifiedDate($messageattachmentindex);
public function setMessageAttachmentLastModifiedDate($messageattachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 73 , $messageattachmentindex);
cloudmail_office365_set($res, 73, $value , $messageattachmentindex);

Default Value

''

Remarks

This field contains the date and time when the attachment was last modified.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

This property is not available at design time.

Data Type

String

MessageAttachmentName Property (CloudMail_Office365 Class)

This property contains the name of the attachment.

Object Oriented Interface

public function getMessageAttachmentName($messageattachmentindex);
public function setMessageAttachmentName($messageattachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 74 , $messageattachmentindex);
cloudmail_office365_set($res, 74, $value , $messageattachmentindex);

Default Value

''

Remarks

This field contains the name of the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

This property is not available at design time.

Data Type

String

MessageAttachmentParentIndex Property (CloudMail_Office365 Class)

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled.

Object Oriented Interface

public function getMessageAttachmentParentIndex($messageattachmentindex);

Procedural Interface

cloudmail_office365_get($res, 75 , $messageattachmentindex);

Default Value

''

Remarks

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. This index is generated by the class rather than by Microsoft and is designed to provide an intuitive mapping of the attachment structure.

If the attachment is a root attachment, then this index will be a single integer starting at 1. For the following intermediate and leaf attachments, the index will add a new integer separated by a . char.

For example, a message may contain the following attachments.

• RootFileAttachment.txt (1)
• RootItemAttachment (2)
  • IntermediateFileAttachment.txt (2.1)
  • IntermediateItemAttachment (2.2)
    • LeafFileAttachment.txt (2.2.1)

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

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

Data Type

String

MessageAttachmentSize Property (CloudMail_Office365 Class)

This property contains the size in bytes of the attachment.

Object Oriented Interface

public function getMessageAttachmentSize($messageattachmentindex);
public function setMessageAttachmentSize($messageattachmentindex, $value);

Procedural Interface

cloudmail_office365_get($res, 76 , $messageattachmentindex);
cloudmail_office365_set($res, 76, $value , $messageattachmentindex);

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

The $messageattachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.

This property is not available at design time.

Data Type

Integer

MessageBcc Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 77 );
cloudmail_office365_set($res, 77, $value );

Default Value

''

Remarks

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

Example (Add a Bcc Recipient)

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

The body content for a message.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 78 );
cloudmail_office365_set($res, 78, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageBodyContentType Property (CloudMail_Office365 Class)

The body content type for a message.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 79 );
cloudmail_office365_set($res, 79, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageCc Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 80 );
cloudmail_office365_set($res, 80, $value );

Default Value

''

Remarks

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

Example (Add a CC Recipient)

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

Whether or not a message will request a Delivery Receipt.

Object Oriented Interface

public function getMessageDeliveryReceipt();
public function setMessageDeliveryReceipt($value);

Procedural Interface

cloudmail_office365_get($res, 81 );
cloudmail_office365_set($res, 81, $value );

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

The author of a message.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 82 );
cloudmail_office365_set($res, 82, $value );

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

The importance of a message.

Object Oriented Interface

public function getMessageImportance();
public function setMessageImportance($value);

Procedural Interface

cloudmail_office365_get($res, 83 );
cloudmail_office365_set($res, 83, $value );

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

MessageInfoCount Property (CloudMail_Office365 Class)

The number of records in the MessageInfo arrays.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 84 );
cloudmail_office365_set($res, 84, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageInfoBcc
• MessageInfoBodyContent
• MessageInfoBodyContentType
• MessageInfoBodyPreview
• MessageInfoCategories
• MessageInfoCc
• MessageInfoConversationId
• MessageInfoConversationIndex
• MessageInfoCreatedDate
• MessageInfoDeliveryReceiptRequested
• MessageInfoFlagStatus
• MessageInfoFrom
• MessageInfoHasAttachments
• MessageInfoId
• MessageInfoImportance
• MessageInfoInferenceClassification
• MessageInfoIsDraft
• MessageInfoIsRead
• MessageInfoJSON
• MessageInfoLastModifiedDate
• MessageInfoMessageHeaders
• MessageInfoMessageId
• MessageInfoParentFolderId
• MessageInfoReadReceiptRequested
• MessageInfoReceivedDate
• MessageInfoReplyTo
• MessageInfoSender
• MessageInfoSentDate
• MessageInfoSubject
• MessageInfoTo
• MessageInfoWebLink

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

This property is not available at design time.

Data Type

Integer

MessageInfoBcc Property (CloudMail_Office365 Class)

The BCc recipients of a message in a message info listing.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 85 , $messageinfoindex);
cloudmail_office365_set($res, 85, $value , $messageinfoindex);

Default Value

''

Remarks

The BCc recipients of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoBodyContent Property (CloudMail_Office365 Class)

The body content of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoBodyContent($messageinfoindex);
public function setMessageInfoBodyContent($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 86 , $messageinfoindex);
cloudmail_office365_set($res, 86, $value , $messageinfoindex);

Default Value

''

Remarks

The body content of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoBodyContentType Property (CloudMail_Office365 Class)

The body content type (e.

Object Oriented Interface

public function getMessageInfoBodyContentType($messageinfoindex);
public function setMessageInfoBodyContentType($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 87 , $messageinfoindex);
cloudmail_office365_set($res, 87, $value , $messageinfoindex);

Default Value

''

Remarks

The body content type (e.g. "HTML") of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoBodyPreview Property (CloudMail_Office365 Class)

The body preview of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoBodyPreview($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 88 , $messageinfoindex);

Default Value

''

Remarks

The body preview of a message in a message info listing.

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

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

Data Type

String

MessageInfoCategories Property (CloudMail_Office365 Class)

The categories of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoCategories($messageinfoindex);
public function setMessageInfoCategories($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 89 , $messageinfoindex);
cloudmail_office365_set($res, 89, $value , $messageinfoindex);

Default Value

''

Remarks

The categories of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoCc Property (CloudMail_Office365 Class)

The Cc recipients of a message in a message info listing.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 90 , $messageinfoindex);
cloudmail_office365_set($res, 90, $value , $messageinfoindex);

Default Value

''

Remarks

The Cc recipients of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoConversationId Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getMessageInfoConversationId($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 91 , $messageinfoindex);

Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoConversationIndex Property (CloudMail_Office365 Class)

The conversation index of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoConversationIndex($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 92 , $messageinfoindex);

Default Value

''

Remarks

The conversation index of a message in a message info listing.

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

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

Data Type

String

MessageInfoCreatedDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getMessageInfoCreatedDate($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 93 , $messageinfoindex);

Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoDeliveryReceiptRequested Property (CloudMail_Office365 Class)

Whether or not a delivery receipt was requested for a message in a message info listing.

Object Oriented Interface

public function getMessageInfoDeliveryReceiptRequested($messageinfoindex);
public function setMessageInfoDeliveryReceiptRequested($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 94 , $messageinfoindex);
cloudmail_office365_set($res, 94, $value , $messageinfoindex);

Default Value

false

Remarks

Whether or not a delivery receipt was requested for a message in a message info listing.

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

This property is not available at design time.

Data Type

Boolean

MessageInfoFlagStatus Property (CloudMail_Office365 Class)

Message flag in a message info listing.

Object Oriented Interface

public function getMessageInfoFlagStatus($messageinfoindex);
public function setMessageInfoFlagStatus($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 95 , $messageinfoindex);
cloudmail_office365_set($res, 95, $value , $messageinfoindex);

Default Value

''

Remarks

Message flag in a message info listing. Example values include:

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

This property is not available at design time.

Data Type

String

MessageInfoFrom Property (CloudMail_Office365 Class)

The sender of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoFrom($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 96 , $messageinfoindex);

Default Value

''

Remarks

The sender of a message in a message info listing.

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

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

Data Type

String

MessageInfoHasAttachments Property (CloudMail_Office365 Class)

Whether or not a message in a message info listing has attachments.

Object Oriented Interface

public function getMessageInfoHasAttachments($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 97 , $messageinfoindex);

Default Value

false

Remarks

Whether or not a message in a message info listing has attachments.

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

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

Data Type

Boolean

MessageInfoId Property (CloudMail_Office365 Class)

The unique identifier of a message in a message info listing set by Microsoft.

Object Oriented Interface

public function getMessageInfoId($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 98 , $messageinfoindex);

Default Value

''

Remarks

The unique identifier of a message in a message info listing set by Microsoft.

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

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

Data Type

String

MessageInfoImportance Property (CloudMail_Office365 Class)

The importance of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoImportance($messageinfoindex);
public function setMessageInfoImportance($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 99 , $messageinfoindex);
cloudmail_office365_set($res, 99, $value , $messageinfoindex);

Default Value

''

Remarks

The importance of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoInferenceClassification Property (CloudMail_Office365 Class)

The inference classification of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoInferenceClassification($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 100 , $messageinfoindex);

Default Value

''

Remarks

The inference classification of a message in a message info listing.

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

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

Data Type

String

MessageInfoIsDraft Property (CloudMail_Office365 Class)

Whether or not a message in a message info listing is a draft.

Object Oriented Interface

public function getMessageInfoIsDraft($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 101 , $messageinfoindex);

Default Value

false

Remarks

Whether or not a message in a message info listing is a draft.

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

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

Data Type

Boolean

MessageInfoIsRead Property (CloudMail_Office365 Class)

Whether or not a message in a message info listing has been read.

Object Oriented Interface

public function getMessageInfoIsRead($messageinfoindex);
public function setMessageInfoIsRead($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 102 , $messageinfoindex);
cloudmail_office365_set($res, 102, $value , $messageinfoindex);

Default Value

false

Remarks

Whether or not a message in a message info listing has been read.

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

This property is not available at design time.

Data Type

Boolean

MessageInfoJSON Property (CloudMail_Office365 Class)

The full JSON content of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoJSON($messageinfoindex);
public function setMessageInfoJSON($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 103 , $messageinfoindex);
cloudmail_office365_set($res, 103, $value , $messageinfoindex);

Default Value

''

Remarks

The full JSON content of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoLastModifiedDate Property (CloudMail_Office365 Class)

The last modified date of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoLastModifiedDate($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 104 , $messageinfoindex);

Default Value

''

Remarks

The last modified date of a message in a message info listing.

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

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

Data Type

String

MessageInfoMessageHeaders Property (CloudMail_Office365 Class)

The message headers of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoMessageHeaders($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 105 , $messageinfoindex);

Default Value

''

Remarks

The message headers of a message in a message info listing.

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

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

Data Type

String

MessageInfoMessageId Property (CloudMail_Office365 Class)

The internet message id for the message as described by rfc2822.

Object Oriented Interface

public function getMessageInfoMessageId($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 106 , $messageinfoindex);

Default Value

''

Remarks

The internet message id for the message as described by rfc2822.

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

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

Data Type

String

MessageInfoParentFolderId Property (CloudMail_Office365 Class)

The unique identifier of the parent folder of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoParentFolderId($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 107 , $messageinfoindex);

Default Value

''

Remarks

The unique identifier of the parent folder of a message in a message info listing.

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

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

Data Type

String

MessageInfoReadReceiptRequested Property (CloudMail_Office365 Class)

Whether or not a read receipt was requested for a message in a message info listing.

Object Oriented Interface

public function getMessageInfoReadReceiptRequested($messageinfoindex);
public function setMessageInfoReadReceiptRequested($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 108 , $messageinfoindex);
cloudmail_office365_set($res, 108, $value , $messageinfoindex);

Default Value

false

Remarks

Whether or not a read receipt was requested for a message in a message info listing.

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

This property is not available at design time.

Data Type

Boolean

MessageInfoReceivedDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getMessageInfoReceivedDate($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 109 , $messageinfoindex);

Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoReplyTo Property (CloudMail_Office365 Class)

Where to send replies for a message in a message info listing.

Object Oriented Interface

public function getMessageInfoReplyTo($messageinfoindex);
public function setMessageInfoReplyTo($messageinfoindex, $value);

Procedural Interface

cloudmail_office365_get($res, 110 , $messageinfoindex);
cloudmail_office365_set($res, 110, $value , $messageinfoindex);

Default Value

''

Remarks

Where to send replies for a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoSender Property (CloudMail_Office365 Class)

The sender of a message in a message info listing.

Object Oriented Interface

public function getMessageInfoSender($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 111 , $messageinfoindex);

Default Value

''

Remarks

The sender of a message in a message info listing.

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

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

Data Type

String

MessageInfoSentDate Property (CloudMail_Office365 Class)

The date a message was sent for a message in a message info listing.

Object Oriented Interface

public function getMessageInfoSentDate($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 112 , $messageinfoindex);

Default Value

''

Remarks

The date a message was sent for a message in a message info listing.

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

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

Data Type

String

MessageInfoSubject Property (CloudMail_Office365 Class)

The subject of a message in a message info listing.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 113 , $messageinfoindex);
cloudmail_office365_set($res, 113, $value , $messageinfoindex);

Default Value

''

Remarks

The subject of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoTo Property (CloudMail_Office365 Class)

The recipients of a message in a message info listing.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 114 , $messageinfoindex);
cloudmail_office365_set($res, 114, $value , $messageinfoindex);

Default Value

''

Remarks

The recipients of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoWebLink Property (CloudMail_Office365 Class)

The URL to open a message in a message info listing in Outlook on the web.

Object Oriented Interface

public function getMessageInfoWebLink($messageinfoindex);

Procedural Interface

cloudmail_office365_get($res, 115 , $messageinfoindex);

Default Value

''

Remarks

The URL to open a message in a message info listing in Outlook on the web.

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

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

Data Type

String

MessageOtherHeaders Property (CloudMail_Office365 Class)

The additional message headers for a message.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 116 );
cloudmail_office365_set($res, 116, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageReadReceipt Property (CloudMail_Office365 Class)

Whether or not a message will request a Read Receipt.

Object Oriented Interface

public function getMessageReadReceipt();
public function setMessageReadReceipt($value);

Procedural Interface

cloudmail_office365_get($res, 117 );
cloudmail_office365_set($res, 117, $value );

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

A mail address to reply to.

Object Oriented Interface

public function getMessageReplyTo();
public function setMessageReplyTo($value);

Procedural Interface

cloudmail_office365_get($res, 118 );
cloudmail_office365_set($res, 118, $value );

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

The subject of a message.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 119 );
cloudmail_office365_set($res, 119, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageTo Property (CloudMail_Office365 Class)

A comma separated list of recipients for a message.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 120 );
cloudmail_office365_set($res, 120, $value );

Default Value

''

Remarks

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

Example (Add a Recipient)

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

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

Object Oriented Interface

public function getNextChangeMarker();
public function setNextChangeMarker($value);

Procedural Interface

cloudmail_office365_get($res, 121 );
cloudmail_office365_set($res, 121, $value );

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

OAuthAccessToken Property (CloudMail_Office365 Class)

The access token returned by the authorization server.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 122 );
cloudmail_office365_set($res, 122, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudMail_Office365 Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 123 );
cloudmail_office365_set($res, 123, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudMail_Office365 Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 124 );
cloudmail_office365_set($res, 124, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudMail_Office365 Class)

The id of the client assigned when registering the application.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 125 );
cloudmail_office365_set($res, 125, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudMail_Office365 Class)

The type of client that is requesting authorization.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 126 );
cloudmail_office365_set($res, 126, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 127 );
cloudmail_office365_set($res, 127, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 128 );
cloudmail_office365_set($res, 128, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 129 );
cloudmail_office365_set($res, 129, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 130 );
cloudmail_office365_set($res, 130, $value );

Default Value

true

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 131 );
cloudmail_office365_set($res, 131, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudMail_Office365 Class)

The URL of the authorization server.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 132 );
cloudmail_office365_set($res, 132, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 133 );
cloudmail_office365_set($res, 133, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudmail_office365_get($res, 134 );

Default Value

''

Remarks

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

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

Data Type

String

ProxyAuthScheme Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 135 );
cloudmail_office365_set($res, 135, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 136 );
cloudmail_office365_set($res, 136, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 137 );
cloudmail_office365_set($res, 137, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 138 );
cloudmail_office365_set($res, 138, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 139 );
cloudmail_office365_set($res, 139, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 140 );
cloudmail_office365_set($res, 140, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 141 );
cloudmail_office365_set($res, 141, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

Select Property (CloudMail_Office365 Class)

The parts of a message that should be retrieved.

Object Oriented Interface

public function getSelect();
public function setSelect($value);

Procedural Interface

cloudmail_office365_get($res, 142 );
cloudmail_office365_set($res, 142, $value );

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

SSLAcceptServerCertEffectiveDate Property (CloudMail_Office365 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudmail_office365_get($res, 143 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudMail_Office365 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudmail_office365_get($res, 144 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudMail_Office365 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudmail_office365_get($res, 145 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudmail_office365_get($res, 146 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudmail_office365_get($res, 147 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudmail_office365_get($res, 148 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudMail_Office365 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudmail_office365_get($res, 149 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudMail_Office365 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudmail_office365_get($res, 150 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudMail_Office365 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudmail_office365_get($res, 151 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudmail_office365_get($res, 152 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudMail_Office365 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudmail_office365_get($res, 153 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_office365_get($res, 154 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudmail_office365_get($res, 155 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudMail_Office365 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudmail_office365_get($res, 156 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudMail_Office365 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudmail_office365_get($res, 157 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudMail_Office365 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 158 );
cloudmail_office365_set($res, 158, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 159 );
cloudmail_office365_set($res, 159, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (CloudMail_Office365 Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 160 );
cloudmail_office365_set($res, 160, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudmail_office365_get($res, 161 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudMail_Office365 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudmail_office365_get($res, 162 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudMail_Office365 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudmail_office365_get($res, 163 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudMail_Office365 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudmail_office365_get($res, 164 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudMail_Office365 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudmail_office365_get($res, 165 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudMail_Office365 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudmail_office365_get($res, 166 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudMail_Office365 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudmail_office365_get($res, 167 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudMail_Office365 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 168 );
cloudmail_office365_set($res, 168, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (CloudMail_Office365 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 169 );
cloudmail_office365_set($res, 169, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudMail_Office365 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudmail_office365_get($res, 170 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudMail_Office365 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudmail_office365_get($res, 171 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudMail_Office365 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudmail_office365_get($res, 172 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudmail_office365_get($res, 173 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudmail_office365_get($res, 174 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudmail_office365_get($res, 175 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudMail_Office365 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudmail_office365_get($res, 176 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudMail_Office365 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudmail_office365_get($res, 177 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudMail_Office365 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudmail_office365_get($res, 178 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudmail_office365_get($res, 179 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudMail_Office365 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudmail_office365_get($res, 180 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_office365_get($res, 181 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudmail_office365_get($res, 182 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudMail_Office365 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudmail_office365_get($res, 183 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudMail_Office365 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudmail_office365_get($res, 184 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertStore Property (CloudMail_Office365 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 185 );
cloudmail_office365_set($res, 185, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 186 );
cloudmail_office365_set($res, 186, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (CloudMail_Office365 Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 187 );
cloudmail_office365_set($res, 187, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudmail_office365_get($res, 188 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudMail_Office365 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudmail_office365_get($res, 189 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudMail_Office365 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudmail_office365_get($res, 190 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudMail_Office365 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudmail_office365_get($res, 191 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudMail_Office365 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudmail_office365_get($res, 192 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudMail_Office365 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudmail_office365_get($res, 193 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudMail_Office365 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudmail_office365_get($res, 194 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudMail_Office365 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 195 );
cloudmail_office365_set($res, 195, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (CloudMail_Office365 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 196 );
cloudmail_office365_set($res, 196, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudMail_Office365 Class)

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

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_get($res, 197 );
cloudmail_office365_set($res, 197, $value );

Default Value

0

Remarks

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

Possible values are as follows:

Additional Notes

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudMail_Office365 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudmail_office365_get($res, 198 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudMail_Office365 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudmail_office365_get($res, 199 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudMail_Office365 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudmail_office365_get($res, 200 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudmail_office365_get($res, 201 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudmail_office365_get($res, 202 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudmail_office365_get($res, 203 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudMail_Office365 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudmail_office365_get($res, 204 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudMail_Office365 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudmail_office365_get($res, 205 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudMail_Office365 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudmail_office365_get($res, 206 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudmail_office365_get($res, 207 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudMail_Office365 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudmail_office365_get($res, 208 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudmail_office365_get($res, 209 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudmail_office365_get($res, 210 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudMail_Office365 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudmail_office365_get($res, 211 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudMail_Office365 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudmail_office365_get($res, 212 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudMail_Office365 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudmail_office365_get($res, 213 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudmail_office365_get($res, 214 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudMail_Office365 Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudmail_office365_get($res, 215 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudMail_Office365 Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudmail_office365_get($res, 216 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudMail_Office365 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudmail_office365_get($res, 217 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudMail_Office365 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudmail_office365_get($res, 218 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudMail_Office365 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudmail_office365_get($res, 219 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudMail_Office365 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudmail_office365_get($res, 220 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudMail_Office365 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudmail_office365_get($res, 221 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudMail_Office365 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudmail_office365_get($res, 222 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudMail_Office365 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudmail_office365_get($res, 223 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudMail_Office365 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudmail_office365_get($res, 224 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

AddAttachment Method (CloudMail_Office365 Class)

Adds a file attachment to an existing message.

Object Oriented Interface

public function doAddAttachment($messageid, $name, $localfile);

Procedural Interface

cloudmail_office365_do_addattachment($res, $messageid, $name, $localfile);

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

AddItemAttachment Method (CloudMail_Office365 Class)

Adds an item attachment to an existing message.

Object Oriented Interface

public function doAddItemAttachment($messageid, $msgtoattachid, $itemjson);

Procedural Interface

cloudmail_office365_do_additemattachment($res, $messageid, $msgtoattachid, $itemjson);

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

Authorize Method (CloudMail_Office365 Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudmail_office365_do_authorize($res);

Remarks

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

For more information, see the introduction section.

Config Method (CloudMail_Office365 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudmail_office365_do_config($res, $configurationstring);

Remarks

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

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

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

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

Copy Method (CloudMail_Office365 Class)

Creates a copy of a message.

Object Oriented Interface

public function doCopy($id, $destinationid);

Procedural Interface

cloudmail_office365_do_copy($res, $id, $destinationid);

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.

CopyFolder Method (CloudMail_Office365 Class)

Copies a folder.

Object Oriented Interface

public function doCopyFolder($id, $destfolderid);

Procedural Interface

cloudmail_office365_do_copyfolder($res, $id, $destfolderid);

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.

CreateCategory Method (CloudMail_Office365 Class)

Creates a new category.

Object Oriented Interface

public function doCreateCategory($displayname, $color);

Procedural Interface

cloudmail_office365_do_createcategory($res, $displayname, $color);

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

CreateContact Method (CloudMail_Office365 Class)

Creates a contact.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_do_createcontact($res, $firstname, $lastname, $emailaddress, $parentid);

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.

CreateDraft Method (CloudMail_Office365 Class)

Creates a new email draft.

Object Oriented Interface

public function doCreateDraft($drafttype, $id);

Procedural Interface

cloudmail_office365_do_createdraft($res, $drafttype, $id);

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

CreateFolder Method (CloudMail_Office365 Class)

Creates a new folder.

Object Oriented Interface

public function doCreateFolder($foldername, $parentfolderid);

Procedural Interface

cloudmail_office365_do_createfolder($res, $foldername, $parentfolderid);

Remarks

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

Delete Method (CloudMail_Office365 Class)

Deletes a message.

Object Oriented Interface

public function doDelete($id);

Procedural Interface

cloudmail_office365_do_delete($res, $id);

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.

DeleteAttachment Method (CloudMail_Office365 Class)

Deletes an attachment.

Object Oriented Interface

public function doDeleteAttachment($id, $attachmentid);

Procedural Interface

cloudmail_office365_do_deleteattachment($res, $id, $attachmentid);

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.

DeleteCategory Method (CloudMail_Office365 Class)

Deletes a mail category.

Object Oriented Interface

public function doDeleteCategory($id);

Procedural Interface

cloudmail_office365_do_deletecategory($res, $id);

Remarks

This method deletes a mail category from the current mailbox. This method will not update the Categories properties.

DeleteContact Method (CloudMail_Office365 Class)

Deletes a contact.

Object Oriented Interface

public function doDeleteContact($id);

Procedural Interface

cloudmail_office365_do_deletecontact($res, $id);

Remarks

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

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" 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; } }

DeleteFolder Method (CloudMail_Office365 Class)

Deletes a folder.

Object Oriented Interface

public function doDeleteFolder($id);

Procedural Interface

cloudmail_office365_do_deletefolder($res, $id);

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.

Forward Method (CloudMail_Office365 Class)

Forward a message.

Object Oriented Interface

public function doForward($id, $messagehtml, $torecipients);

Procedural Interface

cloudmail_office365_do_forward($res, $id, $messagehtml, $torecipients);

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

GetCategory Method (CloudMail_Office365 Class)

Retrieves a mail category.

Object Oriented Interface

public function doGetCategory($id);

Procedural Interface

cloudmail_office365_do_getcategory($res, $id);

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.

GetContact Method (CloudMail_Office365 Class)

Retrieves the contact by Id.

Object Oriented Interface

public function doGetContact($id);

Procedural Interface

cloudmail_office365_do_getcontact($res, $id);

Remarks

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

Example (Get a Contact)

// Retrieve a contact by its ID string contactId = "12345"; // Replace with the actual contact ID 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

GetContactField Method (CloudMail_Office365 Class)

Retrieves the contact property value by JSONPath.

Object Oriented Interface

public function doGetContactField($index, $jsonpath);

Procedural Interface

cloudmail_office365_do_getcontactfield($res, $index, $jsonpath);

Remarks

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

Example (Access Fields of a Contact)

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

GetFolder Method (CloudMail_Office365 Class)

Retrieves a folder.

Object Oriented Interface

public function doGetFolder($id);

Procedural Interface

cloudmail_office365_do_getfolder($res, $id);

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.

Interrupt Method (CloudMail_Office365 Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudmail_office365_do_interrupt($res);

Remarks

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

ListAttachments Method (CloudMail_Office365 Class)

Lists all of a message's attachments.

Object Oriented Interface

public function doListAttachments($id);

Procedural Interface

cloudmail_office365_do_listattachments($res, $id);

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

ListCategories Method (CloudMail_Office365 Class)

Lists all mail categories.

Object Oriented Interface

public function doListCategories();

Procedural Interface

cloudmail_office365_do_listcategories($res);

Remarks

This method lists all of the mail categories in the current mailbox. This method clears and populates the Categories properties.

ListChanges Method (CloudMail_Office365 Class)

Lists messages that have been changed within a specified folder.

Object Oriented Interface

public function doListChanges($id, $maxpagesize);

Procedural Interface

cloudmail_office365_do_listchanges($res, $id, $maxpagesize);

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

ListContactFolders Method (CloudMail_Office365 Class)

Lists the contact folders found in the parent folder.

Object Oriented Interface

public function doListContactFolders($parentfolderid);

Procedural Interface

cloudmail_office365_do_listcontactfolders($res, $parentfolderid);

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

ListContacts Method (CloudMail_Office365 Class)

Lists the contacts in a folder.

Object Oriented Interface

public function doListContacts($folderid);

Procedural Interface

cloudmail_office365_do_listcontacts($res, $folderid);

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

ListFolders Method (CloudMail_Office365 Class)

Lists the folders found in the parent folder.

Object Oriented Interface

public function doListFolders($parentfolderid);

Procedural Interface

cloudmail_office365_do_listfolders($res, $parentfolderid);

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

ListMessages Method (CloudMail_Office365 Class)

Lists the messages in a folder.

Object Oriented Interface

public function doListMessages($folderid, $filter);

Procedural Interface

cloudmail_office365_do_listmessages($res, $folderid, $filter);

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

MoveFolder Method (CloudMail_Office365 Class)

Moves a folder.

Object Oriented Interface

public function doMoveFolder($id, $destfolderid);

Procedural Interface

cloudmail_office365_do_movefolder($res, $id, $destfolderid);

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.

MoveMessage Method (CloudMail_Office365 Class)

Moves a message.

Object Oriented Interface

public function doMoveMessage($id, $destinationid);

Procedural Interface

cloudmail_office365_do_movemessage($res, $id, $destinationid);

Remarks

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

RenameFolder Method (CloudMail_Office365 Class)

Renames a folder.

Object Oriented Interface

public function doRenameFolder($folderid, $newname);

Procedural Interface

cloudmail_office365_do_renamefolder($res, $folderid, $newname);

Remarks

This method renames a folder. This method will not update the Folders properties.

Reply Method (CloudMail_Office365 Class)

Reply to a message.

Object Oriented Interface

public function doReply($id, $messagehtml);

Procedural Interface

cloudmail_office365_do_reply($res, $id, $messagehtml);

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

ReplyAll Method (CloudMail_Office365 Class)

ReplyAll to a message.

Object Oriented Interface

public function doReplyAll($id, $messagehtml);

Procedural Interface

cloudmail_office365_do_replyall($res, $id, $messagehtml);

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

Reset Method (CloudMail_Office365 Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudmail_office365_do_reset($res);

Remarks

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

RetrieveAttachment Method (CloudMail_Office365 Class)

Retrieves a message attachment.

Object Oriented Interface

public function doRetrieveAttachment($id, $attachmentid);

Procedural Interface

cloudmail_office365_do_retrieveattachment($res, $id, $attachmentid);

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.

RetrieveMessage Method (CloudMail_Office365 Class)

Retrieves a message.

Object Oriented Interface

public function doRetrieveMessage($id);

Procedural Interface

cloudmail_office365_do_retrievemessage($res, $id);

Remarks

This method retrieves a message.

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

RetrieveMessageRaw Method (CloudMail_Office365 Class)

Retrieves the raw message of the specified message ID.

Object Oriented Interface

public function doRetrieveMessageRaw($id);

Procedural Interface

cloudmail_office365_do_retrievemessageraw($res, $id);

Remarks

This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the Message property.

Search Method (CloudMail_Office365 Class)

Search for messages.

Object Oriented Interface

public function doSearch($searchkey);

Procedural Interface

cloudmail_office365_do_search($res, $searchkey);

Remarks

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

SendCustomRequest Method (CloudMail_Office365 Class)

Send a custom HTTP request.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

SendDraft Method (CloudMail_Office365 Class)

Sends an existing draft.

Object Oriented Interface

public function doSendDraft($id);

Procedural Interface

cloudmail_office365_do_senddraft($res, $id);

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

SendMail Method (CloudMail_Office365 Class)

Sends a new email.

Object Oriented Interface

public function doSendMail($savetosentitems);

Procedural Interface

cloudmail_office365_do_sendmail($res, $savetosentitems);

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

SetContactField Method (CloudMail_Office365 Class)

Sets the contact field value by JSONPath.

Object Oriented Interface

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

Procedural Interface

cloudmail_office365_do_setcontactfield($res, $index, $jsonpath, $value, $valuetype);

Remarks

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

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

Example (Set/Edit Fields of a Contact before Updating): // 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 business address office365.SetContactField(0, "/json/businessAddress", "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"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);

Update Method (CloudMail_Office365 Class)

Updates a message.

Object Oriented Interface

public function doUpdate($id);

Procedural Interface

cloudmail_office365_do_update($res, $id);

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

UpdateCategory Method (CloudMail_Office365 Class)

Updates a category.

Object Oriented Interface

public function doUpdateCategory($id, $color);

Procedural Interface

cloudmail_office365_do_updatecategory($res, $id, $color);

Remarks

This method changes an existing category's color. This method will not update the Categories properties.

UpdateContact Method (CloudMail_Office365 Class)

Updates a contact.

Object Oriented Interface

public function doUpdateContact($index);

Procedural Interface

cloudmail_office365_do_updatecontact($res, $index);

Remarks

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

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

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

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 business address office365.SetContactField(0, "/json/businessAddress", "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"string\"}", 0); // 0 (Object) // Update the contact office365.UpdateContact(0);

AttachmentList Event (CloudMail_Office365 Class)

Fired when an attachment is retrieved from the server.

Object Oriented Interface

public function fireAttachmentList($param);

Procedural Interface

cloudmail_office365_register_callback($res, 1, array($this, 'fireAttachmentList'));

Parameter List

 'id'
 'name'
 'contenttype'
 'contentlocation'
 'contentbytes'
 'contentid'
 'lastmodifieddatetime'
 'isinline'
 'size'

Remarks

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

CategoryList Event (CloudMail_Office365 Class)

Fired when an attachment is retrieved from the server.

Object Oriented Interface

public function fireCategoryList($param);

Procedural Interface

cloudmail_office365_register_callback($res, 2, array($this, 'fireCategoryList'));

Parameter List

 'id'
 'displayname'
 'color'

Remarks

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

ContactFolderList Event (CloudMail_Office365 Class)

Fired when a contact folder is retrieved by the server.

Object Oriented Interface

public function fireContactFolderList($param);

Procedural Interface

cloudmail_office365_register_callback($res, 3, array($this, 'fireContactFolderList'));

Parameter List

 'id'
 'name'
 'parentfolderid'

Remarks

The ContactFolderList event is fired for each contact folder retrieved from the server when ListContactFolders is called.

ContactList Event (CloudMail_Office365 Class)

Fired when a contact is retrieved from the server.

Object Oriented Interface

public function fireContactList($param);

Procedural Interface

cloudmail_office365_register_callback($res, 4, array($this, 'fireContactList'));

Parameter List

 'id'
 'parentid'
 'displayname'
 'firstemail'

Remarks

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

Error Event (CloudMail_Office365 Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudmail_office365_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

FolderList Event (CloudMail_Office365 Class)

Fired when a folder is retrieved by the server.

Object Oriented Interface

public function fireFolderList($param);

Procedural Interface

cloudmail_office365_register_callback($res, 6, array($this, 'fireFolderList'));

Parameter List

 'id'
 'displayname'
 'parentfolderid'
 'childfoldercount'
 'unreaditemcount'
 'totalitemcount'

Remarks

The FolderList event is fired for each folder retrieved from the server when ListFolders is called.

Log Event (CloudMail_Office365 Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudmail_office365_register_callback($res, 7, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

MessageList Event (CloudMail_Office365 Class)

Fired when a message is retrieved from the server.

Object Oriented Interface

public function fireMessageList($param);

Procedural Interface

cloudmail_office365_register_callback($res, 8, array($this, 'fireMessageList'));

Parameter List

 'id'
 'subject'
 'messagesender'
 'receiveddatetime'
 'sentdatetime'
 'hasattachments'
 'bodycontenttype'
 'bodycontent'
 'bodypreview'

Remarks

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

SSLServerAuthentication Event (CloudMail_Office365 Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudmail_office365_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

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

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

SSLStatus Event (CloudMail_Office365 Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudmail_office365_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Transfer Event (CloudMail_Office365 Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudmail_office365_register_callback($res, 11, array($this, 'fireTransfer'));

Parameter List

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

Remarks

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

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

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

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

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

Config Settings (Office365 Class)

The class accepts one or more of the following configuration settings. Configuration 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.

Office365 Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (Office365 Class)

Office365 Errors