Office365 Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TcmOffice365

Remarks

This component provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the component, first set the Authorization property to a valid OAuth token. The Office365 component 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 component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The component 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 component. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

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

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

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

Authorization Code

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

Example: Office365 office365 = new Office365(); office365.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; office365.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; office365.OAuth.ClientId = CLIENT_ID; office365.OAuth.ClientSecret = CLIENT_SECRET; office365.Authorize();

Client Credentials

When using the Client Credentials grant type, the component will act as a service instead of authorizing and authenticating as a user. This allows for the component 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 component 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 component will request the authorization server to get an access token. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the access token from the redirect.

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

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 component will authenticate as the resource owner. This allows for the component 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 component 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

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the component to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Sending Messages

There are two methods for sending new messages using the Office365 component. The SendMail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the SendDraft method. In both cases the properties of the new message are assigned through the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.).

Sending a Message with SendDraft: office365.MessageSubject = "Subject Text"; office365.MessageImportance = "Low"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text."; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); string messageId = office365.MessageInfo[0].Id; office365.SendDraft(messageId);

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

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

Receiving Messages

Information about messages fetched by the component can be accessed through the MessageInfo* properties. MessageInfo* properties is populated when the ListMessages, FetchMessage, 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 Folder* properties.

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

By default, the component will fetch one page of 100 messages when ListMessages is called. If additional messages remain in the folder, the ListMessagesMarker property will be populated. If ListMessages is then called again on the same folder the next page of messages will be fetched. The example below populates MessageInfo* properties with all the messages in a particular folder. do { office365.ListMessages(folderId); } while (office365.ListMessagesMarker.Length > 0);

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AttachmentCount Property (Office365 Component)

The number of records in the Attachment arrays.

Syntax

