Cloud Mail 2022 PHP Edition
Version 22.0 [Build 8369]

Office365 Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudMail_Office365

Procedural Interface

 cloudmail_office365_open();
 cloudmail_office365_close($res);
 cloudmail_office365_register_callback($res, $id, $function);
 cloudmail_office365_get_last_error($res);
 cloudmail_office365_get_last_error_code($res);
 cloudmail_office365_set($res, $id, $index, $value);
 cloudmail_office365_get($res, $id, $index);
 cloudmail_office365_do_addattachment($res, $messageid, $name, $localfile);
 cloudmail_office365_do_additemattachment($res, $messageid, $msgtoattachid, $itemjson);
 cloudmail_office365_do_authorize($res);
 cloudmail_office365_do_config($res, $configurationstring);
 cloudmail_office365_do_copy($res, $id, $destinationid);
 cloudmail_office365_do_copyfolder($res, $id, $destfolderid);
 cloudmail_office365_do_createcategory($res, $displayname, $color);
 cloudmail_office365_do_createdraft($res, $drafttype, $id);
 cloudmail_office365_do_createfolder($res, $foldername, $parentfolderid);
 cloudmail_office365_do_delete($res, $id);
 cloudmail_office365_do_deleteattachment($res, $id, $attachmentid);
 cloudmail_office365_do_deletecategory($res, $id);
 cloudmail_office365_do_deletefolder($res, $id);
 cloudmail_office365_do_fetchattachment($res, $id, $attachmentid);
 cloudmail_office365_do_fetchmessage($res, $id);
 cloudmail_office365_do_fetchmessageraw($res, $id);
 cloudmail_office365_do_forward($res, $id, $messagehtml, $torecipients);
 cloudmail_office365_do_getcategory($res, $id);
 cloudmail_office365_do_getfolder($res, $id);
 cloudmail_office365_do_interrupt($res);
 cloudmail_office365_do_listattachments($res, $id);
 cloudmail_office365_do_listcategories($res);
 cloudmail_office365_do_listchanges($res, $id, $maxpagesize);
 cloudmail_office365_do_listfolders($res, $parentfolderid);
 cloudmail_office365_do_listmessages($res, $folderid, $filter);
 cloudmail_office365_do_movefolder($res, $id, $destfolderid);
 cloudmail_office365_do_movemessage($res, $id, $destinationid);
 cloudmail_office365_do_renamefolder($res, $folderid, $newname);
 cloudmail_office365_do_reply($res, $id, $messagehtml);
 cloudmail_office365_do_replyall($res, $id, $messagehtml);
 cloudmail_office365_do_reset($res);
 cloudmail_office365_do_search($res, $searchkey);
 cloudmail_office365_do_sendcustomrequest($res, $httpmethod, $url, $postdata);
 cloudmail_office365_do_senddraft($res, $id);
 cloudmail_office365_do_sendmail($res, $savetosentitems);
 cloudmail_office365_do_update($res, $id);
 cloudmail_office365_do_updatecategory($res, $id, $color);

Remarks

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

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Authorization Server URL "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"
Token Server URL "https://login.microsoftonline.com/common/oauth2/v2.0/token"
Scopes "offline_access mail.readwrite mail.send 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 class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

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

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

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

Authorization Code

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

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

Client Credentials

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

Implicit

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

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

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

Password

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

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

For this OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

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

External OAuth Support

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

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

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

Sending Messages

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

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

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

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

Receiving Messages

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

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

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

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

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

Property List


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

AttachmentCountThe number of records in the Attachment arrays.
AttachmentAttachmentTypeThis property contains the attachment type of the attachment.
AttachmentContentIdThis property contains the value of the unique content identifier of the attachment.
AttachmentContentLocationThis property contains the content location of the attachment.
AttachmentContentTypeThis property contains the content type of the attachment.
AttachmentDataThis property contains the raw data of the attachment.
AttachmentFileThis property contains the local file name associated with the attachment.
AttachmentIdThis property contains the attachment identifier of the attachment.
AttachmentIsInlineThis property is true if the attachment is an inline attachment.
AttachmentLastModifiedDateThis property contains the date and time when the attachment was last modified.
AttachmentNameThis property contains the name of the attachment.
AttachmentSizeThis property contains the size in bytes of the attachment.
AuthorizationAn OAuth Authorization String.
CategoryCountThe number of records in the Category arrays.
CategoryColorThis property contains the color of the category.
CategoryDisplayNameThis property contains the display name of the category.
CategoryIdThis property contains the unique identifier of the category.
ChangeMarkerThe page marker for listing changed messages.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FolderCountThe number of records in the Folder arrays.
FolderChildFolderCountThe number of child folders the folder has.
FolderChildFoldersThe child folders of the folder.
FolderDisplayNameThe display name of the folder.
FolderIdThe unique identifier of the folder.
FolderMessageRulesThe message rules of the folder.
FolderMessagesThe messages contained in the folder.
FolderMultiValueExtendedPropertiesThe multi-value extended properties defined for the folder.
FolderParentFolderIdThe unique identifier for the folder's parent.
FolderSingleValueExtendedPropertiesThe single-value extended properties defined for the folder.
FolderTotalItemCountThe number of total items in the folder.
FolderUnreadItemCountThe number of unread items in the folder.
ListFoldersMarkerThe page marker for listing folders.
ListMessagesMarkerThe page marker for listing folders.
MessageProvides the raw message content.
MessageAttachmentCountThe number of records in the MessageAttachment arrays.
MessageAttachmentAttachmentTypeThis property contains the attachment type of the attachment.
MessageAttachmentContentIdThis property contains the value of the unique content identifier of the attachment.
MessageAttachmentContentLocationThis property contains the content location of the attachment.
MessageAttachmentContentTypeThis property contains the content type of the attachment.
MessageAttachmentDataThis property contains the raw data of the attachment.
MessageAttachmentFileThis property contains the local file name associated with the attachment.
MessageAttachmentIdThis property contains the attachment identifier of the attachment.
MessageAttachmentIsInlineThis property is true if the attachment is an inline attachment.
MessageAttachmentLastModifiedDateThis property contains the date and time when the attachment was last modified.
MessageAttachmentNameThis property contains the name of the attachment.
MessageAttachmentSizeThis property contains the size in bytes of the attachment.
MessageBccA comma separated list of recipients for blind carbon copies for a message.
MessageBodyContentThe body content for a message.
MessageBodyContentTypeThe body content type for a message.
MessageCcA comma separated list of recipients for carbon copies for a message.
MessageDeliveryReceiptWhether or not a message will request a Delivery Receipt.
MessageFromThe author of a message.
MessageImportanceThe importance of a message.
MessageInfoCountThe number of records in the MessageInfo arrays.
MessageInfoBccThe BCc recipients of a message in a message info listing.
MessageInfoBodyContentThe body content of a message in a message info listing.
MessageInfoBodyContentTypeThe body content type (e.
MessageInfoBodyPreviewThe body preview of a message in a message info listing.
MessageInfoCategoriesThe categories of a message in a message info listing.
MessageInfoCcThe Cc recipients of a message in a message info listing.
MessageInfoConversationIdThe conversation unique identifier of a message in a message info listing.
MessageInfoConversationIndexThe conversation index of a message in a message info listing.
MessageInfoCreatedDateThe date created of a message in a message info listing.
MessageInfoDeliveryReceiptRequestedWhether or not a delivery receipt was requested for a message in a message info listing.
MessageInfoFlagStatusMessage flag in a message info listing.
MessageInfoFromThe sender of a message in a message info listing.
MessageInfoHasAttachmentsWhether or not a message in a message info listing has attachments.
MessageInfoIdThe unique identifier of a message in a message info listing set by Microsoft.
MessageInfoImportanceThe importance of a message in a message info listing.
MessageInfoInferenceClassificationThe inference classification of a message in a message info listing.
MessageInfoIsDraftWhether or not a message in a message info listing is a draft.
MessageInfoIsReadWhether or not a message in a message info listing has been read.
MessageInfoJSONThe full JSON content of a message in a message info listing.
MessageInfoLastModifiedDateThe last modified date of a message in a message info listing.
MessageInfoMessageHeadersThe message headers of a message in a message info listing.
MessageInfoMessageIdThe internet message id for the message as described by rfc2822.
MessageInfoParentFolderIdThe unique identifier of the parent folder of a message in a message info listing.
MessageInfoReadReceiptRequestedWhether or not a read receipt was requested for a message in a message info listing.
MessageInfoReceivedDateThe received date of a message in a message info listing.
MessageInfoReplyToWhere to send replies for a message in a message info listing.
MessageInfoSenderThe sender of a message in a message info listing.
MessageInfoSentDateThe date a message was sent for a message in a message info listing.
MessageInfoSubjectThe subject of a message in a message info listing.
MessageInfoToThe recipients of a message in a message info listing.
MessageInfoWebLinkThe URL to open a message in a message info listing in Outlook on the web.
MessageOtherHeadersThe additional message headers for a message.
MessageReadReceiptWhether or not a message will request a Read Receipt.
MessageReplyToA mail address to reply to.
MessageSubjectThe subject of a message.
MessageToA comma separated list of recipients for a message.
NextChangeMarkerA marker indicating which page of changes to return in the future.
OAuthAccessTokenThe access token returned by the authorization server.
OAuthAuthorizationCodeThe authorization code that is exchanged for an access token.
OAuthAuthorizationScopeThe scope request or response parameter used during authorization.
OAuthClientIdThe id of the client assigned when registering the application.
OAuthClientProfileThe type of client that is requesting authorization.
OAuthClientSecretThe secret value for the client assigned when registering the application.
OAuthGrantTypeThe OAuth grant type used to acquire an OAuth access token.
OAuthRefreshTokenSpecifies the refresh token received from or sent to the authorization server.
OAuthReturnURLThe URL where the user (browser) returns after authenticating.
OAuthServerAuthURLThe URL of the authorization server.
OAuthServerTokenURLThe URL of the token server used to obtain the access token.
OAuthWebAuthURLThe URL to which the user should be re-directed for authorization.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
SelectThe parts of a message that should be retrieved.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).

