Office365 Component

Properties   Methods   Events   Config Settings   Errors  

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

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 property to set the appropriate fields for the chosen ClientProfile and GrantType.

The component has the following defaults:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what GrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the ServerAuthURL and ServerTokenURL 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 ClientProfile and GrantType 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 AccessToken property will be populated. Additionally, if a refresh token was provided the RefreshToken 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 AccessToken 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 AccessToken. 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 GrantType 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 GrantType 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 GrantType the component expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the authorization code, setting the AuthorizationCode 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 RefreshToken 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 = CloudOAuthClientProfiles.cocpApplication; office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365.OAuth.ClientId = CLIENT_ID; office365.OAuth.ClientSecret = CLIENT_SECRET; office365.Authorize();

Client Credentials

When using the Client Credentials grant type, the 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 GrantType the component expects a ClientId, ClientSecret, and ServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Implicit

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

When using the Implicit grant type, the component will request the authorization server to get an access token. For this GrantType the component expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the 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 GrantType the component requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the 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 user.readwrite Contacts.Read Contacts.ReadWrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Sending Messages

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

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

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

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

Receiving Messages

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

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

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

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

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

Listing Contact Folders

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

Example (List All Contact Folders):

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

Listing Contacts

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

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

Example (List all Contacts in the default Contacts folder):

office365.ListContacts("");

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

Example (List all Contacts Pages in the default Contacts folder): do{ office365.ListContacts(""); } while(!office365.ListContactsMarker.isEmpty());

Creating and Updating Contacts

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

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

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

Example (Create a Contact in a Folder)

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

Example (Update a contact)

office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");// Create a contact in the main contacts folder. // Set a company name office365.Contacts[0].CompanyName = "Volkswagen"; // Set notes office365.Contacts[0].Notes = "testNotes"; // Set multiple phone numbers office365.Contacts[0].PhonesCount = 2; office365.Contacts[0].PhoneIndex = 0; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptMobile; office365.Contacts[0].PhoneNumber = "0123456789"; office365.Contacts[0].PhoneIndex = 1; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptBusiness; office365.Contacts[0].PhoneNumber = "9876543210"; // Update the contact office365.UpdateContact(0); The OLContact type used in the Contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add other fields, you can use the SetContactField method. For a complete list of fields a contact can have please refer to the Microsoft Graph API documentation.

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

Retrieving Contacts

Example (Retrieve a Contact)

// Retrieve a contact by its ID string contactId = "12345"; // Replace with the actual contact ID office365.GetContact(contactId); // Access the retrieved contact var retrievedContact = office365.Contacts[office365.Contacts.Count - 1]; retrievedContact.FirstName; //first name retrievedContact.LastName; //last name retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address retrievedContact.EmailAddress; //first email address value retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number retrievedContact.PhoneNumber; //first phone number value office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact

Deleting Contacts

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

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" office365.ListContacts("folder_id"); for (int i = 0; i < office365.Contacts.Count; i++) { if (office365.Contacts[i].DisplayName == "John Doe") { //Delete the contact office365.DeleteContact(office365.Contacts[i].Id); break; } }

Property List

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

Attachments Property (Office365 Component)

Collection of attachments listed by the server.

Syntax

property Attachments: TcmOLAttachmentList read get_Attachments write set_Attachments;

Remarks

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

This property is not available at design time.

Authorization Property (Office365 Component)

An OAuth Authorization String.

Syntax

property Authorization: String read get_Authorization write set_Authorization;

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.

Categories Property (Office365 Component)

Collection of attachments listed by the server.

Syntax

property Categories: TcmOLCategoryList read get_Categories write set_Categories;

Remarks

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

This property is not available at design time.

ChangeMarker Property (Office365 Component)

The page marker for listing changed messages.

Syntax

property ChangeMarker: String read get_ChangeMarker write set_ChangeMarker;

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.

ContactFolders Property (Office365 Component)

The collection of contact folders listed by the server.

Syntax

property ContactFolders: TcmOLContactFolderList read get_ContactFolders write set_ContactFolders;

Remarks

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

This property is not available at design time.

Contacts Property (Office365 Component)

The collection of contacts listed by the server.

Syntax

property Contacts: TcmOLContactList read get_Contacts write set_Contacts;

Remarks

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

Example (Retrieve Contacts from a Folder)

