Office365 Control
Properties Methods Events Config Settings Errors
The Office365 control provides an easy way to manage sending and receiving mail in Microsoft 365.
Syntax
Office365
Remarks
This control provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the control, first set the Authorization property to a valid OAuth token. The Office365 control 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 control requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.
The control 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 user.read" |
Additionally, depending on how the application is registered (Ex. Multi-tenant) and what OAuthGrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL and OAuthServerTokenURL properties. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes:
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 control. 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 control. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.
To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The control will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the control will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the control will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.
A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.
Authorization Code
When using the Authorization Code grant type, the control will use an authorization code to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the control will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the control 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 control will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.
Example:
Office365 office365 = new Office365();
office365.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
office365.OAuth.ClientId = CLIENT_ID;
office365.OAuth.ClientSecret = CLIENT_SECRET;
office365.Authorize();
Client Credentials
When using the Client Credentials grant type, the control will act as a service instead of authorizing and authenticating as a user. This allows for the control 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 control expects a OAuthClientId, OAuthClientSecret, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.
Implicit
Note: This grant type is considered insecure and should only be used when necessary.
When using the Implicit grant type, the control will request the authorization server to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the control 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 control 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 control will authenticate as the resource owner. This allows for the control 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 control requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.
Web Profile
This profile is similar to setting the control to the Application profile and Authorization Code grant type except the control will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The control will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth control or a separate process. Once complete you should have an authorization string which looks like:Bearer ACCESS_TOKEN_VALUE
Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the control to ignore the values set in the OAuth property.
For Example:
Oauth oauth = new Oauth();
oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
office365.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Sending Messages
There are two methods for sending new messages using the Office365 component. The SendMail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the SendDraft method. In both cases the properties of the new message are assigned through the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.).
Sending a Message with SendDraft:
office365.MessageSubject = "Subject Text";
office365.MessageImportance = "Low";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Body Text.";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
string messageId = office365.MessageInfo[0].Id;
office365.SendDraft(messageId);
There are also methods for replying or forwarding messages using the Office365 component. The Reply, ReplyAll, and Forward method will send a reply or forward directly. Similarly, you can create a reply or forward draft and then send an existing draft using the SendDraft method. Unlike creating a new message, only the direct methods use the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.). When using CreateDraft, the draft must first be made then updated using the MessageInfo properties and Update method.
Sending a Reply with SendDraft:
//Create the reply draft
string originalMessageId = "Message ID";
office365.CreateDraft(1, oringialMessageId);
//Set the new draft MessageInfo fields with desired options
office365.MessageInfo[0].To = "email@example.com";
office365.MessageInfo[0].Subject = "Subject Text";
office365.MessageInfo[0].BodyContentType = "TEXT";
office365.MessageInfo[0].BodyContent = "Body Text";
//Update the draft
office365.Update(office365.MessageInfo[0].Id);
//Send the draft
office365.SendDraft(office365.MessageInfo[0].Id);
Receiving Messages
Information about messages fetched by the component can be accessed through the MessageInfo properties. MessageInfo properties is populated when the ListMessages, RetrieveMessage, Search, or ListChanges methods are called.
The ListMessages and ListChanges methods will respectively list the messages or changed messages in a folder specified by a folderId. To get the ID of a folder, folders can be traversed and read using the ListFolders method and the Folders properties.
Listing Messages in a Folder:
// Get the folder ID
string folderId = "";
office365.ListFolders(""); // Lists the root child folders.
for (int i = 0; i < office365.Folders.Count; i++)
{
if (office365.Folders[i].DisplayName.Equals("SpecificFolderName"))
{
folderId = office365.Folders[i].Id;
break;
}
}
// List folder messages
office365.ListMessages(folderId, "");
By default, the component will fetch one page of 100 messages when ListMessages is called.
If additional messages remain in the folder, the ListMessagesMarker property will be populated.
If ListMessages is then called again on the same folder the next page of messages will be fetched.
The example below populates MessageInfo properties with all the messages in a particular folder.
do {
office365.ListMessages(folderId);
} while (office365.ListMessagesMarker.Length > 0);
The message page size may also be changed by using the MessagePageSize configuration setting.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
AttachmentCount | The number of records in the Attachment arrays. |
AttachmentAttachmentType | This property contains the attachment type of the attachment. |
AttachmentContentId | This property contains the value of the unique content identifier of the attachment. |
AttachmentContentLocation | This property contains the content location of the attachment. |
AttachmentContentType | This property contains the content type of the attachment. |
AttachmentData | This property contains the raw data of the attachment. |
AttachmentFileName | This property contains the local file name associated with the attachment. |
AttachmentId | This property contains the attachment identifier of the attachment. |
AttachmentIsInline | This property is true if the attachment is an inline attachment. |
AttachmentLastModifiedDate | This property contains the date and time when the attachment was last modified. |
AttachmentName | This property contains the name of the attachment. |
AttachmentParentIndex | Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. |
AttachmentSize | This property contains the size in bytes of the attachment. |
Authorization | An OAuth Authorization String. |
CategoryCount | The number of records in the Category arrays. |
CategoryColor | This property contains the color of the category. |
CategoryDisplayName | This property contains the display name of the category. |
CategoryId | This property contains the unique identifier of the category. |
ChangeMarker | The page marker for listing changed messages. |
ContactFolderCount | The number of records in the ContactFolder arrays. |
ContactFolderId | The unique identifier of the contact folder. |
ContactFolderName | The display name of the contact folder. |
ContactFolderParentFolderId | The unique identifier for the folder's parent. |
ContactsCount | The number of records in the Contact arrays. |
ContactCompanyName | The name of the contact's company. |
ContactDisplayName | The contact's display name. |
ContactEmailAddress | The email address at the specified EmailAddressIndex. |
ContactEmailAddressesCount | When retrieving contacts, it indicates the number of email addresses linked to the contact. |
ContactEmailAddressIndex | Index of email address to get or set in the EmailAddress property. |
ContactFirstName | The contact's first name. |
ContactId | The unique identifier of the contact. |
ContactJSON | A JSON representation of the contact. |
ContactLastName | The contact's last name. |
ContactNotes | The user's notes about the contact. |
ContactParentId | The ID of the contact's parent folder. |
ContactPhoneIndex | Index of phone number to get or set in the PhoneNumber property. |
ContactPhoneNumber | This property is used to get or set a phone number at the index specified by PhoneIndex. |
ContactPhonesCount | Number of the contact's phone numbers. |
ContactPhoneType | The phone number type. |
FirewallAutoDetect | This property tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of the firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a username if authentication is to be used when connecting through a firewall. |
FolderCount | The number of records in the Folder arrays. |
FolderChildFolderCount | The number of child folders the folder has. |
FolderChildFolders | The child folders of the folder. |
FolderDisplayName | The display name of the folder. |
FolderId | The unique identifier of the folder. |
FolderMessageRules | The message rules of the folder. |
FolderMessages | The messages contained in the folder. |
FolderMultiValueExtendedProperties | The multi-value extended properties defined for the folder. |
FolderParentFolderId | The unique identifier for the folder's parent. |
FolderSingleValueExtendedProperties | The single-value extended properties defined for the folder. |
FolderTotalItemCount | The number of total items in the folder. |
FolderUnreadItemCount | The number of unread items in the folder. |
ListContactsMarker | The page marker for listing contacts. |
ListFoldersMarker | The page marker for listing folders. |
ListMessagesMarker | The page marker for listing messages. |
Message | Provides the raw message content. |
MessageAttachmentCount | The number of records in the MessageAttachment arrays. |
MessageAttachmentAttachmentType | This property contains the attachment type of the attachment. |
MessageAttachmentContentId | This property contains the value of the unique content identifier of the attachment. |
MessageAttachmentContentLocation | This property contains the content location of the attachment. |
MessageAttachmentContentType | This property contains the content type of the attachment. |
MessageAttachmentData | This property contains the raw data of the attachment. |
MessageAttachmentFileName | This property contains the local file name associated with the attachment. |
MessageAttachmentId | This property contains the attachment identifier of the attachment. |
MessageAttachmentIsInline | This property is true if the attachment is an inline attachment. |
MessageAttachmentLastModifiedDate | This property contains the date and time when the attachment was last modified. |
MessageAttachmentName | This property contains the name of the attachment. |
MessageAttachmentParentIndex | Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. |
MessageAttachmentSize | This property contains the size in bytes of the attachment. |
MessageBcc | A comma separated list of recipients for blind carbon copies for a message. |
MessageBodyContent | The body content for a message. |
MessageBodyContentType | The body content type for a message. |
MessageCc | A comma separated list of recipients for carbon copies for a message. |
MessageDeliveryReceipt | Whether or not a message will request a Delivery Receipt. |
MessageFrom | The author of a message. |
MessageImportance | The importance of a message. |
MessageInfoCount | The number of records in the MessageInfo arrays. |
MessageInfoBcc | The BCc recipients of a message in a message info listing. |
MessageInfoBodyContent | The body content of a message in a message info listing. |
MessageInfoBodyContentType | The body content type (e. |
MessageInfoBodyPreview | The body preview of a message in a message info listing. |
MessageInfoCategories | The categories of a message in a message info listing. |
MessageInfoCc | The Cc recipients of a message in a message info listing. |
MessageInfoConversationId | The conversation unique identifier of a message in a message info listing. |
MessageInfoConversationIndex | The conversation index of a message in a message info listing. |
MessageInfoCreatedDate | The date created of a message in a message info listing. |
MessageInfoDeliveryReceiptRequested | Whether or not a delivery receipt was requested for a message in a message info listing. |
MessageInfoFlagStatus | Message flag in a message info listing. |
MessageInfoFrom | The sender of a message in a message info listing. |
MessageInfoHasAttachments | Whether or not a message in a message info listing has attachments. |
MessageInfoId | The unique identifier of a message in a message info listing set by Microsoft. |
MessageInfoImportance | The importance of a message in a message info listing. |
MessageInfoInferenceClassification | The inference classification of a message in a message info listing. |
MessageInfoIsDraft | Whether or not a message in a message info listing is a draft. |
MessageInfoIsRead | Whether or not a message in a message info listing has been read. |
MessageInfoJSON | The full JSON content of a message in a message info listing. |
MessageInfoLastModifiedDate | The last modified date of a message in a message info listing. |
MessageInfoMessageHeaders | The message headers of a message in a message info listing. |
MessageInfoMessageId | The internet message id for the message as described by rfc2822. |
MessageInfoParentFolderId | The unique identifier of the parent folder of a message in a message info listing. |
MessageInfoReadReceiptRequested | Whether or not a read receipt was requested for a message in a message info listing. |
MessageInfoReceivedDate | The received date of a message in a message info listing. |
MessageInfoReplyTo | Where to send replies for a message in a message info listing. |
MessageInfoSender | The sender of a message in a message info listing. |
MessageInfoSentDate | The date a message was sent for a message in a message info listing. |
MessageInfoSubject | The subject of a message in a message info listing. |
MessageInfoTo | The recipients of a message in a message info listing. |
MessageInfoWebLink | The URL to open a message in a message info listing in Outlook on the web. |
MessageOtherHeaders | The additional message headers for a message. |
MessageReadReceipt | Whether or not a message will request a Read Receipt. |
MessageReplyTo | A mail address to reply to. |
MessageSubject | The subject of a message. |
MessageTo | A comma separated list of recipients for a message. |
NextChangeMarker | A marker indicating which page of changes to return in the future. |
OAuthAccessToken | The access token returned by the authorization server. |
OAuthAuthorizationCode | The authorization code that is exchanged for an access token. |
OAuthAuthorizationScope | The scope request or response parameter used during authorization. |
OAuthClientId | The id of the client assigned when registering the application. |
OAuthClientProfile | The type of client that is requesting authorization. |
OAuthClientSecret | The secret value for the client assigned when registering the application. |
OAuthGrantType | The OAuth grant type used to acquire an OAuth access token. |
OAuthRefreshToken | Specifies the refresh token received from or sent to the authorization server. |
OAuthRequestRefreshToken | Specifies whether the control will request a refresh token during authorization. |
OAuthReturnURL | The URL where the user (browser) returns after authenticating. |
OAuthServerAuthURL | The URL of the authorization server. |
OAuthServerTokenURL | The URL of the token server used to obtain the access token. |
OAuthWebAuthURL | The URL to which the user should be re-directed for authorization. |
ProxyAuthScheme | This property is used to tell the control which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the control whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username if authentication is to be used for the proxy. |
Select | The parts of a message that should be retrieved. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
AddAttachment | Adds a file attachment to an existing message. |
AddItemAttachment | Adds an item attachment to an existing message. |
Authorize | Get the authorization string required to access the protected resource. |
Config | Sets or retrieves a configuration setting. |
Copy | Creates a copy of a message. |
CopyFolder | Copies a folder. |
CreateCategory | Creates a new category. |
CreateContact | Creates a contact. |
CreateDraft | Creates a new email draft. |
CreateFolder | Creates a new folder. |
Delete | Deletes a message. |
DeleteAttachment | Deletes an attachment. |
DeleteCategory | Deletes a mail category. |
DeleteContact | Deletes a contact. |
DeleteFolder | Deletes a folder. |
Forward | Forward a message. |
GetCategory | Retrieves a mail category. |
GetContact | Retrieves the contact by Id. |
GetContactField | Retrieves the contact property value by JSONPath. |
GetFolder | Retrieves a folder. |
Interrupt | Interrupt the current method. |
ListAttachments | Lists all of a message's attachments. |
ListCategories | Lists all mail categories. |
ListChanges | Lists messages that have been changed within a specified folder. |
ListContactFolders | Lists the contact folders found in the parent folder. |
ListContacts | Lists the contacts in a folder. |
ListFolders | Lists the folders found in the parent folder. |
ListMessages | Lists the messages in a folder. |
MoveFolder | Moves a folder. |
MoveMessage | Moves a message. |
RenameFolder | Renames a folder. |
Reply | Reply to a message. |
ReplyAll | ReplyAll to a message. |
Reset | This method will reset the control. |
RetrieveAttachment | Retrieves a message attachment. |
RetrieveMessage | Retrieves a message. |
RetrieveMessageRaw | Retrieves the raw message of the specified message ID. |
Search | Search for messages. |
SendCustomRequest | Send a custom HTTP request. |
SendDraft | Sends an existing draft. |
SendMail | Sends a new email. |
SetContactField | Sets the contact field value by JSONPath. |
Update | Updates a message. |
UpdateCategory | Updates a category. |
UpdateContact | Updates a contact. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
AttachmentList | Fired when an attachment is retrieved from the server. |
CategoryList | Fired when an attachment is retrieved from the server. |
ContactFolderList | Fired when a contact folder is retrieved by the server. |
ContactList | Fired when a contact is retrieved from the server. |
Error | Fired when information is available about errors during data delivery. |
FolderList | Fired when a folder is retrieved by the server. |
Log | This event fires once for each log message. |
MessageList | Fired when a message is retrieved from the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
AttachmentFragmentSize | Size of fragments when uploading large attachments. |
AttachmentJSON[i] | The raw JSON for the selected attachment. |
AttachmentSimpleUploadLimit | The threshold to use simple uploads. |
ContactFoldersPageSize | Page size for fetching contact folders. |
ContactsPageSize | Page size for fetching contacts. |
FolderPageSize | Page size for fetching folders. |
IncludeNestedItemAttachments | Whether nested attachments present on item attachment are included in the request. |
ItemAttachmentCC[i] | The CC field of item attachment messages. |
ItemAttachmentFrom[i] | The from field of item attachment messages. |
ItemAttachmentSentDate[i] | The SentDate field of item attachment messages. |
ItemAttachmentSubject[i] | The Subject field of item attachment messages. |
ItemAttachmentTo[i] | The CC field of item attachment messages. |
ListContactFoldersMarker | The page marker for listing contact folders. |
MessagePageSize | Page size for fetching messages. |
MIMEMessage | MIME encoded message to send. |
Prefer | Specifies a preferred content header type. |
QueryParamCount | The number of custom OData Query Parameters. |
QueryParamName[i] | The name of a custom OData Query Parameter. |
QueryParamValue[i] | The value of a custom OData Query Parameter. |
RequestNestedItemAttachments | Whether nested attachments present on item attachments are included when listing attachments. |
UserId | Sets the Id of a shared mailbox to connect to. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
OAuthAccessTokenExpiration | The lifetime of the access token. |
OAuthAuthorizationTokenType | The type of access token returned. |
OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
OAuthJWTPayload | The payload of the JWT access token if present. |
OAuthJWTXChildCount | The number of child elements of the current element. |
OauthJWTXChildName[i] | The name of the child element. |
OAuthJWTXChildXText[i] | The inner text of the child element. |
OAuthJWTXElement | The name of the current element. |
OauthJWTXParent | The parent of the current element. |
OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
OAuthJWTXSubTree | A snapshot of the current element in the document. |
OAuthJWTXText | The text of the current element. |
OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
OAuthParamName[i] | Specifies the parameter name at the specified index. |
OAuthParamValue[i] | Specifies the parameter value at the specified index. |
OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
OAuthReUseWebServer | Determines if the same server instance is used between requests. |
OAuthTransferredRequest | The full OAuth request last sent by the client. |
OAuthUsePKCE | Specifies if PKCE should be used. |
OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
OAuthWebServerPort | The local port on which the embedded web server listens. |
OAuthWebServerResponse | The custom response that will be displayed to the user. |
OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the control. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the control will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the control. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the control. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the control binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AttachmentCount Property (Office365 Control)
The number of records in the Attachment arrays.
Syntax
office365control.AttachmentCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
- AttachmentAttachmentType
- AttachmentContentId
- AttachmentContentLocation
- AttachmentContentType
- AttachmentData
- AttachmentFileName
- AttachmentId
- AttachmentIsInline
- AttachmentLastModifiedDate
- AttachmentName
- AttachmentParentIndex
- AttachmentSize
This property is not available at design time.
Data Type
Integer
AttachmentAttachmentType Property (Office365 Control)
This property contains the attachment type of the attachment.
Syntax
office365control.AttachmentAttachmentType(AttachmentIndex)
Default Value
""
Remarks
This field contains the attachment type of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentContentId Property (Office365 Control)
This property contains the value of the unique content identifier of the attachment.
Syntax
office365control.AttachmentContentId(AttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the value of the unique content identifier of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
String
AttachmentContentLocation Property (Office365 Control)
This property contains the content location of the attachment.
Syntax
office365control.AttachmentContentLocation(AttachmentIndex)
Default Value
""
Remarks
This field contains the content location of the attachment. It is generally null, as it is no longer supported in the Microsoft Graph API.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentContentType Property (Office365 Control)
This property contains the content type of the attachment.
Syntax
office365control.AttachmentContentType(AttachmentIndex)
Default Value
""
Remarks
This field contains the content type of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentData Property (Office365 Control)
This property contains the raw data of the attachment.
Syntax
office365control.AttachmentData(AttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the raw data of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttachmentDataB.
This property is not available at design time.
Data Type
Binary String
AttachmentFileName Property (Office365 Control)
This property contains the local file name associated with the attachment.
Syntax
office365control.AttachmentFileName(AttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the local file name associated with the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
String
AttachmentId Property (Office365 Control)
This property contains the attachment identifier of the attachment.
Syntax
office365control.AttachmentId(AttachmentIndex)
Default Value
""
Remarks
This field contains the attachment identifier of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentIsInline Property (Office365 Control)
This property is true if the attachment is an inline attachment.
Syntax
office365control.AttachmentIsInline(AttachmentIndex)[=boolean]
Default Value
False
Remarks
This field is true if the attachment is an inline attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
Boolean
AttachmentLastModifiedDate Property (Office365 Control)
This property contains the date and time when the attachment was last modified.
Syntax
office365control.AttachmentLastModifiedDate(AttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the date and time when the attachment was last modified.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
String
AttachmentName Property (Office365 Control)
This property contains the name of the attachment.
Syntax
office365control.AttachmentName(AttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the name of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
String
AttachmentParentIndex Property (Office365 Control)
Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled.
Syntax
office365control.AttachmentParentIndex(AttachmentIndex)
Default Value
""
Remarks
Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. This index is generated by the control rather than by Microsoft and is designed to provide an intuitive mapping of the attachment structure.
If the attachment is a root attachment, then this index will be a single integer starting at 1. For the following intermediate and leaf attachments, the index will add a new integer separated by a . char.
For example, a message may contain the following attachments.
- RootFileAttachment.txt (1)
- RootItemAttachment (2)
- IntermediateFileAttachment.txt (2.1)
- IntermediateItemAttachment (2.2)
- LeafFileAttachment.txt (2.2.1)
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
AttachmentSize Property (Office365 Control)
This property contains the size in bytes of the attachment.
Syntax
office365control.AttachmentSize(AttachmentIndex)[=integer]
Default Value
0
Remarks
This field contains the size in bytes of the attachment.
The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.
This property is not available at design time.
Data Type
Integer
Authorization Property (Office365 Control)
An OAuth Authorization String.
Syntax
office365control.Authorization[=string]
Default Value
""
Remarks
This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.
Example
Oauth oauth = new Oauth();
oauth.ClientId = "YourClientId";
oauth.ClientSecret = "YourClientSecret";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "user.read mail.readwrite mail.send mailboxsettings.readwrite";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
office365.Authorization = oauth.GetAuthorization();
This property is not available at design time.
Data Type
String
CategoryCount Property (Office365 Control)
The number of records in the Category arrays.
Syntax
office365control.CategoryCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at CategoryCount - 1.This property is not available at design time.
Data Type
Integer
CategoryColor Property (Office365 Control)
This property contains the color of the category.
Syntax
office365control.CategoryColor(CategoryIndex)
Default Value
""
Remarks
This field contains the color of the category.
The CategoryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CategoryCount property.
This property is read-only and not available at design time.
Data Type
String
CategoryDisplayName Property (Office365 Control)
This property contains the display name of the category.
Syntax
office365control.CategoryDisplayName(CategoryIndex)
Default Value
""
Remarks
This field contains the display name of the category.
The CategoryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CategoryCount property.
This property is read-only and not available at design time.
Data Type
String
CategoryId Property (Office365 Control)
This property contains the unique identifier of the category.
Syntax
office365control.CategoryId(CategoryIndex)
Default Value
""
Remarks
This field contains the unique identifier of the category.
The CategoryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CategoryCount property.
This property is read-only and not available at design time.
Data Type
String
ChangeMarker Property (Office365 Control)
The page marker for listing changed messages.
Syntax
office365control.ChangeMarker[=string]
Default Value
""
Remarks
This property is populated if there are still unlisted messages after ListChanges is called. It contains the nextLink that will be included as an OData parameter if ListChanges is called again on the same folder. This will cause the next page of changed messages to be listed.
Example (List All Changes of a Message)
do
{
office365.ListChanges(id, "", 100);
} while (office365.ChangeMarker.Length > 0);
This property is not available at design time.
Data Type
String
ContactFolderCount Property (Office365 Control)
The number of records in the ContactFolder arrays.
Syntax
office365control.ContactFolderCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ContactFolderCount - 1.This property is not available at design time.
Data Type
Integer
ContactFolderId Property (Office365 Control)
The unique identifier of the contact folder.
Syntax
office365control.ContactFolderId(ContactFolderIndex)
Default Value
""
Remarks
The unique identifier of the contact folder.
The ContactFolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactFolderCount property.
This property is read-only and not available at design time.
Data Type
String
ContactFolderName Property (Office365 Control)
The display name of the contact folder.
Syntax
office365control.ContactFolderName(ContactFolderIndex)
Default Value
""
Remarks
The display name of the contact folder.
The ContactFolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactFolderCount property.
This property is read-only and not available at design time.
Data Type
String
ContactFolderParentFolderId Property (Office365 Control)
The unique identifier for the folder's parent.
Syntax
office365control.ContactFolderParentFolderId(ContactFolderIndex)
Default Value
""
Remarks
The unique identifier for the folder's parent.
The ContactFolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactFolderCount property.
This property is read-only and not available at design time.
Data Type
String
ContactsCount Property (Office365 Control)
The number of records in the Contact arrays.
Syntax
office365control.ContactsCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
- ContactCompanyName
- ContactDisplayName
- ContactEmailAddress
- ContactEmailAddressesCount
- ContactEmailAddressIndex
- ContactFirstName
- ContactFolderId
- ContactFolderName
- ContactFolderParentFolderId
- ContactId
- ContactJSON
- ContactLastName
- ContactNotes
- ContactParentId
- ContactPhoneIndex
- ContactPhoneNumber
- ContactPhonesCount
- ContactPhoneType
This property is not available at design time.
Data Type
Integer
ContactCompanyName Property (Office365 Control)
The name of the contact's company.
Syntax
office365control.ContactCompanyName(ContactIndex)[=string]
Default Value
""
Remarks
The name of the contact's company.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactDisplayName Property (Office365 Control)
The contact's display name.
Syntax
office365control.ContactDisplayName(ContactIndex)[=string]
Default Value
""
Remarks
The contact's display name.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactEmailAddress Property (Office365 Control)
The email address at the specified EmailAddressIndex.
Syntax
office365control.ContactEmailAddress(ContactIndex)[=string]
Default Value
""
Remarks
The email address at the specified EmailAddressIndex. For example, when updating a contact, setting EmailAddressIndex to 0 and then assigning "example@example.com" to this property will set the first email address of the contact. Similarly, when retrieving a contact, setting EmailAddressIndex to 0 allows you to read the first email address of the contact.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactEmailAddressesCount Property (Office365 Control)
When retrieving contacts, it indicates the number of email addresses linked to the contact.
Syntax
office365control.ContactEmailAddressesCount(ContactIndex)[=integer]
Default Value
0
Remarks
When retrieving contacts, it indicates the number of email addresses linked to the contact. When creating or updating a contact, this property is set to the number of email addresses the contact will have.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
Integer
ContactEmailAddressIndex Property (Office365 Control)
Index of email address to get or set in the EmailAddress property.
Syntax
office365control.ContactEmailAddressIndex(ContactIndex)[=integer]
Default Value
0
Remarks
Index of email address to get or set in the EmailAddress property. For example, setting EmailAddressIndex to 0 and then assigning a value to this field sets the first email address of a contact. If you are retrieving a contact, setting EmailAddressIndex to 0, will populate EmailAddress with the first email address.
Example (Set the email addresses before updating a contact)
office365.Contacts[0].EmailAddressesCount = 2;
office365.Contacts[0].EmailAddressIndex = 0;
office365.Contacts[0].EmailAddress = "email1@domain1.com"; // set the first email address of the contact
office365.Contacts[0].EmailAddressIndex = 1;
office365.Contacts[0].EmailAddress = "email2@domain2.com"; // set the second email address of the contact
office365.UpdateContact(0);
Example (Read email addresses of a retrieved contact)
office365.GetContact(contactId);
OLContact lastContact = office365.Contacts[office365.Contacts.Count - 1];
for(int i = 0; i < lastContact.EmailAddressesCount; i++){
lastContact.EmailAddressIndex = i; // set the index of the next email to read
lastContact.EmailAddress; // read the next email address of the contact
}
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
Integer
ContactFirstName Property (Office365 Control)
The contact's first name.
Syntax
office365control.ContactFirstName(ContactIndex)[=string]
Default Value
""
Remarks
The contact's first name.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactId Property (Office365 Control)
The unique identifier of the contact.
Syntax
office365control.ContactId(ContactIndex)
Default Value
""
Remarks
The unique identifier of the contact.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is read-only and not available at design time.
Data Type
String
ContactJSON Property (Office365 Control)
A JSON representation of the contact.
Syntax
office365control.ContactJSON(ContactIndex)[=string]
Default Value
""
Remarks
A JSON representation of the contact. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactLastName Property (Office365 Control)
The contact's last name.
Syntax
office365control.ContactLastName(ContactIndex)[=string]
Default Value
""
Remarks
The contact's last name.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactNotes Property (Office365 Control)
The user's notes about the contact.
Syntax
office365control.ContactNotes(ContactIndex)[=string]
Default Value
""
Remarks
The user's notes about the contact.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactParentId Property (Office365 Control)
The ID of the contact's parent folder.
Syntax
office365control.ContactParentId(ContactIndex)[=string]
Default Value
""
Remarks
The ID of the contact's parent folder.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactPhoneIndex Property (Office365 Control)
Index of phone number to get or set in the PhoneNumber property.
Syntax
office365control.ContactPhoneIndex(ContactIndex)[=integer]
Default Value
0
Remarks
Index of phone number to get or set in the PhoneNumber property. For example, setting PhoneIndex to 0 and then assigning a value to this field sets the first phone number of a contact. If you are retrieving a contact, setting PhoneIndex to 0, will populate PhoneNumber with the first phone number.
Example (Set the phone numbers before updating a contact):
office365.Contacts[0].PhonesCount = 2;
office365.Contacts[0].PhoneIndex = 0;
office365.Contacts[0].PhoneNumber = "0123456789"; // set the first email address of the contact
office365.Contacts[0].PhoneIndex = 1;
office365.Contacts[0].PhoneNumber = "9876543210"; // set the second email address of the contact
office365.UpdateContact(0);
Example (Read phone numbers of a retrieved contact):
office365.GetContact(contactId);
OLContact lastContact = office365.Contacts[office365.Contacts.Count - 1];
for(int i = 0; i < lastContact.PhonesCount; i++){
lastContact.PhoneIndex = i; // set the index of the next phone number to read
lastContact.PhoneNumber; // read the next phone number of the contact
}
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
Integer
ContactPhoneNumber Property (Office365 Control)
This property is used to get or set a phone number at the index specified by PhoneIndex.
Syntax
office365control.ContactPhoneNumber(ContactIndex)[=string]
Default Value
""
Remarks
This property is used to get or set a phone number at the index specified by PhoneIndex. For example, setting PhoneIndex to 0 and then assigning "0123456789" to this property sets the first phone number of the contact. Similarly, after setting PhoneIndex to 0 you can read the first phone number of the contact.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
String
ContactPhonesCount Property (Office365 Control)
Number of the contact's phone numbers.
Syntax
office365control.ContactPhonesCount(ContactIndex)[=integer]
Default Value
0
Remarks
Number of the contact's phone numbers.
When retrieving contacts, this property indicates the number of phone numbers linked to the contact. When updating a contact, this property is set to the number of phone numbers to be linked to the contact.
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
Integer
ContactPhoneType Property (Office365 Control)
The phone number type.
Syntax
office365control.ContactPhoneType(ContactIndex)[=integer]
Possible Values
optHome(0), optBusiness(1), optMobile(2)
Default Value
0
Remarks
The phone number type.
This property indicates the type of a contact's phone number selected by PhoneIndex. Possible values are:
- 0 (optHome)
- 1 (optBusiness)
- 2 (optMobile)
The ContactIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContactsCount property.
This property is not available at design time.
Data Type
Integer
FirewallAutoDetect Property (Office365 Control)
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Syntax
office365control.FirewallAutoDetect[=boolean]
Default Value
False
Remarks
This property tells the control whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (Office365 Control)
This property determines the type of firewall to connect through.
Syntax
office365control.FirewallType[=integer]
Possible Values
fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)
Default Value
0
Remarks
This property determines 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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (Office365 Control)
This property contains the name or IP address of the firewall (optional).
Syntax
office365control.FirewallHost[=string]
Default Value
""
Remarks
This property contains the name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.
Data Type
String
FirewallPassword Property (Office365 Control)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
office365control.FirewallPassword[=string]
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
Data Type
String
FirewallPort Property (Office365 Control)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
office365control.FirewallPort[=integer]
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (Office365 Control)
This property contains a username if authentication is to be used when connecting through a firewall.
Syntax
office365control.FirewallUser[=string]
Default Value
""
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.
Data Type
String
FolderCount Property (Office365 Control)
The number of records in the Folder arrays.
Syntax
office365control.FolderCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
- FolderChildFolderCount
- FolderChildFolders
- FolderDisplayName
- FolderId
- FolderMessageRules
- FolderMessages
- FolderMultiValueExtendedProperties
- FolderParentFolderId
- FolderSingleValueExtendedProperties
- FolderTotalItemCount
- FolderUnreadItemCount
This property is not available at design time.
Data Type
Integer
FolderChildFolderCount Property (Office365 Control)
The number of child folders the folder has.
Syntax
office365control.FolderChildFolderCount(FolderIndex)
Default Value
0
Remarks
The number of child folders the folder has.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
Integer
FolderChildFolders Property (Office365 Control)
The child folders of the folder.
Syntax
office365control.FolderChildFolders(FolderIndex)
Default Value
""
Remarks
The child folders of the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderDisplayName Property (Office365 Control)
The display name of the folder.
Syntax
office365control.FolderDisplayName(FolderIndex)
Default Value
""
Remarks
The display name of the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderId Property (Office365 Control)
The unique identifier of the folder.
Syntax
office365control.FolderId(FolderIndex)
Default Value
""
Remarks
The unique identifier of the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderMessageRules Property (Office365 Control)
The message rules of the folder.
Syntax
office365control.FolderMessageRules(FolderIndex)
Default Value
""
Remarks
The message rules of the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderMessages Property (Office365 Control)
The messages contained in the folder.
Syntax
office365control.FolderMessages(FolderIndex)
Default Value
""
Remarks
The messages contained in the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderMultiValueExtendedProperties Property (Office365 Control)
The multi-value extended properties defined for the folder.
Syntax
office365control.FolderMultiValueExtendedProperties(FolderIndex)
Default Value
""
Remarks
The multi-value extended properties defined for the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderParentFolderId Property (Office365 Control)
The unique identifier for the folder's parent.
Syntax
office365control.FolderParentFolderId(FolderIndex)
Default Value
""
Remarks
The unique identifier for the folder's parent.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderSingleValueExtendedProperties Property (Office365 Control)
The single-value extended properties defined for the folder.
Syntax
office365control.FolderSingleValueExtendedProperties(FolderIndex)
Default Value
""
Remarks
The single-value extended properties defined for the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
String
FolderTotalItemCount Property (Office365 Control)
The number of total items in the folder.
Syntax
office365control.FolderTotalItemCount(FolderIndex)
Default Value
0
Remarks
The number of total items in the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
Integer
FolderUnreadItemCount Property (Office365 Control)
The number of unread items in the folder.
Syntax
office365control.FolderUnreadItemCount(FolderIndex)
Default Value
0
Remarks
The number of unread items in the folder.
The FolderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FolderCount property.
This property is read-only and not available at design time.
Data Type
Integer
ListContactsMarker Property (Office365 Control)
The page marker for listing contacts.
Syntax
office365control.ListContactsMarker[=string]
Default Value
""
Remarks
This property is populated if there are still unlisted contacts after ListContacts is called. It contains the nextLink that will be included as an OData parameter if ListContacts is called again on the same folder. This will cause the next page of contacts to be listed and added to the end of the Contacts collection.
Example (List All Contacts in a Folder):
do
{
office365.ListContacts(folderId);
} while (!office365.ListContactsMarker.isEmpty());
This property is not available at design time.
Data Type
String
ListFoldersMarker Property (Office365 Control)
The page marker for listing folders.
Syntax
office365control.ListFoldersMarker[=string]
Default Value
""
Remarks
This property is populated if there are still unlisted changes after ListFolders is called. It contains the nextLink that will be included as an OData parameter if ListFolders is called again on the same parent folder. This will cause the next page of folders to be listed.
Example (List All Folders in the Root Directory)
do
{
office365.ListFolders("");
} while (office365.ListFoldersMarker.Length > 0);
This property is not available at design time.
Data Type
String
ListMessagesMarker Property (Office365 Control)
The page marker for listing messages.
Syntax
office365control.ListMessagesMarker[=string]
Default Value
""
Remarks
This property is populated if there are still unlisted messages after ListMessages is called. It contains the nextLink that will be included as an OData parameter if ListMessages is called again on the same folder. This will cause the next page of messages to be listed.
Example (List All Messages in a Folder)
do
{
office365.ListMessages(folderId, filter);
} while (office365.ListMessagesMarker.Length > 0);
This property is not available at design time.
Data Type
String
Message Property (Office365 Control)
Provides the raw message content.
Syntax
office365control.Message
Default Value
""
Remarks
This property is populated after calling RetrieveMessageRaw and holds the raw message content. This can be used to access the data before any processing is done by the control.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .MessageB.
This property is read-only and not available at design time.
Data Type
Binary String
MessageAttachmentCount Property (Office365 Control)
The number of records in the MessageAttachment arrays.
Syntax
office365control.MessageAttachmentCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
- MessageAttachmentAttachmentType
- MessageAttachmentContentId
- MessageAttachmentContentLocation
- MessageAttachmentContentType
- MessageAttachmentData
- MessageAttachmentFileName
- MessageAttachmentId
- MessageAttachmentIsInline
- MessageAttachmentLastModifiedDate
- MessageAttachmentName
- MessageAttachmentParentIndex
- MessageAttachmentSize
This property is not available at design time.
Data Type
Integer
MessageAttachmentAttachmentType Property (Office365 Control)
This property contains the attachment type of the attachment.
Syntax
office365control.MessageAttachmentAttachmentType(MessageAttachmentIndex)
Default Value
""
Remarks
This field contains the attachment type of the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
MessageAttachmentContentId Property (Office365 Control)
This property contains the value of the unique content identifier of the attachment.
Syntax
office365control.MessageAttachmentContentId(MessageAttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the value of the unique content identifier of the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is not available at design time.
Data Type
String
MessageAttachmentContentLocation Property (Office365 Control)
This property contains the content location of the attachment.
Syntax
office365control.MessageAttachmentContentLocation(MessageAttachmentIndex)
Default Value
""
Remarks
This field contains the content location of the attachment. It is generally null, as it is no longer supported in the Microsoft Graph API.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
MessageAttachmentContentType Property (Office365 Control)
This property contains the content type of the attachment.
Syntax
office365control.MessageAttachmentContentType(MessageAttachmentIndex)
Default Value
""
Remarks
This field contains the content type of the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
MessageAttachmentData Property (Office365 Control)
This property contains the raw data of the attachment.
Syntax
office365control.MessageAttachmentData(MessageAttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the raw data of the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .MessageAttachmentDataB.
This property is not available at design time.
Data Type
Binary String
MessageAttachmentFileName Property (Office365 Control)
This property contains the local file name associated with the attachment.
Syntax
office365control.MessageAttachmentFileName(MessageAttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the local file name associated with the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is not available at design time.
Data Type
String
MessageAttachmentId Property (Office365 Control)
This property contains the attachment identifier of the attachment.
Syntax
office365control.MessageAttachmentId(MessageAttachmentIndex)
Default Value
""
Remarks
This field contains the attachment identifier of the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
MessageAttachmentIsInline Property (Office365 Control)
This property is true if the attachment is an inline attachment.
Syntax
office365control.MessageAttachmentIsInline(MessageAttachmentIndex)[=boolean]
Default Value
False
Remarks
This field is true if the attachment is an inline attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is not available at design time.
Data Type
Boolean
MessageAttachmentLastModifiedDate Property (Office365 Control)
This property contains the date and time when the attachment was last modified.
Syntax
office365control.MessageAttachmentLastModifiedDate(MessageAttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the date and time when the attachment was last modified.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is not available at design time.
Data Type
String
MessageAttachmentName Property (Office365 Control)
This property contains the name of the attachment.
Syntax
office365control.MessageAttachmentName(MessageAttachmentIndex)[=string]
Default Value
""
Remarks
This field contains the name of the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is not available at design time.
Data Type
String
MessageAttachmentParentIndex Property (Office365 Control)
Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled.
Syntax
office365control.MessageAttachmentParentIndex(MessageAttachmentIndex)
Default Value
""
Remarks
Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. This index is generated by the control rather than by Microsoft and is designed to provide an intuitive mapping of the attachment structure.
If the attachment is a root attachment, then this index will be a single integer starting at 1. For the following intermediate and leaf attachments, the index will add a new integer separated by a . char.
For example, a message may contain the following attachments.
- RootFileAttachment.txt (1)
- RootItemAttachment (2)
- IntermediateFileAttachment.txt (2.1)
- IntermediateItemAttachment (2.2)
- LeafFileAttachment.txt (2.2.1)
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is read-only and not available at design time.
Data Type
String
MessageAttachmentSize Property (Office365 Control)
This property contains the size in bytes of the attachment.
Syntax
office365control.MessageAttachmentSize(MessageAttachmentIndex)[=integer]
Default Value
0
Remarks
This field contains the size in bytes of the attachment.
The MessageAttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageAttachmentCount property.
This property is not available at design time.
Data Type
Integer
MessageBcc Property (Office365 Control)
A comma separated list of recipients for blind carbon copies for a message.
Syntax
office365control.MessageBcc[=string]
Default Value
""
Remarks
This property contains a comma separated list of destinations for blind carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a Bcc Recipient)
office365.MessageBcc = "bbobbertson@bobmail.com";
office365.SendMail(True);
Example (Add a Bcc Recipient with a Name and Address)
office365.MessageBcc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com";
office365.SendMail(True);
This property is not available at design time.
Data Type
String
MessageBodyContent Property (Office365 Control)
The body content for a message.
Syntax
office365control.MessageBodyContent[=string]
Default Value
""
Remarks
This property contains the content of a message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
Data Type
String
MessageBodyContentType Property (Office365 Control)
The body content type for a message.
Syntax
office365control.MessageBodyContentType[=string]
Default Value
""
Remarks
This property contains the content type of a message. Valid values include text or html. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
Data Type
String
MessageCc Property (Office365 Control)
A comma separated list of recipients for carbon copies for a message.
Syntax
office365control.MessageCc[=string]
Default Value
""
Remarks
This property contains a comma separated list of destinations for carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a CC Recipient)
office365.MessageCc = "bbobbertson@bobmail.com";
office365.SendMail(True);
Example (Add a CC Recipient with a Name and Address)
office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com";
office365.SendMail(True);
This property is not available at design time.
Data Type
String
MessageDeliveryReceipt Property (Office365 Control)
Whether or not a message will request a Delivery Receipt.
Syntax
office365control.MessageDeliveryReceipt[=boolean]
Default Value
False
Remarks
This property determines whether or not messages created with CreateDraft or messages sent with SendMail will request a Delivery Receipt.
Data Type
Boolean
MessageFrom Property (Office365 Control)
The author of a message.
Syntax
office365control.MessageFrom[=string]
Default Value
""
Remarks
This property contains the author of a message. This property is optional. If it is left blank, the message's author will be the Microsoft account used in Authorization.
This property is applied to a message created with CreateDraft or messages sent with SendMail.
Example (Specify Message Author)
office365.MessageFrom = "stephen@company.com";
office365.SendMail(True);
Example (Specify Message Author - Name Included)
office365.MessageFrom = "\"Stephen Withavee\" stephen@company.com";
office365.SendMail(True);
This property is not available at design time.
Data Type
String
MessageImportance Property (Office365 Control)
The importance of a message.
Syntax
office365control.MessageImportance[=string]
Default Value
""
Remarks
This property determines the importance of messages created with CreateDraft or messages sent with SendMail. Valid values are Low, Normal, and High.
This property is not available at design time.
Data Type
String
MessageInfoCount Property (Office365 Control)
The number of records in the MessageInfo arrays.
Syntax
office365control.MessageInfoCount[=integer]
Default Value
0
Remarks
This property controls the size of the following arrays:
- MessageInfoBcc
- MessageInfoBodyContent
- MessageInfoBodyContentType
- MessageInfoBodyPreview
- MessageInfoCategories
- MessageInfoCc
- MessageInfoConversationId
- MessageInfoConversationIndex
- MessageInfoCreatedDate
- MessageInfoDeliveryReceiptRequested
- MessageInfoFlagStatus
- MessageInfoFrom
- MessageInfoHasAttachments
- MessageInfoId
- MessageInfoImportance
- MessageInfoInferenceClassification
- MessageInfoIsDraft
- MessageInfoIsRead
- MessageInfoJSON
- MessageInfoLastModifiedDate
- MessageInfoMessageHeaders
- MessageInfoMessageId
- MessageInfoParentFolderId
- MessageInfoReadReceiptRequested
- MessageInfoReceivedDate
- MessageInfoReplyTo
- MessageInfoSender
- MessageInfoSentDate
- MessageInfoSubject
- MessageInfoTo
- MessageInfoWebLink
This property is not available at design time.
Data Type
Integer
MessageInfoBcc Property (Office365 Control)
The BCc recipients of a message in a message info listing.
Syntax
office365control.MessageInfoBcc(MessageInfoIndex)[=string]
Default Value
""
Remarks
The BCc recipients of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoBodyContent Property (Office365 Control)
The body content of a message in a message info listing.
Syntax
office365control.MessageInfoBodyContent(MessageInfoIndex)[=string]
Default Value
""
Remarks
The body content of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoBodyContentType Property (Office365 Control)
The body content type (e.
Syntax
office365control.MessageInfoBodyContentType(MessageInfoIndex)[=string]
Default Value
""
Remarks
The body content type (e.g. "HTML") of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoBodyPreview Property (Office365 Control)
The body preview of a message in a message info listing.
Syntax
office365control.MessageInfoBodyPreview(MessageInfoIndex)
Default Value
""
Remarks
The body preview of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoCategories Property (Office365 Control)
The categories of a message in a message info listing.
Syntax
office365control.MessageInfoCategories(MessageInfoIndex)[=string]
Default Value
""
Remarks
The categories of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoCc Property (Office365 Control)
The Cc recipients of a message in a message info listing.
Syntax
office365control.MessageInfoCc(MessageInfoIndex)[=string]
Default Value
""
Remarks
The Cc recipients of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoConversationId Property (Office365 Control)
The conversation unique identifier of a message in a message info listing.
Syntax
office365control.MessageInfoConversationId(MessageInfoIndex)
Default Value
""
Remarks
The conversation unique identifier of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoConversationIndex Property (Office365 Control)
The conversation index of a message in a message info listing.
Syntax
office365control.MessageInfoConversationIndex(MessageInfoIndex)
Default Value
""
Remarks
The conversation index of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoCreatedDate Property (Office365 Control)
The date created of a message in a message info listing.
Syntax
office365control.MessageInfoCreatedDate(MessageInfoIndex)
Default Value
""
Remarks
The date created of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoDeliveryReceiptRequested Property (Office365 Control)
Whether or not a delivery receipt was requested for a message in a message info listing.
Syntax
office365control.MessageInfoDeliveryReceiptRequested(MessageInfoIndex)[=boolean]
Default Value
False
Remarks
Whether or not a delivery receipt was requested for a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
Boolean
MessageInfoFlagStatus Property (Office365 Control)
Message flag in a message info listing.
Syntax
office365control.MessageInfoFlagStatus(MessageInfoIndex)[=string]
Default Value
""
Remarks
Message flag in a message info listing. Example values include:
notFlagged | |
complete | |
flagged |
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoFrom Property (Office365 Control)
The sender of a message in a message info listing.
Syntax
office365control.MessageInfoFrom(MessageInfoIndex)
Default Value
""
Remarks
The sender of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoHasAttachments Property (Office365 Control)
Whether or not a message in a message info listing has attachments.
Syntax
office365control.MessageInfoHasAttachments(MessageInfoIndex)
Default Value
False
Remarks
Whether or not a message in a message info listing has attachments.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MessageInfoId Property (Office365 Control)
The unique identifier of a message in a message info listing set by Microsoft.
Syntax
office365control.MessageInfoId(MessageInfoIndex)
Default Value
""
Remarks
The unique identifier of a message in a message info listing set by Microsoft.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoImportance Property (Office365 Control)
The importance of a message in a message info listing.
Syntax
office365control.MessageInfoImportance(MessageInfoIndex)[=string]
Default Value
""
Remarks
The importance of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoInferenceClassification Property (Office365 Control)
The inference classification of a message in a message info listing.
Syntax
office365control.MessageInfoInferenceClassification(MessageInfoIndex)
Default Value
""
Remarks
The inference classification of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoIsDraft Property (Office365 Control)
Whether or not a message in a message info listing is a draft.
Syntax
office365control.MessageInfoIsDraft(MessageInfoIndex)
Default Value
False
Remarks
Whether or not a message in a message info listing is a draft.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
Boolean
MessageInfoIsRead Property (Office365 Control)
Whether or not a message in a message info listing has been read.
Syntax
office365control.MessageInfoIsRead(MessageInfoIndex)[=boolean]
Default Value
False
Remarks
Whether or not a message in a message info listing has been read.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
Boolean
MessageInfoJSON Property (Office365 Control)
The full JSON content of a message in a message info listing.
Syntax
office365control.MessageInfoJSON(MessageInfoIndex)[=string]
Default Value
""
Remarks
The full JSON content of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoLastModifiedDate Property (Office365 Control)
The last modified date of a message in a message info listing.
Syntax
office365control.MessageInfoLastModifiedDate(MessageInfoIndex)
Default Value
""
Remarks
The last modified date of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoMessageHeaders Property (Office365 Control)
The message headers of a message in a message info listing.
Syntax
office365control.MessageInfoMessageHeaders(MessageInfoIndex)
Default Value
""
Remarks
The message headers of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoMessageId Property (Office365 Control)
The internet message id for the message as described by rfc2822.
Syntax
office365control.MessageInfoMessageId(MessageInfoIndex)
Default Value
""
Remarks
The internet message id for the message as described by rfc2822.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoParentFolderId Property (Office365 Control)
The unique identifier of the parent folder of a message in a message info listing.
Syntax
office365control.MessageInfoParentFolderId(MessageInfoIndex)
Default Value
""
Remarks
The unique identifier of the parent folder of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoReadReceiptRequested Property (Office365 Control)
Whether or not a read receipt was requested for a message in a message info listing.
Syntax
office365control.MessageInfoReadReceiptRequested(MessageInfoIndex)[=boolean]
Default Value
False
Remarks
Whether or not a read receipt was requested for a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
Boolean
MessageInfoReceivedDate Property (Office365 Control)
The received date of a message in a message info listing.
Syntax
office365control.MessageInfoReceivedDate(MessageInfoIndex)
Default Value
""
Remarks
The received date of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoReplyTo Property (Office365 Control)
Where to send replies for a message in a message info listing.
Syntax
office365control.MessageInfoReplyTo(MessageInfoIndex)[=string]
Default Value
""
Remarks
Where to send replies for a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoSender Property (Office365 Control)
The sender of a message in a message info listing.
Syntax
office365control.MessageInfoSender(MessageInfoIndex)
Default Value
""
Remarks
The sender of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoSentDate Property (Office365 Control)
The date a message was sent for a message in a message info listing.
Syntax
office365control.MessageInfoSentDate(MessageInfoIndex)
Default Value
""
Remarks
The date a message was sent for a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageInfoSubject Property (Office365 Control)
The subject of a message in a message info listing.
Syntax
office365control.MessageInfoSubject(MessageInfoIndex)[=string]
Default Value
""
Remarks
The subject of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoTo Property (Office365 Control)
The recipients of a message in a message info listing.
Syntax
office365control.MessageInfoTo(MessageInfoIndex)[=string]
Default Value
""
Remarks
The recipients of a message in a message info listing.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is not available at design time.
Data Type
String
MessageInfoWebLink Property (Office365 Control)
The URL to open a message in a message info listing in Outlook on the web.
Syntax
office365control.MessageInfoWebLink(MessageInfoIndex)
Default Value
""
Remarks
The URL to open a message in a message info listing in Outlook on the web.
The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.
This property is read-only and not available at design time.
Data Type
String
MessageOtherHeaders Property (Office365 Control)
The additional message headers for a message.
Syntax
office365control.MessageOtherHeaders[=string]
Default Value
""
Remarks
This property contains additional message headers to the sent or created message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
Data Type
String
MessageReadReceipt Property (Office365 Control)
Whether or not a message will request a Read Receipt.
Syntax
office365control.MessageReadReceipt[=boolean]
Default Value
False
Remarks
This property determines whether or not messages created with CreateDraft or messages sent with SendMail will request a Read Receipt.
Data Type
Boolean
MessageReplyTo Property (Office365 Control)
A mail address to reply to.
Syntax
office365control.MessageReplyTo[=string]
Default Value
""
Remarks
This property contains a comma separated list of destinations for the ReplyTo property of a message. This property is optional. This property is useful when replies should be sent to addresses other than those in MessageFrom. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
Data Type
String
MessageSubject Property (Office365 Control)
The subject of a message.
Syntax
office365control.MessageSubject[=string]
Default Value
""
Remarks
This property contains the subject of a message. This property will be applied to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
Data Type
String
MessageTo Property (Office365 Control)
A comma separated list of recipients for a message.
Syntax
office365control.MessageTo[=string]
Default Value
""
Remarks
This property contains a comma separated list of destinations for a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a Recipient)
office365.MessageCc = "bbobbertson@bobmail.com";
office365.SendMail(True);
Example (Add a Recipient with a Name and Address)
office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com";
office365.SendMail(True);
This property is not available at design time.
Data Type
String
NextChangeMarker Property (Office365 Control)
A marker indicating which page of changes to return in the future.
Syntax
office365control.NextChangeMarker[=string]
Default Value
""
Remarks
This property will be populated when ListChanges is called if there are no more changes to list. Refer to ListChanges for more information.
This property is not available at design time.
Data Type
String
OAuthAccessToken Property (Office365 Control)
The access token returned by the authorization server.
Syntax
office365control.OAuthAccessToken[=string]
Default Value
""
Remarks
The access token returned by the authorization server. This is set when the control makes a request to the token server.
This property is not available at design time.
Data Type
String
OAuthAuthorizationCode Property (Office365 Control)
The authorization code that is exchanged for an access token.
Syntax
office365control.OAuthAuthorizationCode[=string]
Default Value
""
Remarks
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
This property is not available at design time.
Data Type
String
OAuthAuthorizationScope Property (Office365 Control)
The scope request or response parameter used during authorization.
Syntax
office365control.OAuthAuthorizationScope[=string]
Default Value
""
Remarks
The scope request or response parameter used during authorization.
This property is not available at design time.
Data Type
String
OAuthClientId Property (Office365 Control)
The id of the client assigned when registering the application.
Syntax
office365control.OAuthClientId[=string]
Default Value
""
Remarks
The id of the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthClientProfile Property (Office365 Control)
The type of client that is requesting authorization.
Syntax
office365control.OAuthClientProfile[=integer]
Possible Values
cocpApplication(0), cocpWeb(1)
Default Value
0
Remarks
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. |
This property is not available at design time.
Data Type
Integer
OAuthClientSecret Property (Office365 Control)
The secret value for the client assigned when registering the application.
Syntax
office365control.OAuthClientSecret[=string]
Default Value
""
Remarks
The secret value for the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthGrantType Property (Office365 Control)
The OAuth grant type used to acquire an OAuth access token.
Syntax
office365control.OAuthGrantType[=integer]
Possible Values
cogtAuthorizationCode(0), cogtImplicit(1), cogtPassword(2), cogtClientCredentials(3)
Default Value
0
Remarks
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
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 |
This property is not available at design time.
Data Type
Integer
OAuthRefreshToken Property (Office365 Control)
Specifies the refresh token received from or sent to the authorization server.
Syntax
office365control.OAuthRefreshToken[=string]
Default Value
""
Remarks
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
This property is not available at design time.
Data Type
String
OAuthRequestRefreshToken Property (Office365 Control)
Specifies whether the control will request a refresh token during authorization.
Syntax
office365control.OAuthRequestRefreshToken[=boolean]
Default Value
True
Remarks
Specifies whether the control will request a refresh token during authorization. By default, this value is True.
When True, the control will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.
This property is not available at design time.
Data Type
Boolean
OAuthReturnURL Property (Office365 Control)
The URL where the user (browser) returns after authenticating.
Syntax
office365control.OAuthReturnURL[=string]
Default Value
""
Remarks
The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the control when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
This property is not available at design time.
Data Type
String
OAuthServerAuthURL Property (Office365 Control)
The URL of the authorization server.
Syntax
office365control.OAuthServerAuthURL[=string]
Default Value
""
Remarks
The URL of the authorization server.
This property is not available at design time.
Data Type
String
OAuthServerTokenURL Property (Office365 Control)
The URL of the token server used to obtain the access token.
Syntax
office365control.OAuthServerTokenURL[=string]
Default Value
""
Remarks
The URL of the token server used to obtain the access token.
This property is not available at design time.
Data Type
String
OAuthWebAuthURL Property (Office365 Control)
The URL to which the user should be re-directed for authorization.
Syntax
office365control.OAuthWebAuthURL
Default Value
""
Remarks
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
This property is read-only and not available at design time.
Data Type
String
ProxyAuthScheme Property (Office365 Control)
This property is used to tell the control which type of authorization to perform when connecting to the proxy.
Syntax
office365control.ProxyAuthScheme[=integer]
Possible Values
authBasic(0), authDigest(1), authProprietary(2), authNone(3), authNtlm(4), authNegotiate(5)
Default Value
0
Remarks
This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (Office365 Control)
This property tells the control whether or not to automatically detect and use proxy system settings, if available.
Syntax
office365control.ProxyAutoDetect[=boolean]
Default Value
False
Remarks
This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .
Data Type
Boolean
ProxyPassword Property (Office365 Control)
This property contains a password if authentication is to be used for the proxy.
Syntax
office365control.ProxyPassword[=string]
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (Office365 Control)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
office365control.ProxyPort[=integer]
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (Office365 Control)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
office365control.ProxyServer[=string]
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (Office365 Control)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
office365control.ProxySSL[=integer]
Possible Values
psAutomatic(0), psAlways(1), psNever(2), psTunnel(3)
Default Value
0
Remarks
This property determines 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 control will use the psTunnel option. If the URL is an http URL, the control 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. |
Data Type
Integer
ProxyUser Property (Office365 Control)
This property contains a username if authentication is to be used for the proxy.
Syntax
office365control.ProxyUser[=string]
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
Select Property (Office365 Control)
The parts of a message that should be retrieved.
Syntax
office365control.Select[=string]
Default Value
""
Remarks
This property can be used to select specific message or attachment properties to retrieve when calling ListMessages RetrieveMessage, ListAttachments, or RetrieveAttachment. Specify the message or attachment properties to be selected as a comma separated list.
When this property is an empty string, all message or attachment properties will be selected.
Messages
Selectable properties for messages include:
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)
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)
office365.Select = "name, size";
office365.ListAttachments(messageId);
This property is not available at design time.
Data Type
String
SSLAcceptServerCertEffectiveDate Property (Office365 Control)
This is the date on which this certificate becomes valid.
Syntax
office365control.SSLAcceptServerCertEffectiveDate
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (Office365 Control)
This is the date the certificate expires.
Syntax
office365control.SSLAcceptServerCertExpirationDate
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (Office365 Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
office365control.SSLAcceptServerCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (Office365 Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
office365control.SSLAcceptServerCertFingerprint
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (Office365 Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
office365control.SSLAcceptServerCertFingerprintSHA1
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (Office365 Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
office365control.SSLAcceptServerCertFingerprintSHA256
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (Office365 Control)
This is the issuer of the certificate.
Syntax
office365control.SSLAcceptServerCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (Office365 Control)
This is the private key of the certificate (if available).
Syntax
office365control.SSLAcceptServerCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (Office365 Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
office365control.SSLAcceptServerCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (Office365 Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
office365control.SSLAcceptServerCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (Office365 Control)
This is the public key of the certificate.
Syntax
office365control.SSLAcceptServerCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (Office365 Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
office365control.SSLAcceptServerCertPublicKeyAlgorithm
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (Office365 Control)
This is the length of the certificate's public key (in bits).
Syntax
office365control.SSLAcceptServerCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (Office365 Control)
This is the serial number of the certificate encoded as a string.
Syntax
office365control.SSLAcceptServerCertSerialNumber
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (Office365 Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
office365control.SSLAcceptServerCertSignatureAlgorithm
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (Office365 Control)
This is the name of the certificate store for the client certificate.
Syntax
office365control.SSLAcceptServerCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (Office365 Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
office365control.SSLAcceptServerCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLAcceptServerCertStoreType Property (Office365 Control)
This is the type of certificate store for this certificate.
Syntax
office365control.SSLAcceptServerCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (Office365 Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
office365control.SSLAcceptServerCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (Office365 Control)
This property contains the MD5 hash of the certificate.
Syntax
office365control.SSLAcceptServerCertThumbprintMD5
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (Office365 Control)
This property contains the SHA-1 hash of the certificate.
Syntax
office365control.SSLAcceptServerCertThumbprintSHA1
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (Office365 Control)
This property contains the SHA-256 hash of the certificate.
Syntax
office365control.SSLAcceptServerCertThumbprintSHA256
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (Office365 Control)
This property contains the text description of UsageFlags .
Syntax
office365control.SSLAcceptServerCertUsage
Default Value
""
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (Office365 Control)
This property contains the flags that show intended use for the certificate.
Syntax
office365control.SSLAcceptServerCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags 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 SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (Office365 Control)
This property contains the certificate's version number.
Syntax
office365control.SSLAcceptServerCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (Office365 Control)
This is the subject of the certificate used for client authentication.
Syntax
office365control.SSLAcceptServerCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLAcceptServerCertEncoded Property (Office365 Control)
This is the certificate (PEM/Base64 encoded).
Syntax
office365control.SSLAcceptServerCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (Office365 Control)
This is the date on which this certificate becomes valid.
Syntax
office365control.SSLCertEffectiveDate
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (Office365 Control)
This is the date the certificate expires.
Syntax
office365control.SSLCertExpirationDate
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (Office365 Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
office365control.SSLCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (Office365 Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
office365control.SSLCertFingerprint
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (Office365 Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
office365control.SSLCertFingerprintSHA1
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (Office365 Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
office365control.SSLCertFingerprintSHA256
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (Office365 Control)
This is the issuer of the certificate.
Syntax
office365control.SSLCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (Office365 Control)
This is the private key of the certificate (if available).
Syntax
office365control.SSLCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (Office365 Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
office365control.SSLCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (Office365 Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
office365control.SSLCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (Office365 Control)
This is the public key of the certificate.
Syntax
office365control.SSLCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (Office365 Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
office365control.SSLCertPublicKeyAlgorithm
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (Office365 Control)
This is the length of the certificate's public key (in bits).
Syntax
office365control.SSLCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (Office365 Control)
This is the serial number of the certificate encoded as a string.
Syntax
office365control.SSLCertSerialNumber
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (Office365 Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
office365control.SSLCertSignatureAlgorithm
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (Office365 Control)
This is the name of the certificate store for the client certificate.
Syntax
office365control.SSLCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (Office365 Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
office365control.SSLCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (Office365 Control)
This is the type of certificate store for this certificate.
Syntax
office365control.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLCertSubjectAltNames Property (Office365 Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
office365control.SSLCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (Office365 Control)
This property contains the MD5 hash of the certificate.
Syntax
office365control.SSLCertThumbprintMD5
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (Office365 Control)
This property contains the SHA-1 hash of the certificate.
Syntax
office365control.SSLCertThumbprintSHA1
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (Office365 Control)
This property contains the SHA-256 hash of the certificate.
Syntax
office365control.SSLCertThumbprintSHA256
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (Office365 Control)
This property contains the text description of UsageFlags .
Syntax
office365control.SSLCertUsage
Default Value
""
Remarks
This property contains the text description of SSLCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (Office365 Control)
This property contains the flags that show intended use for the certificate.
Syntax
office365control.SSLCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (Office365 Control)
This property contains the certificate's version number.
Syntax
office365control.SSLCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (Office365 Control)
This is the subject of the certificate used for client authentication.
Syntax
office365control.SSLCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLCertEncoded Property (Office365 Control)
This is the certificate (PEM/Base64 encoded).
Syntax
office365control.SSLCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLProvider Property (Office365 Control)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
office365control.SSLProvider[=integer]
Possible Values
sslpAutomatic(0), sslpPlatform(1), sslpInternal(2)
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 control 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. |
In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
Data Type
Integer
SSLServerCertEffectiveDate Property (Office365 Control)
This is the date on which this certificate becomes valid.
Syntax
office365control.SSLServerCertEffectiveDate
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (Office365 Control)
This is the date the certificate expires.
Syntax
office365control.SSLServerCertExpirationDate
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (Office365 Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
office365control.SSLServerCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (Office365 Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
office365control.SSLServerCertFingerprint
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (Office365 Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
office365control.SSLServerCertFingerprintSHA1
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (Office365 Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
office365control.SSLServerCertFingerprintSHA256
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (Office365 Control)
This is the issuer of the certificate.
Syntax
office365control.SSLServerCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (Office365 Control)
This is the private key of the certificate (if available).
Syntax
office365control.SSLServerCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (Office365 Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
office365control.SSLServerCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (Office365 Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
office365control.SSLServerCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (Office365 Control)
This is the public key of the certificate.
Syntax
office365control.SSLServerCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (Office365 Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
office365control.SSLServerCertPublicKeyAlgorithm
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (Office365 Control)
This is the length of the certificate's public key (in bits).
Syntax
office365control.SSLServerCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (Office365 Control)
This is the serial number of the certificate encoded as a string.
Syntax
office365control.SSLServerCertSerialNumber
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (Office365 Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
office365control.SSLServerCertSignatureAlgorithm
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertStore Property (Office365 Control)
This is the name of the certificate store for the client certificate.
Syntax
office365control.SSLServerCertStore
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (Office365 Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
office365control.SSLServerCertStorePassword
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (Office365 Control)
This is the type of certificate store for this certificate.
Syntax
office365control.SSLServerCertStoreType
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (Office365 Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
office365control.SSLServerCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (Office365 Control)
This property contains the MD5 hash of the certificate.
Syntax
office365control.SSLServerCertThumbprintMD5
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (Office365 Control)
This property contains the SHA-1 hash of the certificate.
Syntax
office365control.SSLServerCertThumbprintSHA1
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (Office365 Control)
This property contains the SHA-256 hash of the certificate.
Syntax
office365control.SSLServerCertThumbprintSHA256
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (Office365 Control)
This property contains the text description of UsageFlags .
Syntax
office365control.SSLServerCertUsage
Default Value
""
Remarks
This property contains the text description of SSLServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (Office365 Control)
This property contains the flags that show intended use for the certificate.
Syntax
office365control.SSLServerCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags 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 SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (Office365 Control)
This property contains the certificate's version number.
Syntax
office365control.SSLServerCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (Office365 Control)
This is the subject of the certificate used for client authentication.
Syntax
office365control.SSLServerCertSubject
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (Office365 Control)
This is the certificate (PEM/Base64 encoded).
Syntax
office365control.SSLServerCertEncoded
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.
This property is read-only and not available at design time.
Data Type
Binary String
AddAttachment Method (Office365 Control)
Adds a file attachment to an existing message.
Syntax
office365control.AddAttachment MessageId, Name, LocalFile
Remarks
This method adds a file attachment to an existing message, specified by the MessageId parameter. To add a more complex attachment, set the Name and LocalFile parameters and the control will use the first attachment in the MessageAttachments properties. As a note, this will not clear the MessageAttachments properties. If the file is larger than the value set in the AttachmentSimpleUploadLimit configuration, then the control will use an upload session to upload the attachment in fragments. The size of the fragments are specified in the AttachmentFragmentSize configuration.
This method is not used to add attachments to messages that are sent with the SendMail method.
Example (Adding a Simple Attachment to a New Draft)
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip");
Example (Adding a Simple Attachment to a New Draft)
office365.MessageSubject = "Subject";
office365.MessageBodyContentType = "html";
office365.MessageBodyContent = "<p>Body</p><img src='cid:test1'>";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip");
Example (Adding a Complex Attachment to a New Draft)
office365.SetMessageSubject("Subject");
office365.SetMessageBodyContentType("HTML");
office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>");
office365.SetMessageTo("email@example.com");
office365.CreateDraft(0,"");
office365.SetMessageAttachmentCount(1);
office365.SetMessageAttachmentFile(0, "./test.png");
office365.SetMessageAttachmentContentId(0, "test1");
office365.SetMessageAttachmentIsInline(0, true);
office365.AddAttachment(office365.GetMessageInfoId(0), "", "");
office365.SendDraft(office365.GetMessageInfoId(0));
AddItemAttachment Method (Office365 Control)
Adds an item attachment to an existing message.
Syntax
office365control.AddItemAttachment MessageId, msgToAttachId, ItemJSON
Remarks
Adds an item attachment to an existing message, specified by the MessageId parameter. Item attachments are non-file attachments, such as Outlook messages, events, and contacts. To add another message as an attachment, set the msgToAttachId parameter to its ID. To add an event or contact as an attachment, leave the msgToAttachId parameter empty and provide the full JSON.
This method is not used to add attachments to messages that are sent with the SendMail method.
Example (Adding an Existing Message to a New Draft)
office365.MessageSubject = "Subject";
office365.MessageBodyContentType = "text";
office365.MessageBodyContent = "Body";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddItemAttachment(messageId, "AAMkADNkNJp5JVnQIe9r0=", "");
Example (Adding an Event to a New Draft)
office365.MessageSubject = "Subject";
office365.MessageBodyContentType = "text";
office365.MessageBodyContent = "Body";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddItemAttachment(messageId, "", "{\"@odata.type\": \"#microsoft.graph.itemAttachment\", \"name\": \"Holiday event\", \"item\":{ \"@odata.type\": \"microsoft.graph.event\", \"subject\": \"Discuss gifts for children\", \"body\":{ \"content\": \"Let's look for funding!\"}, \"start\": {\"dateTime\": \"2016-12-02T18:00:00\"}, \"end\": {\"dateTime\": \"2016-12-02T19:00:00\"}}}");
Authorize Method (Office365 Control)
Get the authorization string required to access the protected resource.
Syntax
office365control.Authorize
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.
For more information, see the introduction section.
Config Method (Office365 Control)
Sets or retrieves a configuration setting.
Syntax
office365control.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Copy Method (Office365 Control)
Creates a copy of a message.
Syntax
office365control.Copy id, destinationId
Remarks
This method copies a message to a folder. id takes the ID of the message to be copied, and destinationId takes the ID of the folder the message will be copied to.
CopyFolder Method (Office365 Control)
Copies a folder.
Syntax
office365control.CopyFolder id, destFolderID
Remarks
This method copies a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder. Since this method does not change the name of a folder, it is not possible to directly create a copy of a folder in the original folder's location.
CreateCategory Method (Office365 Control)
Creates a new category.
Syntax
office365control.CreateCategory DisplayName, Color
Remarks
This method creates a new Office365 category. The created category is added to the end of the Categories properties.
Example
office365.CreateCategory(categoryName, "preset9");
CreateContact Method (Office365 Control)
Creates a contact.
Syntax
office365control.CreateContact FirstName, LastName, EmailAddress, ParentId
Remarks
This method creates a new contact with the specified first name, last name, and email address. At least one of the arguments must be provided. If all parameters are null or empty, an error is thrown. The contact is added to the parent folder specified by ParentId. Set ParentId to empty string or null to create the contact in the default Contacts folder of the signed-in user. The new contact is added to the end of the Contacts list.
After creating a contact with basic information, you can update it and set additional fields by editing the contact in the Contacts collection and calling the UpdateContact method. For more details, refer to the UpdateContact method.
Example (Create a Contact in the Default Contacts Folder of the User)
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Create the contact in the main contacts folder.
Example (Create a Contact in a Folder)
office365.ListContactFolders(""); //This method lists all contact folders in the root folder and populates the ContactFolder collection.
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", office365.ContactFolders[0].Id);
// Created the contact in the first folder in the ContactFolders collection.
Note that additional operations on a newly created contact may not be successful if performed immediately after creation. It is recommended to wait two or more second after creation before attempting further operations on the contact resource.
CreateDraft Method (Office365 Control)
Creates a new email draft.
Syntax
office365control.CreateDraft DraftType, id
Remarks
This method creates a new draft in the Drafts folder. The created message's information, including the draft's message id, is also added to the MessageInfo properties. As a note, this will not clear the properties but will add it to the end.
Valid values for DraftType :
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 method can be used instead to fill in the different parts of the message.
Example (New Draft)
// Create a draft message
office365.MessageSubject = "Subject Text";
office365.MessageImportance = "High";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Body Text";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
office365.SendDraft(office365.MessageInfo[0].Id);
Example (Reply)
// Create the reply draft
string originalMessageId = "Message ID";
office365.CreateDraft(1, originalMessageId);
// Set the new draft MessageInfo fields with desired options
office365.MessageInfo[0].To = "email@example.com";
office365.MessageInfo[0].Subject = "Subject Text";
office365.MessageInfo[0].BodyContentType = "TEXT";
office365.MessageInfo[0].BodyContent = "Body Text";
// Update the draft
office365.Update(office365.MessageInfo[0].Id);
// Send the draft
office365.SendDraft(office365.MessageInfo[0].Id);
CreateFolder Method (Office365 Control)
Creates a new folder.
Syntax
office365control.CreateFolder folderName, parentFolderId
Remarks
This method creates a new folder. To create a folder in the root directory set parentFolderId to an empty string.
Delete Method (Office365 Control)
Deletes a message.
Syntax
office365control.Delete id
Remarks
This method is used to delete both drafts and messages in other folders. Deleted messages will be moved to the Deleted folder. id takes the message ID of the message to be deleted. This will not remove the message from the MessageInfo properties.
DeleteAttachment Method (Office365 Control)
Deletes an attachment.
Syntax
office365control.DeleteAttachment id, attachmentId
Remarks
This method deletes an attachment. id takes the ID of the message the attachment is attached to. attachmentId takes the attachment ID of an existing attachment. This will not delete the attachment from the Attachments properties.
DeleteCategory Method (Office365 Control)
Deletes a mail category.
Syntax
office365control.DeleteCategory id
Remarks
This method deletes a mail category from the current mailbox. This method will not update the Categories properties.
DeleteContact Method (Office365 Control)
Deletes a contact.
Syntax
office365control.DeleteContact id
Remarks
This method deletes a contact specified by its ID. The id parameter takes the contact ID of the contact to be deleted. The contact is also removed from the Contacts collection.
Example (Delete a Contact)
// List contacts and search for a contact with the name "John Doe"
office365.ListContacts("folder_id");
for (int i = 0; i < office365.Contacts.Count; i++) {
if (office365.Contacts[i].DisplayName == "John Doe") {
//Delete the contact
office365.DeleteContact(office365.Contacts[i].Id);
break;
}
}
DeleteFolder Method (Office365 Control)
Deletes a folder.
Syntax
office365control.DeleteFolder id
Remarks
This method deletes a folder from the current mailbox. id takes the ID of an existing folder. This method will not update the Folders properties.
Forward Method (Office365 Control)
Forward a message.
Syntax
office365control.Forward id, messageHTML, toRecipients
Remarks
This method can be used to quickly forward a message specified by id to the recipients specified by toRecipients. The toRecipients parameter accepts a comma separated list of emails to forward the message to. The messageHTML parameter is the message body to include with the forward. If messageHTML is an empty string, then the following properties are used:
Property | Default if not set |
MessageBcc | Blank |
MessageBodyContent | Blank |
MessageBodyContentType | HTML |
MessageCc | Blank |
MessageDeliveryReceipt | False |
MessageFrom | Currently authenticated mailbox |
MessageImportance | Blank |
MessageReadReceipt | False |
MessageSubject | FW:" + original subject |
Example (Simple):
office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");
Example (Advanced):
office365.MessageSubject = "Subject for the reply";
office365.MessageImportance = "Low";
office365.MessageCc = "Example@email.com";
office365.MessageBcc = "Example@email.com";
office365.MessageBodyContent = "Reply Message body";
office365.Forward(messageId, "", "example@email.com, exampletwo@email.com");
This method forwards a message specified by id. toRecipients accepts a comma separated list of emails to forward the message to.
Example (Forwarding a Message to Two Addresses)
office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");
GetCategory Method (Office365 Control)
Retrieves a mail category.
Syntax
office365control.GetCategory id
Remarks
This method retrieves a mail category.
The fetched category can be accessed through the Categories properties. As a note, the control does not clear the properties and will append the category to the end of it.
GetContact Method (Office365 Control)
Retrieves the contact by Id.
Syntax
office365control.GetContact Id
Remarks
This method retrieves a contact specified by its ID and adds the contact to the end of the Contacts list. If the contact already exists in the Contacts collection, it will be removed and then added to the end, preventing duplication.
Example (Get a Contact)
// Retrieve a contact by its ID
string contactId = "12345"; // Replace with the actual contact ID
office365.GetContact(contactId);
// Access the retrieved contact
var retrievedContact = office365.Contacts[office365.Contacts.Count - 1];
retrievedContact.FirstName; //first name
retrievedContact.LastName; //last name
retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address
retrievedContact.EmailAddress; //first email address value
retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number
retrievedContact.PhoneNumber; //first phone number value
office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact
GetContactField Method (Office365 Control)
Retrieves the contact property value by JSONPath.
Syntax
office365control.GetContactField index, JsonPath
Remarks
This method retrieves a specific field within the contact's JSON field. The first parameter, index, is an integer representing the index of the contact in the Contacts collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.
Example (Access Fields of a Contact)
office365.GetContact("ContactId");
office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/homePhones/[1]"); //first home phone number of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/businessPhones/[2]"); //second business phone number of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/postalCode"); //postal code of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/street"); //street name of the contact
GetFolder Method (Office365 Control)
Retrieves a folder.
Syntax
office365control.GetFolder id
Remarks
This method retrieves a folder.
The fetched folder can be accessed through the Folders properties. As a note, the control does not clear the properties and will append the folder to the end of it.
Interrupt Method (Office365 Control)
Interrupt the current method.
Syntax
office365control.Interrupt
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListAttachments Method (Office365 Control)
Lists all of a message's attachments.
Syntax
office365control.ListAttachments id
Remarks
This method lists all of a message's attachments. This method clears and populates the Attachments properties.
If the RequestNestedItemAttachments configuration setting is set to true (default false), the method will also list any nested attachments found within item attachments.
//List messages with attachments
office365.ListMessage("inbox", "hasAttachments eq true");
//List attachments of the first message
office365.ListAttachments(office365.MessageInfo[0].Id);
ListCategories Method (Office365 Control)
Lists all mail categories.
Syntax
office365control.ListCategories
Remarks
This method lists all of the mail categories in the current mailbox. This method clears and populates the Categories properties.
ListChanges Method (Office365 Control)
Lists messages that have been changed within a specified folder.
Syntax
office365control.ListChanges id, maxPageSize
Remarks
This method lists changed messages within the folder specified by id.
Starting from a Baseline State
For most use-cases, it is necessary to obtain a baseline state first in order to only list messages that have been changed after the baseline state was established.
To obtain a baseline state, ensure that both ChangeMarker and NextChangeMarker are empty, and then call ListChanges. Then follow the process described in the "General Usage" section (below) until ChangeMarker is empty to list all the changed messages.
General Usage
When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the MessageList event to fire once for each change, and will also populate the MessageInfo properties.
If there are still more messages available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the MessageInfo properties (Once there aren't any more changed messages available to list, the NextChangeMarker property will be populated instead).
When NextChangeMarker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)
ListContactFolders Method (Office365 Control)
Lists the contact folders found in the parent folder.
Syntax
office365control.ListContactFolders parentFolderId
Remarks
This method retrieves and lists the contact folders within the specified parent folder. It clears and then populates the ContactFolders collection with the retrieved folders.
To list all contact folders in the root folder, set the parentFolderId parameter to an empty string.
Example (List All Contact Folders in the Root Folder):
office365.ListContactFolders(""); // List root folders.
foreach(OLContactFolder folder in office365.ContactFolders){
folder.Id; // Folder id
folder.Name; // Folder name
folder.ParentFolderId; // Folder parent id
}
Example (List all Contact Sub Folders in a Folder):
office365.ListContactFolders("");
office365.ListContactFolders(office365.ContactFolders[0].Id); //List the sub folders of the first root folder.
office365.ContactFolders[0]; // The first sub folder of the first root folder.
If the number of contact folders exceeds the page size, the ListContactFoldersMarker config value will be populated. You can call ListContactFolders again to retrieve the next page of folders. These folders will be added to the end of the ContactFolders collection.
Example (List All Contact Folders Pages in the Root Folder):
do{
office365.ListContactFolders(""); // List root folders.
} while (!office365.Config("ListContactFoldersMarker").IsEmpty());
ListContacts Method (Office365 Control)
Lists the contacts in a folder.
Syntax
office365control.ListContacts folderId
Remarks
This method retrieves and lists the contacts within the specified folder. It clears and then populates the Contacts collection with the retrieved contacts. Providing an empty string as folderId retrieves the contacts from the default Contacts folder of the signed-in user.
Example (List All Contacts in a Folder)
office365.ListContactFolders(""); // List root folders (no need to do this if you already have a Folder Id)
office365.ListContacts(office365.ContactFolders[0].Id); //Lists contacts
Example (List all Contacts in the default Contacts folder):
office365.ListContacts("");
If the number of contacts exceeds the page size, the ListContactsMarker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the Contacts collection.
Example (List all Contacts Pages in the default Contacts folder):
do{
office365.ListContacts("");
} while(!office365.ListContactsMarker.isEmpty());
ListFolders Method (Office365 Control)
Lists the folders found in the parent folder.
Syntax
office365control.ListFolders parentFolderId
Remarks
This method lists the folders found in the parent folder. This method clears populates the Folders properties.
Set parentFolderId to be an empty string to list all folders in the root folder.
If the number of folders is greater than the folder page size, ListFoldersMarker will be populated and calling ListFolders again will list the next page of folders.
Example (List All Folders in the Root Folder)
office365.ListFolders("");
ListMessages Method (Office365 Control)
Lists the messages in a folder.
Syntax
office365control.ListMessages folderId, filter
Remarks
This method lists the messages found in the specified folder. This method clears and populates the MessageInfo properties.
If the number of messages is greater than the message page size, ListMessagesMarker will be populated and calling ListMessages again will list the next page of messages.
filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a folder. filter follows the OData protocol syntax.
Example (List All Messages in a Folder)
office365.ListMessages(folderId, "");
Example (List Unread Messages in a Folder)
office365.ListMessages(folderId, "isRead eq false");
Example (List Messages from a Specific Address)
office365.ListMessages(folderId, "from/emailAddress/address eq 'specific@address.com'");
Example (List Unread Messages from a Specific Address)
office365.ListMessages(folderId, "isRead eq false and from/emailAddress/address eq 'specific@address.com'");
MoveFolder Method (Office365 Control)
Moves a folder.
Syntax
office365control.MoveFolder id, destFolderId
Remarks
This method moves a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder.
MoveMessage Method (Office365 Control)
Moves a message.
Syntax
office365control.MoveMessage id, destinationId
Remarks
This method moves a message. destinationId refers to the folder ID where the message will be moved to.
RenameFolder Method (Office365 Control)
Renames a folder.
Syntax
office365control.RenameFolder folderId, newName
Remarks
This method renames a folder. This method will not update the Folders properties.
Reply Method (Office365 Control)
Reply to a message.
Syntax
office365control.Reply id, messageHTML
Remarks
This method can be used to quickly reply to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:
Property | Default if not set |
MessageBcc | Blank |
MessageBodyContent | Blank |
MessageBodyContentType | HTML |
MessageCc | Blank |
MessageDeliveryReceipt | False |
MessageFrom | Currently authenticated mailbox |
MessageImportance | Blank |
MessageReadReceipt | False |
MessageSubject | RE:" + original subject |
MessageTo | Original sender |
Example (Simple):
office365.ReplyAll(messageId, "Reply messageHTML");
Example (Advanced):
office365.MessageSubject = "Subject for the reply";
office365.MessageImportance = "Low";
office365.MessageCc = "Example@email.com";
office365.MessageBcc = "Example@email.com";
office365.MessageBodyContent = "Reply Message body";
office365.ReplyAll(messageId, "");
ReplyAll Method (Office365 Control)
ReplyAll to a message.
Syntax
office365control.ReplyAll id, messageHTML
Remarks
This method can be used to quickly reply all to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:
Property | Default if not set |
MessageBcc | Blank |
MessageBodyContent | Blank |
MessageBodyContentType | HTML |
MessageCc | Original CC recipients |
MessageDeliveryReceipt | False |
MessageFrom | Currently authenticated mailbox |
MessageImportance | Blank |
MessageReadReceipt | False |
MessageSubject | RE:" + original subject |
MessageTo | Original sender and recipients |
Example (Simple):
office365.ReplyAll(messageId, "ReplyAll messageHTML");
Example (Advanced):
office365.MessageSubject = "Subject for the reply";
office365.MessageImportance = "Low";
office365.MessageCc = "Example@email.com";
office365.MessageBcc = "Example@email.com";
office365.MessageBodyContent = "Reply Message body";
office365.ReplyAll(messageId, "");
Reset Method (Office365 Control)
This method will reset the control.
Syntax
office365control.Reset
Remarks
This method will reset the control's properties to their default values.
RetrieveAttachment Method (Office365 Control)
Retrieves a message attachment.
Syntax
office365control.RetrieveAttachment id, attachmentId
Remarks
This method retrieves an attachment. id specifies the message ID for the message the attachment is attached to.
The fetched attachment can be accessed through the Attachments properties. If the RequestNestedItemAttachments configuration setting is set to true (default false) and the attachment to be retrieved is an item attachment, the method will provide any nested attachments as well.
RetrieveMessage Method (Office365 Control)
Retrieves a message.
Syntax
office365control.RetrieveMessage id
Remarks
This method retrieves a message.
Information about the retrieved message can be accessed through the MessageInfo properties.
RetrieveMessageRaw Method (Office365 Control)
Retrieves the raw message of the specified message ID.
Syntax
office365control.RetrieveMessageRaw id
Remarks
This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the Message property.
Search Method (Office365 Control)
Search for messages.
Syntax
office365control.Search searchKey
Remarks
This method can be used to search for messages. Results are returned through the MessageInfo properties. searchKey specifies a string to be searched for.
SendCustomRequest Method (Office365 Control)
Send a custom HTTP request.
Syntax
office365control.SendCustomRequest HTTPMethod, URL, PostData
Remarks
This method can be used to send a custom HTTP request to the server.
SendDraft Method (Office365 Control)
Sends an existing draft.
Syntax
office365control.SendDraft id
Remarks
This method sends an existing draft. The id parameter takes the ID of the draft that is going to be sent. To create a draft see the CreateDraft method. As a note, the relevant properties are not cleared after the method is called. It is recommend to do so after calling this method.
Example (New Draft)
//Create a draft message
office365.MessageSubject = "Subject Text";
office365.MessageImportance = "High";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Body Text";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
office365.SendDraft(office365.MessageInfo[0].Id);
Example (Reply)
// Create the reply draft
string originalMessageId = "Message ID";
office365.CreateDraft(1, originalMessageId);
// Set the new draft MessageInfo fields with desired options
office365.MessageInfo[0].To = "email@example.com";
office365.MessageInfo[0].Subject = "Subject Text";
office365.MessageInfo[0].BodyContentType = "TEXT";
office365.MessageInfo[0].BodyContent = "Body Text";
// Update the draft
office365.Update(office365.MessageInfo[0].Id);
// Send the draft
office365.SendDraft(office365.MessageInfo[0].Id);
Example (HTML with Attachments)
office365.SetMessageSubject("Subject");
office365.SetMessageBodyContentType("HTML");
office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>");
office365.SetMessageTo("email@example.com");
office365.CreateDraft(0,"");
office365.SetMessageAttachmentCount(1);
office365.SetMessageAttachmentFile(0, "./test.png");
office365.SetMessageAttachmentContentId(0, "test1");
office365.SetMessageAttachmentIsInline(0, true);
office365.AddAttachment(office365.GetMessageInfoId(0), "", "");
office365.SendDraft(office365.GetMessageInfoId(0));
SendMail Method (Office365 Control)
Sends a new email.
Syntax
office365control.SendMail saveToSentItems
Remarks
This method sends a new message. Use the Message* (excluding MessageInfo properties and Message) to set the fields of the message that will be sent. To add an attachment, use the MessageAttachments properties to add the attachment information. As a note, the relevant properties are not cleared after the method is called. It is recommend to do so after calling this method.
Example: Simple Email
office365.MessageSubject = "I saw a Tree";
office365.MessageImportance = "High";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked.";
office365.MessageTo = "TreeLookOut@gmail.com";
office365.SendMail(True);
Example: HTML email with Attachments
office365.SetMessageSubject("Subject");
office365.SetMessageBodyContentType("HTML");
office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>");
office365.SetMessageTo("email@example.com");
//Set up attachments
//Inline:
office365.SetMessageAttachmentCount(2);
office365.SetMessageAttachmentFile(0, "./test.png");
office365.SetMessageAttachmentName(0, "test picture");
office365.SetMessageAttachmentContentId(0, "test1");
office365.SetMessageAttachmentIsInline(0, true);
//Normal
office365.SetMessageAttachmentFile(1, "./test.txt");
office365.SetMessageAttachmentName(1, "test file");
office365.SendMail(true);
SetContactField Method (Office365 Control)
Sets the contact field value by JSONPath.
Syntax
office365control.SetContactField index, JsonPath, Value, ValueType
Remarks
This method updates a specific field within the contact's JSON representation. The parameters for this method are as follows: the first parameter, index, is an integer representing the index of the contact in the Contacts collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)
Example (Set/Edit Fields of a Contact before Updating):
// Create a contact in the main contacts folder.
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");
// Set company name
office365.SetContactField(0, "/json/companyName", "nsoftware", 2); // 2 (String)
// Set home address
office365.SetContactField(0,
"/json/businessAddress",
"{ \"city\": \"string\", \"countryOrRegion\": \"string\", \"postalCode\": \"string\", \"state\": \"string\", \"street\": \"string\" }",
0); // 0 (Object)
office365.SetContactField(0,
"/json/emailAddresses",
"[{"name": "Garth", "address": "garth@contoso.com"}, {"name": "Garth", "address": "garth1@contoso.com"}]",
1); // 1 (Array)
// Update the contact
office365.UpdateContact(0);
Update Method (Office365 Control)
Updates a message.
Syntax
office365control.Update id
Remarks
This property updates a message that has been edited in the MessageInfo properties. The id takes the message's ID that should be updated. The following values can be updated from the OLMessageInfo type:
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)
// Create the reply draft
string originalMessageId = "Message ID";
office365.CreateDraft(1, originalMessageId);
// Set the new draft MessageInfo fields with desired options
office365.MessageInfo[0].To = "email@example.com";
office365.MessageInfo[0].Subject = "Subject Text";
office365.MessageInfo[0].BodyContentType = "TEXT";
office365.MessageInfo[0].BodyContent = "Body Text";
// Update the draft
office365.Update(office365.MessageInfo[0].Id);
// Send the draft
office365.SendDraft(office365.MessageInfo[0].Id);
UpdateCategory Method (Office365 Control)
Updates a category.
Syntax
office365control.UpdateCategory id, color
Remarks
This method changes an existing category's color. This method will not update the Categories properties.
UpdateContact Method (Office365 Control)
Updates a contact.
Syntax
office365control.UpdateContact index
Remarks
This method allows you to update an existing contact. The index parameter specifies the position of the contact in the Contacts collection. The method uses this index to take all the data from the specified contact and update the corresponding contact on the server.
To update a contact, edit the desired contact fields within the Contacts collection. Then, call the UpdateContact method with the index of the contact. Note that changing the JSON data will overwrite the entire contact, ignoring other field edits made before setting the JSON.
The OLContact type used in the Contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add another field, you can use the SetContactField method.
Example:
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");// Create a contact in the main contacts folder.
// Set a company name
office365.Contacts[0].CompanyName = "Volkswagen";
// Set notes
office365.Contacts[0].Notes = "testNotes";
// Set multiple phone numbers
office365.Contacts[0].PhonesCount = 2;
office365.Contacts[0].PhoneIndex = 0;
office365.Contacts[0].PhoneType = TOLPhoneTypes.ptMobile;
office365.Contacts[0].PhoneNumber = "0123456789";
office365.Contacts[0].PhoneIndex = 1;
office365.Contacts[0].PhoneType = TOLPhoneTypes.ptBusiness;
office365.Contacts[0].PhoneNumber = "9876543210";
// Set birthday
office365.SetContactField(0, "/json/birthday", "2024-05-21", 2); // The last argument is the type of the field. 2 (String)
// Set home address
office365.SetContactField(0, "/json/businessAddress", "{ \"city\": \"string\", \"countryOrRegion\": \"string\", \"postalCode\": \"string\", \"state\": \"string\", \"street\": \"string\" }", 0); // The last argument is the type of the field. 0 (Object)
// Update the contact
office365.UpdateContact(0);
AttachmentList Event (Office365 Control)
Fired when an attachment is retrieved from the server.
Syntax
Sub office365control_AttachmentList(Id As String, Name As String, ContentType As String, ContentLocation As String, ContentBytes As String, ContentId As String, LastModifiedDateTime As String, IsInline As Boolean, Size As Integer)
Remarks
The AttachmentList event is fired for each attachment retrieved from the server when ListAttachments is called.
CategoryList Event (Office365 Control)
Fired when an attachment is retrieved from the server.
Syntax
Sub office365control_CategoryList(Id As String, DisplayName As String, Color As String)
Remarks
The CategoryList event is fired for each attachment retrieved from the server when ListCategories is called.
ContactFolderList Event (Office365 Control)
Fired when a contact folder is retrieved by the server.
Syntax
Sub office365control_ContactFolderList(Id As String, Name As String, ParentFolderId As String)
Remarks
The ContactFolderList event is fired for each contact folder retrieved from the server when ListContactFolders is called.
ContactList Event (Office365 Control)
Fired when a contact is retrieved from the server.
Syntax
Sub office365control_ContactList(Id As String, ParentId As String, DisplayName As String, FirstEmail As String)
Remarks
The ContactList event is fired for each contact retrieved from the server when ListContacts is called. This event provides the contact's Id, DisplayName, FirstEmail address, and the ParentId of the folder containing the contact.
Error Event (Office365 Control)
Fired when information is available about errors during data delivery.
Syntax
Sub office365control_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FolderList Event (Office365 Control)
Fired when a folder is retrieved by the server.
Syntax
Sub office365control_FolderList(Id As String, DisplayName As String, ParentFolderId As String, ChildFolderCount As Integer, UnreadItemCount As Integer, TotalItemCount As Integer)
Remarks
The FolderList event is fired for each folder retrieved from the server when ListFolders is called.
Log Event (Office365 Control)
This event fires once for each log message.
Syntax
Sub office365control_Log(LogLevel As Integer, Message As String, LogType As String)
Remarks
This event fires once for each log message generated by the control. The verbosity is controlled by the 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"
MessageList Event (Office365 Control)
Fired when a message is retrieved from the server.
Syntax
Sub office365control_MessageList(Id As String, Subject As String, MessageSender As String, ReceivedDateTime As String, SentDateTime As String, HasAttachments As Boolean, BodyContentType As String, BodyContent As String, BodyPreview As String)
Remarks
The MessageList event is fired for each message retrieved from the server when ListMessages is called.
SSLServerAuthentication Event (Office365 Control)
Fired after the server presents its certificate to the client.
Syntax
Sub office365control_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Office365 Control)
Fired when secure connection progress messages are available.
Syntax
Sub office365control_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Transfer Event (Office365 Control)
This event is fired while a document transfers (delivers document).
Syntax
Sub office365control_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Config Settings (Office365 Control)
The control 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 control, access to these internal properties is provided through the Config method.Office365 Config Settings
The default value is 2097152 (2MiBs).
The default value is 2097152 (2MiBs).
The default value is 100.
The default value is 100.
The default value is 100.
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 request.
Example (List All Contact Folders in the Root Directory)
do
{
office365.ListContactFolders("");
} while (office365.Config("ListContactFoldersMarker").Length > 0);
The default value is 100.
component.Config("MIMEMessage" + MIME_MESSAGE);
component.SendMail();
The default value is 0.
Example:
component.Config("QueryParamCount=1");
component.Config("QueryParamName[0]=Select");
component.Config("QueryParamValue[0]=name");
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and 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 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. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "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.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
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 control does not need any additional properties set as it can already get a new access token without user interaction.
If set to (default) the redirect_uri will be sent in all cases. If set to the redirect_uri will only be sent if it has a value.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
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. |
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.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
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.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the control will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. 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 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.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Note: This is required when OAuthWebServerSSLEnabled is set to .
Note: This is only applicable when OAuthWebServerSSLEnabled is set to .
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. |
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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 is set to .
The default value is localhost.
HTTP Config Settings
When True, the control adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the control will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the control fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP control can be extended with other security schemes in addition to the authorization schemes already implemented by the control.
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 property in the form "Basic [encoded-user-password]".
The default value is False.
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 control fails with an error.
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 control fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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 control 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 after calling a method. The 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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
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).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .
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 control beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the control will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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 control 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control 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).
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.
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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.
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.
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".
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.
If set to True, the control 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 control is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
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 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the control will pick all of the supported cipher suites. If 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 is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider 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
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 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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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:
By default when TLS 1.3 is enabled, the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the control when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the control 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 control will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the control 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 control fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control 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
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 |
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 |
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (Office365 Control)
Office365 Errors
21302 | Invalid Input Error. |