Method List


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

AddAttachmentAdds a file attachment to an existing message.
AddItemAttachmentAdds an item attachment to an existing message.
AuthorizeGet the authorization string required to access the protected resource.
ConfigSets or retrieves a configuration setting.
CopyCreates a copy of a message.
CopyFolderCopies a folder.
CreateCategoryCreates a new category.
CreateDraftCreates a new email draft.
CreateFolderCreates a new folder.
DeleteDeletes a message.
DeleteAttachmentDeletes an attachment.
DeleteCategoryDeletes a mail category.
DeleteFolderDeletes a folder.
FetchAttachmentRetrieves a message attachment.
FetchMessageRetrieves a message.
FetchMessageRawRetrieves the raw message of the specified message ID.
ForwardForward a message.
GetCategoryRetrieves a mail category.
GetFolderRetrieves a folder.
InterruptInterrupt the current method.
ListAttachmentsLists all of a message's attachments.
ListCategoriesLists all mail categories.
ListChangesLists messages that have been changed within a specified folder.
ListFoldersLists the folders found in the parent folder.
ListMessagesLists the messages in a folder.
MoveFolderMoves a folder.
MoveMessageMoves a message.
RenameFolderRenames a folder.
ReplyReply to a message.
ReplyAllReplyAll to a message.
ResetReset the class.
SearchSearch for messages.
SendCustomRequestSend a custom HTTP request.
SendDraftSends an existing draft.
SendMailSends a new email.
UpdateUpdates a message.
UpdateCategoryUpdates a category.

Event List


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

AttachmentListFired when an attachment is retrieved from the server.
CategoryListFired when an attachment is retrieved from the server.
ErrorInformation about errors during data delivery.
FolderListFired when a folder is retrieved by the server.
LogThis event fires once for each log message.
MessageListFired when a message is retrieved from the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
TransferThis event is fired while a document transfers (delivers document).

Config Settings


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

AttachmentFragmentSizeSize of fragments when uploading large attachments.
AttachmentSimpleUploadLimitThe threshold to use simple uploads.
FolderPageSizePage size for fetching folders.
IncludeNestedItemAttachmentsWhether nested attachments present on item attachment are included in the request.
MessagePageSizePage size for fetching messages.
MIMEMessageMIME encoded message to send.
OAuthAccessTokenExpirationThe lifetime of the access token.
OAuthAuthorizationTokenTypeThe type of access token returned.
OAuthAutomaticRefreshWhether or not to refresh an expired access token automatically.
OAuthBrowserResponseTimeoutSpecifies the amount of time to wait for a response from the browser.
OAuthIncludeEmptyRedirectURIWhether an empty redirect_uri parameter is included in requests.
OAuthJWTPayloadThe payload of the JWT access token if present.
OAuthJWTXPathProvides a way to point to a specific element in the returned payload of a JWT based access token.
OAuthJWTXTextThe text of the current element.
OAuthParamCountSpecifies 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.
OAuthPasswordGrantUsernameUsed in the Resource Owner Password grant type.
OAuthPKCEChallengeEncodingThe PKCE code challenge method to use.
OAuthReUseWebServerDetermines if the same server instance is used between requests.
OAuthUsePKCESpecifies if PKCE should be used.
OAuthWebServerActiveSpecifies and controls whether the embedded web server is active.
OAuthWebServerCertStoreThe certificate with private key to use when SSL is enabled.
OAuthWebServerCertStorePasswordThe certificate with private key to use when SSL is enabled.
OAuthWebServerCertStoreTypeThe certificate with private key to use when SSL is enabled.
OAuthWebServerCertSubjectThe certificate with private key to use when SSL is enabled.
OAuthWebServerFailedResponseThe custom response that will be displayed to the user if authentication failed.
OAuthWebServerHostThe hostname used by the embedded web server displayed in the ReturnURL.
OAuthWebServerPortThe local port on which the embedded web server listens.
OAuthWebServerResponseThe custom response that will be displayed to the user.
OAuthWebServerSSLEnabledWhether the web server requires SSL connections.
PreferSpecifies a preferred content header type.
QueryParamCountThe 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.
UserIdSets the Id of a shared mailbox to connect to.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

AttachmentCount Property (CloudMail_Office365 Class)

The number of records in the Attachment arrays.

Object Oriented Interface


public function getAttachmentCount();


public function setAttachmentCount($value);

Procedural Interface


cloudmail_office365_get($res, 1 );


cloudmail_office365_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AttachmentAttachmentType Property (CloudMail_Office365 Class)

This property contains the attachment type of the attachment.

Object Oriented Interface


public function getAttachmentAttachmentType($attachmentindex);


Procedural Interface


cloudmail_office365_get($res, 2 , $attachmentindex);


Default Value

''

Remarks

This field contains the attachment type of the attachment.

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

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

Data Type

String

AttachmentContentId Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getAttachmentContentId($attachmentindex);