// List contacts of the default Contacts folder of the user office365.ListContacts(""); // Data for each Contact foreach (OLContact contact in office365.Contacts) { contact.FirstName; contact.LastName; contact.EmailAddressIndex=0; contact.EmailAddress; //first email address contact.PhoneIndex=0; contact.PhoneNumber; //first phone number }

This property is not available at design time.

Firewall Property (Office365 Component)

A set of properties related to firewall access.

Syntax

property Firewall: TcmFirewall read get_Firewall write set_Firewall;

Remarks

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

Folders Property (Office365 Component)

Collection of folders listed by the server.

Syntax

property Folders: TcmOLFolderList read get_Folders write set_Folders;

Remarks

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

This property is not available at design time.

ListContactsMarker Property (Office365 Component)

The page marker for listing contacts.

Syntax

property ListContactsMarker: String read get_ListContactsMarker write set_ListContactsMarker;

Default Value

''

Remarks

This property is populated if there are still unlisted contacts after ListContacts is called. It contains the nextLink that will be included as an OData parameter if ListContacts is called again on the same folder. This will cause the next page of contacts to be listed and added to the end of the Contacts collection.

Example (List All Contacts in a Folder):

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

This property is not available at design time.

ListFoldersMarker Property (Office365 Component)

The page marker for listing folders.

Syntax

property ListFoldersMarker: String read get_ListFoldersMarker write set_ListFoldersMarker;

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.

ListMessagesMarker Property (Office365 Component)

The page marker for listing messages.

Syntax

property ListMessagesMarker: String read get_ListMessagesMarker write set_ListMessagesMarker;

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.

Message Property (Office365 Component)

Provides the raw message content.

Syntax

property Message: String read get_Message;
property MessageB: TBytes read get_MessageB;

Default Value

''

Remarks

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

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

MessageAttachments Property (Office365 Component)

A collection of attachments to add to a message.

Syntax

property MessageAttachments: TcmOLAttachmentList read get_MessageAttachments write set_MessageAttachments;

Remarks

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

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

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

This property is not available at design time.

MessageBcc Property (Office365 Component)

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

Syntax

property MessageBcc: String read get_MessageBcc write set_MessageBcc;

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.

MessageBodyContent Property (Office365 Component)

The body content for a message.

Syntax

property MessageBodyContent: String read get_MessageBodyContent write set_MessageBodyContent;

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.

MessageBodyContentType Property (Office365 Component)

The body content type for a message.

Syntax

property MessageBodyContentType: String read get_MessageBodyContentType write set_MessageBodyContentType;

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.

MessageCc Property (Office365 Component)

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

Syntax

property MessageCc: String read get_MessageCc write set_MessageCc;

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.

MessageDeliveryReceipt Property (Office365 Component)

Whether or not a message will request a Delivery Receipt.

Syntax

property MessageDeliveryReceipt: Boolean read get_MessageDeliveryReceipt write set_MessageDeliveryReceipt;

Default Value

false

Remarks

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

MessageFrom Property (Office365 Component)

The author of a message.

Syntax

property MessageFrom: String read get_MessageFrom write set_MessageFrom;

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.

MessageImportance Property (Office365 Component)

The importance of a message.

Syntax

property MessageImportance: String read get_MessageImportance write set_MessageImportance;

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.

MessageInfo Property (Office365 Component)

Collection of information about retrieved messages.

Syntax

property MessageInfo: TcmOLMessageInfoList read get_MessageInfo write set_MessageInfo;

Remarks

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

This property is not available at design time.

MessageOtherHeaders Property (Office365 Component)

The additional message headers for a message.

Syntax

property MessageOtherHeaders: String read get_MessageOtherHeaders write set_MessageOtherHeaders;

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.

MessageReadReceipt Property (Office365 Component)

Whether or not a message will request a Read Receipt.

Syntax

property MessageReadReceipt: Boolean read get_MessageReadReceipt write set_MessageReadReceipt;

Default Value

false

Remarks

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

MessageReplyTo Property (Office365 Component)

A mail address to reply to.

Syntax

property MessageReplyTo: String read get_MessageReplyTo write set_MessageReplyTo;

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.

MessageSubject Property (Office365 Component)

The subject of a message.

Syntax

property MessageSubject: String read get_MessageSubject write set_MessageSubject;

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.

MessageTo Property (Office365 Component)

A comma separated list of recipients for a message.

Syntax

property MessageTo: String read get_MessageTo write set_MessageTo;

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.

NextChangeMarker Property (Office365 Component)

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

