# Office365 Class

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

## Syntax

**cloudmail.office365()**

## Remarks

This class provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the class, first set the [Authorization](#office365authorization-property) property to a valid OAuth token. The Office365 class can be used for sending or creating new messages; retrieving, moving, or copying existing messages; creating, deleting, or copying folders; and several other functionalities supported by the Microsoft Graph API.

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the [OAuth](#office365oauth-property) property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

|  |  |
| --- | --- |
| Authorization Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" |
| Token Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/token" |
| Scopes | "offline_access mail.readwrite mail.send contacts.readwrite user.read" |

Additionally, depending on how the application is registered (e.g. Multi-tenant) and what OAuthGrantType is selected (e.g. 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:

|  |  |
| --- | --- |
| Authorization Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize" |
| Token Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token" |
| Scopes | "https://graph.microsoft.com/.default" |

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

### Application Profile

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

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

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

**Authorization Code**

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

**Example: **

```csharp
Office365 office365 = new Office365();

office365.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
office365.OAuth.ClientId = CLIENT_ID;
office365.OAuth.ClientSecret = CLIENT_SECRET;

office365.Authorize();
```

**Client Credentials**

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

**Implicit**

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

When using the *Implicit* grant type, the class will request the authorization server to get an *access token*. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the [Authorize](#office365authorize-method) method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the *access token* from the redirect.

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

**Password**

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

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

For this OAuthGrantType the class requires [OAuthPasswordGrantUsername](#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](#office365authorize-method) method is called, the component will make a request to the token server for an *access token* using the username and password. The token server will return an *access token* if the authentication was successful. When this *access token* is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

### Web Profile

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

### External OAuth Support

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

```text
Bearer ACCESS_TOKEN_VALUE
```

Assign this value to the [Authorization](#office365authorization-property) property before attempting any operations. Setting the [Authorization](#office365authorization-property) property will cause the class to ignore the values set in the [OAuth](#office365oauth-property) property.

 For Example:

```csharp
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](#office365sendmail-method) method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the [SendDraft](#office365senddraft-method) method. In both cases the properties of the new message are assigned through the Message properties ([MessageSubject](#office365messagesubject-property), [MessageBodyContent](#office365messagebodycontent-property), [MessageCc](#office365messagecc-property), etc.).

**Sending a Message with SendDraft:**

```csharp
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](#office365reply-method), [ReplyAll](#office365replyall-method), and [Forward](#office365forward-method) 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](#office365senddraft-method) method. Unlike creating a new message, only the direct methods use the Message properties ([MessageSubject](#office365messagesubject-property), [MessageBodyContent](#office365messagebodycontent-property), [MessageCc](#office365messagecc-property), etc.). When using [CreateDraft](#office365createdraft-method), the draft must first be made then updated using the [MessageInfo](#office365messageinfo-property) collection and [Update](#office365update-method) method.

**Sending a Reply with SendDraft:**

```csharp
//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](#office365messageinfo-property) collection. [MessageInfo](#office365messageinfo-property) collection is populated when the [ListMessages](#office365listmessages-method), [RetrieveMessage](#office365retrievemessage-method), [Search](#office365search-method), or [ListChanges](#office365listchanges-method) methods are called.

The [ListMessages](#office365listmessages-method) and [ListChanges](#office365listchanges-method) 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](#office365listfolders-method) method and the [Folders](#office365folders-property) collection.

**Listing Messages in a Folder:**

```csharp
// 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](#office365listmessages-method) is called. If additional messages remain in the folder, the [ListMessagesMarker](#office365listmessagesmarker-property) property will be populated. If [ListMessages](#office365listmessages-method) is then called again on the same folder the next page of messages will be fetched. The example below populates [MessageInfo](#office365messageinfo-property) collection with all the messages in a particular folder.

```csharp
do {
  office365.ListMessages(folderId);
} while (office365.ListMessagesMarker.Length > 0);
```

The message page size may also be changed by using the [MessagePageSize](#MessagePageSize) configuration setting.

### Listing Contact Folders

To list the contact folders of a user use the [ListContactFolders](#office365listcontactfolders-method) method. It populates the [ContactFolders](#office365contactfolders-property) collection with the retrieved folders. For each retrieved folder the [ContactFolderList](#office365contactfolderlist-event) event is fired.

**Example (List All Contact Folders): **

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

### Listing Contacts

Use the [ListContacts](#office365listcontacts-method) to populate the [Contacts](#office365contacts-property) 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](#office365contactlist-event) event is fired.

**Example (List All Contacts in a Folder)**

```text
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):**

```csharp
office365.ListContacts("");
```

If the number of contacts exceeds the page size, the [ListContactsMarker](#office365listcontactsmarker-property) 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](#office365contacts-property) collection.

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

```csharp
do{
  office365.ListContacts("");
} while(!office365.ListContactsMarker.isEmpty());
```

### Creating and Updating Contacts

To create a new contact use the [CreateContact](#office365createcontact-method) 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](#office365contacts-property) collection.

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

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

**Example (Create a Contact in a Folder)**

```csharp
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](#office365contacts-property) collection, edit its fields and make a call to the [UpdateContact](#office365updatecontact-method) method. To edit the newly created contact select the last contact of the collection.

**Example (Update a contact)**

```csharp
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](#olcontact-type) type used in the [Contacts](#office365contacts-property) collection includes the most commonly used fields for contacts. Refer to the [OLContact](#olcontact-type) type for a complete list of fields. If you need to add other fields, you can use the [SetContactField](#office365setcontactfield-method) 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)**

```csharp
// Set birthday
office365.SetContactField(0, "/json/birthday", "2024-05-21", 2); // The last argument is the type of the field. 2 (String)

// Set business address
office365.SetContactField(0,
              "/json/businessAddress",
              "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"string\"}",
              0); // 0 (Object)

// Update the contact
office365.UpdateContact(0);
```

### Retrieving Contacts

 To retrieve a contact use the [GetContact](#office365getcontact-method) method and provide the Id of the contact as the argument. The contact is added to the end of the [Contacts](#office365contacts-property) collection.

**Example (Retrieve a Contact)**

```csharp
// 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](#office365deletecontact-method) method and provide the Id of the contact as the argument. The contact is also removed from the [Contacts](#office365contacts-property) collection.

**Example (Delete a Contact)**

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

## Property List

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

|  |  |
| --- | --- |
| [Attachments](#office365attachments-property) | Collection of attachments listed by the server. |
| [Authorization](#office365authorization-property) | An OAuth Authorization String. |
| [Categories](#office365categories-property) | Collection of attachments listed by the server. |
| [ChangeMarker](#office365changemarker-property) | The page marker for listing changed messages. |
| [ContactFolders](#office365contactfolders-property) | The collection of contact folders listed by the server. |
| [Contacts](#office365contacts-property) | The collection of contacts listed by the server. |
| [Firewall](#office365firewall-property) | A set of properties related to firewall access. |
| [Folders](#office365folders-property) | Collection of folders listed by the server. |
| [ListContactsMarker](#office365listcontactsmarker-property) | The page marker for listing contacts. |
| [ListFoldersMarker](#office365listfoldersmarker-property) | The page marker for listing folders. |
| [ListMessagesMarker](#office365listmessagesmarker-property) | The page marker for listing messages. |
| [Message](#office365message-property) | Provides the raw message content. |
| [MessageAttachments](#office365messageattachments-property) | A collection of attachments to add to a message. |
| [MessageBcc](#office365messagebcc-property) | A comma separated list of recipients for blind carbon copies for a message. |
| [MessageBodyContent](#office365messagebodycontent-property) | The body content for a message. |
| [MessageBodyContentType](#office365messagebodycontenttype-property) | The body content type for a message. |
| [MessageCc](#office365messagecc-property) | A comma separated list of recipients for carbon copies for a message. |
| [MessageDeliveryReceipt](#office365messagedeliveryreceipt-property) | Whether or not a message will request a Delivery Receipt. |
| [MessageFrom](#office365messagefrom-property) | The author of a message. |
| [MessageImportance](#office365messageimportance-property) | The importance of a message. |
| [MessageInfo](#office365messageinfo-property) | Collection of information about retrieved messages. |
| [MessageOtherHeaders](#office365messageotherheaders-property) | The additional message headers for a message. |
| [MessageReadReceipt](#office365messagereadreceipt-property) | Whether or not a message will request a Read Receipt. |
| [MessageReplyTo](#office365messagereplyto-property) | A mail address to reply to. |
| [MessageSubject](#office365messagesubject-property) | The subject of a message. |
| [MessageTo](#office365messageto-property) | A comma separated list of recipients for a message. |
| [NextChangeMarker](#office365nextchangemarker-property) | A marker indicating which page of changes to return in the future. |
| [OAuth](#office365oauth-property) | The OAuth settings. |
| [Proxy](#office365proxy-property) | A set of properties related to proxy access. |
| [Select](#office365select-property) | The parts of a message that should be retrieved. |
| [SSLAcceptServerCert](#office365sslacceptservercert-property) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#office365sslcert-property) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLProvider](#office365sslprovider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#office365sslservercert-property) | The server certificate for the last established connection. |
| [Timeout](#office365timeout-property) | The timeout for the class. |
| [UserId](#office365userid-property) | The Id or userPrincipalName of the mailbox to access. |

## Method List

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

|  |  |
| --- | --- |
| [AddAttachment](#office365addattachment-method) | Adds a file attachment to an existing message. |
| [AddItemAttachment](#office365additemattachment-method) | Adds an item attachment to an existing message. |
| [Authorize](#office365authorize-method) | Get the authorization string required to access the protected resource. |
| [Config](#office365config-method) | Sets or retrieves a configuration setting. |
| [Copy](#office365copy-method) | Creates a copy of a message. |
| [CopyFolder](#office365copyfolder-method) | Copies a folder. |
| [CreateCategory](#office365createcategory-method) | Creates a new category. |
| [CreateContact](#office365createcontact-method) | Creates a contact. |
| [CreateDraft](#office365createdraft-method) | Creates a new email draft. |
| [CreateFolder](#office365createfolder-method) | Creates a new folder. |
| [Delete](#office365delete-method) | Deletes a message. |
| [DeleteAttachment](#office365deleteattachment-method) | Deletes an attachment. |
| [DeleteCategory](#office365deletecategory-method) | Deletes a mail category. |
| [DeleteContact](#office365deletecontact-method) | Deletes a contact. |
| [DeleteFolder](#office365deletefolder-method) | Deletes a folder. |
| [Forward](#office365forward-method) | Forward a message. |
| [GetCategory](#office365getcategory-method) | Retrieves a mail category. |
| [GetContact](#office365getcontact-method) | Retrieves the contact by Id. |
| [GetContactField](#office365getcontactfield-method) | Retrieves the contact property value by JSONPath. |
| [GetFolder](#office365getfolder-method) | Retrieves a folder. |
| [Interrupt](#office365interrupt-method) | Interrupt the current method. |
| [ListAttachments](#office365listattachments-method) | Lists all of a message's attachments. |
| [ListCategories](#office365listcategories-method) | Lists all mail categories. |
| [ListChanges](#office365listchanges-method) | Lists messages that have been changed within a specified folder. |
| [ListContactFolders](#office365listcontactfolders-method) | Lists the contact folders found in the parent folder. |
| [ListContacts](#office365listcontacts-method) | Lists the contacts in a folder. |
| [ListFolders](#office365listfolders-method) | Lists the folders found in the parent folder. |
| [ListMessages](#office365listmessages-method) | Lists the messages in a folder. |
| [MoveFolder](#office365movefolder-method) | Moves a folder. |
| [MoveMessage](#office365movemessage-method) | Moves a message. |
| [RenameFolder](#office365renamefolder-method) | Renames a folder. |
| [Reply](#office365reply-method) | Reply to a message. |
| [ReplyAll](#office365replyall-method) | ReplyAll to a message. |
| [Reset](#office365reset-method) | This method will reset the class. |
| [RetrieveAttachment](#office365retrieveattachment-method) | Retrieves a message attachment. |
| [RetrieveMessage](#office365retrievemessage-method) | Retrieves a message. |
| [RetrieveMessageRaw](#office365retrievemessageraw-method) | Retrieves the raw message of the specified message ID. |
| [Search](#office365search-method) | Search for messages. |
| [SendCustomRequest](#office365sendcustomrequest-method) | Send a custom HTTP request. |
| [SendDraft](#office365senddraft-method) | Sends an existing draft. |
| [SendMail](#office365sendmail-method) | Sends a new email. |
| [SetAttachmentInStream](#office365setattachmentinstream-method) | Sets an attachment using a stream. |
| [SetContactField](#office365setcontactfield-method) | Sets the contact field value by JSONPath. |
| [Update](#office365update-method) | Updates a message. |
| [UpdateCategory](#office365updatecategory-method) | Updates a category. |
| [UpdateContact](#office365updatecontact-method) | Updates a contact. |

## Event List

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

|  |  |
| --- | --- |
| [AttachmentList](#office365attachmentlist-event) | Fired when an attachment is retrieved from the server. |
| [CategoryList](#office365categorylist-event) | Fired when an attachment is retrieved from the server. |
| [ContactFolderList](#office365contactfolderlist-event) | Fired when a contact folder is retrieved by the server. |
| [ContactList](#office365contactlist-event) | Fired when a contact is retrieved from the server. |
| [Error](#office365error-event) | Fired when information is available about errors during data delivery. |
| [FolderList](#office365folderlist-event) | Fired when a folder is retrieved by the server. |
| [Log](#office365log-event) | Fired once for each log message. |
| [MessageList](#office365messagelist-event) | Fired when a message is retrieved from the server. |
| [SSLServerAuthentication](#office365sslserverauthentication-event) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#office365sslstatus-event) | Fired when secure connection progress messages are available. |
| [Transfer](#office365transfer-event) | Fired while a document transfers (delivers document). |

## Config Settings

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

|  |  |
| --- | --- |
| [AttachmentFragmentSize](#AttachmentFragmentSize) | Size of fragments when uploading large attachments. |
| [AttachmentJSON\[i\]](#AttachmentJSON[i]) | The raw JSON for the selected attachment. |
| [AttachmentSimpleUploadLimit](#AttachmentSimpleUploadLimit) | The threshold to use simple uploads. |
| [ContactFoldersPageSize](#ContactFoldersPageSize) | Page size for fetching contact folders. |
| [ContactsPageSize](#ContactsPageSize) | Page size for fetching contacts. |
| [FolderPageSize](#FolderPageSize) | Page size for fetching folders. |
| [IncludeNestedItemAttachments](#IncludeNestedItemAttachments) | Whether nested attachments present on item attachment are included in the request. |
| [ItemAttachmentCC\[i\]](#ItemAttachmentCC[i]) | The CC field of item attachment messages. |
| [ItemAttachmentFrom\[i\]](#ItemAttachmentFrom[i]) | The from field of item attachment messages. |
| [ItemAttachmentSentDate\[i\]](#ItemAttachmentSentDate[i]) | The SentDate field of item attachment messages. |
| [ItemAttachmentSubject\[i\]](#ItemAttachmentSubject[i]) | The Subject field of item attachment messages. |
| [ItemAttachmentTo\[i\]](#ItemAttachmentTo[i]) | The CC field of item attachment messages. |
| [ListContactFoldersMarker](#ListContactFoldersMarker) | The page marker for listing contact folders. |
| [MessagePageSize](#MessagePageSize) | Page size for fetching messages. |
| [MIMEMessage](#MIMEMessage) | MIME encoded message to send. |
| [Prefer](#Prefer) | Specifies a preferred content header type. |
| [QueryParamCount](#QueryParamCount) | The number of custom OData Query Parameters. |
| [QueryParamName\[i\]](#QueryParamName[i]) | The name of a custom OData Query Parameter. |
| [QueryParamValue\[i\]](#QueryParamValue[i]) | The value of a custom OData Query Parameter. |
| [RequestNestedItemAttachments](#RequestNestedItemAttachments) | Whether nested attachments present on item attachments are included when listing attachments. |
| [UserId](#UserId) | Sets the Id of a shared mailbox to connect to. |
| [XChildCount](#XChildCount) | The number of child elements of the current element. |
| [XChildName\[i\]](#XChildName[i]) | The name of the child element. |
| [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. |
| [XElement](#XElement) | The name of the current element. |
| [XParent](#XParent) | The parent of the current element. |
| [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. |
| [XSubTree](#XSubTree) | A snapshot of the current element in the document. |
| [XText](#XText) | The text of the current element. |
| [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. |
| [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. |
| [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. |
| [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. |
| [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. |
| [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. |
| [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. |
| [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. |
| [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. |
| [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. |
| [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. |
| [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
| [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. |
| [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. |
| [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. |
| [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. |
| [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. |
| [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. |
| [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. |
| [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. |
| [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. |
| [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. |
| [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. |
| [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. |
| [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. |
| [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. |
| [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. |
| [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. |
| [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. |
| [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) | Whether to trust any certificate presented by the server. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [Office365](#office365-class).Attachments Property

Collection of attachments listed by the server.

## Syntax

```text
getAttachments(): OLAttachmentList;
```

## Default Value

## Remarks

This collection contains a list of attachments returned by the server when [ListAttachments](#office365listattachments-method) is called.

This property is not available at design time.

 Please refer to the [OLAttachment](#olattachment-type) type for a complete list of fields.

# [Office365](#office365-class).Authorization Property

An OAuth Authorization String.

## Syntax

```text
async getAuthorization(): Promise<string>;
setAuthorization(authorization: string): void;
```

## Default Value

""

## Remarks

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

**Example**

```text
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.

# [Office365](#office365-class).Categories Property

Collection of attachments listed by the server.

## Syntax

```text
getCategories(): OLCategoryList;
```

## Default Value

## Remarks

This collection contains a list of categories returned by the server when [ListCategories](#office365listcategories-method) is called.

This property is not available at design time.

 Please refer to the [OLCategory](#olcategory-type) type for a complete list of fields.

# [Office365](#office365-class).ChangeMarker Property

The page marker for listing changed messages.

## Syntax

```text
getChangeMarker(): string;
setChangeMarker(changeMarker: string): void;
```

## Default Value

""

## Remarks

This property is populated if there are still unlisted messages after [ListChanges](#office365listchanges-method) is called. It contains the nextLink that will be included as an OData parameter if [ListChanges](#office365listchanges-method) 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)**

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

This property is not available at design time.

# [Office365](#office365-class).ContactFolders Property

The collection of contact folders listed by the server.

## Syntax

```text
getContactFolders(): OLContactFolderList;
```

## Default Value

## Remarks

This collection contains a list of contact folders returned by the server. It is populated when [ListContactFolders](#office365listcontactfolders-method) is called.

This property is not available at design time.

 Please refer to the [OLContactFolder](#olcontactfolder-type) type for a complete list of fields.

# [Office365](#office365-class).Contacts Property

The collection of contacts listed by the server.

## Syntax

```text
getContacts(): OLContactList;
```

## Default Value

## Remarks

This collection contains a list of contacts returned by the server. It is populated when [ListContacts](#office365listcontacts-method) or [GetContact](#office365getcontact-method) is called. A [GetContact](#office365getcontact-method) call adds the retrieved contact to the beginning of the list. If the contact already exists in the Contacts collection, it will be removed and then added back to the beginning, preventing duplication.

**Example (Retrieve Contacts from a Folder)**

```csharp
// 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.

 Please refer to the [OLContact](#olcontact-type) type for a complete list of fields.

# [Office365](#office365-class).Firewall Property

A set of properties related to firewall access.

## Syntax

```text
getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;
```

## Default Value

## Remarks

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

 Please refer to the [Firewall](#firewall-type) type for a complete list of fields.

# [Office365](#office365-class).Folders Property

Collection of folders listed by the server.

## Syntax

```text
getFolders(): OLFolderList;
```

## Default Value

## Remarks

This collection contains a list of folders returned by the server. It is populated when [ListFolders](#office365listfolders-method) or [GetFolder](#office365getfolder-method) is called.

This property is not available at design time.

 Please refer to the [OLFolder](#olfolder-type) type for a complete list of fields.

# [Office365](#office365-class).ListContactsMarker Property

The page marker for listing contacts.

## Syntax

```text
getListContactsMarker(): string;
setListContactsMarker(listContactsMarker: string): void;
```

## Default Value

""

## Remarks

This property is populated if there are still unlisted contacts after [ListContacts](#office365listcontacts-method) is called. It contains the nextLink that will be included as an OData parameter if [ListContacts](#office365listcontacts-method) 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](#office365contacts-property) collection.

**Example (List All Contacts in a Folder): **

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

This property is not available at design time.

# [Office365](#office365-class).ListFoldersMarker Property

The page marker for listing folders.

## Syntax

```text
getListFoldersMarker(): string;
setListFoldersMarker(listFoldersMarker: string): void;
```

## Default Value

""

## Remarks

This property is populated if there are still unlisted changes after [ListFolders](#office365listfolders-method) is called. It contains the nextLink that will be included as an OData parameter if [ListFolders](#office365listfolders-method) 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)**

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

This property is not available at design time.

# [Office365](#office365-class).ListMessagesMarker Property

The page marker for listing messages.

## Syntax

```text
getListMessagesMarker(): string;
setListMessagesMarker(listMessagesMarker: string): void;
```

## Default Value

""

## Remarks

This property is populated if there are still unlisted messages after [ListMessages](#office365listmessages-method) is called. It contains the nextLink that will be included as an OData parameter if [ListMessages](#office365listmessages-method) 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)**

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

This property is not available at design time.

# [Office365](#office365-class).Message Property

Provides the raw message content.

## Syntax

```text
getMessage(): Uint8Array;
```

## Default Value

""

## Remarks

This property is populated after calling [RetrieveMessageRaw](#office365retrievemessageraw-method) and holds the raw message content. This can be used to access the data before any processing is done by the class.

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

# [Office365](#office365-class).MessageAttachments Property

A collection of attachments to add to a message.

## Syntax

```text
getMessageAttachments(): OLAttachmentList;
```

## Default Value

## Remarks

This property contains a list of files to attach to a message. These files are added to a message sent with [SendMail](#office365sendmail-method) or created with [CreateDraft](#office365createdraft-method)*.

*This applies only to drafts made with the DRAFTTYPE_MESSAGE type. For other types of drafts see [AddAttachment](#office365addattachment-method).

**Example**

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

This property is not available at design time.

 Please refer to the [OLAttachment](#olattachment-type) type for a complete list of fields.

# [Office365](#office365-class).MessageBcc Property

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

## Syntax

```text
getMessageBcc(): string;
setMessageBcc(messageBcc: string): void;
```

## 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](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

**Example (Add a Bcc Recipient)**

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

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

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

This property is not available at design time.

# [Office365](#office365-class).MessageBodyContent Property

The body content for a message.

## Syntax

```text
getMessageBodyContent(): string;
setMessageBodyContent(messageBodyContent: string): void;
```

## Default Value

""

## Remarks

This property contains the content of a message. These addresses are added to a message created with [CreateDraft](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

This property is not available at design time.

# [Office365](#office365-class).MessageBodyContentType Property

The body content type for a message.

## Syntax

```text
getMessageBodyContentType(): string;
setMessageBodyContentType(messageBodyContentType: string): void;
```

## 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](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

This property is not available at design time.

# [Office365](#office365-class).MessageCc Property

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

## Syntax

```text
getMessageCc(): string;
setMessageCc(messageCc: string): void;
```

## 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](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

**Example (Add a CC Recipient)**

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

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

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

This property is not available at design time.

# [Office365](#office365-class).MessageDeliveryReceipt Property

Whether or not a message will request a Delivery Receipt.

## Syntax

```text
isMessageDeliveryReceipt(): boolean;
setMessageDeliveryReceipt(messageDeliveryReceipt: boolean): void;
```

## Default Value

FALSE

## Remarks

This property determines whether or not messages created with [CreateDraft](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method) will request a Delivery Receipt.

# [Office365](#office365-class).MessageFrom Property

The author of a message.

## Syntax

```text
getMessageFrom(): string;
setMessageFrom(messageFrom: string): void;
```

## 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](#office365authorization-property).

This property is applied to a message created with [CreateDraft](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

**Example (Specify Message Author)**

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

**Example (Specify Message Author - Name Included)**

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

This property is not available at design time.

# [Office365](#office365-class).MessageImportance Property

The importance of a message.

## Syntax

```text
getMessageImportance(): string;
setMessageImportance(messageImportance: string): void;
```

## Default Value

""

## Remarks

This property determines the importance of messages created with [CreateDraft](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method). Valid values are *Low*, *Normal*, and *High*.

This property is not available at design time.

# [Office365](#office365-class).MessageInfo Property

Collection of information about retrieved messages.

## Syntax

```text
getMessageInfo(): OLMessageInfoList;
```

## Default Value

## Remarks

This collection contains a list of *OLMessageInfo* for messages fetched by the server. This property is populated when [ListMessages](#office365listmessages-method), [RetrieveMessage](#office365retrievemessage-method), [Search](#office365search-method), or [ListChanges](#office365listchanges-method) is called.

This property is not available at design time.

 Please refer to the [OLMessageInfo](#olmessageinfo-type) type for a complete list of fields.

# [Office365](#office365-class).MessageOtherHeaders Property

The additional message headers for a message.

## Syntax

```text
getMessageOtherHeaders(): string;
setMessageOtherHeaders(messageOtherHeaders: string): void;
```

## 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](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

This property is not available at design time.

# [Office365](#office365-class).MessageReadReceipt Property

Whether or not a message will request a Read Receipt.

## Syntax

```text
isMessageReadReceipt(): boolean;
setMessageReadReceipt(messageReadReceipt: boolean): void;
```

## Default Value

FALSE

## Remarks

This property determines whether or not messages created with [CreateDraft](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method) will request a Read Receipt.

# [Office365](#office365-class).MessageReplyTo Property

A mail address to reply to.

## Syntax

```text
getMessageReplyTo(): string;
setMessageReplyTo(messageReplyTo: string): void;
```

## 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](#office365messagefrom-property). These recipients are added to a message created with [CreateDraft](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

This property is not available at design time.

# [Office365](#office365-class).MessageSubject Property

The subject of a message.

## Syntax

```text
getMessageSubject(): string;
setMessageSubject(messageSubject: string): void;
```

## Default Value

""

## Remarks

This property contains the subject of a message. This property will be applied to a message created with [CreateDraft](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

This property is not available at design time.

# [Office365](#office365-class).MessageTo Property

A comma separated list of recipients for a message.

## Syntax

```text
getMessageTo(): string;
setMessageTo(messageTo: string): void;
```

## 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](#office365createdraft-method) or messages sent with [SendMail](#office365sendmail-method).

**Example (Add a Recipient)**

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

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

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

This property is not available at design time.

# [Office365](#office365-class).NextChangeMarker Property

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

## Syntax

```text
getNextChangeMarker(): string;
setNextChangeMarker(nextChangeMarker: string): void;
```

## Default Value

""

## Remarks

This property will be populated when [ListChanges](#office365listchanges-method) is called if there are no more changes to list. Refer to [ListChanges](#office365listchanges-method) for more information.

This property is not available at design time.

# [Office365](#office365-class).OAuth Property

The OAuth settings.

## Syntax

```text
getOAuth(): OAuthSettings;
```

## Default Value

## Remarks

This property is used to configure 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.

 Please refer to the [OAuthSettings](#oauthsettings-type) type for a complete list of fields.

# [Office365](#office365-class).Proxy Property

A set of properties related to proxy access.

## Syntax

```text
getProxy(): Proxy;
setProxy(proxy: Proxy): void;
```

## Default Value

## Remarks

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

 Please refer to the [Proxy](#proxy-type) type for a complete list of fields.

# [Office365](#office365-class).Select Property

The parts of a message that should be retrieved.

## Syntax

```text
getSelect(): string;
setSelect(select: string): void;
```

## Default Value

""

## Remarks

This property can be used to select specific message or attachment properties to retrieve when calling [ListMessages](#office365listmessages-method) [RetrieveMessage](#office365retrievemessage-method), [ListAttachments](#office365listattachments-method), or [RetrieveAttachment](#office365retrieveattachment-method). 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:

|  |  |
| --- | --- |
| bccRecipients | The bcc'd recipients of the message. |
| body | The message body type and content. |
| bodyPreview | A preview of the message body containing the first few lines of text. |
| categories | The mail categories that this message falls under. |
| ccRecipients | The cc'd recipients of this message. |
| conversationId | The ID of the conversation this message is a part of. |
| createdDateTime | The date and time when this message was created. |
| flag | The flag status of the message. |
| from | The address the message is from. |
| hasAttachments | A boolean for if the message has attachments. |
| importance | The importance level of the message. |
| inferenceClassification | The inference classification of this message (e.g. focused, other). |
| internetMessageHeaders | The message headers for the message according to rfc 5322. |
| isDeliveryReceiptRequested | A boolean for if a delivery receipt was requested. |
| isDraft | A boolean for if the message is a draft. |
| isRead | A boolean for if the message has been read. |
| isReadReceiptRequested | A boolean for if a read receipt was requested. |
| lastModifiedDateTime | The date and time when this message was last modified. |
| parentFolderId | The ID of the messages parent folder. |
| receivedDateTime | The date and time when this message was received. |
| replyTo | The addresses the message is a reply to. |
| sender | The sender of the message. |
| sentDateTime | The date and time when this message was sent. |
| subject | The subject of the message. |
| toRecipients | The recipients of the message. |
| webLink | A weblink for the message. |

**Example (Get the Subject and Sender of a Message)**

```text
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:

|  |  |
| --- | --- |
| contentType | The MIME type of the attachment. |
| isInline | If the attachment is an inline attachment. |
| lastModifiedDateTime | ISO 8601 format timestamp of the last modified date (UTC). |
| name | The attachments file name. |
| size | The length of the attachment in bytes. |

**Example (Get the Name and Size of an attachment)**

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

This property is not available at design time.

# [Office365](#office365-class).SSLAcceptServerCert Property

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

## Syntax

```text
getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;
```

## Default Value

## Remarks

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

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

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

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [Office365](#office365-class).SSLCert Property

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

## Syntax

```text
getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;
```

## Default Value

## Remarks

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

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [Office365](#office365-class).SSLProvider Property

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

## Syntax

```text
getSSLProvider(): Office365SSLProviders;
setSSLProvider(SSLProvider: Office365SSLProviders): void;
enum Office365SSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}
```

## Default Value

0

## Remarks

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

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

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

When Automatic is selected, the platform implementation will be used by default in all cases in the JavaScript edition.

NOTE: The internal provider is not support at this time.

# [Office365](#office365-class).SSLServerCert Property

The server certificate for the last established connection.

## Syntax

```text
getSSLServerCert(): Certificate;
```

## Default Value

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

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [Office365](#office365-class).Timeout Property

The timeout for the class.

## Syntax

```text
getTimeout(): number;
setTimeout(timeout: number): void;
```

## Default Value

60

## Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

# [Office365](#office365-class).UserId Property

The Id or userPrincipalName of the mailbox to access.

## Syntax

```text
getUserId(): string;
setUserId(userId: string): void;
```

## Default Value

""

## Remarks

This property is used to dictate the mailbox that class requests will target. By default, the class operates against the mailbox of the user associated with the currently authorized account (i.e., the *me* context).

This property should be set to either the unique Id (an Azure Active Directory object Id) or its userPrincipalName (typically the user's email address), which is required in two common scenarios.

First, when attempting to access a shared mailbox with a delegated authorization flow, this property should be set to the shared mailbox's address with the *mail.read.shared* authorization scope (or *mail.readwrite.shared* to also send and modify messages) included during the OAuth process so the signed-in user can access it.

Second, when authenticating with application permissions instead of delegated permissions, there is no signed-in user to imply a mailbox via the *me* context, so this property must be set to identify which user's mailbox to access.

If this property is not set, the class will continue to use the *me* context, which is only valid for delegated authorization flows.

This property is not available at design time.

# [Office365](#office365-class).addAttachment Method

Adds a file attachment to an existing message.

## Syntax

```text
async office365.addAttachment(messageId : string, name : string, localFile : string): Promise< void>
```

## Remarks

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

This method is **not** used to add attachments to messages that are sent with the [SendMail](#office365sendmail-method) method.

**Example (Adding a Simple Attachment to a New Draft)**

```text
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)**

```text
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)**

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

# [Office365](#office365-class).addItemAttachment Method

Adds an item attachment to an existing message.

## Syntax

```text
async office365.addItemAttachment(messageId : string, msgToAttachId : string, itemJSON : string): Promise< void>
```

## 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](#office365sendmail-method) method.

**Example (Adding an Existing Message to a New Draft)**

```text
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)**

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

# [Office365](#office365-class).authorize Method

Get the authorization string required to access the protected resource.

## Syntax

```text
async office365.authorize(): Promise< void>
```

## 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](#office365authorization-property) property. It should instead be used when setting the [OAuth](#office365oauth-property) property.

For more information, see the introduction section.

# [Office365](#office365-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async office365.config(configurationString : string): Promise< string>
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-cloudmailoffice365) for the class.

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

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

To read (query) the value of a [configuration setting](#config-settings-class-cloudmailoffice365), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [Office365](#office365-class).copy Method

Creates a copy of a message.

## Syntax

```text
async office365.copy(id : string, destinationId : string): Promise< void>
```

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

# [Office365](#office365-class).copyFolder Method

Copies a folder.

## Syntax

```text
async office365.copyFolder(id : string, destFolderID : string): Promise< void>
```

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

# [Office365](#office365-class).createCategory Method

Creates a new category.

## Syntax

```text
async office365.createCategory(displayName : string, color : string): Promise< void>
```

## Remarks

This method creates a new Office365 category. The created category is added to the end of the [Categories](#office365categories-property) collection.

**Example**

```text
office365.CreateCategory(categoryName, "preset9");
```

# [Office365](#office365-class).createContact Method

Creates a contact.

## Syntax

```text
async office365.createContact(firstName : string, lastName : string, emailAddress : string, parentId : string): Promise< void>
```

## 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 beginning of the [Contacts](#office365contacts-property) list.

After creating a contact with basic information, you can update it and set additional fields by editing the contact in the [Contacts](#office365contacts-property) collection and calling the [UpdateContact](#office365updatecontact-method) method. For more details, refer to the [UpdateContact](#office365updatecontact-method) method.

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

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

**Example (Create a Contact in a Folder)**

```csharp
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.

# [Office365](#office365-class).createDraft Method

Creates a new email draft.

## Syntax

```text
async office365.createDraft(draftType : number, id : string): Promise< void>
```

## 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](#office365messageinfo-property) collection. As a note, this will not clear the collection but will add it to the end.

Valid values for *DraftType* :

|  |  |
| --- | --- |
| 0 | DRAFTTYPE_MESSAGE |
| 1 | DRAFTTYPE_REPLY |
| 2 | DRAFTTYPE_REPLYALL |
| 3 | DRAFTTYPE_FORWARD |

**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](#office365update-method) method can be used instead to fill in the different parts of the message.

**Example (New Draft)**

```text
// 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)**

```text
// 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);
```

# [Office365](#office365-class).createFolder Method

Creates a new folder.

## Syntax

```text
async office365.createFolder(folderName : string, parentFolderId : string): Promise< void>
```

## Remarks

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

# [Office365](#office365-class).delete Method

Deletes a message.

## Syntax

```text
async office365.delete(id : string): Promise< void>
```

## 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](#office365messageinfo-property) collection.

# [Office365](#office365-class).deleteAttachment Method

Deletes an attachment.

## Syntax

```text
async office365.deleteAttachment(id : string, attachmentId : string): Promise< void>
```

## 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](#office365attachments-property) collection.

# [Office365](#office365-class).deleteCategory Method

Deletes a mail category.

## Syntax

```text
async office365.deleteCategory(id : string): Promise< void>
```

## Remarks

This method deletes a mail category from the current mailbox. This method will not update the [Categories](#office365categories-property) collection.

# [Office365](#office365-class).deleteContact Method

Deletes a contact.

## Syntax

```text
async office365.deleteContact(id : string): Promise< void>
```

## 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](#office365contacts-property) collection.

**Example (Delete a Contact)**

```csharp
// 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;
  }
}
```

# [Office365](#office365-class).deleteFolder Method

Deletes a folder.

## Syntax

```text
async office365.deleteFolder(id : string): Promise< void>
```

## 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](#office365folders-property) collection.

# [Office365](#office365-class).forward Method

Forward a message.

## Syntax

```text
async office365.forward(id : string, messageHTML : string, toRecipients : string): Promise< void>
```

## 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:

| Property | Default if not set |
| --- | --- |
| [MessageBcc](#office365messagebcc-property) | Blank |
| [MessageBodyContent](#office365messagebodycontent-property) | Blank |
| [MessageBodyContentType](#office365messagebodycontenttype-property) | HTML |
| [MessageCc](#office365messagecc-property) | Blank |
| [MessageDeliveryReceipt](#office365messagedeliveryreceipt-property) | False |
| [MessageFrom](#office365messagefrom-property) | Currently authenticated mailbox |
| [MessageImportance](#office365messageimportance-property) | Blank |
| [MessageReadReceipt](#office365messagereadreceipt-property) | False |
| [MessageSubject](#office365messagesubject-property) | FW:" + original subject |

**Example (Simple):**

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

**Example (Advanced):**

```text
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)**

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

# [Office365](#office365-class).getCategory Method

Retrieves a mail category.

## Syntax

```text
async office365.getCategory(id : string): Promise< void>
```

## Remarks

This method retrieves a mail category.

The fetched category can be accessed through the [Categories](#office365categories-property) collection. As a note, the class does not clear the collection and will append the category to the end of it.

# [Office365](#office365-class).getContact Method

Retrieves the contact by Id.

## Syntax

```text
async office365.getContact(id : string): Promise< void>
```

## Remarks

This method retrieves a contact specified by its ID and adds the contact to the beginning of the [Contacts](#office365contacts-property) list. If the contact already exists in the [Contacts](#office365contacts-property) collection, it will be removed and then added to the beginning, preventing duplication.

**Example (Get a Contact)**

```csharp
// 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[0];
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(0, "/json/birthday");   //birthday of the contact
office365.GetContactField(0, "/json/middleName"); //middle name of the contact
```

# [Office365](#office365-class).getContactField Method

Retrieves the contact property value by JSONPath.

## Syntax

```text
async office365.getContactField(index : number, jsonPath : string): Promise< 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](#office365contacts-property) 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](#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)**

```csharp
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
```

# [Office365](#office365-class).getFolder Method

Retrieves a folder.

## Syntax

```text
async office365.getFolder(id : string): Promise< void>
```

## Remarks

This method retrieves a folder.

The fetched folder can be accessed through the [Folders](#office365folders-property) collection. As a note, the class does not clear the collection and will add the folder to the beginning of it. If the folder already exists in the collection, it will be removed and then added back to the beginning, preventing duplication.

# [Office365](#office365-class).interrupt Method

Interrupt the current method.

## Syntax

```text
async office365.interrupt(): Promise< void>
```

## Remarks

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

# [Office365](#office365-class).listAttachments Method

Lists all of a message's attachments.

## Syntax

```text
async office365.listAttachments(id : string): Promise< void>
```

## Remarks

This method lists all of a message's attachments. This method clears and populates the [Attachments](#office365attachments-property) collection. If the [RequestNestedItemAttachments](#RequestNestedItemAttachments) configuration setting is set to true (default false), the method will also list any nested attachments found within item attachments.

```text
//List messages with attachments
office365.ListMessage("inbox", "hasAttachments eq true");

//List attachments of the first message
office365.ListAttachments(office365.MessageInfo[0].Id);
```

# [Office365](#office365-class).listCategories Method

Lists all mail categories.

## Syntax

```text
async office365.listCategories(): Promise< void>
```

## Remarks

This method lists all of the mail categories in the current mailbox. This method clears and populates the [Categories](#office365categories-property) collection.

# [Office365](#office365-class).listChanges Method

Lists messages that have been changed within a specified folder.

## Syntax

```text
async office365.listChanges(id : string, maxPageSize : number): Promise< void>
```

## 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](#office365changemarker-property) and [NextChangeMarker](#office365nextchangemarker-property) are empty, and then call ListChanges. Then follow the process described in the "General Usage" section (below) until [ChangeMarker](#office365changemarker-property) 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](#office365changemarker-property) or [NextChangeMarker](#office365nextchangemarker-property) (only one can be populated at a time) to request the next page of changes. This method causes the [MessageList](#office365messagelist-event) event to fire once for each change, and will also populate the [MessageInfo](#office365messageinfo-property) collection.

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

When [NextChangeMarker](#office365nextchangemarker-property) 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](#office365nextchangemarker-property) is populated will not return any further changes.)

# [Office365](#office365-class).listContactFolders Method

Lists the contact folders found in the parent folder.

## Syntax

```text
async office365.listContactFolders(parentFolderId : string): Promise< void>
```

## Remarks

This method retrieves and lists the contact folders within the specified parent folder. It clears and then populates the [ContactFolders](#office365contactfolders-property) 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): **

```csharp
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):**

```csharp
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](#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](#office365contactfolders-property) collection.

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

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

# [Office365](#office365-class).listContacts Method

Lists the contacts in a folder.

## Syntax

```text
async office365.listContacts(folderId : string): Promise< void>
```

## Remarks

This method retrieves and lists the contacts within the specified folder. It clears and then populates the [Contacts](#office365contacts-property) 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)**

```text
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):**

```csharp
office365.ListContacts("");
```

If the number of contacts exceeds the page size, the [ListContactsMarker](#office365listcontactsmarker-property) 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](#office365contacts-property) collection.

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

```csharp
do{
  office365.ListContacts("");
} while(!office365.ListContactsMarker.isEmpty());
```

# [Office365](#office365-class).listFolders Method

Lists the folders found in the parent folder.

## Syntax

```text
async office365.listFolders(parentFolderId : string): Promise< void>
```

## Remarks

This method lists the folders found in the parent folder. This method clears populates the [Folders](#office365folders-property) collection.

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](#office365listfoldersmarker-property) will be populated and calling ListFolders again will list the next page of folders.

**Example (List All Folders in the Root Folder)**

```text
office365.ListFolders("");
```

# [Office365](#office365-class).listMessages Method

Lists the messages in a folder.

## Syntax

```text
async office365.listMessages(folderId : string, filter : string): Promise< void>
```

## Remarks

This method lists the messages found in the specified folder. This method clears and populates the [MessageInfo](#office365messageinfo-property) collection.

If the number of messages is greater than the message page size, [ListMessagesMarker](#office365listmessagesmarker-property) 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)**

```text
office365.ListMessages(folderId, "");
```

**Example (List Unread Messages in a Folder)**

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

**Example (List Messages from a Specific Address)**

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

**Example (List Unread Messages from a Specific Address)**

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

# [Office365](#office365-class).moveFolder Method

Moves a folder.

## Syntax

```text
async office365.moveFolder(id : string, destFolderId : string): Promise< void>
```

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

# [Office365](#office365-class).moveMessage Method

Moves a message.

## Syntax

```text
async office365.moveMessage(id : string, destinationId : string): Promise< void>
```

## Remarks

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

# [Office365](#office365-class).renameFolder Method

Renames a folder.

## Syntax

```text
async office365.renameFolder(folderId : string, newName : string): Promise< void>
```

## Remarks

This method renames a folder. This method will not update the [Folders](#office365folders-property) collection.

# [Office365](#office365-class).reply Method

Reply to a message.

## Syntax

```text
async office365.reply(id : string, messageHTML : string): Promise< void>
```

## 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:

| Property | Default if not set |
| --- | --- |
| [MessageBcc](#office365messagebcc-property) | Blank |
| [MessageBodyContent](#office365messagebodycontent-property) | Blank |
| [MessageBodyContentType](#office365messagebodycontenttype-property) | HTML |
| [MessageCc](#office365messagecc-property) | Blank |
| [MessageDeliveryReceipt](#office365messagedeliveryreceipt-property) | False |
| [MessageFrom](#office365messagefrom-property) | Currently authenticated mailbox |
| [MessageImportance](#office365messageimportance-property) | Blank |
| [MessageReadReceipt](#office365messagereadreceipt-property) | False |
| [MessageSubject](#office365messagesubject-property) | RE:" + original subject |
| [MessageTo](#office365messageto-property) | Original sender |

**Example (Simple):**

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

**Example (Advanced):**

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

# [Office365](#office365-class).replyAll Method

ReplyAll to a message.

## Syntax

```text
async office365.replyAll(id : string, messageHTML : string): Promise< void>
```

## 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:

| Property | Default if not set |
| --- | --- |
| [MessageBcc](#office365messagebcc-property) | Blank |
| [MessageBodyContent](#office365messagebodycontent-property) | Blank |
| [MessageBodyContentType](#office365messagebodycontenttype-property) | HTML |
| [MessageCc](#office365messagecc-property) | Original CC recipients |
| [MessageDeliveryReceipt](#office365messagedeliveryreceipt-property) | False |
| [MessageFrom](#office365messagefrom-property) | Currently authenticated mailbox |
| [MessageImportance](#office365messageimportance-property) | Blank |
| [MessageReadReceipt](#office365messagereadreceipt-property) | False |
| [MessageSubject](#office365messagesubject-property) | RE:" + original subject |
| [MessageTo](#office365messageto-property) | Original sender and recipients |

**Example (Simple):**

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

**Example (Advanced):**

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

# [Office365](#office365-class).reset Method

This method will reset the class.

## Syntax

```text
async office365.reset(): Promise< void>
```

## Remarks

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

# [Office365](#office365-class).retrieveAttachment Method

Retrieves a message attachment.

## Syntax

```text
async office365.retrieveAttachment(id : string, attachmentId : string): Promise< void>
```

## 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](#office365attachments-property) collection. If the [RequestNestedItemAttachments](#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.

# [Office365](#office365-class).retrieveMessage Method

Retrieves a message.

## Syntax

```text
async office365.retrieveMessage(id : string): Promise< void>
```

## Remarks

This method retrieves a message.

Information about the retrieved message can be accessed through the [MessageInfo](#office365messageinfo-property) collection.

# [Office365](#office365-class).retrieveMessageRaw Method

Retrieves the raw message of the specified message ID.

## Syntax

```text
async office365.retrieveMessageRaw(id : string): Promise< void>
```

## Remarks

This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the [Message](#office365message-property) property.

# [Office365](#office365-class).search Method

Search for messages.

## Syntax

```text
async office365.search(searchKey : string): Promise< void>
```

## Remarks

This method can be used to search for messages. Results are returned through the [MessageInfo](#office365messageinfo-property) collection. *searchKey* specifies a string to be searched for.

# [Office365](#office365-class).sendCustomRequest Method

Send a custom HTTP request.

## Syntax

```text
async office365.sendCustomRequest(HTTPMethod : string, URL : string, postData : string): Promise< void>
```

## Remarks

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

# [Office365](#office365-class).sendDraft Method

Sends an existing draft.

## Syntax

```text
async office365.sendDraft(id : string): Promise< void>
```

## 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](#office365createdraft-method) method. As a note, the relevant collection are not cleared after the method is called. It is recommend to do so after calling this method.

**Example (New Draft)**

```text
//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)**

```text
// 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)**

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

# [Office365](#office365-class).sendMail Method

Sends a new email.

## Syntax

```text
async office365.sendMail(saveToSentItems : boolean): Promise< void>
```

## Remarks

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

**Example: Simple Email**

```text
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**

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

# [Office365](#office365-class).setAttachmentInStream Method

Sets an attachment using a stream.

## Syntax

```text
async office365.setAttachmentInStream(index : number, inputStream : ReadableStream): Promise< void>
```

## Remarks

This method allows for setting an attachment in the [MessageAttachments](#office365messageattachments-property) collection through a stream using the *InputStream* parameter. The *Index* parameter specifies which attachment in the [MessageAttachments](#office365messageattachments-property) collection the stream will affect.

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

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

```text
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)**

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

# [Office365](#office365-class).setContactField Method

Sets the contact field value by JSONPath.

## Syntax

```text
async office365.setContactField(index : number, jsonPath : string, value : string, valueType : number): Promise< void>
```

## 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](#office365contacts-property) collection to be edited. The second parameter, **JsonPath**, specifies the JSON path to the field you want to set. Please refer to [XPath](#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): **

```csharp
// 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);
```

# [Office365](#office365-class).update Method

Updates a message.

## Syntax

```text
async office365.update(id : string): Promise< void>
```

## Remarks

This property updates a message that has been edited in the [MessageInfo](#office365messageinfo-property) collection. The *id* takes the message's ID that should be updated. The following values can be updated from the [OLMessageInfo](#olmessageinfo-type) type:

|  |  |
| --- | --- |
| Field | Draft Only |
| Bcc | False |
| BodyContent | True |
| BodyContentType | True |
| Cc | False |
| FlagStatus | False |
| From | False |
| Importance | False |
| isDeliveryReceiptRequested | False |
| isRead | False |
| isReadReceiptRequested | False |
| JSON | False |
| ReplyTo | True |
| Subject | True |
| To | False |

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

**Example (Reply Draft)**

```text
// 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);
```

# [Office365](#office365-class).updateCategory Method

Updates a category.

## Syntax

```text
async office365.updateCategory(id : string, color : string): Promise< void>
```

## Remarks

This method changes an existing category's color. This method will not update the [Categories](#office365categories-property) collection.

# [Office365](#office365-class).updateContact Method

Updates a contact.

## Syntax

```text
async office365.updateContact(index : number): Promise< void>
```

## Remarks

This method allows you to update an existing contact. The index parameter specifies the position of the contact in the [Contacts](#office365contacts-property) 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](#office365contacts-property) 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](#olcontact-type) type used in the [Contacts](#office365contacts-property) collection includes the most commonly used fields for contacts. Refer to the [OLContact](#olcontact-type) type for a complete list of fields. If you need to add other fields, you can use the [SetContactField](#office365setcontactfield-method) method. For a complete list of fields a contact can have please refer to the Microsoft Graph API documentation.

Example:

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

# [Office365](#office365-class).AttachmentList Event

Fired when an attachment is retrieved from the server.

## Syntax

```text
office365.on('AttachmentList', listener: (e: {readonly id: string, readonly name: string, readonly contentType: string, readonly contentLocation: string, readonly contentBytes: string, readonly contentBytesB: Uint8Array, readonly contentId: string, readonly lastModifiedDateTime: string, readonly isInline: boolean, readonly size: number}) => void )
```

## Remarks

The AttachmentList event is fired for each attachment retrieved from the server when [ListAttachments](#office365listattachments-method) is called.

# [Office365](#office365-class).CategoryList Event

Fired when an attachment is retrieved from the server.

## Syntax

```text
office365.on('CategoryList', listener: (e: {readonly id: string, readonly displayName: string, readonly color: string}) => void )
```

## Remarks

The CategoryList event is fired for each attachment retrieved from the server when [ListCategories](#office365listcategories-method) is called.

# [Office365](#office365-class).ContactFolderList Event

Fired when a contact folder is retrieved by the server.

## Syntax

```text
office365.on('ContactFolderList', listener: (e: {readonly id: string, readonly name: string, readonly parentFolderId: string}) => void )
```

## Remarks

The ContactFolderList event is fired for each contact folder retrieved from the server when [ListContactFolders](#office365listcontactfolders-method) is called.

# [Office365](#office365-class).ContactList Event

Fired when a contact is retrieved from the server.

## Syntax

```text
office365.on('ContactList', listener: (e: {readonly id: string, readonly parentId: string, readonly displayName: string, readonly firstEmail: string}) => void )
```

## Remarks

The ContactList event is fired for each contact retrieved from the server when [ListContacts](#office365listcontacts-method) is called. This event provides the contact's *Id*, *DisplayName*, *FirstEmail* address, and the *ParentId* of the folder containing the contact.

# [Office365](#office365-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
office365.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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](#trappable-errors-class-cloudmailoffice365) section.

# [Office365](#office365-class).FolderList Event

Fired when a folder is retrieved by the server.

## Syntax

```text
office365.on('FolderList', listener: (e: {readonly id: string, readonly displayName: string, readonly parentFolderId: string, readonly childFolderCount: number, readonly unreadItemCount: number, readonly totalItemCount: number}) => void )
```

## Remarks

The FolderList event is fired for each folder retrieved from the server when [ListFolders](#office365listfolders-method) is called.

# [Office365](#office365-class).Log Event

Fired once for each log message.

## Syntax

```text
office365.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )
```

## Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

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

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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"

# [Office365](#office365-class).MessageList Event

Fired when a message is retrieved from the server.

## Syntax

```text
office365.on('MessageList', listener: (e: {readonly id: string, readonly subject: string, readonly messageSender: string, readonly receivedDateTime: string, readonly sentDateTime: string, readonly hasAttachments: boolean, readonly bodyContentType: string, readonly bodyContent: string, readonly bodyPreview: string}) => void )
```

## Remarks

The MessageList event is fired for each message retrieved from the server when [ListMessages](#office365listmessages-method) is called.

# [Office365](#office365-class).SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

## Syntax

```text
office365.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )
```

## Remarks

This event fires with information about the server certificate. The *Status* property shows why verification failed (otherwise, *Status* contains the string *OK*). To manually accept an untrusted certificate, the [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) setting must be set to True before initiating the connection.

# [Office365](#office365-class).SSLStatus Event

Fired when secure connection progress messages are available.

## Syntax

```text
office365.on('SSLStatus', listener: (e: {readonly message: string}) => void )
```

## Remarks

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

# [Office365](#office365-class).Transfer Event

Fired while a document transfers (delivers document).

## Syntax

```text
office365.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )
```

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

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *string (read-only)*
*Default Value: ""*

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

23-Jan-2000 15:00:00.

 **ExpirationDate** *string (read-only)*
*Default Value: ""*

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

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *string (read-only)*
*Default Value: ""*

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

 **Fingerprint** *string (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA1** *string (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA256** *string (read-only)*
*Default Value: ""*

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

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

 **Issuer** *string (read-only)*
*Default Value: ""*

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

 **KeyPassword** *string*
*Default Value: ""*

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys.

NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

 **PrivateKey** *string (read-only)*
*Default Value: ""*

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

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

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

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

 **PrivateKeyContainer** *string (read-only)*
*Default Value: ""*

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

 **PublicKey** *string (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *string (read-only)*
*Default Value: ""*

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

 **PublicKeyLength** *number (read-only)*
*Default Value: 0*

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

 **SerialNumber** *string (read-only)*
*Default Value: ""*

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

 **SignatureAlgorithm** *string (read-only)*
*Default Value: ""*

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

 **Store** *string*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

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

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

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

 **StoreB** *Uint8Array*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

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

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

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

 **StorePassword** *string*
*Default Value: ""*

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

 **StoreType** *CertStoreTypes*
*Default Value: 0*

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr class by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *string (read-only)*
*Default Value: ""*

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

 **ThumbprintMD5** *string (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA1** *string (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA256** *string (read-only)*
*Default Value: ""*

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

 **Usage** *string (read-only)*
*Default Value: ""*

The text description of .

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

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

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

 **UsageFlags** *number (read-only)*
*Default Value: 0*

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

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the  property for a text representation of .

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

 **Version** *string (read-only)*
*Default Value: ""*

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

 **Subject** *string*
*Default Value: ""*

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **Encoded** *string*
*Default Value: ""*

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

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

 **EncodedB** *Uint8Array*
*Default Value: ""*

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

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

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(int storeType, String store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# Firewall Type

The firewall the class will connect through.

## Remarks

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

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *boolean*
*Default Value: False*

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

 **FirewallType** *FirewallTypes*
*Default Value: 0*

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

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [](#f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. |

 **Host** *string*
*Default Value: ""*

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

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

 **Password** *string*
*Default Value: ""*

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

 **Port** *number*
*Default Value: 0*

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

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

 **User** *string*
*Default Value: ""*

A username if authentication is to be used when connecting through a firewall. If  is specified, this property and the  property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class .

## Constructors

```text
public Firewall();
```

# OAuthSettings Type

The settings used to authenticate with the service provider.

## Remarks

This type is used to give the class the necessary information needed to complete the OAuth process.

The following fields are available:

- [AccessToken](#OAuthSettings_f_AccessToken)

- [AuthorizationCode](#OAuthSettings_f_AuthorizationCode)

- [AuthorizationScope](#OAuthSettings_f_AuthorizationScope)

- [ClientId](#OAuthSettings_f_ClientId)

- [ClientProfile](#OAuthSettings_f_ClientProfile)

- [ClientSecret](#OAuthSettings_f_ClientSecret)

- [GrantType](#OAuthSettings_f_GrantType)

- [RefreshToken](#OAuthSettings_f_RefreshToken)

- [RequestRefreshToken](#OAuthSettings_f_RequestRefreshToken)

- [ReturnURL](#OAuthSettings_f_ReturnURL)

- [ServerAuthURL](#OAuthSettings_f_ServerAuthURL)

- [ServerTokenURL](#OAuthSettings_f_ServerTokenURL)

- [Timeout](#OAuthSettings_f_Timeout)

- [WebAuthURL](#OAuthSettings_f_WebAuthURL)

## Fields

 **AccessToken** *string*
*Default Value: ""*

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

 **AuthorizationCode** *string*
*Default Value: ""*

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.

 **AuthorizationScope** *string*
*Default Value: ""*

The scope request or response parameter used during authorization.

 **ClientId** *string*
*Default Value: ""*

The id of the client assigned when registering the application.

 **ClientProfile** *CloudOAuthClientProfiles*
*Default Value: 0*

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

|  |  |
| --- | --- |
| 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
| 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |

 **ClientSecret** *string*
*Default Value: ""*

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

 **GrantType** *OAuthSettingsGrantTypes*
*Default Value: 0*

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

|  |  |
| --- | --- |
| 0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
| 1 (cogtImplicit) | Implicit grant type |
| 2 (cogtPassword) | Resource Owner Password Credentials grant type |
| 3 (cogtClientCredentials) | Client Credentials grant type |

 **RefreshToken** *string*
*Default Value: ""*

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.

 **RequestRefreshToken** *boolean*
*Default Value: True*

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

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

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

 **ReturnURL** *string*
*Default Value: ""*

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

 **ServerAuthURL** *string*
*Default Value: ""*

The URL of the authorization server.

 **ServerTokenURL** *string*
*Default Value: ""*

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

 **Timeout** *number*
*Default Value: 60*

The amount of time (in seconds) the component will wait for a response from the browser in the LaunchBrowser event. The default value is 60.

 **WebAuthURL** *string (read-only)*
*Default Value: ""*

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.

## Constructors

```text
public OAuthSettings();
```

# OLAttachment Type

Holds information about an attachment.

## Remarks

Holds information about an attachment.

The following fields are available:

- [AttachmentType](#OLAttachment_f_AttachmentType)

- [ContentId](#OLAttachment_f_ContentId)

- [ContentLocation](#OLAttachment_f_ContentLocation)

- [ContentType](#OLAttachment_f_ContentType)

- [Data](#OLAttachment_f_Data)

- [FileName](#OLAttachment_f_FileName)

- [Id](#OLAttachment_f_Id)

- [InputStream](#OLAttachment_f_InputStream)

- [IsInline](#OLAttachment_f_IsInline)

- [LastModifiedDate](#OLAttachment_f_LastModifiedDate)

- [Name](#OLAttachment_f_Name)

- [ParentIndex](#OLAttachment_f_ParentIndex)

- [Size](#OLAttachment_f_Size)

## Fields

 **AttachmentType** *string (read-only)*
*Default Value: ""*

This field contains the attachment type of the attachment.

 **ContentId** *string*
*Default Value: ""*

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

 **ContentLocation** *string (read-only)*
*Default Value: ""*

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

 **ContentType** *string (read-only)*
*Default Value: ""*

This field contains the content type of the attachment.

 **Data** *string*
*Default Value: ""*

This field contains the raw data of the attachment.

 **DataB** *Uint8Array*
*Default Value: ""*

This field contains the raw data of the attachment.

 **FileName** *string*
*Default Value: ""*

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

 **Id** *string (read-only)*
*Default Value: ""*

This field contains the attachment identifier of the attachment.

 **InputStream** *ReadableStream*
*Default Value: ""*

If  is set, the data from the specified stream will be used for the attachment.

 **IsInline** *boolean*
*Default Value: False*

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

 **LastModifiedDate** *string*
*Default Value: ""*

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

 **Name** *string*
*Default Value: ""*

This field contains the name of the attachment.

 **ParentIndex** *string (read-only)*
*Default Value: ""*

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

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

For example, a message may contain the following attachments.

- RootFileAttachment.txt (1)
- RootItemAttachment (2)

  - IntermediateFileAttachment.txt (2.1)
  - IntermediateItemAttachment (2.2)

    - LeafFileAttachment.txt (2.2.1)

 **Size** *number*
*Default Value: 0*

This field contains the size in bytes of the attachment.

## Constructors

```text
public OLAttachment();
```

```text
public OLAttachment(String fileName);
```

```text
public OLAttachment(String name, String fileName);
```

```text
public OLAttachment(String name, java.io.InputStream inputStream);
```

# OLCategory Type

Holds information about a category.

## Remarks

Holds information about a category.

The following fields are available:

- [Color](#OLCategory_f_Color)

- [DisplayName](#OLCategory_f_DisplayName)

- [Id](#OLCategory_f_Id)

## Fields

 **Color** *string (read-only)*
*Default Value: ""*

This field contains the color of the category.

 **DisplayName** *string (read-only)*
*Default Value: ""*

This field contains the display name of the category.

 **Id** *string (read-only)*
*Default Value: ""*

This field contains the unique identifier of the category.

## Constructors

```text
public OLCategory();
```

# OLContact Type

Holds information about a contact.

## Remarks

Holds information about a contact.

The following fields are available:

- [CompanyName](#OLContact_f_CompanyName)

- [DisplayName](#OLContact_f_DisplayName)

- [EmailAddress](#OLContact_f_EmailAddress)

- [EmailAddressesCount](#OLContact_f_EmailAddressesCount)

- [EmailAddressIndex](#OLContact_f_EmailAddressIndex)

- [FirstName](#OLContact_f_FirstName)

- [Id](#OLContact_f_Id)

- [JSON](#OLContact_f_JSON)

- [LastName](#OLContact_f_LastName)

- [Notes](#OLContact_f_Notes)

- [ParentId](#OLContact_f_ParentId)

- [PhoneIndex](#OLContact_f_PhoneIndex)

- [PhoneNumber](#OLContact_f_PhoneNumber)

- [PhonesCount](#OLContact_f_PhonesCount)

- [PhoneType](#OLContact_f_PhoneType)

## Fields

 **CompanyName** *string*
*Default Value: ""*

The name of the contact's company.

 **DisplayName** *string*
*Default Value: ""*

The contact's display name.

 **EmailAddress** *string*
*Default Value: ""*

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

 **EmailAddressesCount** *number*
*Default Value: 0*

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

 **EmailAddressIndex** *number*
*Default Value: 0*

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

Example (Set the email addresses before updating a contact)

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

Example (Read email addresses of a retrieved contact)

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

 **FirstName** *string*
*Default Value: ""*

The contact's first name.

 **Id** *string (read-only)*
*Default Value: ""*

The unique identifier of the contact.

 **JSON** *string*
*Default Value: ""*

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

 **LastName** *string*
*Default Value: ""*

The contact's last name.

 **Notes** *string*
*Default Value: ""*

The user's notes about the contact.

 **ParentId** *string*
*Default Value: ""*

The ID of the contact's parent folder.

 **PhoneIndex** *number*
*Default Value: 0*

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

Example (Set the phone numbers before updating a contact):

```csharp
office365.Contacts[0].PhonesCount = 2;
office365.Contacts[0].PhoneIndex = 0;
office365.Contacts[0].PhoneNumber = "0123456789"; // set the first email address of the contact
office365.Contacts[0].PhoneIndex = 1;
office365.Contacts[0].PhoneNumber = "9876543210"; // set the second email address of the contact
office365.UpdateContact(0);
```

Example (Read phone numbers of a retrieved contact):

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

 **PhoneNumber** *string*
*Default Value: ""*

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

 **PhonesCount** *number*
*Default Value: 0*

Number of the contact's phone numbers.

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

 **PhoneType** *TOLPhoneTypes*
*Default Value: 0*

The phone number type.

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

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

## Constructors

```text
public OLContact();
```

# OLContactFolder Type

Holds information about a contact folder.

## Remarks

Holds information about a contact folder.

The following fields are available:

- [Id](#OLContactFolder_f_Id)

- [Name](#OLContactFolder_f_Name)

- [ParentFolderId](#OLContactFolder_f_ParentFolderId)

## Fields

 **Id** *string (read-only)*
*Default Value: ""*

The unique identifier of the contact folder.

 **Name** *string (read-only)*
*Default Value: ""*

The display name of the contact folder.

 **ParentFolderId** *string (read-only)*
*Default Value: ""*

The unique identifier for the folder's parent.

## Constructors

```text
public OLContactFolder();
```

# OLFolder Type

Holds information about a folder.

## Remarks

Holds information about a folder.

The following fields are available:

- [ChildFolderCount](#OLFolder_f_ChildFolderCount)

- [ChildFolders](#OLFolder_f_ChildFolders)

- [DisplayName](#OLFolder_f_DisplayName)

- [Id](#OLFolder_f_Id)

- [MessageRules](#OLFolder_f_MessageRules)

- [Messages](#OLFolder_f_Messages)

- [MultiValueExtendedProperties](#OLFolder_f_MultiValueExtendedProperties)

- [ParentFolderId](#OLFolder_f_ParentFolderId)

- [SingleValueExtendedProperties](#OLFolder_f_SingleValueExtendedProperties)

- [TotalItemCount](#OLFolder_f_TotalItemCount)

- [UnreadItemCount](#OLFolder_f_UnreadItemCount)

## Fields

 **ChildFolderCount** *number (read-only)*
*Default Value: 0*

The number of child folders the folder has.

 **ChildFolders** *string (read-only)*
*Default Value: ""*

The child folders of the folder.

 **DisplayName** *string (read-only)*
*Default Value: ""*

The display name of the folder.

 **Id** *string (read-only)*
*Default Value: ""*

The unique identifier of the folder.

 **MessageRules** *string (read-only)*
*Default Value: ""*

The message rules of the folder.

 **Messages** *string (read-only)*
*Default Value: ""*

The messages contained in the folder.

 **MultiValueExtendedProperties** *string (read-only)*
*Default Value: ""*

The multi-value extended properties defined for the folder.

 **ParentFolderId** *string (read-only)*
*Default Value: ""*

The unique identifier for the folder's parent.

 **SingleValueExtendedProperties** *string (read-only)*
*Default Value: ""*

The single-value extended properties defined for the folder.

 **TotalItemCount** *number (read-only)*
*Default Value: 0*

The number of total items in the folder.

 **UnreadItemCount** *number (read-only)*
*Default Value: 0*

The number of unread items in the folder.

## Constructors

```text
public OLFolder();
```

# OLMessageInfo Type

Holds information about a message.

## Remarks

Holds information about a message.

The following fields are available:

- [Bcc](#OLMessageInfo_f_Bcc)

- [BodyContent](#OLMessageInfo_f_BodyContent)

- [BodyContentType](#OLMessageInfo_f_BodyContentType)

- [BodyPreview](#OLMessageInfo_f_BodyPreview)

- [Categories](#OLMessageInfo_f_Categories)

- [Cc](#OLMessageInfo_f_Cc)

- [ConversationId](#OLMessageInfo_f_ConversationId)

- [ConversationIndex](#OLMessageInfo_f_ConversationIndex)

- [CreatedDate](#OLMessageInfo_f_CreatedDate)

- [DeliveryReceiptRequested](#OLMessageInfo_f_DeliveryReceiptRequested)

- [FlagStatus](#OLMessageInfo_f_FlagStatus)

- [From](#OLMessageInfo_f_From)

- [HasAttachments](#OLMessageInfo_f_HasAttachments)

- [Id](#OLMessageInfo_f_Id)

- [Importance](#OLMessageInfo_f_Importance)

- [InferenceClassification](#OLMessageInfo_f_InferenceClassification)

- [IsDraft](#OLMessageInfo_f_IsDraft)

- [IsRead](#OLMessageInfo_f_IsRead)

- [JSON](#OLMessageInfo_f_JSON)

- [LastModifiedDate](#OLMessageInfo_f_LastModifiedDate)

- [MessageHeaders](#OLMessageInfo_f_MessageHeaders)

- [MessageId](#OLMessageInfo_f_MessageId)

- [ParentFolderId](#OLMessageInfo_f_ParentFolderId)

- [ReadReceiptRequested](#OLMessageInfo_f_ReadReceiptRequested)

- [ReceivedDate](#OLMessageInfo_f_ReceivedDate)

- [ReplyTo](#OLMessageInfo_f_ReplyTo)

- [Sender](#OLMessageInfo_f_Sender)

- [SentDate](#OLMessageInfo_f_SentDate)

- [Subject](#OLMessageInfo_f_Subject)

- [To](#OLMessageInfo_f_To)

- [WebLink](#OLMessageInfo_f_WebLink)

## Fields

 **Bcc** *string*
*Default Value: ""*

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

 **BodyContent** *string*
*Default Value: ""*

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

 **BodyContentType** *string*
*Default Value: ""*

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

 **BodyPreview** *string (read-only)*
*Default Value: ""*

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

 **Categories** *string*
*Default Value: ""*

The categories of a message in a message info listing.

 **Cc** *string*
*Default Value: ""*

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

 **ConversationId** *string (read-only)*
*Default Value: ""*

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

 **ConversationIndex** *string (read-only)*
*Default Value: ""*

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

 **CreatedDate** *string (read-only)*
*Default Value: ""*

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

 **DeliveryReceiptRequested** *boolean*
*Default Value: False*

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

 **FlagStatus** *string*
*Default Value: ""*

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

|  |  |
| --- | --- |
| notFlagged |  |
| complete |  |
| flagged |  |

 **From** *string (read-only)*
*Default Value: ""*

The sender of a message in a message info listing.

 **HasAttachments** *boolean (read-only)*
*Default Value: False*

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

 **Id** *string (read-only)*
*Default Value: ""*

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

 **Importance** *string*
*Default Value: ""*

The importance of a message in a message info listing.

 **InferenceClassification** *string (read-only)*
*Default Value: ""*

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

 **IsDraft** *boolean (read-only)*
*Default Value: False*

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

 **IsRead** *boolean*
*Default Value: False*

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

 **JSON** *string*
*Default Value: ""*

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

 **LastModifiedDate** *string (read-only)*
*Default Value: ""*

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

 **MessageHeaders** *string (read-only)*
*Default Value: ""*

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

 **MessageId** *string (read-only)*
*Default Value: ""*

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

 **ParentFolderId** *string (read-only)*
*Default Value: ""*

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

 **ReadReceiptRequested** *boolean*
*Default Value: False*

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

 **ReceivedDate** *string (read-only)*
*Default Value: ""*

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

 **ReplyTo** *string*
*Default Value: ""*

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

 **Sender** *string (read-only)*
*Default Value: ""*

The sender of a message in a message info listing.

 **SentDate** *string (read-only)*
*Default Value: ""*

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

 **Subject** *string*
*Default Value: ""*

The subject of a message in a message info listing.

 **To** *string*
*Default Value: ""*

The recipients of a message in a message info listing.

 **WebLink** *string (read-only)*
*Default Value: ""*

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

## Constructors

```text
public OLMessageInfo();
```

# Proxy Type

The proxy the class will connect to.

## Remarks

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

The following fields are available:

- [AuthScheme](#Proxy_f_AuthScheme)

- [AutoDetect](#Proxy_f_AutoDetect)

- [Password](#Proxy_f_Password)

- [Port](#Proxy_f_Port)

- [Server](#Proxy_f_Server)

- [SSL](#Proxy_f_SSL)

- [User](#Proxy_f_User)

## Fields

 **AuthScheme** *ProxyAuthSchemes*
*Default Value: 0*

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

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

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

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

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

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

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

 **AutoDetect** *boolean*
*Default Value: False*

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

 **Password** *string*
*Default Value: ""*

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

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

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

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

 **Port** *number*
*Default Value: 80*

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

 **Server** *string*
*Default Value: ""*

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

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

 **SSL** *ProxySSLTypes*
*Default Value: 0*

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

|  |  |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |

 **User** *string*
*Default Value: ""*

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

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

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

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

## Constructors

```text
public Proxy();
```

```text
public Proxy(String server, int port);
```

```text
public Proxy(String server, int port, String user, String password);
```

# ReadableStream Type

## Syntax

```text
interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}
```

## Remarks

 The Office365 class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the Office365 class.

 When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }
```

```text
readSync(buffer: Uint8Array, offset: number, length: number): number { }
```

```text
available(): number { }
```

```text
close(): void { }
```

```text
mark(): void { }
```

```text
reset(): void { }
```

```text
markSupported(): boolean { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | buffer: The buffer to store the read data. <br> offset: The starting position within the buffer to write data.<br> length: The maximum number of bytes to read.<br> |
| read | Reads data from the stream into the provided buffer. This method must be implemented.<br> Returns a promise resolving to the number of bytes read, -1 if no data is available. |
| readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. |
| available | Returns the number of bytes available for reading. This method must be implemented.<br> |
| close | Closes the stream and releases associated resources. |
| mark | Marks the current position in this stream. |
| reset | Repositions this stream to the position at the time the mark method was last called. |
| markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. |

# WriteableStream Type

## Syntax

```text
interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}
```

## Remarks

 The Office365 class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the Office365 class.

 When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
write(data: Uint8Array, offset: number, length: number): Promise <void> { }
```

```text
writeSync(data: Uint8Array, offset: number, length: number): void { }
```

```text
close(): void { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | data: The buffer containing the data to write.<br> offset: The starting position in the buffer to read data from.<br> length: The maximum number of bytes to write.<br> |
| write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.<br> Returns a promise that resolves when the write operation completes. |
| writeSync | Synchronously writes data from the buffer to the stream. |
| close | Closes the stream and releases associated resources. |

# Config Settings (*class *cloudmail.[office365](#office365-class))

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#office365config-method) method.

### Office365 Config Settings

**AttachmentFragmentSize**: Size of fragments when uploading large attachments.This setting specifies the size, in bytes, of the fragments that are uploaded during an advanced upload session when using the [AddAttachment](#office365addattachment-method) method.

The default value is *2097152* (2MiBs).

**AttachmentJSON[i]**: The raw JSON for the selected attachment.This method returns the raw JSON for the selected attachment. The attachment index correlates to the [Attachments](#office365attachments-property) collection.

**AttachmentSimpleUploadLimit**: The threshold to use simple uploads.This setting specifies the limit before the component will switch from simple uploads to upload sessions when using the [AddAttachment](#office365addattachment-method) method.

The default value is *2097152* (2MiBs).

**ContactFoldersPageSize**: Page size for fetching contact folders.This setting specifies the contact folders page size, or the maximum number of contact folders that will be fetched from the server in one get call.

The default value is *100*.

**ContactsPageSize**: Page size for fetching contacts.This setting specifies the contacts page size, or the maximum number of contacts that will be fetched from the server in one get call.

The default value is *100*.

**FolderPageSize**: Page size for fetching folders.This setting specifies the folder page size, or the maximum number of folders that will be fetched from the server in one get call.

The default value is *100*.

**IncludeNestedItemAttachments**: Whether nested attachments present on item attachment are included in the request.This setting specifies whether item attachments retain their own attachments. If set to *True*, additional requests will be made to ensure that nested attachments present in the item attachment remain. If set to *False* (default), this will not occur, reducing the size of the request.

At this time, Microsoft does not support nested attachments in item attachments. Once support is added, this may be set to *True* to include these attachments with the [AddItemAttachment](#office365additemattachment-method) request.

**ItemAttachmentCC[i]**: The CC field of item attachment messages.This method returns the *CC* field for item attachments that are messages. The attachment index correlates to the [Attachments](#office365attachments-property) collection. If the indexed attachment is not a message item attachment, the component will throw an exception.

**ItemAttachmentFrom[i]**: The from field of item attachment messages.This method returns the *From* field for item attachments that are messages. The attachment index correlates to the [Attachments](#office365attachments-property) collection. If the indexed attachment is not a message item attachment, the component will throw an exception.

**ItemAttachmentSentDate[i]**: The SentDate field of item attachment messages.This method returns the *SentDate* field for item attachments that are messages. The attachment index correlates to the [Attachments](#office365attachments-property) collection. If the indexed attachment is not a message item attachment, the component will throw an exception.

**ItemAttachmentSubject[i]**: The Subject field of item attachment messages.This method returns the *Subject* field for item attachments that are messages. The attachment index correlates to the [Attachments](#office365attachments-property) collection. If the indexed attachment is not a message item attachment, the component will throw an exception.

**ItemAttachmentTo[i]**: The CC field of item attachment messages.This method returns the *To* field for item attachments that are messages. The attachment index correlates to the [Attachments](#office365attachments-property) collection. If the indexed attachment is not a message item attachment, the component will throw an exception.

**ListContactFoldersMarker**: The page marker for listing contact folders.This property is populated if there are still unlisted changes after [ListContactFolders](#office365listcontactfolders-method) is called. It contains the nextLink that will be included as an OData parameter if [ListContactFolders](#office365listcontactfolders-method) is called again on the same parent folder. This will cause the next page of contact folders to be listed.

**Example (List All Contact Folders in the Root Directory)**

```text
do
{
  office365.ListContactFolders("");
} while (office365.Config("ListContactFoldersMarker").Length > 0);
```

**MessagePageSize**: Page size for fetching messages.This setting specifies the message page size, or the maximum number of messages that will be fetched from the server in one get call.

The default value is *100*.

**MIMEMessage**: MIME encoded message to send.When set with a MIME message, the [SendMail](#office365sendmail-method) method will use the MIME message rather than the Message* properties.

```text
component.Config("MIMEMessage" + MIME_MESSAGE);
component.SendMail();
```

**Prefer**: Specifies a preferred content header type.This setting can be used to specify a preferred content header type to be used when retrieving messages.

**QueryParamCount**: The number of custom OData Query Parameters.This setting specifies the number of custom OData Query parameters that will be added to a request when fetching data.

The default value is *0*.

**Example:**

```text
component.Config("QueryParamCount=1");
component.Config("QueryParamName[0]=Select");
component.Config("QueryParamValue[0]=name");
```

**QueryParamName[i]**: The name of a custom OData Query Parameter.This setting specifies the name of the custom OData Query parameter at index *i*.

**QueryParamValue[i]**: The value of a custom OData Query Parameter.This setting specifies the value of the custom OData Query parameter at index *i*.

**RequestNestedItemAttachments**: Whether nested attachments present on item attachments are included when listing attachments.When set to true, the [ListAttachments](#office365listattachments-method) and [RetrieveAttachment](#office365retrieveattachment-method) methods will recursively iterate through each item attachment in the [Attachments](#office365attachments-property) collection. See AttachmentsParentIndex for more information on identifying the parent of each nested attachment. This setting is disabled by default.

**UserId**: Sets the Id of a shared mailbox to connect to.Specifies the Id to use when connecting to the server. When the "mail.read.shared" scope is also added, this allows reading from shared mailboxes. Must be set when using Admin consented authorization flows.

**XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XElement**: The name of the current element.This configuration setting provides the name of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XParent**: The parent of the current element.This configuration setting provides the parent of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response.

When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element.

XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:

| Accessor | Description |
| --- | --- |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |
| name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) |
| . | The current element. |
| .. | The parent element. |

 NOTE: XPath indices are *1-based*.

For example, assume the following XML and JSON responses.

XML:

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

JSON:

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

The following are examples of valid XPaths for these responses:

| Description | XML XPath | JSON XPath |
| --- | --- | --- |
| Document root | / | /json |
| Specific element | /firstlevel/one | /json/firstlevel/one |
| i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |

This list is not exhaustive, but it provides a general idea of the possibilities.

**XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XText**: The text of the current element.This configuration setting provides the inner text of the current element.

The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only.

### OAuth Config Settings

**OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated.

**OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following:

|  |  |
| --- | --- |
| Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [Authorize](#office365authorize-method) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |

**OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *true* and the [Authorization](#office365authorization-property) property is not set, the class will automatically get a new access token if it has the necessary properties to do so without user interaction.

For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction.

**OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the class will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the class will wait indefinitely.

**OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [Authorize](#office365authorize-method) if it is empty.

If set to *true* (default) the *redirect_uri* will be sent in all cases. If set to *false* the *redirect_uri* will only be sent if it has a value.

**OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service.

To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath).

**OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXElement**: The name of the current element.Provides the name of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXParent**: The parent of the current element.Provides the parent of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token.

XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:

| Accessor | Description |
| --- | --- |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |

 Here are some examples of valid XPaths and some common claims:

| Description | JSON XPath |
| --- | --- |
| Document root | /json |
| Specific element | /json/element_one |
| Username Claim (Microsoft Specific) | /json/preferred_username |
| Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |

This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [OAuthJWTXText](#OAuthJWTXText).

**OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXText**: The text of the current element.Provides the inner text of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the OAuthClientProfile is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:

```text
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
```

Additionally, this will also be updated to hold the parameters returned in the response.

```text
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
  string name = component.Config("OAuthParamName[" + i + "]");
  string value = component.Config("OAuthParamValue[" + i + "]");
}
```

**OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username property when the OAuthGrantType is set to the password grant type and [Authorize](#office365authorize-method) is called.

**OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *true*. Possible values are:

- 1 (Plain)
- 2 (S256/SHA256 - default)

**OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [Authorize](#office365authorize-method) method and the OAuthWebAuthURL field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb OAuthClientProfile, the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request.

**OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *true* (default), the [Reset](#office365reset-method) method will reset the OAuth settings including any authorization fields like OAuthAccessToken and OAuthRefreshToken. This means the [Authorize](#office365authorize-method) method must be called again to get new authorization information. When set to *false*, the [Reset](#office365reset-method) method will **not** reset the [OAuth](#office365oauth-property) property and the OAuth* configuration settings. This allows for the class to be reset without having to get authorization again.

**OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *true* (default), the same embedded web server instance will be used for multiple requests. If set to *false* the embedded web server will be created and destroyed on each call to [Authorize](#office365authorize-method)

**OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET

```text
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
```

 C++

```text
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
```

**OAuthUsePKCE**: Specifies if PKCE should be used.If set to *true* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code OAuthGrantType. The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used.

**OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*.

This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when [Authorize](#office365authorize-method) is called. In certain cases, it is required to start the webserver before calling [Authorize](#office365authorize-method). For example, if the OAuthReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the [OAuthReUseWebServer](#OAuthReUseWebServer) is set to true, the server will not be automatically stopped, and this configuration setting must be set to *"false"* to stop the embedded web server.

**OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL.

The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) property specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword).

[OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) property in order to specify the certificate to be used during SSL.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are:

|  |  |
| --- | --- |
| 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. |
| 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. |
| 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
| 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |

 Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate.

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [Authorize](#office365authorize-method) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.

**OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when OAuthClientProfile is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the OAuthReturnURL. This should be set to the hostname only, not the full URL.

The default value is *localhost*.

**OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

**OAuthWebServerResponse**: The custom response that will be displayed to the user.When [Authorize](#office365authorize-method) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.

**OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2.

The default value is True.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the [Authorization](#office365authorization-property) property in the form "Basic [encoded-user-password]".

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#office365transfer-event) event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class .

**Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class instead.

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

**HTTP/2 Notes**

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

**HTTP/3 Notes**

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#office365log-event) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*.

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to *True*.

When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#office365timeout-property) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The LocalHost setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#office365sslprovider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#office365sslstatus-event) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#office365sslprovider-property) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.

**SSLAcceptAnyServerCert**: Whether to trust any certificate presented by the server.This configuration setting disables all certificate verification when set to *True*. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#office365sslprovider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#office365sslcert-property) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----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-----
```

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#office365sslstatus-event) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----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-----
```

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#office365sslprovider-property) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#office365sslprovider-property) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#office365sslprovider-property) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#office365sslprovider-property) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#office365sslprovider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#office365sslprovider-property) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#office365sslprovider-property) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#office365sslserverauthentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#office365sslserverauthentication-event) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#office365sslserverauthentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#office365sslprovider-property) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----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-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#office365sslprovider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class .

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#office365sslprovider-property) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#office365timeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

# Trappable Errors (*class *cloudmail.[office365](#office365-class))

### Office365 Errors

|  |  |
| --- | --- |
| 1301 | Invalid Input Error. |