public function setAttachmentContentId($attachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 3 , $attachmentindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentContentLocation Property (CloudMail_Office365 Class)

This property contains the content location of the attachment.

Object Oriented Interface


public function getAttachmentContentLocation($attachmentindex);


Procedural Interface


cloudmail_office365_get($res, 4 , $attachmentindex);


Default Value

''

Remarks

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

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

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

Data Type

String

AttachmentContentType Property (CloudMail_Office365 Class)

This property contains the content type of the attachment.

Object Oriented Interface


public function getAttachmentContentType($attachmentindex);


Procedural Interface


cloudmail_office365_get($res, 5 , $attachmentindex);


Default Value

''

Remarks

This field contains the content type of the attachment.

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

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

Data Type

String

AttachmentData Property (CloudMail_Office365 Class)

This property contains the raw data of the attachment.

Object Oriented Interface


public function getAttachmentData($attachmentindex);


public function setAttachmentData($attachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 6 , $attachmentindex);


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

Default Value

''

Remarks

This field contains the raw data of the attachment.

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

This property is not available at design time.

Data Type

Binary String

AttachmentFile Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getAttachmentFile($attachmentindex);


public function setAttachmentFile($attachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 7 , $attachmentindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentId Property (CloudMail_Office365 Class)

This property contains the attachment identifier of the attachment.

Object Oriented Interface


public function getAttachmentId($attachmentindex);


Procedural Interface


cloudmail_office365_get($res, 8 , $attachmentindex);


Default Value

''

Remarks

This field contains the attachment identifier of the attachment.

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

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

Data Type

String

AttachmentIsInline Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getAttachmentIsInline($attachmentindex);


public function setAttachmentIsInline($attachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 10 , $attachmentindex);


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

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

AttachmentLastModifiedDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getAttachmentLastModifiedDate($attachmentindex);


public function setAttachmentLastModifiedDate($attachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 11 , $attachmentindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentName Property (CloudMail_Office365 Class)

This property contains the name of the attachment.

Object Oriented Interface


public function getAttachmentName($attachmentindex);


public function setAttachmentName($attachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 12 , $attachmentindex);


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

Default Value

''

Remarks

This field contains the name of the attachment.

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

This property is not available at design time.

Data Type

String

AttachmentSize Property (CloudMail_Office365 Class)

This property contains the size in bytes of the attachment.

Object Oriented Interface


public function getAttachmentSize($attachmentindex);


public function setAttachmentSize($attachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 13 , $attachmentindex);


cloudmail_office365_set($res, 13, $value , $attachmentindex);

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

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

This property is not available at design time.

Data Type

Integer

Authorization Property (CloudMail_Office365 Class)

An OAuth Authorization String.

Object Oriented Interface


public function getAuthorization();


public function setAuthorization($value);

Procedural Interface


cloudmail_office365_get($res, 14 );


cloudmail_office365_set($res, 14, $value );

Default Value

''

Remarks

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

Example

Oauth oauth = new Oauth(); oauth.ClientId = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "user.read mail.readwrite mail.send mailboxsettings.readwrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

CategoryCount Property (CloudMail_Office365 Class)

The number of records in the Category arrays.

Object Oriented Interface


public function getCategoryCount();


public function setCategoryCount($value);

Procedural Interface


cloudmail_office365_get($res, 15 );


cloudmail_office365_set($res, 15, $value );

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

This property contains the color of the category.

Object Oriented Interface


public function getCategoryColor($categoryindex);


Procedural Interface


cloudmail_office365_get($res, 16 , $categoryindex);


Default Value

''

Remarks

This field contains the color of the category.

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

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

Data Type

String

CategoryDisplayName Property (CloudMail_Office365 Class)

This property contains the display name of the category.

Object Oriented Interface


public function getCategoryDisplayName($categoryindex);


Procedural Interface


cloudmail_office365_get($res, 17 , $categoryindex);


Default Value

''

Remarks

This field contains the display name of the category.

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

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

Data Type

String

CategoryId Property (CloudMail_Office365 Class)

This property contains the unique identifier of the category.

Object Oriented Interface


public function getCategoryId($categoryindex);


Procedural Interface


cloudmail_office365_get($res, 18 , $categoryindex);


Default Value

''

Remarks

This field contains the unique identifier of the category.

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

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

Data Type

String

ChangeMarker Property (CloudMail_Office365 Class)

The page marker for listing changed messages.

Object Oriented Interface


public function getChangeMarker();


public function setChangeMarker($value);

Procedural Interface


cloudmail_office365_get($res, 19 );


cloudmail_office365_set($res, 19, $value );

Default Value

''

Remarks

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

Example (List All Changes of a Message)

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface


cloudmail_office365_get($res, 20 );


cloudmail_office365_set($res, 20, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudMail_Office365 Class)

This property determines the type of firewall to connect through.

Object Oriented Interface


public function getFirewallType();


public function setFirewallType($value);

Procedural Interface


cloudmail_office365_get($res, 21 );


cloudmail_office365_set($res, 21, $value );

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

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

Object Oriented Interface


public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface


cloudmail_office365_get($res, 22 );


cloudmail_office365_set($res, 22, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface


cloudmail_office365_get($res, 23 );


cloudmail_office365_set($res, 23, $value );

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 class fails with an error.

Data Type

String

FirewallPort Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface


cloudmail_office365_get($res, 24 );


cloudmail_office365_set($res, 24, $value );

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

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

Object Oriented Interface


public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface


cloudmail_office365_get($res, 25 );


cloudmail_office365_set($res, 25, $value );

Default Value

''

Remarks

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

Data Type

String

FolderCount Property (CloudMail_Office365 Class)

The number of records in the Folder arrays.

Object Oriented Interface


public function getFolderCount();


public function setFolderCount($value);

Procedural Interface


cloudmail_office365_get($res, 26 );


cloudmail_office365_set($res, 26, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

FolderChildFolderCount Property (CloudMail_Office365 Class)

The number of child folders the folder has.

Object Oriented Interface


public function getFolderChildFolderCount($folderindex);


Procedural Interface


cloudmail_office365_get($res, 27 , $folderindex);


Default Value

0

Remarks

The number of child folders the folder has.

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

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

Data Type

Integer

FolderChildFolders Property (CloudMail_Office365 Class)

The child folders of the folder.

Object Oriented Interface


public function getFolderChildFolders($folderindex);


Procedural Interface


cloudmail_office365_get($res, 28 , $folderindex);


Default Value

''

Remarks

The child folders of the folder.

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

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

Data Type

String

FolderDisplayName Property (CloudMail_Office365 Class)

The display name of the folder.

Object Oriented Interface


public function getFolderDisplayName($folderindex);


Procedural Interface


cloudmail_office365_get($res, 29 , $folderindex);


Default Value

''

Remarks

The display name of the folder.

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

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

Data Type

String

FolderId Property (CloudMail_Office365 Class)

The unique identifier of the folder.

Object Oriented Interface


public function getFolderId($folderindex);


Procedural Interface


cloudmail_office365_get($res, 30 , $folderindex);


Default Value

''

Remarks

The unique identifier of the folder.

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

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

Data Type

String

FolderMessageRules Property (CloudMail_Office365 Class)

The message rules of the folder.

Object Oriented Interface


public function getFolderMessageRules($folderindex);


Procedural Interface


cloudmail_office365_get($res, 31 , $folderindex);


Default Value

''

Remarks

The message rules of the folder.

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

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

Data Type

String

FolderMessages Property (CloudMail_Office365 Class)

The messages contained in the folder.

Object Oriented Interface


public function getFolderMessages($folderindex);


Procedural Interface


cloudmail_office365_get($res, 32 , $folderindex);


Default Value

''

Remarks

The messages contained in the folder.

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

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

Data Type

String

FolderMultiValueExtendedProperties Property (CloudMail_Office365 Class)

The multi-value extended properties defined for the folder.

Object Oriented Interface


public function getFolderMultiValueExtendedProperties($folderindex);


Procedural Interface


cloudmail_office365_get($res, 33 , $folderindex);


Default Value

''

Remarks

The multi-value extended properties defined for the folder.

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

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

Data Type

String

FolderParentFolderId Property (CloudMail_Office365 Class)

The unique identifier for the folder's parent.

Object Oriented Interface


public function getFolderParentFolderId($folderindex);


Procedural Interface


cloudmail_office365_get($res, 34 , $folderindex);


Default Value

''

Remarks

The unique identifier for the folder's parent.

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

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

Data Type

String

FolderSingleValueExtendedProperties Property (CloudMail_Office365 Class)

The single-value extended properties defined for the folder.

Object Oriented Interface


public function getFolderSingleValueExtendedProperties($folderindex);


Procedural Interface


cloudmail_office365_get($res, 35 , $folderindex);


Default Value

''

Remarks

The single-value extended properties defined for the folder.

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

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

Data Type

String

FolderTotalItemCount Property (CloudMail_Office365 Class)

The number of total items in the folder.

Object Oriented Interface


public function getFolderTotalItemCount($folderindex);


Procedural Interface


cloudmail_office365_get($res, 36 , $folderindex);


Default Value

0

Remarks

The number of total items in the folder.

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

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

Data Type

Integer

FolderUnreadItemCount Property (CloudMail_Office365 Class)

The number of unread items in the folder.

Object Oriented Interface


public function getFolderUnreadItemCount($folderindex);


Procedural Interface


cloudmail_office365_get($res, 37 , $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

ListFoldersMarker Property (CloudMail_Office365 Class)

The page marker for listing folders.

Object Oriented Interface


public function getListFoldersMarker();


public function setListFoldersMarker($value);

Procedural Interface


cloudmail_office365_get($res, 38 );


cloudmail_office365_set($res, 38, $value );

Default Value

''

Remarks

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

Example (List All Folders in the Root Directory)

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

This property is not available at design time.

Data Type

String

ListMessagesMarker Property (CloudMail_Office365 Class)

The page marker for listing folders.

Object Oriented Interface


public function getListMessagesMarker();


public function setListMessagesMarker($value);

Procedural Interface


cloudmail_office365_get($res, 39 );


cloudmail_office365_set($res, 39, $value );

Default Value

''

Remarks

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

Example (List All Message in a Folder)

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

This property is not available at design time.

Data Type

String

Message Property (CloudMail_Office365 Class)

Provides the raw message content.

Object Oriented Interface


public function getMessage();


Procedural Interface


cloudmail_office365_get($res, 40 );


Default Value

''

Remarks

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

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

Data Type

Binary String

MessageAttachmentCount Property (CloudMail_Office365 Class)

The number of records in the MessageAttachment arrays.

Object Oriented Interface


public function getMessageAttachmentCount();


public function setMessageAttachmentCount($value);

Procedural Interface


cloudmail_office365_get($res, 41 );


cloudmail_office365_set($res, 41, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

MessageAttachmentAttachmentType Property (CloudMail_Office365 Class)

This property contains the attachment type of the attachment.

Object Oriented Interface


public function getMessageAttachmentAttachmentType($messageattachmentindex);


Procedural Interface


cloudmail_office365_get($res, 42 , $messageattachmentindex);


Default Value

''

Remarks

This field contains the attachment type of the attachment.

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

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

Data Type

String

MessageAttachmentContentId Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageAttachmentContentId($messageattachmentindex);


public function setMessageAttachmentContentId($messageattachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 43 , $messageattachmentindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageAttachmentContentLocation Property (CloudMail_Office365 Class)

This property contains the content location of the attachment.

Object Oriented Interface


public function getMessageAttachmentContentLocation($messageattachmentindex);


Procedural Interface


cloudmail_office365_get($res, 44 , $messageattachmentindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageAttachmentContentType Property (CloudMail_Office365 Class)

This property contains the content type of the attachment.

Object Oriented Interface


public function getMessageAttachmentContentType($messageattachmentindex);


Procedural Interface


cloudmail_office365_get($res, 45 , $messageattachmentindex);


Default Value

''

Remarks

This field contains the content type of the attachment.

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

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

Data Type

String

MessageAttachmentData Property (CloudMail_Office365 Class)

This property contains the raw data of the attachment.

Object Oriented Interface


public function getMessageAttachmentData($messageattachmentindex);


public function setMessageAttachmentData($messageattachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 46 , $messageattachmentindex);


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

Default Value

''

Remarks

This field contains the raw data of the attachment.

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

This property is not available at design time.

Data Type

Binary String

MessageAttachmentFile Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageAttachmentFile($messageattachmentindex);


public function setMessageAttachmentFile($messageattachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 47 , $messageattachmentindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageAttachmentId Property (CloudMail_Office365 Class)

This property contains the attachment identifier of the attachment.

Object Oriented Interface


public function getMessageAttachmentId($messageattachmentindex);


Procedural Interface


cloudmail_office365_get($res, 48 , $messageattachmentindex);


Default Value

''

Remarks

This field contains the attachment identifier of the attachment.

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

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

Data Type

String

MessageAttachmentIsInline Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageAttachmentIsInline($messageattachmentindex);


public function setMessageAttachmentIsInline($messageattachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 50 , $messageattachmentindex);


cloudmail_office365_set($res, 50, $value , $messageattachmentindex);

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

MessageAttachmentLastModifiedDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageAttachmentLastModifiedDate($messageattachmentindex);


public function setMessageAttachmentLastModifiedDate($messageattachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 51 , $messageattachmentindex);


cloudmail_office365_set($res, 51, $value , $messageattachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageAttachmentName Property (CloudMail_Office365 Class)

This property contains the name of the attachment.

Object Oriented Interface


public function getMessageAttachmentName($messageattachmentindex);


public function setMessageAttachmentName($messageattachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 52 , $messageattachmentindex);


cloudmail_office365_set($res, 52, $value , $messageattachmentindex);

Default Value

''

Remarks

This field contains the name of the attachment.

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

This property is not available at design time.

Data Type

String

MessageAttachmentSize Property (CloudMail_Office365 Class)

This property contains the size in bytes of the attachment.

Object Oriented Interface


public function getMessageAttachmentSize($messageattachmentindex);


public function setMessageAttachmentSize($messageattachmentindex, $value);

Procedural Interface


cloudmail_office365_get($res, 53 , $messageattachmentindex);


cloudmail_office365_set($res, 53, $value , $messageattachmentindex);

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

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

This property is not available at design time.

Data Type

Integer

MessageBcc Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageBcc();


public function setMessageBcc($value);

Procedural Interface


cloudmail_office365_get($res, 54 );


cloudmail_office365_set($res, 54, $value );

Default Value

''

Remarks

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

Example (Add a Bcc Recipient)

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

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

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

This property is not available at design time.

Data Type

String

MessageBodyContent Property (CloudMail_Office365 Class)

The body content for a message.

Object Oriented Interface


public function getMessageBodyContent();


public function setMessageBodyContent($value);

Procedural Interface


cloudmail_office365_get($res, 55 );


cloudmail_office365_set($res, 55, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageBodyContentType Property (CloudMail_Office365 Class)

The body content type for a message.

Object Oriented Interface


public function getMessageBodyContentType();


public function setMessageBodyContentType($value);

Procedural Interface


cloudmail_office365_get($res, 56 );


cloudmail_office365_set($res, 56, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageCc Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageCc();


public function setMessageCc($value);

Procedural Interface


cloudmail_office365_get($res, 57 );


cloudmail_office365_set($res, 57, $value );

Default Value

''

Remarks

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

Example (Add a CC Recipient)

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

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

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

This property is not available at design time.

Data Type

String

MessageDeliveryReceipt Property (CloudMail_Office365 Class)

Whether or not a message will request a Delivery Receipt.

Object Oriented Interface


public function getMessageDeliveryReceipt();


public function setMessageDeliveryReceipt($value);

Procedural Interface


cloudmail_office365_get($res, 58 );


cloudmail_office365_set($res, 58, $value );

Default Value

false

Remarks

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

Data Type

Boolean

MessageFrom Property (CloudMail_Office365 Class)

The author of a message.

Object Oriented Interface


public function getMessageFrom();


public function setMessageFrom($value);

Procedural Interface


cloudmail_office365_get($res, 59 );


cloudmail_office365_set($res, 59, $value );

Default Value

''

Remarks

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

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

Example (Specify Message Author)

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

Example (Specify Message Author - Name Included)

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

This property is not available at design time.

Data Type

String

MessageImportance Property (CloudMail_Office365 Class)

The importance of a message.

Object Oriented Interface


public function getMessageImportance();


public function setMessageImportance($value);

Procedural Interface


cloudmail_office365_get($res, 60 );


cloudmail_office365_set($res, 60, $value );

Default Value

''

Remarks

This property determines the importance of messages created with CreateDraft or messages sent with SendMail. Valid values are Low, Normal, and High.

This property is not available at design time.

Data Type

String

MessageInfoCount Property (CloudMail_Office365 Class)

The number of records in the MessageInfo arrays.

Object Oriented Interface


public function getMessageInfoCount();


public function setMessageInfoCount($value);

Procedural Interface


cloudmail_office365_get($res, 61 );


cloudmail_office365_set($res, 61, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

MessageInfoBcc Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoBcc($messageinfoindex);


public function setMessageInfoBcc($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 62 , $messageinfoindex);


cloudmail_office365_set($res, 62, $value , $messageinfoindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageInfoBodyContent Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoBodyContent($messageinfoindex);


public function setMessageInfoBodyContent($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 63 , $messageinfoindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageInfoBodyContentType Property (CloudMail_Office365 Class)

The body content type (e.

Object Oriented Interface


public function getMessageInfoBodyContentType($messageinfoindex);


public function setMessageInfoBodyContentType($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 64 , $messageinfoindex);


cloudmail_office365_set($res, 64, $value , $messageinfoindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageInfoBodyPreview Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoBodyPreview($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 65 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoCategories Property (CloudMail_Office365 Class)

The categories of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoCategories($messageinfoindex);


public function setMessageInfoCategories($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 66 , $messageinfoindex);


cloudmail_office365_set($res, 66, $value , $messageinfoindex);

Default Value

''

Remarks

The categories of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoCc Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoCc($messageinfoindex);


public function setMessageInfoCc($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 67 , $messageinfoindex);


cloudmail_office365_set($res, 67, $value , $messageinfoindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageInfoConversationId Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoConversationId($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 68 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoConversationIndex Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoConversationIndex($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 69 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoCreatedDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoCreatedDate($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 70 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoDeliveryReceiptRequested Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoDeliveryReceiptRequested($messageinfoindex);


public function setMessageInfoDeliveryReceiptRequested($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 71 , $messageinfoindex);


cloudmail_office365_set($res, 71, $value , $messageinfoindex);

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

MessageInfoFlagStatus Property (CloudMail_Office365 Class)

Message flag in a message info listing.

Object Oriented Interface


public function getMessageInfoFlagStatus($messageinfoindex);


public function setMessageInfoFlagStatus($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 72 , $messageinfoindex);


cloudmail_office365_set($res, 72, $value , $messageinfoindex);

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

The sender of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoFrom($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 73 , $messageinfoindex);


Default Value

''

Remarks

The sender of a message in a message info listing.

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

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

Data Type

String

MessageInfoHasAttachments Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoHasAttachments($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 74 , $messageinfoindex);


Default Value

false

Remarks

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

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

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

Data Type

Boolean

MessageInfoId Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoId($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 75 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoImportance Property (CloudMail_Office365 Class)

The importance of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoImportance($messageinfoindex);


public function setMessageInfoImportance($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 76 , $messageinfoindex);


cloudmail_office365_set($res, 76, $value , $messageinfoindex);

Default Value

''

Remarks

The importance of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoInferenceClassification Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoInferenceClassification($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 77 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoIsDraft Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoIsDraft($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 78 , $messageinfoindex);


Default Value

false

Remarks

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

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

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

Data Type

Boolean

MessageInfoIsRead Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoIsRead($messageinfoindex);


public function setMessageInfoIsRead($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 79 , $messageinfoindex);


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

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

MessageInfoJSON Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoJSON($messageinfoindex);


public function setMessageInfoJSON($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 80 , $messageinfoindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageInfoLastModifiedDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoLastModifiedDate($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 81 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoMessageHeaders Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoMessageHeaders($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 82 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoMessageId Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoMessageId($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 83 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoParentFolderId Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoParentFolderId($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 84 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoReadReceiptRequested Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoReadReceiptRequested($messageinfoindex);


public function setMessageInfoReadReceiptRequested($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 85 , $messageinfoindex);


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

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

MessageInfoReceivedDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoReceivedDate($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 86 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoReplyTo Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoReplyTo($messageinfoindex);


public function setMessageInfoReplyTo($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 87 , $messageinfoindex);


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

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageInfoSender Property (CloudMail_Office365 Class)

The sender of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoSender($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 88 , $messageinfoindex);


Default Value

''

Remarks

The sender of a message in a message info listing.

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

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

Data Type

String

MessageInfoSentDate Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoSentDate($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 89 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageInfoSubject Property (CloudMail_Office365 Class)

The subject of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoSubject($messageinfoindex);


public function setMessageInfoSubject($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 90 , $messageinfoindex);


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

Default Value

''

Remarks

The subject of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoTo Property (CloudMail_Office365 Class)

The recipients of a message in a message info listing.

Object Oriented Interface


public function getMessageInfoTo($messageinfoindex);


public function setMessageInfoTo($messageinfoindex, $value);

Procedural Interface


cloudmail_office365_get($res, 91 , $messageinfoindex);


cloudmail_office365_set($res, 91, $value , $messageinfoindex);

Default Value

''

Remarks

The recipients of a message in a message info listing.

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

This property is not available at design time.

Data Type

String

MessageInfoWebLink Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getMessageInfoWebLink($messageinfoindex);


Procedural Interface


cloudmail_office365_get($res, 92 , $messageinfoindex);


Default Value

''

Remarks

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

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

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

Data Type

String

MessageOtherHeaders Property (CloudMail_Office365 Class)

The additional message headers for a message.

Object Oriented Interface


public function getMessageOtherHeaders();


public function setMessageOtherHeaders($value);

Procedural Interface


cloudmail_office365_get($res, 93 );


cloudmail_office365_set($res, 93, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageReadReceipt Property (CloudMail_Office365 Class)

Whether or not a message will request a Read Receipt.

Object Oriented Interface


public function getMessageReadReceipt();


public function setMessageReadReceipt($value);

Procedural Interface


cloudmail_office365_get($res, 94 );


cloudmail_office365_set($res, 94, $value );

Default Value

false

Remarks

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

Data Type

Boolean

MessageReplyTo Property (CloudMail_Office365 Class)

A mail address to reply to.

Object Oriented Interface


public function getMessageReplyTo();


public function setMessageReplyTo($value);

Procedural Interface


cloudmail_office365_get($res, 95 );


cloudmail_office365_set($res, 95, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageSubject Property (CloudMail_Office365 Class)

The subject of a message.

Object Oriented Interface


public function getMessageSubject();


public function setMessageSubject($value);

Procedural Interface


cloudmail_office365_get($res, 96 );


cloudmail_office365_set($res, 96, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageTo Property (CloudMail_Office365 Class)

A comma separated list of recipients for a message.

Object Oriented Interface


public function getMessageTo();


public function setMessageTo($value);

Procedural Interface


cloudmail_office365_get($res, 97 );


cloudmail_office365_set($res, 97, $value );

Default Value

''

Remarks

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

Example (Add a Recipient)

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

Example (Add a Recipient with a Name and Address)

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

This property is not available at design time.

Data Type

String

NextChangeMarker Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getNextChangeMarker();


public function setNextChangeMarker($value);

Procedural Interface


cloudmail_office365_get($res, 98 );


cloudmail_office365_set($res, 98, $value );

Default Value

''

Remarks

This property will be populated when ListChanges is called if there are no more changes to list. Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (CloudMail_Office365 Class)

The access token returned by the authorization server.

Object Oriented Interface


public function getOAuthAccessToken();


public function setOAuthAccessToken($value);

Procedural Interface


cloudmail_office365_get($res, 99 );


cloudmail_office365_set($res, 99, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudMail_Office365 Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface


public function getOAuthAuthorizationCode();


public function setOAuthAuthorizationCode($value);

Procedural Interface


cloudmail_office365_get($res, 100 );


cloudmail_office365_set($res, 100, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudMail_Office365 Class)

The scope request or response parameter used during authorization.

Object Oriented Interface


public function getOAuthAuthorizationScope();


public function setOAuthAuthorizationScope($value);

Procedural Interface


cloudmail_office365_get($res, 101 );


cloudmail_office365_set($res, 101, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudMail_Office365 Class)

The id of the client assigned when registering the application.

Object Oriented Interface


public function getOAuthClientId();


public function setOAuthClientId($value);

Procedural Interface


cloudmail_office365_get($res, 102 );


cloudmail_office365_set($res, 102, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudMail_Office365 Class)

The type of client that is requesting authorization.

Object Oriented Interface


public function getOAuthClientProfile();


public function setOAuthClientProfile($value);

Procedural Interface


cloudmail_office365_get($res, 103 );


cloudmail_office365_set($res, 103, $value );

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

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

Object Oriented Interface


public function getOAuthClientSecret();


public function setOAuthClientSecret($value);

Procedural Interface


cloudmail_office365_get($res, 104 );


cloudmail_office365_set($res, 104, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getOAuthGrantType();


public function setOAuthGrantType($value);

Procedural Interface


cloudmail_office365_get($res, 105 );


cloudmail_office365_set($res, 105, $value );

Default Value

0

Remarks

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

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

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

Object Oriented Interface


public function getOAuthRefreshToken();


public function setOAuthRefreshToken($value);

Procedural Interface


cloudmail_office365_get($res, 106 );


cloudmail_office365_set($res, 106, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getOAuthReturnURL();


public function setOAuthReturnURL($value);

Procedural Interface


cloudmail_office365_get($res, 107 );


cloudmail_office365_set($res, 107, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudMail_Office365 Class)

The URL of the authorization server.

Object Oriented Interface


public function getOAuthServerAuthURL();


public function setOAuthServerAuthURL($value);

Procedural Interface


cloudmail_office365_get($res, 108 );


cloudmail_office365_set($res, 108, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getOAuthServerTokenURL();


public function setOAuthServerTokenURL($value);

Procedural Interface


cloudmail_office365_get($res, 109 );


cloudmail_office365_set($res, 109, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getOAuthWebAuthURL();


Procedural Interface


cloudmail_office365_get($res, 110 );


Default Value

''

Remarks

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

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

Data Type

String

ProxyAuthScheme Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface


cloudmail_office365_get($res, 111 );


cloudmail_office365_set($res, 111, $value );

Default Value

0

Remarks

This property is used to tell the class 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 class. Look at the configuration file for the class being used to find more information about manually setting this token.

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

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

Data Type

Integer

ProxyAutoDetect Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface


cloudmail_office365_get($res, 112 );


cloudmail_office365_set($res, 112, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface


cloudmail_office365_get($res, 113 );


cloudmail_office365_set($res, 113, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getProxyPort();


public function setProxyPort($value);

Procedural Interface


cloudmail_office365_get($res, 114 );


cloudmail_office365_set($res, 114, $value );

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

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

Object Oriented Interface


public function getProxyServer();


public function setProxyServer($value);

Procedural Interface


cloudmail_office365_get($res, 115 );


cloudmail_office365_set($res, 115, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getProxySSL();


public function setProxySSL($value);

Procedural Interface


cloudmail_office365_get($res, 116 );


cloudmail_office365_set($res, 116, $value );

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 class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getProxyUser();


public function setProxyUser($value);

Procedural Interface


cloudmail_office365_get($res, 117 );


cloudmail_office365_set($res, 117, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

Select Property (CloudMail_Office365 Class)

The parts of a message that should be retrieved.

Object Oriented Interface


public function getSelect();


public function setSelect($value);

Procedural Interface


cloudmail_office365_get($res, 118 );


cloudmail_office365_set($res, 118, $value );

Default Value

''

Remarks

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

This property is an empty string all message properties will be selected.

Possible properties to be selected are:

bccRecipientsThe bcc'd recipients of the message.
bodyThe message body type and content.
bodyPreviewA preview of the message body containing the first few lines of text.
categoriesThe mail categories that this message falls under.
ccRecipientsThe cc'd recipients of this message.
conversationIdThe ID of the conversation this message is a part of.
createdDateTimeThe date and time when this message was created.
flagThe flag status of the message.
fromThe address the message is from.
hasAttachmentsA boolean for if the message has attachments.
importanceThe importance level of the message.
inferenceClassificationThe inference classification of this message (e.g. focused, other).
internetMessageHeadersThe message headers for the message according to rfc 5322.
isDeliveryReceiptRequestedA boolean for if a delivery receipt was requested.
isDraftA boolean for if the message is a draft.
isReadA boolean for if the message has been read.
isReadReceiptRequestedA boolean for if a read receipt was requested.
lastModifiedDateTimeThe date and time when this message was last modified.
parentFolderIdThe ID of the messages parent folder.
receivedDateTimeThe date and time when this message was received.
replyToThe addresses the message is a reply to.
senderThe sender of the message.
sentDateTimeThe date and time when this message was sent.
subjectThe subject of the message.
toRecipientsThe recipients of the message.
webLinkA weblink for the message.

Example (Get the Subject and Sender of a Message)

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

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudMail_Office365 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


cloudmail_office365_get($res, 120 );


cloudmail_office365_set($res, 120, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (CloudMail_Office365 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


cloudmail_office365_get($res, 148 );


cloudmail_office365_set($res, 148, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


cloudmail_office365_get($res, 164 );


cloudmail_office365_set($res, 164, $value );

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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface


cloudmail_office365_get($res, 165 );


cloudmail_office365_set($res, 165, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (CloudMail_Office365 Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


cloudmail_office365_get($res, 166 );


cloudmail_office365_set($res, 166, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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

SSLCertSubject Property (CloudMail_Office365 Class)

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

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


cloudmail_office365_get($res, 167 );


cloudmail_office365_set($res, 167, $value );

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (CloudMail_Office365 Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


cloudmail_office365_get($res, 175 );


cloudmail_office365_set($res, 175, $value );

Default Value

0

Remarks

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

Possible values are:

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

Additional Notes

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

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

Data Type

Integer

SSLServerCertEncoded Property (CloudMail_Office365 Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


cloudmail_office365_get($res, 177 );


Default Value

''

Remarks

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

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

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

Data Type

Binary String

AddAttachment Method (CloudMail_Office365 Class)

Adds a file attachment to an existing message.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

This method is not used to add attachments to messages that are sent with the SendMail method.

Example (Adding a Simple Attachment to a New Draft)

office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip"); Example (Adding a Simple Attachment to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "html"; office365.MessageBodyContent = "<p>Body</p><img src='cid:test1'>"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip"); Example (Adding a Complex Attachment to a New Draft) office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); office365.CreateDraft(0,""); office365.SetMessageAttachmentCount(1); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); office365.AddAttachment(office365.GetMessageInfoId(0), "", ""); office365.SendDraft(office365.GetMessageInfoId(0));

AddItemAttachment Method (CloudMail_Office365 Class)

Adds an item attachment to an existing message.

Object Oriented Interface

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

Procedural Interface

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

Remarks

Adds an item attachment to an existing message, specified by the MessageId parameter. Item attachments are non-file attachments, such as Outlook messages, events, and contacts. To add another message as an attachment, set the msgToAttachId parameter to its ID. To add an event or contact as an attachment, leave the msgToAttachId parameter empty and provide the full JSON.

This method is not used to add attachments to messages that are sent with the SendMail method.

Example (Adding an Existing Message to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "text"; office365.MessageBodyContent = "Body"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddItemAttachment(messageId, "AAMkADNkNJp5JVnQIe9r0=", ""); Example (Adding an Event to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "text"; office365.MessageBodyContent = "Body"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddItemAttachment(messageId, "", "{\"@odata.type\": \"#microsoft.graph.itemAttachment\", \"name\": \"Holiday event\", \"item\":{ \"@odata.type\": \"microsoft.graph.event\", \"subject\": \"Discuss gifts for children\", \"body\":{ \"content\": \"Let's look for funding!\"}, \"start\": {\"dateTime\": \"2016-12-02T18:00:00\"}, \"end\": {\"dateTime\": \"2016-12-02T19:00:00\"}}}");

Authorize Method (CloudMail_Office365 Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudmail_office365_do_authorize($res);

Remarks

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

For more information, see the introduction section.

Config Method (CloudMail_Office365 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudmail_office365_do_config($res, $configurationstring);

Remarks

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

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

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

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

Copy Method (CloudMail_Office365 Class)

Creates a copy of a message.

Object Oriented Interface

public function doCopy($id, $destinationid);

Procedural Interface

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

Remarks

This method copies a message to a folder. id takes the ID of the message to be copied, and destinationId takes the ID of the folder the message will be copied to.

CopyFolder Method (CloudMail_Office365 Class)

Copies a folder.

Object Oriented Interface

public function doCopyFolder($id, $destfolderid);

Procedural Interface

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

Remarks

This method copies a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder. Since this method does not change the name of a folder, it is not possible to directly create a copy of a folder in the original folder's location.

CreateCategory Method (CloudMail_Office365 Class)

Creates a new category.

Object Oriented Interface

public function doCreateCategory($displayname, $color);

Procedural Interface

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

Remarks

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

Example

office365.CreateCategory(categoryName, "preset9");

CreateDraft Method (CloudMail_Office365 Class)

Creates a new email draft.

Object Oriented Interface

public function doCreateDraft($drafttype, $id);

Procedural Interface

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

Remarks

This method creates a new draft in the Drafts folder. The created message's information, including the draft's message id, is also added to the MessageInfo* properties. As a note, this will not clear the properties but will add it to the end.

Valid values for DraftType :

0DRAFTTYPE_MESSAGE
1DRAFTTYPE_REPLY
2DRAFTTYPE_REPLYALL
3DRAFTTYPE_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 (CloudMail_Office365 Class)

Creates a new folder.

Object Oriented Interface

public function doCreateFolder($foldername, $parentfolderid);

Procedural Interface

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

Remarks

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

Delete Method (CloudMail_Office365 Class)

Deletes a message.

Object Oriented Interface

public function doDelete($id);

Procedural Interface

cloudmail_office365_do_delete($res, $id);

Remarks

This method is used to delete both drafts and messages in other folders. Deleted messages will be moved to the Deleted folder. id takes the message ID of the message to be deleted. This will not remove the message from the MessageInfo* properties.

DeleteAttachment Method (CloudMail_Office365 Class)

Deletes an attachment.

Object Oriented Interface

public function doDeleteAttachment($id, $attachmentid);

Procedural Interface

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

Remarks

This method deletes an attachment. id takes the ID of the message the attachment is attached to. attachmentId takes the attachment ID of an existing attachment. This will not delete the attachment from the Attachments* properties.

DeleteCategory Method (CloudMail_Office365 Class)

Deletes a mail category.

Object Oriented Interface

public function doDeleteCategory($id);

Procedural Interface

cloudmail_office365_do_deletecategory($res, $id);

Remarks

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

DeleteFolder Method (CloudMail_Office365 Class)

Deletes a folder.

Object Oriented Interface

public function doDeleteFolder($id);

Procedural Interface

cloudmail_office365_do_deletefolder($res, $id);

Remarks

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

FetchAttachment Method (CloudMail_Office365 Class)

Retrieves a message attachment.

Object Oriented Interface

public function doFetchAttachment($id, $attachmentid);

Procedural Interface

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

Remarks

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

The fetched attachment can be accessed through the Attachment* properties.

FetchMessage Method (CloudMail_Office365 Class)

Retrieves a message.

Object Oriented Interface

public function doFetchMessage($id);

Procedural Interface

cloudmail_office365_do_fetchmessage($res, $id);

Remarks

This method retrieves a message.

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

FetchMessageRaw Method (CloudMail_Office365 Class)

Retrieves the raw message of the specified message ID.

Object Oriented Interface

public function doFetchMessageRaw($id);

Procedural Interface

cloudmail_office365_do_fetchmessageraw($res, $id);

Remarks

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

Forward Method (CloudMail_Office365 Class)

Forward a message.

Object Oriented Interface

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

Procedural Interface

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

Remarks

This method can be used to quickly forward a message specified by id to the recipients specified by toRecipients. The toRecipients parameter accepts a comma separated list of emails to forward the message to. The messageHTML parameter is the message body to include with the forward. If messageHTML is an empty string, then the following properties are used:

PropertyDefault if not set
MessageBccBlank
MessageBodyContentBlank
MessageBodyContentTypeHTML
MessageCcBlank
MessageDeliveryReceiptFalse
MessageFromCurrently authenticated mailbox
MessageImportanceBlank
MessageReadReceiptFalse
MessageSubjectFW:" + 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 (CloudMail_Office365 Class)

Retrieves a mail category.

Object Oriented Interface

public function doGetCategory($id);

Procedural Interface

cloudmail_office365_do_getcategory($res, $id);

Remarks

This method retrieves a mail category.

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

GetFolder Method (CloudMail_Office365 Class)

Retrieves a folder.

Object Oriented Interface

public function doGetFolder($id);

Procedural Interface

cloudmail_office365_do_getfolder($res, $id);

Remarks

This method retrieves a folder.

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

Interrupt Method (CloudMail_Office365 Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudmail_office365_do_interrupt($res);

Remarks

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

ListAttachments Method (CloudMail_Office365 Class)

Lists all of a message's attachments.

Object Oriented Interface

public function doListAttachments($id);

Procedural Interface

cloudmail_office365_do_listattachments($res, $id);

Remarks

This method lists all of a message's attachments. This method clears and populates the Attachment* properties.

ListCategories Method (CloudMail_Office365 Class)

Lists all mail categories.

Object Oriented Interface

public function doListCategories();

Procedural Interface

cloudmail_office365_do_listcategories($res);

Remarks

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

ListChanges Method (CloudMail_Office365 Class)

Lists messages that have been changed within a specified folder.

Object Oriented Interface

public function doListChanges($id, $maxpagesize);

Procedural Interface

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

Remarks

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

Starting from a Baseline State

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

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

General Usage

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

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

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

ListFolders Method (CloudMail_Office365 Class)

Lists the folders found in the parent folder.

Object Oriented Interface

public function doListFolders($parentfolderid);

Procedural Interface

cloudmail_office365_do_listfolders($res, $parentfolderid);

Remarks

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

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

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

Example (List All Folders in the Root Folder)

office365.ListFolders("");

ListMessages Method (CloudMail_Office365 Class)

Lists the messages in a folder.

Object Oriented Interface

public function doListMessages($folderid, $filter);

Procedural Interface

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

Remarks

This method lists the messages found in the specified folder. This method clears and populates the MessageInfo* properties.

If the number of messages is greater than the message page size, ListMessagesMarker will be populated and calling ListMessages again will list the next page of messages.

filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a folder. filter follows the OData protocol syntax.

Example (List All Messages in a Folder)

office365.ListMessages(folderId, "");

Example (List Unread Messages in a Folder)

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

Example (List Messages from a Specific Address)

office365.ListMessages(folderId, "address eq 'specific@address.com'");

Example (List Unread Messages from a Specific Address)

office365.ListMessages(folderId, "isRead eq false and address eq 'specific@address.com'");

MoveFolder Method (CloudMail_Office365 Class)

Moves a folder.

Object Oriented Interface

public function doMoveFolder($id, $destfolderid);

Procedural Interface

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

Remarks

This method moves a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder.

MoveMessage Method (CloudMail_Office365 Class)

Moves a message.

Object Oriented Interface

public function doMoveMessage($id, $destinationid);

Procedural Interface

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

Remarks

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

RenameFolder Method (CloudMail_Office365 Class)

Renames a folder.

Object Oriented Interface

public function doRenameFolder($folderid, $newname);

Procedural Interface

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

Remarks

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

Reply Method (CloudMail_Office365 Class)

Reply to a message.

Object Oriented Interface

public function doReply($id, $messagehtml);

Procedural Interface

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

Remarks

This method can be used to quickly reply to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:

PropertyDefault if not set
MessageBccBlank
MessageBodyContentBlank
MessageBodyContentTypeHTML
MessageCcBlank
MessageDeliveryReceiptFalse
MessageFromCurrently authenticated mailbox
MessageImportanceBlank
MessageReadReceiptFalse
MessageSubjectRE:" + original subject
MessageToOriginal 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 (CloudMail_Office365 Class)

ReplyAll to a message.

Object Oriented Interface

public function doReplyAll($id, $messagehtml);

Procedural Interface

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

Remarks

This method can be used to quickly reply all to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:

PropertyDefault if not set
MessageBccBlank
MessageBodyContentBlank
MessageBodyContentTypeHTML
MessageCcOriginal CC recipients
MessageDeliveryReceiptFalse
MessageFromCurrently authenticated mailbox
MessageImportanceBlank
MessageReadReceiptFalse
MessageSubjectRE:" + original subject
MessageToOriginal 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 (CloudMail_Office365 Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudmail_office365_do_reset($res);

Remarks

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

Search Method (CloudMail_Office365 Class)

Search for messages.

Object Oriented Interface

public function doSearch($searchkey);

Procedural Interface

cloudmail_office365_do_search($res, $searchkey);

Remarks

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

SendCustomRequest Method (CloudMail_Office365 Class)

Send a custom HTTP request.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

SendDraft Method (CloudMail_Office365 Class)

Sends an existing draft.

Object Oriented Interface

public function doSendDraft($id);

Procedural Interface

cloudmail_office365_do_senddraft($res, $id);

Remarks

This method sends an existing draft. The id parameter takes the ID of the draft that is going to be sent. To create a draft see the CreateDraft method. As a note, the relevant properties are not cleared after the method is called. It is recommend to do so after calling this method.

Example (New Draft)

//Create a draft message office365.MessageSubject = "Subject Text"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); office365.SendDraft(office365.MessageInfo[0].Id); Example (Reply)

// Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, originalMessageId); // Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; // Update the draft office365.Update(office365.MessageInfo[0].Id); // Send the draft office365.SendDraft(office365.MessageInfo[0].Id); Example (HTML with Attachments) office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); office365.CreateDraft(0,""); office365.SetMessageAttachmentCount(1); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); office365.AddAttachment(office365.GetMessageInfoId(0), "", ""); office365.SendDraft(office365.GetMessageInfoId(0));

SendMail Method (CloudMail_Office365 Class)

Sends a new email.

Object Oriented Interface

public function doSendMail($savetosentitems);

Procedural Interface

cloudmail_office365_do_sendmail($res, $savetosentitems);

Remarks

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

Example: Simple Email

office365.MessageSubject = "I saw a Tree"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked."; office365.MessageTo = "TreeLookOut@gmail.com"; office365.SendMail(True); Example: HTML email with Attachments office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); //Set up attachments //Inline: office365.SetMessageAttachmentCount(2); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentName(0, "test picture"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); //Normal office365.SetMessageAttachmentFile(1, "./test.txt"); office365.SetMessageAttachmentName(1, "test file"); office365.SendMail(true);

Update Method (CloudMail_Office365 Class)

Updates a message.

Object Oriented Interface

public function doUpdate($id);

Procedural Interface

cloudmail_office365_do_update($res, $id);

Remarks

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

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

Updates a category.

Object Oriented Interface

public function doUpdateCategory($id, $color);

Procedural Interface

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

Remarks

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

AttachmentList Event (CloudMail_Office365 Class)

Fired when an attachment is retrieved from the server.

Object Oriented Interface

public function fireAttachmentList($param);

Procedural Interface

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

Parameter List

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

Remarks

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

CategoryList Event (CloudMail_Office365 Class)

Fired when an attachment is retrieved from the server.

Object Oriented Interface

public function fireCategoryList($param);

Procedural Interface

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

Parameter List

 'id'
'displayname'
'color'

Remarks

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

Error Event (CloudMail_Office365 Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
'description'

Remarks

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

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

FolderList Event (CloudMail_Office365 Class)

Fired when a folder is retrieved by the server.

Object Oriented Interface

public function fireFolderList($param);

Procedural Interface

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

Parameter List

 'id'
'displayname'
'parentfolderid'
'childfoldercount'
'unreaditemcount'
'totalitemcount'

Remarks

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

Log Event (CloudMail_Office365 Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudmail_office365_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
'message'
'logtype'

Remarks

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

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

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

Fired when a message is retrieved from the server.

Object Oriented Interface

public function fireMessageList($param);

Procedural Interface

cloudmail_office365_register_callback($res, 6, array($this, 'fireMessageList'));

Parameter List

 'id'
'subject'
'messagesender'
'receiveddatetime'
'sentdatetime'
'hasattachments'
'bodycontenttype'
'bodycontent'
'bodypreview'

Remarks

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

SSLServerAuthentication Event (CloudMail_Office365 Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudmail_office365_register_callback($res, 7, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

SSLStatus Event (CloudMail_Office365 Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudmail_office365_register_callback($res, 8, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Transfer Event (CloudMail_Office365 Class)

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

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudmail_office365_register_callback($res, 9, array($this, 'fireTransfer'));

Parameter List

 'direction'
'bytestransferred'
'percentdone'
'text'

Remarks

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

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

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

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

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

Config Settings (Office365 Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Office365 Config Settings

AttachmentFragmentSize:   Size of fragments when uploading large attachments.

This setting specifies the size, in bytes, of the fragments that are uploaded during an advanced upload session when using the AddAttachment method.

The default value is 2097152 (2MiBs).

AttachmentSimpleUploadLimit:   The threshold to use simple uploads.

This setting specifies the limit before the component will switch from simple uploads to upload sessions when using the AddAttachment method.

The default value is 2097152 (2MiBs).

FolderPageSize:   Page size for fetching folders.

This setting specifies the folder page size, or the maximum number of folders that will be fetched from the server in one get call.

The default value is 100.

IncludeNestedItemAttachments:   Whether nested attachments present on item attachment are included in the request.

This setting specifies whether item attachments retain their own attachments. If set to True, additional requests will be made to ensure that nested attachments present in the item attachment remain. If set to False (default), this will not occur, reducing the size of the request.

At this time, Microsoft does not support nested attachments in item attachments. Once support is added, this may be set to True to include these attachments with the AddItemAttachment request.

MessagePageSize:   Page size for fetching messages.

This setting specifies the message page size, or the maximum number of messages that will be fetched from the server in one get call.

The default value is 100.

MIMEMessage:   MIME encoded message to send.

When set with a MIME message, the SendMail method will use the MIME message rather than the Message* properties.

component.Config("MIMEMessage" + MIME_MESSAGE); component.SendMail();

OAuthAccessTokenExpiration:   The lifetime of the access token.

This setting holds the lifetime of the access token in seconds. For instance the value 3600 indicates that the token will expire in one hour from the time it was generated.

OAuthAuthorizationTokenType:   The type of access token returned.

The applicable values include the following:

Bearer (default)When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header.

OAuthAutomaticRefresh:   Whether or not to refresh an expired access token automatically.

When this setting is set to true and the Authorization property is not set, the class will automatically get a new access token if it has the necessary properties to do so without user interaction.

For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction.

OAuthBrowserResponseTimeout:   Specifies the amount of time to wait for a response from the browser.

This setting specifies the amount of time (in seconds) the class will wait for a response from the browser when requesting user authentication. The default value is 0, meaning that the class will wait indefinitely.

OAuthIncludeEmptyRedirectURI:   Whether an empty redirect_uri parameter is included in requests.

This setting specifies whether redirect_uri is included in the request made by Authorize if it is empty.

If set to true (default) the redirect_uri will be sent in all cases. If set to false the redirect_uri will only be sent if it has a value.

OAuthJWTPayload:   The payload of the JWT access token if present.

This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to access tokens that are returned from a service provider after successfully authorizing and authenticating with the service.

To parse the payload for specific claims, see OAuthJWTXPath.

OAuthJWTXPath:   Provides a way to point to a specific element in the returned payload of a JWT based access token.

The OAuthJWTXPath setting allows you to point to specific claims within the payload of a JWT based access token.

XPath Syntax

XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:

Accessor Description
name The first element with a particular name. Can be *.
[i] The i-th element.
name[i] The i-th element with a particular name.
[last()] The last element.
[last()-i] The element i before the last element.

Here are some examples of valid XPaths and some common claims:

DescriptionJSON XPath
Document root /json
Specific element /json/element_one
Username Claim (Microsoft Specific) /json/preferred_username
Registered Application Name Claim (Microsoft Specific) /json/app_displayname

This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see OAuthJWTXText.

OAuthJWTXText:   The text of the current element.

Provides the inner text of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthParamCount:   Specifies the number of additional parameters variables to include in the request.

This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the OAuthClientProfile is ocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:

component.Config("OAuthParamCount=2"); component.Config("OAuthParamName[0]=myvar"); component.Config("OAuthParamValue[0]=myvalue"); component.Config("OAuthParamName[1]=testname"); component.Config("OAuthParamValue[1]=testvalue");

Addtionally, 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 + "]"); }

OAuthParamName[i]:   Specifies the parameter name at the specified index.

This setting can be used to retrieve or specify the parameter variable name at the index specified. See OAuthParamCount for details.

OAuthParamValue[i]:   Specifies the parameter value at the specified index.

This setting can be used to retrieve or specify the parameter variable value at the index specified. See OAuthParamCount for details.

OAuthPasswordGrantUsername:   Used in the Resource Owner Password grant type.

Used to set the username property when the OAuthGrantType is set to the password grant type and Authorize is called.

OAuthPKCEChallengeEncoding:   The PKCE code challenge method to use.

This setting controls the PKCE code challenge method used when OAuthUsePKCE is set to true. Possible values are:

  • 1 (Plain)
  • 2 (S256/SHA256 - default)
OAuthReUseWebServer:   Determines if the same server instance is used between requests.

If set to true (default), the same embedded web server instance will be used for multiple requests. If set to false the embedded web server will be created and destroyed on each call to Authorize

OAuthUsePKCE:   Specifies if PKCE should be used.

If set to true (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code OAuthGrantType. The OAuthPKCEChallengeEncoding configuration setting can be used to control the code challenge method that will be used.

OAuthWebServerActive:   Specifies and controls whether the embedded web server is active.

The setting when queried will return the current state of the web server. If the webserver is active, it will return "true" and if it is inactive it will return "false".

This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when Authorize 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.

OAuthWebServerCertStore:   The certificate with private key to use when SSL is enabled.

The name of the certificate store used for the embedded web server's SSL.

The OAuthWebServerCertStoreType 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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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. PKCS12 certificate store).

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertStorePassword:   The certificate with private key to use when SSL is enabled.

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

Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertStoreType:   The certificate with private key to use when SSL is enabled.

This specifies the type of certificate store. Possible values are:

0 User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java.
5 JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java.
6 PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
14 PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 XMLFile - The certificate store is the name of a file that contains a certificate in XML format.
17 XMLBlob - The certificate store is a string that contains a certificate in XML format.

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertSubject:   The certificate with private key to use when SSL is enabled.

The subject of the SSL certificate.

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerFailedResponse:   The custom response that will be displayed to the user if authentication failed.

When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.

OAuthWebServerHost:   The hostname used by the embedded web server displayed in the ReturnURL.

This setting specifies the hostname used by the embedded web server when OAuthClientProfile is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the OAuthReturnURL. This should be set to the hostname only, not the full URL.

The default value is localhost.

OAuthWebServerPort:   The local port on which the embedded web server listens.

This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

OAuthWebServerResponse:   The custom response that will be displayed to the user.

When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.

OAuthWebServerSSLEnabled:   Whether the web server requires SSL connections.

This setting specifies whether the embedded web server will use SSL. If set to True OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to False only plaintext connects are supported.

Prefer:   Specifies a preferred content header type.

This setting can be used to specify a preferred content header type to be used when retrieving messages.

QueryParamCount:   The number of custom OData Query Parameters.

This setting specifies the number of custom OData Query parameters that will be added to a request when fetching data.

The default value is 0.

QueryParamName[i]:   The name of a custom OData Query Parameter.

This setting specifies the name of the custom OData Query parameter at index i.

QueryParamValue[i]:   The value of a custom OData Query Parameter.

This setting specifies the value of the custom OData Query parameter at index i.

UserId:   Sets the Id of a shared mailbox to connect to.

Specifies the Id to use when connecting to the server. When the "mail.read.shared" scope is also added, this allows reading from shared mailboxes. Must be set when using Admin consented authorization flows.

XPath:   Provides a way to point to a specific element in the returned XML or JSON response.

The XPath setting allows you to point to specific elements in the XML or JSON response.

XPath Syntax

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.

Note: XPath indices are 1-based.

XPath Examples

Assuming the following XML response:

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

Or, alternatively, the following JSON response:

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

Here are some examples of valid XPaths:

DescriptionXML 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 is not an exhaustive list by any means, but should provide a general idea of the possibilities.

XText:   The text of the current element.

Provides the inner text of the current element.

The current element is specified in the XPath configuration setting. This configuration setting is read-only.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class 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 class fails with an error instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion 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.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

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

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

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

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

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

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

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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 classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime 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 class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength 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.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

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 setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this 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 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 config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites 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: 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:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: 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_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • 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.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation.

In editions which 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 only supported 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 only available 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 the above 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.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

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.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: TCPClient.SSLProvider = TCPClientSSLProviders.sslpInternal; TCPClient.Config("SSLEnabledProtocols=3072"); //TLS 1.2 TCPClient.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this 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.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

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

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (Office365 Class)

Office365 Errors

1301   Invalid Input Error.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Mail 2022 PHP Edition - Version 22.0 [Build 8369]