__property int AttachmentCount = { read=FAttachmentCount, write=FSetAttachmentCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentAttachmentType
• AttachmentContentId
• AttachmentContentLocation
• AttachmentContentType
• AttachmentData
• AttachmentFile
• AttachmentId
• AttachmentIsInline
• AttachmentLastModifiedDate
• AttachmentName
• 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 (Office365 Component)

This property contains the attachment type of the attachment.

Syntax

__property String AttachmentAttachmentType[int AttachmentIndex] = { read=FAttachmentAttachmentType };

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

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

Syntax

__property String AttachmentContentId[int AttachmentIndex] = { read=FAttachmentContentId, write=FSetAttachmentContentId };

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

This property contains the content location of the attachment.

Syntax

__property String AttachmentContentLocation[int AttachmentIndex] = { read=FAttachmentContentLocation };

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

This property contains the content type of the attachment.

Syntax

__property String AttachmentContentType[int AttachmentIndex] = { read=FAttachmentContentType };

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

This property contains the raw data of the attachment.

Syntax

__property String AttachmentData[int AttachmentIndex] = { read=FAttachmentData, write=FSetAttachmentData };
__property DynamicArray<Byte> AttachmentDataB[int AttachmentIndex] = { read=FAttachmentDataB, write=FSetAttachmentDataB };

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

Byte Array

AttachmentFile Property (Office365 Component)

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

Syntax

__property String AttachmentFile[int AttachmentIndex] = { read=FAttachmentFile, write=FSetAttachmentFile };

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

This property contains the attachment identifier of the attachment.

Syntax

__property String AttachmentId[int AttachmentIndex] = { read=FAttachmentId };

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

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

Syntax

__property bool AttachmentIsInline[int AttachmentIndex] = { read=FAttachmentIsInline, write=FSetAttachmentIsInline };

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

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

Syntax

__property String AttachmentLastModifiedDate[int AttachmentIndex] = { read=FAttachmentLastModifiedDate, write=FSetAttachmentLastModifiedDate };

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

This property contains the name of the attachment.

Syntax

__property String AttachmentName[int AttachmentIndex] = { read=FAttachmentName, write=FSetAttachmentName };

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

AttachmentSize Property (Office365 Component)

This property contains the size in bytes of the attachment.

Syntax

__property int AttachmentSize[int AttachmentIndex] = { read=FAttachmentSize, write=FSetAttachmentSize };

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

An OAuth Authorization String.

Syntax

__property String Authorization = { read=FAuthorization, write=FSetAuthorization };

Default Value

""

Remarks

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

Example

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

The number of records in the Category arrays.

Syntax

__property int CategoryCount = { read=FCategoryCount, write=FSetCategoryCount };

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

This property contains the color of the category.

Syntax

__property String CategoryColor[int CategoryIndex] = { read=FCategoryColor };

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

This property contains the display name of the category.

Syntax

__property String CategoryDisplayName[int CategoryIndex] = { read=FCategoryDisplayName };

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

This property contains the unique identifier of the category.

Syntax

__property String CategoryId[int CategoryIndex] = { read=FCategoryId };

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

The page marker for listing changed messages.

Syntax

__property String ChangeMarker = { read=FChangeMarker, write=FSetChangeMarker };

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

FirewallAutoDetect Property (Office365 Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

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

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (Office365 Component)

This property determines the type of firewall to connect through.

Syntax

__property TcmOffice365FirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TcmOffice365FirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (Office365 Component)

This property contains the name or IP address of firewall (optional).

Syntax

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

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (Office365 Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

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

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (Office365 Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

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

Default Value

0

Remarks

This property contains 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 (Office365 Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

FolderCount Property (Office365 Component)

The number of records in the Folder arrays.

Syntax

__property int FolderCount = { read=FFolderCount, write=FSetFolderCount };

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

The number of child folders the folder has.

Syntax

__property int FolderChildFolderCount[int FolderIndex] = { read=FFolderChildFolderCount };

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

The child folders of the folder.

Syntax

__property String FolderChildFolders[int FolderIndex] = { read=FFolderChildFolders };

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

The display name of the folder.

Syntax

__property String FolderDisplayName[int FolderIndex] = { read=FFolderDisplayName };

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

The unique identifier of the folder.

Syntax

__property String FolderId[int FolderIndex] = { read=FFolderId };

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

The message rules of the folder.

Syntax

__property String FolderMessageRules[int FolderIndex] = { read=FFolderMessageRules };

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

The messages contained in the folder.

Syntax

__property String FolderMessages[int FolderIndex] = { read=FFolderMessages };

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

The multi-value extended properties defined for the folder.

Syntax

__property String FolderMultiValueExtendedProperties[int FolderIndex] = { read=FFolderMultiValueExtendedProperties };

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

The unique identifier for the folder's parent.

Syntax

__property String FolderParentFolderId[int FolderIndex] = { read=FFolderParentFolderId };

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

The single-value extended properties defined for the folder.

Syntax

__property String FolderSingleValueExtendedProperties[int FolderIndex] = { read=FFolderSingleValueExtendedProperties };

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

The number of total items in the folder.

Syntax

__property int FolderTotalItemCount[int FolderIndex] = { read=FFolderTotalItemCount };

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

The number of unread items in the folder.

Syntax

__property int FolderUnreadItemCount[int FolderIndex] = { read=FFolderUnreadItemCount };

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

ListFoldersMarker Property (Office365 Component)

The page marker for listing folders.

Syntax

__property String ListFoldersMarker = { read=FListFoldersMarker, write=FSetListFoldersMarker };

Default Value

""

Remarks

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

Example (List All Folders in the Root Directory)

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

This property is not available at design time.

Data Type

String

ListMessagesMarker Property (Office365 Component)

The page marker for listing messages.

Syntax

__property String ListMessagesMarker = { read=FListMessagesMarker, write=FSetListMessagesMarker };

Default Value

""

Remarks

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

Example (List All Messages in a Folder)

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

This property is not available at design time.

Data Type

String

Message Property (Office365 Component)

Provides the raw message content.

Syntax

__property String Message = { read=FMessage };
__property DynamicArray<Byte> MessageB = { read=FMessageB };

Default Value

""

Remarks

This property is populated after calling FetchMessageRaw and holds the raw message content. This can be used to access the data before any processing is done by the component.

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

Data Type

Byte Array

MessageAttachmentCount Property (Office365 Component)

The number of records in the MessageAttachment arrays.

Syntax

__property int MessageAttachmentCount = { read=FMessageAttachmentCount, write=FSetMessageAttachmentCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageAttachmentAttachmentType
• MessageAttachmentContentId
• MessageAttachmentContentLocation
• MessageAttachmentContentType
• MessageAttachmentData
• MessageAttachmentFile
• MessageAttachmentId
• MessageAttachmentIsInline
• MessageAttachmentLastModifiedDate
• MessageAttachmentName
• 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 (Office365 Component)

This property contains the attachment type of the attachment.

Syntax

__property String MessageAttachmentAttachmentType[int MessageAttachmentIndex] = { read=FMessageAttachmentAttachmentType };

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

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

Syntax

__property String MessageAttachmentContentId[int MessageAttachmentIndex] = { read=FMessageAttachmentContentId, write=FSetMessageAttachmentContentId };

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

This property contains the content location of the attachment.

Syntax

__property String MessageAttachmentContentLocation[int MessageAttachmentIndex] = { read=FMessageAttachmentContentLocation };

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

This property contains the content type of the attachment.

Syntax

__property String MessageAttachmentContentType[int MessageAttachmentIndex] = { read=FMessageAttachmentContentType };

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

This property contains the raw data of the attachment.

Syntax

__property String MessageAttachmentData[int MessageAttachmentIndex] = { read=FMessageAttachmentData, write=FSetMessageAttachmentData };
__property DynamicArray<Byte> MessageAttachmentDataB[int MessageAttachmentIndex] = { read=FMessageAttachmentDataB, write=FSetMessageAttachmentDataB };

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

Byte Array

MessageAttachmentFile Property (Office365 Component)

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

Syntax

__property String MessageAttachmentFile[int MessageAttachmentIndex] = { read=FMessageAttachmentFile, write=FSetMessageAttachmentFile };

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

This property contains the attachment identifier of the attachment.

Syntax

__property String MessageAttachmentId[int MessageAttachmentIndex] = { read=FMessageAttachmentId };

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

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

Syntax

__property bool MessageAttachmentIsInline[int MessageAttachmentIndex] = { read=FMessageAttachmentIsInline, write=FSetMessageAttachmentIsInline };

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

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

Syntax

__property String MessageAttachmentLastModifiedDate[int MessageAttachmentIndex] = { read=FMessageAttachmentLastModifiedDate, write=FSetMessageAttachmentLastModifiedDate };

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

This property contains the name of the attachment.

Syntax

__property String MessageAttachmentName[int MessageAttachmentIndex] = { read=FMessageAttachmentName, write=FSetMessageAttachmentName };

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

MessageAttachmentSize Property (Office365 Component)

This property contains the size in bytes of the attachment.

Syntax

__property int MessageAttachmentSize[int MessageAttachmentIndex] = { read=FMessageAttachmentSize, write=FSetMessageAttachmentSize };

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

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

Syntax

__property String MessageBcc = { read=FMessageBcc, write=FSetMessageBcc };

Default Value

""

Remarks

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

Example (Add a Bcc Recipient)

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

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

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

This property is not available at design time.

Data Type

String

MessageBodyContent Property (Office365 Component)

The body content for a message.

Syntax

__property String MessageBodyContent = { read=FMessageBodyContent, write=FSetMessageBodyContent };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageBodyContentType Property (Office365 Component)

The body content type for a message.

Syntax

__property String MessageBodyContentType = { read=FMessageBodyContentType, write=FSetMessageBodyContentType };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageCc Property (Office365 Component)

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

Syntax

__property String MessageCc = { read=FMessageCc, write=FSetMessageCc };

Default Value

""

Remarks

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

Example (Add a CC Recipient)

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

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

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

This property is not available at design time.

Data Type

String

MessageDeliveryReceipt Property (Office365 Component)

Whether or not a message will request a Delivery Receipt.

Syntax

__property bool MessageDeliveryReceipt = { read=FMessageDeliveryReceipt, write=FSetMessageDeliveryReceipt };

Default Value

false

Remarks

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

Data Type

Boolean

MessageFrom Property (Office365 Component)

The author of a message.

Syntax

__property String MessageFrom = { read=FMessageFrom, write=FSetMessageFrom };

Default Value

""

Remarks

This property contains the author of a message. This property is optional. If it is left blank, the message's author will be the Microsoft account used in Authorization.

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

Example (Specify Message Author)

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

Example (Specify Message Author - Name Included)

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

This property is not available at design time.

Data Type

String

MessageImportance Property (Office365 Component)

The importance of a message.

Syntax

__property String MessageImportance = { read=FMessageImportance, write=FSetMessageImportance };

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

The number of records in the MessageInfo arrays.

Syntax

__property int MessageInfoCount = { read=FMessageInfoCount, write=FSetMessageInfoCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageInfoBcc
• 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 (Office365 Component)

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

Syntax

__property String MessageInfoBcc[int MessageInfoIndex] = { read=FMessageInfoBcc, write=FSetMessageInfoBcc };

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

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

Syntax

__property String MessageInfoBodyContent[int MessageInfoIndex] = { read=FMessageInfoBodyContent, write=FSetMessageInfoBodyContent };

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

The body content type (e.

Syntax

__property String MessageInfoBodyContentType[int MessageInfoIndex] = { read=FMessageInfoBodyContentType, write=FSetMessageInfoBodyContentType };

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

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

Syntax

__property String MessageInfoBodyPreview[int MessageInfoIndex] = { read=FMessageInfoBodyPreview };

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

The categories of a message in a message info listing.

Syntax

__property String MessageInfoCategories[int MessageInfoIndex] = { read=FMessageInfoCategories, write=FSetMessageInfoCategories };

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

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

Syntax

__property String MessageInfoCc[int MessageInfoIndex] = { read=FMessageInfoCc, write=FSetMessageInfoCc };

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

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

Syntax

__property String MessageInfoConversationId[int MessageInfoIndex] = { read=FMessageInfoConversationId };

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

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

Syntax

__property String MessageInfoConversationIndex[int MessageInfoIndex] = { read=FMessageInfoConversationIndex };

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

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

Syntax

__property String MessageInfoCreatedDate[int MessageInfoIndex] = { read=FMessageInfoCreatedDate };

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

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

Syntax

__property bool MessageInfoDeliveryReceiptRequested[int MessageInfoIndex] = { read=FMessageInfoDeliveryReceiptRequested, write=FSetMessageInfoDeliveryReceiptRequested };

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

Message flag in a message info listing.

Syntax

__property String MessageInfoFlagStatus[int MessageInfoIndex] = { read=FMessageInfoFlagStatus, write=FSetMessageInfoFlagStatus };

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

The sender of a message in a message info listing.

Syntax

__property String MessageInfoFrom[int MessageInfoIndex] = { read=FMessageInfoFrom };

Default Value

""

Remarks

The sender of a message in a message info listing.

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

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

Data Type

String

MessageInfoHasAttachments Property (Office365 Component)

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

Syntax

__property bool MessageInfoHasAttachments[int MessageInfoIndex] = { read=FMessageInfoHasAttachments };

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

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

Syntax

__property String MessageInfoId[int MessageInfoIndex] = { read=FMessageInfoId };

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

The importance of a message in a message info listing.

Syntax

__property String MessageInfoImportance[int MessageInfoIndex] = { read=FMessageInfoImportance, write=FSetMessageInfoImportance };

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

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

Syntax

__property String MessageInfoInferenceClassification[int MessageInfoIndex] = { read=FMessageInfoInferenceClassification };

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

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

Syntax

__property bool MessageInfoIsDraft[int MessageInfoIndex] = { read=FMessageInfoIsDraft };

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

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

Syntax

__property bool MessageInfoIsRead[int MessageInfoIndex] = { read=FMessageInfoIsRead, write=FSetMessageInfoIsRead };

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

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

Syntax

__property String MessageInfoJSON[int MessageInfoIndex] = { read=FMessageInfoJSON, write=FSetMessageInfoJSON };

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

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

Syntax

__property String MessageInfoLastModifiedDate[int MessageInfoIndex] = { read=FMessageInfoLastModifiedDate };

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

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

Syntax

__property String MessageInfoMessageHeaders[int MessageInfoIndex] = { read=FMessageInfoMessageHeaders };

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

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

Syntax

__property String MessageInfoMessageId[int MessageInfoIndex] = { read=FMessageInfoMessageId };

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

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

Syntax

__property String MessageInfoParentFolderId[int MessageInfoIndex] = { read=FMessageInfoParentFolderId };

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

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

Syntax

__property bool MessageInfoReadReceiptRequested[int MessageInfoIndex] = { read=FMessageInfoReadReceiptRequested, write=FSetMessageInfoReadReceiptRequested };

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

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

Syntax

__property String MessageInfoReceivedDate[int MessageInfoIndex] = { read=FMessageInfoReceivedDate };

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

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

Syntax

__property String MessageInfoReplyTo[int MessageInfoIndex] = { read=FMessageInfoReplyTo, write=FSetMessageInfoReplyTo };

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

The sender of a message in a message info listing.

Syntax

__property String MessageInfoSender[int MessageInfoIndex] = { read=FMessageInfoSender };

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

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

Syntax

__property String MessageInfoSentDate[int MessageInfoIndex] = { read=FMessageInfoSentDate };

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

The subject of a message in a message info listing.

Syntax

__property String MessageInfoSubject[int MessageInfoIndex] = { read=FMessageInfoSubject, write=FSetMessageInfoSubject };

Default Value

""

Remarks

The subject of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoTo Property (Office365 Component)

The recipients of a message in a message info listing.

Syntax

__property String MessageInfoTo[int MessageInfoIndex] = { read=FMessageInfoTo, write=FSetMessageInfoTo };

Default Value

""

Remarks

The recipients of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoWebLink Property (Office365 Component)

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

Syntax

__property String MessageInfoWebLink[int MessageInfoIndex] = { read=FMessageInfoWebLink };

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

The additional message headers for a message.

Syntax

__property String MessageOtherHeaders = { read=FMessageOtherHeaders, write=FSetMessageOtherHeaders };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageReadReceipt Property (Office365 Component)

Whether or not a message will request a Read Receipt.

Syntax

__property bool MessageReadReceipt = { read=FMessageReadReceipt, write=FSetMessageReadReceipt };

Default Value

false

Remarks

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

Data Type

Boolean

MessageReplyTo Property (Office365 Component)

A mail address to reply to.

Syntax

__property String MessageReplyTo = { read=FMessageReplyTo, write=FSetMessageReplyTo };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageSubject Property (Office365 Component)

The subject of a message.

Syntax

__property String MessageSubject = { read=FMessageSubject, write=FSetMessageSubject };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageTo Property (Office365 Component)

A comma separated list of recipients for a message.

Syntax

__property String MessageTo = { read=FMessageTo, write=FSetMessageTo };

Default Value

""

Remarks

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

Example (Add a Recipient)

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

Example (Add a Recipient with a Name and Address)

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

This property is not available at design time.

Data Type

String

NextChangeMarker Property (Office365 Component)

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

Syntax

__property String NextChangeMarker = { read=FNextChangeMarker, write=FSetNextChangeMarker };

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

The access token returned by the authorization server.

Syntax

__property String OAuthAccessToken = { read=FOAuthAccessToken, write=FSetOAuthAccessToken };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (Office365 Component)

The authorization code that is exchanged for an access token.

Syntax

__property String OAuthAuthorizationCode = { read=FOAuthAuthorizationCode, write=FSetOAuthAuthorizationCode };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (Office365 Component)

The scope request or response parameter used during authorization.

Syntax

__property String OAuthAuthorizationScope = { read=FOAuthAuthorizationScope, write=FSetOAuthAuthorizationScope };

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (Office365 Component)

The id of the client assigned when registering the application.

Syntax

__property String OAuthClientId = { read=FOAuthClientId, write=FSetOAuthClientId };

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (Office365 Component)

The type of client that is requesting authorization.

Syntax

__property TcmOffice365OAuthClientProfiles OAuthClientProfile = { read=FOAuthClientProfile, write=FSetOAuthClientProfile };

enum TcmOffice365OAuthClientProfiles {
  cocpApplication=0,
  cocpWeb=1
};

Default Value

cocpApplication

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (Office365 Component)

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

Syntax

__property String OAuthClientSecret = { read=FOAuthClientSecret, write=FSetOAuthClientSecret };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (Office365 Component)

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

Syntax

__property TcmOffice365OAuthGrantTypes OAuthGrantType = { read=FOAuthGrantType, write=FSetOAuthGrantType };

enum TcmOffice365OAuthGrantTypes {
  cogtAuthorizationCode=0,
  cogtImplicit=1,
  cogtPassword=2,
  cogtClientCredentials=3
};

Default Value

cogtAuthorizationCode

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (Office365 Component)

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

Syntax

__property String OAuthRefreshToken = { read=FOAuthRefreshToken, write=FSetOAuthRefreshToken };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (Office365 Component)

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

Syntax

__property String OAuthReturnURL = { read=FOAuthReturnURL, write=FSetOAuthReturnURL };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (Office365 Component)

The URL of the authorization server.

Syntax

__property String OAuthServerAuthURL = { read=FOAuthServerAuthURL, write=FSetOAuthServerAuthURL };

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (Office365 Component)

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

Syntax

__property String OAuthServerTokenURL = { read=FOAuthServerTokenURL, write=FSetOAuthServerTokenURL };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (Office365 Component)

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

Syntax

__property String OAuthWebAuthURL = { read=FOAuthWebAuthURL };

Default Value

""

Remarks

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

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

Data Type

String

ProxyAuthScheme Property (Office365 Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TcmOffice365ProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TcmOffice365ProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (Office365 Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

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

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (Office365 Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

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

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword 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 (Office365 Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

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

Default Value

80

Remarks

This property contains 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 (Office365 Component)

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (Office365 Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TcmOffice365ProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TcmOffice365ProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines 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 (Office365 Component)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

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

Default Value

""

Remarks

This property contains 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 (Office365 Component)

The parts of a message that should be retrieved.

Syntax

__property String Select = { read=FSelect, write=FSetSelect };

Default Value

""

Remarks

This property can be used to select specific message or attachment properties to retrieve when calling ListMessages FetchMessage, ListAttachments, or FetchAttachment. 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

SSLAcceptServerCertEncoded Property (Office365 Component)

This is the certificate (PEM/base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (Office365 Component)

This is the certificate (PEM/base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (Office365 Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (Office365 Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (Office365 Component)

This is the type of certificate store for this certificate.

Syntax

__property TcmOffice365SSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TcmOffice365SSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (Office365 Component)

This is the subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

This is 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

SSLProvider Property (Office365 Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TcmOffice365SSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TcmOffice365SSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

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

Possible values are:

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (Office365 Component)

This is the certificate (PEM/base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

AddAttachment Method (Office365 Component)

Adds a file attachment to an existing message.

Syntax

void __fastcall AddAttachment(String MessageId, String Name, String 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 component 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 component 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 (Office365 Component)

Adds an item attachment to an existing message.

Syntax

void __fastcall AddItemAttachment(String MessageId, String msgToAttachId, String 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 (Office365 Component)

Get the authorization string required to access the protected resource.

Syntax

void __fastcall Authorize();

Remarks

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

For more information, see the introduction section.

Config Method (Office365 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

Copy Method (Office365 Component)

Creates a copy of a message.

Syntax

void __fastcall Copy(String id, String 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 (Office365 Component)

Copies a folder.

Syntax

void __fastcall CopyFolder(String id, String 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 (Office365 Component)

Creates a new category.

Syntax

void __fastcall CreateCategory(String DisplayName, String Color);

Remarks

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

Example

office365.CreateCategory(categoryName, "preset9");

CreateDraft Method (Office365 Component)

Creates a new email draft.

Syntax

void __fastcall CreateDraft(int DraftType, String 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 (Office365 Component)

Creates a new folder.

Syntax

void __fastcall CreateFolder(String folderName, String parentFolderId);

Remarks

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

Delete Method (Office365 Component)

Deletes a message.

Syntax

void __fastcall Delete(String 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 (Office365 Component)

Deletes an attachment.

Syntax

void __fastcall DeleteAttachment(String id, String 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 (Office365 Component)

Deletes a mail category.

Syntax

void __fastcall DeleteCategory(String id);

Remarks

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

DeleteFolder Method (Office365 Component)

Deletes a folder.

Syntax

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

FetchAttachment Method (Office365 Component)

Retrieves a message attachment.

Syntax

void __fastcall FetchAttachment(String id, String 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 Attachment* properties.

FetchMessage Method (Office365 Component)

Retrieves a message.

Syntax

void __fastcall FetchMessage(String id);

Remarks

This method retrieves a message.

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

FetchMessageRaw Method (Office365 Component)

Retrieves the raw message of the specified message ID.

Syntax

void __fastcall FetchMessageRaw(String id);

Remarks

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

Forward Method (Office365 Component)

Forward a message.

Syntax

void __fastcall Forward(String id, String messageHTML, String 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 (Office365 Component)

Retrieves a mail category.

Syntax

void __fastcall GetCategory(String id);

Remarks

This method retrieves a mail category.

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

GetFolder Method (Office365 Component)

Retrieves a folder.

Syntax

void __fastcall GetFolder(String id);

Remarks

This method retrieves a folder.

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

Interrupt Method (Office365 Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

ListAttachments Method (Office365 Component)

Lists all of a message's attachments.

Syntax

void __fastcall ListAttachments(String id);

Remarks

This method lists all of a message's attachments. This method clears and populates the Attachment* properties. //List messages with attachments office365.ListMessage("inbox", "hasAttachments eq true"); //List attachments of the first message office365.ListAttachments(office365.MessageInfo[0].Id);

ListCategories Method (Office365 Component)

Lists all mail categories.

Syntax

void __fastcall ListCategories();

Remarks

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

ListChanges Method (Office365 Component)

Lists messages that have been changed within a specified folder.

Syntax

void __fastcall ListChanges(String id, int 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.)

ListFolders Method (Office365 Component)

Lists the folders found in the parent folder.

Syntax

void __fastcall ListFolders(String parentFolderId);

Remarks

This method lists the folders found in the parent folder. This method clears populates the Folder* 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 (Office365 Component)

Lists the messages in a folder.

Syntax

void __fastcall ListMessages(String folderId, String 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 (Office365 Component)

Moves a folder.

Syntax

void __fastcall MoveFolder(String id, String 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 (Office365 Component)

Moves a message.

Syntax

void __fastcall MoveMessage(String id, String destinationId);

Remarks

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

RenameFolder Method (Office365 Component)

Renames a folder.

Syntax

void __fastcall RenameFolder(String folderId, String newName);

Remarks

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

Reply Method (Office365 Component)

Reply to a message.

Syntax

void __fastcall Reply(String id, String 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 (Office365 Component)

ReplyAll to a message.

Syntax

void __fastcall ReplyAll(String id, String 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 (Office365 Component)

Reset the component.

Syntax

void __fastcall Reset();

Remarks

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

Search Method (Office365 Component)

Search for messages.

Syntax

void __fastcall Search(String searchKey);

Remarks

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

SendCustomRequest Method (Office365 Component)

Send a custom HTTP request.

Syntax

void __fastcall SendCustomRequest(String HTTPMethod, String URL, String PostData);

Remarks

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

SendDraft Method (Office365 Component)

Sends an existing draft.

Syntax

void __fastcall SendDraft(String 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 (Office365 Component)

Sends a new email.

Syntax

void __fastcall SendMail(bool 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);

Update Method (Office365 Component)

Updates a message.

Syntax

void __fastcall Update(String 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 MessageInfo* properties:

*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 (Office365 Component)

Updates a category.

Syntax

void __fastcall UpdateCategory(String id, String color);

Remarks

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

AttachmentList Event (Office365 Component)

Fired when an attachment is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String Name;
  String ContentType;
  String ContentLocation;
  String ContentBytes;
  DynamicArray<Byte> ContentBytesB;
  String ContentId;
  String LastModifiedDateTime;
  bool IsInline;
  int Size;
} TcmOffice365AttachmentListEventParams;
typedef void __fastcall (__closure *TcmOffice365AttachmentListEvent)(System::TObject* Sender, TcmOffice365AttachmentListEventParams *e);
__property TcmOffice365AttachmentListEvent OnAttachmentList = { read=FOnAttachmentList, write=FOnAttachmentList };

Remarks

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

CategoryList Event (Office365 Component)

Fired when an attachment is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String DisplayName;
  String Color;
} TcmOffice365CategoryListEventParams;
typedef void __fastcall (__closure *TcmOffice365CategoryListEvent)(System::TObject* Sender, TcmOffice365CategoryListEventParams *e);
__property TcmOffice365CategoryListEvent OnCategoryList = { read=FOnCategoryList, write=FOnCategoryList };

Remarks

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

Error Event (Office365 Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TcmOffice365ErrorEventParams;
typedef void __fastcall (__closure *TcmOffice365ErrorEvent)(System::TObject* Sender, TcmOffice365ErrorEventParams *e);
__property TcmOffice365ErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FolderList Event (Office365 Component)

Fired when a folder is retrieved by the server.

Syntax

typedef struct {
  String Id;
  String DisplayName;
  String ParentFolderId;
  int ChildFolderCount;
  int UnreadItemCount;
  int TotalItemCount;
} TcmOffice365FolderListEventParams;
typedef void __fastcall (__closure *TcmOffice365FolderListEvent)(System::TObject* Sender, TcmOffice365FolderListEventParams *e);
__property TcmOffice365FolderListEvent OnFolderList = { read=FOnFolderList, write=FOnFolderList };

Remarks

The FolderList event is fired for each folder retrieved from the server when ListFolders is called.

Log Event (Office365 Component)

This event fires once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TcmOffice365LogEventParams;
typedef void __fastcall (__closure *TcmOffice365LogEvent)(System::TObject* Sender, TcmOffice365LogEventParams *e);
__property TcmOffice365LogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MessageList Event (Office365 Component)

Fired when a message is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String Subject;
  String MessageSender;
  String ReceivedDateTime;
  String SentDateTime;
  bool HasAttachments;
  String BodyContentType;
  String BodyContent;
  String BodyPreview;
} TcmOffice365MessageListEventParams;
typedef void __fastcall (__closure *TcmOffice365MessageListEvent)(System::TObject* Sender, TcmOffice365MessageListEventParams *e);
__property TcmOffice365MessageListEvent OnMessageList = { read=FOnMessageList, write=FOnMessageList };

Remarks

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

SSLServerAuthentication Event (Office365 Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TcmOffice365SSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TcmOffice365SSLServerAuthenticationEvent)(System::TObject* Sender, TcmOffice365SSLServerAuthenticationEventParams *e);
__property TcmOffice365SSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

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

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

SSLStatus Event (Office365 Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TcmOffice365SSLStatusEventParams;
typedef void __fastcall (__closure *TcmOffice365SSLStatusEvent)(System::TObject* Sender, TcmOffice365SSLStatusEventParams *e);
__property TcmOffice365SSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Transfer Event (Office365 Component)

This event is fired while a document transfers (delivers document).

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
} TcmOffice365TransferEventParams;
typedef void __fastcall (__closure *TcmOffice365TransferEvent)(System::TObject* Sender, TcmOffice365TransferEventParams *e);
__property TcmOffice365TransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (Office365 Component)

Office365 Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (Office365 Component)

Office365 Errors