Syntax

property NextChangeMarker: String read get_NextChangeMarker write set_NextChangeMarker;

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.

OAuth Property (Office365 Component)

This property holds the OAuth Settings.

Syntax

property OAuth: TcmOAuthSettings read get_OAuth;

Remarks

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

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

Proxy Property (Office365 Component)

A set of properties related to proxy access.

Syntax

property Proxy: TcmProxy read get_Proxy write set_Proxy;

Remarks

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

Select Property (Office365 Component)

The parts of a message that should be retrieved.

Syntax

property Select: String read get_Select write set_Select;

Default Value

''

Remarks

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

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

Messages

Selectable properties for messages include:

Example (Get the Subject and Sender of a Message)

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

Attachments

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

Selectable properties for attachments include:

Example (Get the Name and Size of an attachment)

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

This property is not available at design time.

SSLAcceptServerCert Property (Office365 Component)

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

Syntax

property SSLAcceptServerCert: TcmCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert;

Remarks

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

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

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

SSLCert Property (Office365 Component)

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

Syntax

property SSLCert: TcmCertificate read get_SSLCert write set_SSLCert;

Remarks

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

SSLProvider Property (Office365 Component)

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

Syntax

property SSLProvider: TcmTSSLProviders read get_SSLProvider write set_SSLProvider;

TcmTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

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 as follows:

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, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

SSLServerCert Property (Office365 Component)

The server certificate for the last established connection.

Syntax

property SSLServerCert: TcmCertificate read get_SSLServerCert;

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

AddAttachment Method (Office365 Component)

Adds a file attachment to an existing message.

Syntax

procedure AddAttachment(MessageId: String; Name: String; LocalFile: String);

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

procedure AddItemAttachment(MessageId: String; msgToAttachId: String; ItemJSON: String);

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

procedure Authorize();

Remarks

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

For more information, see the introduction section.

Config Method (Office365 Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

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

procedure Copy(id: String; destinationId: String);

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

procedure CopyFolder(id: String; destFolderID: String);

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

procedure CreateCategory(DisplayName: String; Color: String);

Remarks

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

Example

office365.CreateCategory(categoryName, "preset9");

CreateContact Method (Office365 Component)

Creates a contact.

Syntax

procedure CreateContact(FirstName: String; LastName: String; EmailAddress: String; ParentId: String);

Remarks

This method creates a new contact with the specified first name, last name, and email address. At least one of the arguments must be provided. If all parameters are null or empty, an error is thrown. The contact is added to the parent folder specified by ParentId. Set ParentId to empty string or null to create the contact in the default Contacts folder of the signed-in user. The new contact is added to the end of the Contacts list.

After creating a contact with basic information, you can update it and set additional fields by editing the contact in the Contacts collection and calling the UpdateContact method. For more details, refer to the UpdateContact method.

Example (Create a Contact in the Default Contacts Folder of the User)

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

Example (Create a Contact in a Folder)

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

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

CreateDraft Method (Office365 Component)

Creates a new email draft.

Syntax

procedure CreateDraft(DraftType: Integer; id: String);

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

procedure CreateFolder(folderName: String; parentFolderId: String);

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

procedure Delete(id: String);

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

procedure DeleteAttachment(id: String; attachmentId: String);

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

procedure DeleteCategory(id: String);

Remarks

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

DeleteContact Method (Office365 Component)

Deletes a contact.

Syntax

procedure DeleteContact(id: String);

Remarks

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

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" office365.ListContacts("folder_id"); for (int i = 0; i < office365.Contacts.Count; i++) { if (office365.Contacts[i].DisplayName == "John Doe") { //Delete the contact office365.DeleteContact(office365.Contacts[i].Id); break; } }

DeleteFolder Method (Office365 Component)

Deletes a folder.

Syntax

procedure DeleteFolder(id: String);

Remarks

This method deletes a folder from the current mailbox. id takes the ID of an existing folder. This method will not update the Folders properties.

Forward Method (Office365 Component)

Forward a message.

Syntax

procedure Forward(id: String; messageHTML: String; toRecipients: String);

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

procedure GetCategory(id: String);

Remarks

This method retrieves a mail category.

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

GetContact Method (Office365 Component)

Retrieves the contact by Id.

Syntax

procedure GetContact(Id: String);

Remarks

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

Example (Get a Contact)

// Retrieve a contact by its ID string contactId = "12345"; // Replace with the actual contact ID office365.GetContact(contactId); // Access the retrieved contact var retrievedContact = office365.Contacts[office365.Contacts.Count - 1]; retrievedContact.FirstName; //first name retrievedContact.LastName; //last name retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address retrievedContact.EmailAddress; //first email address value retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number retrievedContact.PhoneNumber; //first phone number value office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact

GetContactField Method (Office365 Component)

Retrieves the contact property value by JSONPath.

Syntax

function GetContactField(index: Integer; JsonPath: String): String;

Remarks

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

Example (Access Fields of a Contact)

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

GetFolder Method (Office365 Component)

Retrieves a folder.

Syntax

procedure GetFolder(id: String);

Remarks

This method retrieves a folder.

The fetched folder can be accessed through the Folders 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

procedure 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

procedure ListAttachments(id: String);

Remarks

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

ListCategories Method (Office365 Component)

Lists all mail categories.

Syntax

procedure ListCategories();

Remarks

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

ListChanges Method (Office365 Component)

Lists messages that have been changed within a specified folder.

Syntax

procedure ListChanges(id: String; maxPageSize: Integer);

Remarks

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

Starting from a Baseline State

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

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

General Usage

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

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

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

ListContactFolders Method (Office365 Component)

Lists the contact folders found in the parent folder.

Syntax

procedure ListContactFolders(parentFolderId: String);

Remarks

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

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

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

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

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

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

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

do{ office365.ListContactFolders(""); // List root folders. } while (!office365.Config("ListContactFoldersMarker").IsEmpty());

ListContacts Method (Office365 Component)

Lists the contacts in a folder.

Syntax

procedure ListContacts(folderId: String);

Remarks

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

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

Example (List all Contacts in the default Contacts folder): office365.ListContacts("");

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

Example (List all Contacts Pages in the default Contacts folder): do{ office365.ListContacts(""); } while(!office365.ListContactsMarker.isEmpty());

ListFolders Method (Office365 Component)

Lists the folders found in the parent folder.

Syntax

procedure ListFolders(parentFolderId: String);

Remarks

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

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

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

Example (List All Folders in the Root Folder)

office365.ListFolders("");

ListMessages Method (Office365 Component)

Lists the messages in a folder.

Syntax

procedure ListMessages(folderId: String; filter: String);

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

procedure MoveFolder(id: String; destFolderId: String);

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

procedure MoveMessage(id: String; destinationId: String);

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

procedure RenameFolder(folderId: String; newName: String);

Remarks

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

Reply Method (Office365 Component)

Reply to a message.

Syntax

procedure Reply(id: String; messageHTML: String);

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

procedure ReplyAll(id: String; messageHTML: String);

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)

This method will reset the component.

Syntax

procedure Reset();

Remarks

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

RetrieveAttachment Method (Office365 Component)

Retrieves a message attachment.

Syntax

procedure RetrieveAttachment(id: String; attachmentId: String);

Remarks

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

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

RetrieveMessage Method (Office365 Component)

Retrieves a message.

Syntax

procedure RetrieveMessage(id: String);

Remarks

This method retrieves a message.

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

RetrieveMessageRaw Method (Office365 Component)

Retrieves the raw message of the specified message ID.

Syntax

procedure RetrieveMessageRaw(id: String);

Remarks

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

Search Method (Office365 Component)

Search for messages.

Syntax

procedure Search(searchKey: String);

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

procedure SendCustomRequest(HTTPMethod: String; URL: String; PostData: String);

Remarks

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

SendDraft Method (Office365 Component)

Sends an existing draft.

Syntax

procedure SendDraft(id: String);

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

procedure SendMail(saveToSentItems: Boolean);

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

SetAttachmentInStream Method (Office365 Component)

Sets an attachment using a stream.

Syntax

procedure SetAttachmentInStream(Index: Integer; InputStream: TStream);

Remarks

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

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

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

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

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

SetContactField Method (Office365 Component)

Sets the contact field value by JSONPath.

Syntax

procedure SetContactField(index: Integer; JsonPath: String; Value: String; ValueType: Integer);

Remarks

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

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

Example (Set/Edit Fields of a Contact before Updating): // Create a contact in the main contacts folder. office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Set company name office365.SetContactField(0, "/json/companyName", "nsoftware", 2); // 2 (String) // Set business address office365.SetContactField(0, "/json/businessAddress", "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"string\"}", 0); // 0 (Object) office365.SetContactField(0, "/json/emailAddresses", "[{"name": "Garth", "address": "garth@contoso.com"}, {"name": "Garth", "address": "garth1@contoso.com"}]", 1); // 1 (Array) // Update the contact office365.UpdateContact(0);

Update Method (Office365 Component)

Updates a message.

Syntax

procedure Update(id: String);

Remarks

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

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

Example (Reply Draft)

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

UpdateCategory Method (Office365 Component)

Updates a category.

Syntax

procedure UpdateCategory(id: String; color: String);

Remarks

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

UpdateContact Method (Office365 Component)

Updates a contact.

Syntax

procedure UpdateContact(index: Integer);

Remarks

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

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

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

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

AttachmentList Event (Office365 Component)

Fired when an attachment is retrieved from the server.

Syntax

type TAttachmentListEvent = procedure (
  Sender: TObject;
  const Id: String;
  const Name: String;
  const ContentType: String;
  const ContentLocation: String;
  const ContentBytes: String;
  const ContentBytesB: TBytes;
  const ContentId: String;
  const LastModifiedDateTime: String;
  IsInline: Boolean;
  Size: Integer
) of Object;

property OnAttachmentList: TAttachmentListEvent 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

type TCategoryListEvent = procedure (
  Sender: TObject;
  const Id: String;
  const DisplayName: String;
  const Color: String
) of Object;

property OnCategoryList: TCategoryListEvent read FOnCategoryList write FOnCategoryList;

Remarks

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

ContactFolderList Event (Office365 Component)

Fired when a contact folder is retrieved by the server.

Syntax

type TContactFolderListEvent = procedure (
  Sender: TObject;
  const Id: String;
  const Name: String;
  const ParentFolderId: String
) of Object;

property OnContactFolderList: TContactFolderListEvent read FOnContactFolderList write FOnContactFolderList;

Remarks

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

ContactList Event (Office365 Component)

Fired when a contact is retrieved from the server.

Syntax

type TContactListEvent = procedure (
  Sender: TObject;
  const Id: String;
  const ParentId: String;
  const DisplayName: String;
  const FirstEmail: String
) of Object;

property OnContactList: TContactListEvent read FOnContactList write FOnContactList;

Remarks

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

Error Event (Office365 Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent 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

type TFolderListEvent = procedure (
  Sender: TObject;
  const Id: String;
  const DisplayName: String;
  const ParentFolderId: String;
  ChildFolderCount: Integer;
  UnreadItemCount: Integer;
  TotalItemCount: Integer
) of Object;

property OnFolderList: TFolderListEvent 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)

Fired once for each log message.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

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

type TMessageListEvent = procedure (
  Sender: TObject;
  const Id: String;
  const Subject: String;
  const MessageSender: String;
  const ReceivedDateTime: String;
  const SentDateTime: String;
  HasAttachments: Boolean;
  const BodyContentType: String;
  const BodyContent: String;
  const BodyPreview: String
) of Object;

property OnMessageList: TMessageListEvent 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

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  const CertEncoded: String;
  const CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent 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)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent 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)

Fired while a document transfers (delivers document).

Syntax

type TTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer;
  BytesTransferred: Int64;
  PercentDone: Integer;
  const Text: String;
  const TextB: TBytes
) of Object;

property OnTransfer: TTransferEvent 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.

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

Constructors

>

constructor Create();

constructor Create(valEncoded: TBytes);

constructor Create(valStoreType: TcmCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

constructor Create(valStoreType: TcmCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

constructor Create();

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

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

Fields

Constructors

constructor Create();

OLAttachment Type

Holds information about an attachment.

Remarks

Holds information about an attachment.

Fields

Constructors

constructor Create();

constructor Create(valFileName: String);

constructor Create(valName: String; valFileName: String);

OLCategory Type

Holds information about a category.

Remarks

Holds information about a category.

Fields

Constructors

constructor Create();

OLContact Type

Holds information about a contact.

Remarks

Holds information about a contact.

Fields

Constructors

constructor Create();

OLContactFolder Type

Holds information about a contact folder.

Remarks

Holds information about a contact folder.

Fields

Constructors

constructor Create();

OLFolder Type

Holds information about a folder.

Remarks

Holds information about a folder.

Fields

Constructors

constructor Create();

OLMessageInfo Type

Holds information about a message.

Remarks

Holds information about a message.

Fields

Constructors

constructor Create();

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

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

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings