Office365 Component
Properties Methods Events Config Settings Errors
The Office365 component provides an easy way to manage sending and receiving mail in Microsoft 365.
Syntax
nsoftware.CloudMail.Office365
Remarks
This component provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the component, first set the Authorization property to a valid OAuth token. The Office365 component can be used for sending or creating new messages; retrieving, moving, or copying existing messages; creating, deleting, or copying folders; and several other functionalities supported by the Microsoft Graph API.
This component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.
The component has the following defaults:
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 GrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the ServerAuthURL and ServerTokenURL fields. 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 ClientProfile and GrantType values that are supported by this component. For a more in-depth description of what needs to be set, refer to the service documentation.
Application Profile
This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the component. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.
To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the component will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType field. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.
A brief description of the supported values for the GrantType field are below. For more information, see the service documentation.
Authorization Code
When using the Authorization Code grant type, the component will use an authorization code to get an access token. For this GrantType the component expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the authorization code, setting the AuthorizationCode field, from the redirect. Immediately, the component will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken field is set, or a refresh token is cached, then the component will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.
Example:
Office365 office365 = new Office365();
office365.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
office365.OAuth.ClientId = CLIENT_ID;
office365.OAuth.ClientSecret = CLIENT_SECRET;
office365.Authorize();
Client Credentials
When using the Client Credentials grant type, the component will act as a service instead of authorizing and authenticating as a user. This allows for the component to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this GrantType the component expects a ClientId, ClientSecret, and ServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.
Implicit
Note: This grant type is considered insecure and should only be used when necessary.
When using the Implicit grant type, the component will request the authorization server to get an access token. For this GrantType the component expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the access token from the redirect.
A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the component will not be able to automatically get a fresh token once it expires.
Password
Note: This grant type is considered insecure and should only be used when necessary.
When using the Resource Owner Password Credentials grant type, the component will authenticate as the resource owner. This allows for the component to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.
For this GrantType the component requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.
Web Profile
This profile is similar to setting the component to the Application profile and Authorization Code grant type except the component 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 ClientId, ClientSecret, ServerAuthURL, ServerTokenURL, and the ReturnURL fields to be set. Before calling the Authorize method, the WebAuthURL field 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 ReturnURL field. The ReturnURL field 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 AuthorizationCode field. 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 component will then cache these values like normal and use them to make requests. If the RefreshToken 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 component 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 component to ignore the values set in the OAuth property.
For Example:
Oauth oauth = new Oauth();
oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
office365.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Sending Messages
There are two methods for sending new messages using the Office365 component. The SendMail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the SendDraft method. In both cases the properties of the new message are assigned through the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.).
Sending a Message with SendDraft:
office365.MessageSubject = "Subject Text";
office365.MessageImportance = "Low";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Body Text.";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
string messageId = office365.MessageInfo[0].Id;
office365.SendDraft(messageId);
There are also methods for replying or forwarding messages using the Office365 component. The Reply, ReplyAll, and Forward method will send a reply or forward directly. Similarly, you can create a reply or forward draft and then send an existing draft using the SendDraft method. Unlike creating a new message, only the direct methods use the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.). When using CreateDraft, the draft must first be made then updated using the MessageInfo collection 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 collection. MessageInfo collection is populated when the ListMessages, RetrieveMessage, Search, or ListChanges methods are called.
The ListMessages and ListChanges methods will respectively list the messages or changed messages in a folder specified by a folderId. To get the ID of a folder, folders can be traversed and read using the ListFolders method and the Folders collection.
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 collection with all the messages in a particular folder.
do {
office365.ListMessages(folderId);
} while (office365.ListMessagesMarker.Length > 0);
The message page size may also be changed by using the MessagePageSize configuration setting.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Attachments | Collection of attachments listed by the server. |
Authorization | An OAuth Authorization String |
Categories | Collection of attachments listed by the server. |
ChangeMarker | The page marker for listing changed messages. |
ContactFolders | The collection of contact folders listed by the server. |
Contacts | The collection of contacts listed by the server. |
Firewall | A set of properties related to firewall access. |
Folders | Collection of folders listed by the server. |
ListContactsMarker | The page marker for listing contacts. |
ListFoldersMarker | The page marker for listing folders. |
ListMessagesMarker | The page marker for listing messages. |
Message | Provides the raw message content. |
MessageAttachments | A collection of attachments to add to a message. |
MessageBcc | A comma separated list of recipients for blind carbon copies for a message. |
MessageBodyContent | The body content for a message. |
MessageBodyContentType | The body content type for a message. |
MessageCc | A comma separated list of recipients for carbon copies for a message. |
MessageDeliveryReceipt | Whether or not a message will request a Delivery Receipt. |
MessageFrom | The author of a message. |
MessageImportance | The importance of a message. |
MessageInfo | Collection of information about retrieved messages. |
MessageOtherHeaders | The additional message headers for a message. |
MessageReadReceipt | Whether or not a message will request a Read Receipt. |
MessageReplyTo | A mail address to reply to. |
MessageSubject | The subject of a message. |
MessageTo | A comma separated list of recipients for a message. |
NextChangeMarker | A marker indicating which page of changes to return in the future. |
OAuth | This property holds the OAuth Settings. |
Proxy | A set of properties related to proxy access. |
Select | The parts of a message that should be retrieved. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddAttachment | Adds a file attachment to an existing message. |
AddItemAttachment | Adds an item attachment to an existing message. |
Authorize | Get the authorization string required to access the protected resource. |
Config | Sets or retrieves a configuration setting. |
Copy | Creates a copy of a message. |
CopyFolder | Copies a folder. |
CreateCategory | Creates a new category. |
CreateContact | Creates a contact. |
CreateDraft | Creates a new email draft. |
CreateFolder | Creates a new folder. |
Delete | Deletes a message. |
DeleteAttachment | Deletes an attachment. |
DeleteCategory | Deletes a mail category. |
DeleteContact | Deletes a contact. |
DeleteFolder | Deletes a folder. |
Forward | Forward a message. |
GetCategory | Retrieves a mail category. |
GetContact | Retrieves the contact by Id. |
GetContactField | Retrieves the contact property value by JSONPath. |
GetFolder | Retrieves a folder. |
Interrupt | Interrupt the current method. |
ListAttachments | Lists all of a message's attachments. |
ListCategories | Lists all mail categories. |
ListChanges | Lists messages that have been changed within a specified folder. |
ListContactFolders | Lists the contact folders found in the parent folder. |
ListContacts | Lists the contacts in a folder. |
ListFolders | Lists the folders found in the parent folder. |
ListMessages | Lists the messages in a folder. |
MoveFolder | Moves a folder. |
MoveMessage | Moves a message. |
RenameFolder | Renames a folder. |
Reply | Reply to a message. |
ReplyAll | ReplyAll to a message. |
Reset | This method will reset the component. |
RetrieveAttachment | Retrieves a message attachment. |
RetrieveMessage | Retrieves a message. |
RetrieveMessageRaw | Retrieves the raw message of the specified message ID. |
Search | Search for messages. |
SendCustomRequest | Send a custom HTTP request. |
SendDraft | Sends an existing draft. |
SendMail | Sends a new email. |
SetAttachmentInStream | Sets an attachment using a stream. |
SetContactField | Sets the contact field value by JSONPath. |
Update | Updates a message. |
UpdateCategory | Updates a category. |
UpdateContact | Updates a contact. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
AttachmentList | Fired when an attachment is retrieved from the server. |
CategoryList | Fired when an attachment is retrieved from the server. |
ContactFolderList | Fired when a contact folder is retrieved by the server. |
ContactList | Fired when a contact is retrieved from the server. |
Error | Fired when information is available about errors during data delivery. |
FolderList | Fired when a folder is retrieved by the server. |
Log | This event fires once for each log message. |
MessageList | Fired when a message is retrieved from the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AttachmentFragmentSize | Size of fragments when uploading large attachments. |
AttachmentJSON[i] | The raw JSON for the selected attachment. |
AttachmentSimpleUploadLimit | The threshold to use simple uploads. |
ContactFoldersPageSize | Page size for fetching contact folders. |
ContactsPageSize | Page size for fetching contacts. |
FolderPageSize | Page size for fetching folders. |
IncludeNestedItemAttachments | Whether nested attachments present on item attachment are included in the request. |
ItemAttachmentCC[i] | The CC field of item attachment messages. |
ItemAttachmentFrom[i] | The from field of item attachment messages. |
ItemAttachmentSentDate[i] | The SentDate field of item attachment messages. |
ItemAttachmentSubject[i] | The Subject field of item attachment messages. |
ItemAttachmentTo[i] | The CC field of item attachment messages. |
ListContactFoldersMarker | The page marker for listing contact folders. |
MessagePageSize | Page size for fetching messages. |
MIMEMessage | MIME encoded message to send. |
Prefer | Specifies a preferred content header type. |
QueryParamCount | The number of custom OData Query Parameters. |
QueryParamName[i] | The name of a custom OData Query Parameter. |
QueryParamValue[i] | The value of a custom OData Query Parameter. |
RequestNestedItemAttachments | Whether nested attachments present on item attachments are included when listing attachments. |
UserId | Sets the Id of a shared mailbox to connect to. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
OAuthAccessTokenExpiration | The lifetime of the access token. |
OAuthAuthorizationTokenType | The type of access token returned. |
OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
OAuthJWTPayload | The payload of the JWT access token if present. |
OAuthJWTXChildCount | The number of child elements of the current element. |
OauthJWTXChildName[i] | The name of the child element. |
OAuthJWTXChildXText[i] | The inner text of the child element. |
OAuthJWTXElement | The name of the current element. |
OauthJWTXParent | The parent of the current element. |
OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
OAuthJWTXSubTree | A snapshot of the current element in the document. |
OAuthJWTXText | The text of the current element. |
OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
OAuthParamName[i] | Specifies the parameter name at the specified index. |
OAuthParamValue[i] | Specifies the parameter value at the specified index. |
OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
OAuthReUseWebServer | Determines if the same server instance is used between requests. |
OAuthTransferredRequest | The full OAuth request last sent by the client. |
OAuthUsePKCE | Specifies if PKCE should be used. |
OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
OAuthWebServerPort | The local port on which the embedded web server listens. |
OAuthWebServerResponse | The custom response that will be displayed to the user. |
OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Attachments Property (Office365 Component)
Collection of attachments listed by the server.
Syntax
public OLAttachmentList Attachments { get; }
Public Property Attachments As OLAttachmentList
Remarks
This collection contains a list of attachments returned by the server when ListAttachments is called.
This property is not available at design time.
Please refer to the OLAttachment type for a complete list of fields.Authorization Property (Office365 Component)
An OAuth Authorization String
Syntax
Default Value
""
Remarks
This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.
Example
Oauth oauth = new Oauth();
oauth.ClientId = "YourClientId";
oauth.ClientSecret = "YourClientSecret";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "user.read mail.readwrite mail.send mailboxsettings.readwrite";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
office365.Authorization = oauth.GetAuthorization();
This property is not available at design time.
Categories Property (Office365 Component)
Collection of attachments listed by the server.
Syntax
public OLCategoryList Categories { get; }
Public Property Categories As OLCategoryList
Remarks
This collection contains a list of categories returned by the server when ListCategories is called.
This property is not available at design time.
Please refer to the OLCategory type for a complete list of fields.ChangeMarker Property (Office365 Component)
The page marker for listing changed messages.
Syntax
Default Value
""
Remarks
This property is populated if there are still unlisted messages after ListChanges is called. It contains the nextLink that will be included as an OData parameter if ListChanges is called again on the same folder. This will cause the next page of changed messages to be listed.
Example (List All Changes of a Message)
do
{
office365.ListChanges(id, "", 100);
} while (office365.ChangeMarker.Length > 0);
This property is not available at design time.
ContactFolders Property (Office365 Component)
The collection of contact folders listed by the server.
Syntax
public OLContactFolderList ContactFolders { get; }
Public Property ContactFolders As OLContactFolderList
Remarks
This collection contains a list of contact folders returned by the server. It is populated when ListContactFolders is called.
This property is not available at design time.
Please refer to the OLContactFolder type for a complete list of fields.Contacts Property (Office365 Component)
The collection of contacts listed by the server.
Syntax
public OLContactList Contacts { get; }
Public Property Contacts As OLContactList
Remarks
This collection contains a list of contacts returned by the server. It is populated when ListContacts or GetContact is called. A GetContact call adds the retrieved contact to the end of the list. If the contact already exists in the Contacts collection, it will be removed and then added to the end, preventing duplication.
Example (Retrieve Contacts from a Folder)
// List contacts of the default Contacts folder of the user
office365.ListContacts("");
// Data for each Contact
foreach (OLContact contact in office365.Contacts) {
contact.FirstName;
contact.LastName;
contact.EmailAddressIndex=0;
contact.EmailAddress; //first email address
contact.PhoneIndex=0;
contact.PhoneNumber; //first phone number
}
This property is not available at design time.
Please refer to the OLContact type for a complete list of fields.Firewall Property (Office365 Component)
A set of properties related to firewall access.
Syntax
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Folders Property (Office365 Component)
Collection of folders listed by the server.
Syntax
public OLFolderList Folders { get; }
Public Property Folders As OLFolderList
Remarks
This collection contains a list of folders returned by the server. It is populated when ListFolders or GetFolder is called.
This property is not available at design time.
Please refer to the OLFolder type for a complete list of fields.ListContactsMarker Property (Office365 Component)
The page marker for listing contacts.
Syntax
Default Value
""
Remarks
This property is populated if there are still unlisted contacts after ListContacts is called. It contains the nextLink that will be included as an OData parameter if ListContacts is called again on the same folder. This will cause the next page of contacts to be listed and added to the end of the Contacts collection.
Example (List All Contacts in a Folder):
do
{
office365.ListContacts(folderId);
} while (!office365.ListContactsMarker.isEmpty());
This property is not available at design time.
ListFoldersMarker Property (Office365 Component)
The page marker for listing folders.
Syntax
Default Value
""
Remarks
This property is populated if there are still unlisted changes after ListFolders is called. It contains the nextLink that will be included as an OData parameter if ListFolders is called again on the same parent folder. This will cause the next page of folders to be listed.
Example (List All Folders in the Root Directory)
do
{
office365.ListFolders("");
} while (office365.ListFoldersMarker.Length > 0);
This property is not available at design time.
ListMessagesMarker Property (Office365 Component)
The page marker for listing messages.
Syntax
Default Value
""
Remarks
This property is populated if there are still unlisted messages after ListMessages is called. It contains the nextLink that will be included as an OData parameter if ListMessages is called again on the same folder. This will cause the next page of messages to be listed.
Example (List All Messages in a Folder)
do
{
office365.ListMessages(folderId, filter);
} while (office365.ListMessagesMarker.Length > 0);
This property is not available at design time.
Message Property (Office365 Component)
Provides the raw message content.
Syntax
Default Value
""
Remarks
This property is populated after calling RetrieveMessageRaw and holds the raw message content. This can be used to access the data before any processing is done by the component.
This property is read-only and not available at design time.
MessageAttachments Property (Office365 Component)
A collection of attachments to add to a message.
Syntax
public OLAttachmentList MessageAttachments { get; }
Public Property MessageAttachments As OLAttachmentList
Remarks
This property contains a list of files to attach to a message. These files are added to a message sent with SendMail or created with CreateDraft*.
*This applies only to drafts made with the DRAFTTYPE_MESSAGE type. For other types of drafts see AddAttachment.
Example
office365.MessageAttachments.Add(new OLAttachment("./text.txt"));
This property is not available at design time.
Please refer to the OLAttachment type for a complete list of fields.MessageBcc Property (Office365 Component)
A comma separated list of recipients for blind carbon copies for a message.
Syntax
Default Value
""
Remarks
This property contains a comma separated list of destinations for blind carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a Bcc Recipient)
office365.MessageBcc = "bbobbertson@bobmail.com";
office365.SendMail(True);
Example (Add a Bcc Recipient with a Name and Address)
office365.MessageBcc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com";
office365.SendMail(True);
This property is not available at design time.
MessageBodyContent Property (Office365 Component)
The body content for a message.
Syntax
Default Value
""
Remarks
This property contains the content of a message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
MessageBodyContentType Property (Office365 Component)
The body content type for a message.
Syntax
Default Value
""
Remarks
This property contains the content type of a message. Valid values include text or html. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
MessageCc Property (Office365 Component)
A comma separated list of recipients for carbon copies for a message.
Syntax
Default Value
""
Remarks
This property contains a comma separated list of destinations for carbon copies of a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a CC Recipient)
office365.MessageCc = "bbobbertson@bobmail.com";
office365.SendMail(True);
Example (Add a CC Recipient with a Name and Address)
office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com";
office365.SendMail(True);
This property is not available at design time.
MessageDeliveryReceipt Property (Office365 Component)
Whether or not a message will request a Delivery Receipt.
Syntax
Default Value
False
Remarks
This property determines whether or not messages created with CreateDraft or messages sent with SendMail will request a Delivery Receipt.
MessageFrom Property (Office365 Component)
The author of a message.
Syntax
Default Value
""
Remarks
This property contains the author of a message. This property is optional. If it is left blank, the message's author will be the Microsoft account used in Authorization.
This property is applied to a message created with CreateDraft or messages sent with SendMail.
Example (Specify Message Author)
office365.MessageFrom = "stephen@company.com";
office365.SendMail(True);
Example (Specify Message Author - Name Included)
office365.MessageFrom = "\"Stephen Withavee\" stephen@company.com";
office365.SendMail(True);
This property is not available at design time.
MessageImportance Property (Office365 Component)
The importance of a message.
Syntax
Default Value
""
Remarks
This property determines the importance of messages created with CreateDraft or messages sent with SendMail. Valid values are Low, Normal, and High.
This property is not available at design time.
MessageInfo Property (Office365 Component)
Collection of information about retrieved messages.
Syntax
public OLMessageInfoList MessageInfo { get; }
Public Property MessageInfo As OLMessageInfoList
Remarks
This collection contains a list of OLMessageInfo for messages fetched by the server. This property is populated when ListMessages, RetrieveMessage, Search, or ListChanges is called.
This property is not available at design time.
Please refer to the OLMessageInfo type for a complete list of fields.MessageOtherHeaders Property (Office365 Component)
The additional message headers for a message.
Syntax
Default Value
""
Remarks
This property contains additional message headers to the sent or created message. These addresses are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
MessageReadReceipt Property (Office365 Component)
Whether or not a message will request a Read Receipt.
Syntax
Default Value
False
Remarks
This property determines whether or not messages created with CreateDraft or messages sent with SendMail will request a Read Receipt.
MessageReplyTo Property (Office365 Component)
A mail address to reply to.
Syntax
Default Value
""
Remarks
This property contains a comma separated list of destinations for the ReplyTo property of a message. This property is optional. This property is useful when replies should be sent to addresses other than those in MessageFrom. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
MessageSubject Property (Office365 Component)
The subject of a message.
Syntax
Default Value
""
Remarks
This property contains the subject of a message. This property will be applied to a message created with CreateDraft or messages sent with SendMail.
This property is not available at design time.
MessageTo Property (Office365 Component)
A comma separated list of recipients for a message.
Syntax
Default Value
""
Remarks
This property contains a comma separated list of destinations for a mail message. These recipients are added to a message created with CreateDraft or messages sent with SendMail.
Example (Add a Recipient)
office365.MessageCc = "bbobbertson@bobmail.com";
office365.SendMail(True);
Example (Add a Recipient with a Name and Address)
office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com";
office365.SendMail(True);
This property is not available at design time.
NextChangeMarker Property (Office365 Component)
A marker indicating which page of changes to return in the future.
Syntax
Default Value
""
Remarks
This property will be populated when ListChanges is called if there are no more changes to list. Refer to ListChanges for more information.
This property is not available at design time.
OAuth Property (Office365 Component)
This property holds the OAuth Settings.
Syntax
public OAuthSettings OAuth { get; }
Public ReadOnly Property OAuth As OAuthSettings
Remarks
This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.
This property is read-only and not available at design time.
Please refer to the OAuthSettings type for a complete list of fields.Proxy Property (Office365 Component)
A set of properties related to proxy access.
Syntax
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.Select Property (Office365 Component)
The parts of a message that should be retrieved.
Syntax
Default Value
""
Remarks
This property can be used to select specific message or attachment properties to retrieve when calling ListMessages RetrieveMessage, ListAttachments, or RetrieveAttachment. Specify the message or attachment properties to be selected as a comma separated list.
When this property is an empty string, all message or attachment properties will be selected.
Messages
Selectable properties for messages include:
bccRecipients | The bcc'd recipients of the message. |
body | The message body type and content. |
bodyPreview | A preview of the message body containing the first few lines of text. |
categories | The mail categories that this message falls under. |
ccRecipients | The cc'd recipients of this message. |
conversationId | The ID of the conversation this message is a part of. |
createdDateTime | The date and time when this message was created. |
flag | The flag status of the message. |
from | The address the message is from. |
hasAttachments | A boolean for if the message has attachments. |
importance | The importance level of the message. |
inferenceClassification | The inference classification of this message (e.g. focused, other). |
internetMessageHeaders | The message headers for the message according to rfc 5322. |
isDeliveryReceiptRequested | A boolean for if a delivery receipt was requested. |
isDraft | A boolean for if the message is a draft. |
isRead | A boolean for if the message has been read. |
isReadReceiptRequested | A boolean for if a read receipt was requested. |
lastModifiedDateTime | The date and time when this message was last modified. |
parentFolderId | The ID of the messages parent folder. |
receivedDateTime | The date and time when this message was received. |
replyTo | The addresses the message is a reply to. |
sender | The sender of the message. |
sentDateTime | The date and time when this message was sent. |
subject | The subject of the message. |
toRecipients | The recipients of the message. |
webLink | A weblink for the message. |
Example (Get the Subject and Sender of a Message)
office365.Select = "subject, sender";
office365.GetMessage(messageId);
Attachments
Due to limitations in the OData parameters, item attachments will always contain the entire list of properties.
Selectable properties for attachments include:
contentType | The MIME type of the attachment. |
isInline | If the attachment is an inline attachment. |
lastModifiedDateTime | ISO 8601 format timestamp of the last modified date (UTC). |
name | The attachments file name. |
size | The length of the attachment in bytes. |
Example (Get the Name and Size of an attachment)
office365.Select = "name, size";
office365.ListAttachments(messageId);
This property is not available at design time.
SSLAcceptServerCert Property (Office365 Component)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (Office365 Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (Office365 Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public Office365SSLProviders SSLProvider { get; set; }
enum Office365SSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As Office365SSLProviders
Enum Office365SSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (Office365 Component)
This property includes the server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.AddAttachment Method (Office365 Component)
Adds a file attachment to an existing message.
Syntax
public void AddAttachment(string messageId, string name, string localFile); Async Version public async Task AddAttachment(string messageId, string name, string localFile); public async Task AddAttachment(string messageId, string name, string localFile, CancellationToken cancellationToken);
Public Sub AddAttachment(ByVal MessageId As String, ByVal Name As String, ByVal LocalFile As String) Async Version Public Sub AddAttachment(ByVal MessageId As String, ByVal Name As String, ByVal LocalFile As String) As Task Public Sub AddAttachment(ByVal MessageId As String, ByVal Name As String, ByVal LocalFile As String, cancellationToken As CancellationToken) As Task
Remarks
This method adds a file attachment to an existing message, specified by the MessageId parameter. To add a more complex attachment, set the Name and LocalFile parameters and the component will use the first attachment in the MessageAttachments collection. As a note, this will not clear the MessageAttachments collection. If the file is larger than the value set in the AttachmentSimpleUploadLimit configuration, then the component will use an upload session to upload the attachment in fragments. The size of the fragments are specified in the AttachmentFragmentSize configuration.
This method is not used to add attachments to messages that are sent with the SendMail method.
Example (Adding a Simple Attachment to a New Draft)
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip");
Example (Adding a Simple Attachment to a New Draft)
office365.MessageSubject = "Subject";
office365.MessageBodyContentType = "html";
office365.MessageBodyContent = "<p>Body</p><img src='cid:test1'>";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip");
Example (Adding a Complex Attachment to a New Draft)
office365.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.MessageAttachments.Add(new OLAttachment("test picture", "./test.txt"));
office365.MessageAttachments[0].IsInline = true;
office365.MessageAttachments[0].ContentId = "test1";
office365.AddAttachment(messageId, "", "");
office365.SendDraft(messageId);
AddItemAttachment Method (Office365 Component)
Adds an item attachment to an existing message.
Syntax
public void AddItemAttachment(string messageId, string msgToAttachId, string itemJSON); Async Version public async Task AddItemAttachment(string messageId, string msgToAttachId, string itemJSON); public async Task AddItemAttachment(string messageId, string msgToAttachId, string itemJSON, CancellationToken cancellationToken);
Public Sub AddItemAttachment(ByVal MessageId As String, ByVal msgToAttachId As String, ByVal ItemJSON As String) Async Version Public Sub AddItemAttachment(ByVal MessageId As String, ByVal msgToAttachId As String, ByVal ItemJSON As String) As Task Public Sub AddItemAttachment(ByVal MessageId As String, ByVal msgToAttachId As String, ByVal ItemJSON As String, cancellationToken As CancellationToken) As Task
Remarks
Adds an item attachment to an existing message, specified by the MessageId parameter. Item attachments are non-file attachments, such as Outlook messages, events, and contacts. To add another message as an attachment, set the msgToAttachId parameter to its ID. To add an event or contact as an attachment, leave the msgToAttachId parameter empty and provide the full JSON.
This method is not used to add attachments to messages that are sent with the SendMail method.
Example (Adding an Existing Message to a New Draft)
office365.MessageSubject = "Subject";
office365.MessageBodyContentType = "text";
office365.MessageBodyContent = "Body";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddItemAttachment(messageId, "AAMkADNkNJp5JVnQIe9r0=", "");
Example (Adding an Event to a New Draft)
office365.MessageSubject = "Subject";
office365.MessageBodyContentType = "text";
office365.MessageBodyContent = "Body";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.AddItemAttachment(messageId, "", "{\"@odata.type\": \"#microsoft.graph.itemAttachment\", \"name\": \"Holiday event\", \"item\":{ \"@odata.type\": \"microsoft.graph.event\", \"subject\": \"Discuss gifts for children\", \"body\":{ \"content\": \"Let's look for funding!\"}, \"start\": {\"dateTime\": \"2016-12-02T18:00:00\"}, \"end\": {\"dateTime\": \"2016-12-02T19:00:00\"}}}");
Authorize Method (Office365 Component)
Get the authorization string required to access the protected resource.
Syntax
public void Authorize(); Async Version public async Task Authorize(); public async Task Authorize(CancellationToken cancellationToken);
Public Sub Authorize() Async Version Public Sub Authorize() As Task Public Sub Authorize(cancellationToken As CancellationToken) As Task
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.
For more information, see the introduction section.
Config Method (Office365 Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Copy Method (Office365 Component)
Creates a copy of a message.
Syntax
Remarks
This method copies a message to a folder. id takes the ID of the message to be copied, and destinationId takes the ID of the folder the message will be copied to.
CopyFolder Method (Office365 Component)
Copies a folder.
Syntax
Remarks
This method copies a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder. Since this method does not change the name of a folder, it is not possible to directly create a copy of a folder in the original folder's location.
CreateCategory Method (Office365 Component)
Creates a new category.
Syntax
public void CreateCategory(string displayName, string color); Async Version public async Task CreateCategory(string displayName, string color); public async Task CreateCategory(string displayName, string color, CancellationToken cancellationToken);
Public Sub CreateCategory(ByVal DisplayName As String, ByVal Color As String) Async Version Public Sub CreateCategory(ByVal DisplayName As String, ByVal Color As String) As Task Public Sub CreateCategory(ByVal DisplayName As String, ByVal Color As String, cancellationToken As CancellationToken) As Task
Remarks
This method creates a new Office365 category. The created category is added to the end of the Categories collection.
Example
office365.CreateCategory(categoryName, "preset9");
CreateContact Method (Office365 Component)
Creates a contact.
Syntax
public void CreateContact(string firstName, string lastName, string emailAddress, string parentId); Async Version public async Task CreateContact(string firstName, string lastName, string emailAddress, string parentId); public async Task CreateContact(string firstName, string lastName, string emailAddress, string parentId, CancellationToken cancellationToken);
Public Sub CreateContact(ByVal FirstName As String, ByVal LastName As String, ByVal EmailAddress As String, ByVal ParentId As String) Async Version Public Sub CreateContact(ByVal FirstName As String, ByVal LastName As String, ByVal EmailAddress As String, ByVal ParentId As String) As Task Public Sub CreateContact(ByVal FirstName As String, ByVal LastName As String, ByVal EmailAddress As String, ByVal ParentId As String, cancellationToken As CancellationToken) As Task
Remarks
This method creates a new contact with the specified first name, last name, and email address. At least one of the arguments must be provided. If all parameters are null or empty, an error is thrown. The contact is added to the parent folder specified by ParentId. Set ParentId to empty string or null to create the contact in the default Contacts folder of the signed-in user. The new contact is added to the end of the Contacts list.
After creating a contact with basic information, you can update it and set additional fields by editing the contact in the Contacts collection and calling the UpdateContact method. For more details, refer to the UpdateContact method.
Example (Create a Contact in the Default Contacts Folder of the User)
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Create the contact in the main contacts folder.
Example (Create a Contact in a Folder)
office365.ListContactFolders(""); //This method lists all contact folders in the root folder and populates the ContactFolder collection.
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", office365.ContactFolders[0].Id);
// Created the contact in the first folder in the ContactFolders collection.
Note that additional operations on a newly created contact may not be successful if performed immediately after creation. It is recommended to wait two or more second after creation before attempting further operations on the contact resource.
CreateDraft Method (Office365 Component)
Creates a new email draft.
Syntax
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 collection. As a note, this will not clear the collection but will add it to the end.
Valid values for DraftType :
0 | DRAFTTYPE_MESSAGE |
1 | DRAFTTYPE_REPLY |
2 | DRAFTTYPE_REPLYALL |
3 | DRAFTTYPE_FORWARD |
Important Notes
When using DRAFTTYPE_MESSAGE, pass in an empty string as the id. The created draft will be built using the Message* properties (i.e. MessageTo, MessageSubject, MessageFrom, etc.).
When using DRAFTTYPE_REPLY, DRAFTTYPE_REPLYALL, or DRAFTTYPE_FORWARD the id parameter can be used to specify the message that is being replied to or forwarded. Also, the created draft will NOT be built with the Message* properties. Instead, the created draft will be empty (except for the From field). The Update method can be used instead to fill in the different parts of the message.
Example (New Draft)
// Create a draft message
office365.MessageSubject = "Subject Text";
office365.MessageImportance = "High";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Body Text";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
office365.SendDraft(office365.MessageInfo[0].Id);
Example (Reply)
// Create the reply draft
string originalMessageId = "Message ID";
office365.CreateDraft(1, originalMessageId);
// Set the new draft MessageInfo fields with desired options
office365.MessageInfo[0].To = "email@example.com";
office365.MessageInfo[0].Subject = "Subject Text";
office365.MessageInfo[0].BodyContentType = "TEXT";
office365.MessageInfo[0].BodyContent = "Body Text";
// Update the draft
office365.Update(office365.MessageInfo[0].Id);
// Send the draft
office365.SendDraft(office365.MessageInfo[0].Id);
CreateFolder Method (Office365 Component)
Creates a new folder.
Syntax
public void CreateFolder(string folderName, string parentFolderId); Async Version public async Task CreateFolder(string folderName, string parentFolderId); public async Task CreateFolder(string folderName, string parentFolderId, CancellationToken cancellationToken);
Public Sub CreateFolder(ByVal folderName As String, ByVal parentFolderId As String) Async Version Public Sub CreateFolder(ByVal folderName As String, ByVal parentFolderId As String) As Task Public Sub CreateFolder(ByVal folderName As String, ByVal parentFolderId As String, cancellationToken As CancellationToken) As Task
Remarks
This method creates a new folder. To create a folder in the root directory set parentFolderId to an empty string.
Delete Method (Office365 Component)
Deletes a message.
Syntax
public void Delete(string id); Async Version public async Task Delete(string id); public async Task Delete(string id, CancellationToken cancellationToken);
Public Sub Delete(ByVal id As String) Async Version Public Sub Delete(ByVal id As String) As Task Public Sub Delete(ByVal id As String, cancellationToken As CancellationToken) As Task
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 collection.
DeleteAttachment Method (Office365 Component)
Deletes an attachment.
Syntax
public void DeleteAttachment(string id, string attachmentId); Async Version public async Task DeleteAttachment(string id, string attachmentId); public async Task DeleteAttachment(string id, string attachmentId, CancellationToken cancellationToken);
Public Sub DeleteAttachment(ByVal id As String, ByVal attachmentId As String) Async Version Public Sub DeleteAttachment(ByVal id As String, ByVal attachmentId As String) As Task Public Sub DeleteAttachment(ByVal id As String, ByVal attachmentId As String, cancellationToken As CancellationToken) As Task
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 collection.
DeleteCategory Method (Office365 Component)
Deletes a mail category.
Syntax
public void DeleteCategory(string id); Async Version public async Task DeleteCategory(string id); public async Task DeleteCategory(string id, CancellationToken cancellationToken);
Public Sub DeleteCategory(ByVal id As String) Async Version Public Sub DeleteCategory(ByVal id As String) As Task Public Sub DeleteCategory(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes a mail category from the current mailbox. This method will not update the Categories collection.
DeleteContact Method (Office365 Component)
Deletes a contact.
Syntax
public void DeleteContact(string id); Async Version public async Task DeleteContact(string id); public async Task DeleteContact(string id, CancellationToken cancellationToken);
Public Sub DeleteContact(ByVal id As String) Async Version Public Sub DeleteContact(ByVal id As String) As Task Public Sub DeleteContact(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes a contact specified by its ID. The id parameter takes the contact ID of the contact to be deleted. The contact is also removed from the Contacts collection.
Example (Delete a Contact)
// List contacts and search for a contact with the name "John Doe"
office365.ListContacts("folder_id");
for (int i = 0; i < office365.Contacts.Count; i++) {
if (office365.Contacts[i].DisplayName == "John Doe") {
//Delete the contact
office365.DeleteContact(office365.Contacts[i].Id);
break;
}
}
DeleteFolder Method (Office365 Component)
Deletes a folder.
Syntax
public void DeleteFolder(string id); Async Version public async Task DeleteFolder(string id); public async Task DeleteFolder(string id, CancellationToken cancellationToken);
Public Sub DeleteFolder(ByVal id As String) Async Version Public Sub DeleteFolder(ByVal id As String) As Task Public Sub DeleteFolder(ByVal id As String, cancellationToken As CancellationToken) As Task
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 collection.
Forward Method (Office365 Component)
Forward a message.
Syntax
public void Forward(string id, string messageHTML, string toRecipients); Async Version public async Task Forward(string id, string messageHTML, string toRecipients); public async Task Forward(string id, string messageHTML, string toRecipients, CancellationToken cancellationToken);
Public Sub Forward(ByVal id As String, ByVal messageHTML As String, ByVal toRecipients As String) Async Version Public Sub Forward(ByVal id As String, ByVal messageHTML As String, ByVal toRecipients As String) As Task Public Sub Forward(ByVal id As String, ByVal messageHTML As String, ByVal toRecipients As String, cancellationToken As CancellationToken) As Task
Remarks
This method can be used to quickly forward a message specified by id to the recipients specified by toRecipients. The toRecipients parameter accepts a comma separated list of emails to forward the message to. The messageHTML parameter is the message body to include with the forward. If messageHTML is an empty string, then the following properties are used:
Property | Default if not set |
MessageBcc | Blank |
MessageBodyContent | Blank |
MessageBodyContentType | HTML |
MessageCc | Blank |
MessageDeliveryReceipt | False |
MessageFrom | Currently authenticated mailbox |
MessageImportance | Blank |
MessageReadReceipt | False |
MessageSubject | FW:" + original subject |
Example (Simple):
office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");
Example (Advanced):
office365.MessageSubject = "Subject for the reply";
office365.MessageImportance = "Low";
office365.MessageCc = "Example@email.com";
office365.MessageBcc = "Example@email.com";
office365.MessageBodyContent = "Reply Message body";
office365.Forward(messageId, "", "example@email.com, exampletwo@email.com");
This method forwards a message specified by id. toRecipients accepts a comma separated list of emails to forward the message to.
Example (Forwarding a Message to Two Addresses)
office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");
GetCategory Method (Office365 Component)
Retrieves a mail category.
Syntax
public void GetCategory(string id); Async Version public async Task GetCategory(string id); public async Task GetCategory(string id, CancellationToken cancellationToken);
Public Sub GetCategory(ByVal id As String) Async Version Public Sub GetCategory(ByVal id As String) As Task Public Sub GetCategory(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves a mail category.
The fetched category can be accessed through the Categories collection. As a note, the component does not clear the collection and will append the category to the end of it.
GetContact Method (Office365 Component)
Retrieves the contact by Id.
Syntax
public void GetContact(string id); Async Version public async Task GetContact(string id); public async Task GetContact(string id, CancellationToken cancellationToken);
Public Sub GetContact(ByVal Id As String) Async Version Public Sub GetContact(ByVal Id As String) As Task Public Sub GetContact(ByVal Id As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves a contact specified by its ID and adds the contact to the end of the Contacts list. If the contact already exists in the Contacts collection, it will be removed and then added to the end, preventing duplication.
Example (Get a Contact)
// Retrieve a contact by its ID
string contactId = "12345"; // Replace with the actual contact ID
office365.GetContact(contactId);
// Access the retrieved contact
var retrievedContact = office365.Contacts[office365.Contacts.Count - 1];
retrievedContact.FirstName; //first name
retrievedContact.LastName; //last name
retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address
retrievedContact.EmailAddress; //first email address value
retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number
retrievedContact.PhoneNumber; //first phone number value
office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact
GetContactField Method (Office365 Component)
Retrieves the contact property value by JSONPath.
Syntax
public string GetContactField(int index, string jsonPath); Async Version public async Task<string> GetContactField(int index, string jsonPath); public async Task<string> GetContactField(int index, string jsonPath, CancellationToken cancellationToken);
Public Function GetContactField(ByVal index As Integer, ByVal JsonPath As String) As String Async Version Public Function GetContactField(ByVal index As Integer, ByVal JsonPath As String) As Task(Of String) Public Function GetContactField(ByVal index As Integer, ByVal JsonPath As String, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method retrieves a specific field within the contact's JSON field. The first parameter, index, is an integer representing the index of the contact in the Contacts collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.
Example (Access Fields of a Contact)
office365.GetContact("ContactId");
office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/homePhones/[1]"); //first home phone number of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/businessPhones/[2]"); //second business phone number of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/postalCode"); //postal code of the contact
office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/street"); //street name of the contact
GetFolder Method (Office365 Component)
Retrieves a folder.
Syntax
public void GetFolder(string id); Async Version public async Task GetFolder(string id); public async Task GetFolder(string id, CancellationToken cancellationToken);
Public Sub GetFolder(ByVal id As String) Async Version Public Sub GetFolder(ByVal id As String) As Task Public Sub GetFolder(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves a folder.
The fetched folder can be accessed through the Folders collection. As a note, the component does not clear the collection and will append the folder to the end of it.
Interrupt Method (Office365 Component)
Interrupt the current method.
Syntax
public void Interrupt(); Async Version public async Task Interrupt(); public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt() Async Version Public Sub Interrupt() As Task Public Sub Interrupt(cancellationToken As CancellationToken) As Task
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListAttachments Method (Office365 Component)
Lists all of a message's attachments.
Syntax
public void ListAttachments(string id); Async Version public async Task ListAttachments(string id); public async Task ListAttachments(string id, CancellationToken cancellationToken);
Public Sub ListAttachments(ByVal id As String) Async Version Public Sub ListAttachments(ByVal id As String) As Task Public Sub ListAttachments(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists all of a message's attachments. This method clears and populates the Attachments collection.
If the RequestNestedItemAttachments configuration setting is set to true (default false), the method will also list any nested attachments found within item attachments.
//List messages with attachments
office365.ListMessage("inbox", "hasAttachments eq true");
//List attachments of the first message
office365.ListAttachments(office365.MessageInfo[0].Id);
ListCategories Method (Office365 Component)
Lists all mail categories.
Syntax
public void ListCategories(); Async Version public async Task ListCategories(); public async Task ListCategories(CancellationToken cancellationToken);
Public Sub ListCategories() Async Version Public Sub ListCategories() As Task Public Sub ListCategories(cancellationToken As CancellationToken) As Task
Remarks
This method lists all of the mail categories in the current mailbox. This method clears and populates the Categories collection.
ListChanges Method (Office365 Component)
Lists messages that have been changed within a specified folder.
Syntax
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 collection.
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 collection (Once there aren't any more changed messages available to list, the NextChangeMarker property will be populated instead).
When NextChangeMarker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)
ListContactFolders Method (Office365 Component)
Lists the contact folders found in the parent folder.
Syntax
public void ListContactFolders(string parentFolderId); Async Version public async Task ListContactFolders(string parentFolderId); public async Task ListContactFolders(string parentFolderId, CancellationToken cancellationToken);
Public Sub ListContactFolders(ByVal parentFolderId As String) Async Version Public Sub ListContactFolders(ByVal parentFolderId As String) As Task Public Sub ListContactFolders(ByVal parentFolderId As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves and lists the contact folders within the specified parent folder. It clears and then populates the ContactFolders collection with the retrieved folders.
To list all contact folders in the root folder, set the parentFolderId parameter to an empty string.
Example (List All Contact Folders in the Root Folder):
office365.ListContactFolders(""); // List root folders.
foreach(OLContactFolder folder in office365.ContactFolders){
folder.Id; // Folder id
folder.Name; // Folder name
folder.ParentFolderId; // Folder parent id
}
Example (List all Contact Sub Folders in a Folder):
office365.ListContactFolders("");
office365.ListContactFolders(office365.ContactFolders[0].Id); //List the sub folders of the first root folder.
office365.ContactFolders[0]; // The first sub folder of the first root folder.
If the number of contact folders exceeds the page size, the ListContactFoldersMarker config value will be populated. You can call ListContactFolders again to retrieve the next page of folders. These folders will be added to the end of the ContactFolders collection.
Example (List All Contact Folders Pages in the Root Folder):
do{
office365.ListContactFolders(""); // List root folders.
} while (!office365.Config("ListContactFoldersMarker").IsEmpty());
ListContacts Method (Office365 Component)
Lists the contacts in a folder.
Syntax
public void ListContacts(string folderId); Async Version public async Task ListContacts(string folderId); public async Task ListContacts(string folderId, CancellationToken cancellationToken);
Public Sub ListContacts(ByVal folderId As String) Async Version Public Sub ListContacts(ByVal folderId As String) As Task Public Sub ListContacts(ByVal folderId As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves and lists the contacts within the specified folder. It clears and then populates the Contacts collection with the retrieved contacts. Providing an empty string as folderId retrieves the contacts from the default Contacts folder of the signed-in user.
Example (List All Contacts in a Folder)
office365.ListContactFolders(""); // List root folders (no need to do this if you already have a Folder Id)
office365.ListContacts(office365.ContactFolders[0].Id); //Lists contacts
Example (List all Contacts in the default Contacts folder):
office365.ListContacts("");
If the number of contacts exceeds the page size, the ListContactsMarker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the Contacts collection.
Example (List all Contacts Pages in the default Contacts folder):
do{
office365.ListContacts("");
} while(!office365.ListContactsMarker.isEmpty());
ListFolders Method (Office365 Component)
Lists the folders found in the parent folder.
Syntax
public void ListFolders(string parentFolderId); Async Version public async Task ListFolders(string parentFolderId); public async Task ListFolders(string parentFolderId, CancellationToken cancellationToken);
Public Sub ListFolders(ByVal parentFolderId As String) Async Version Public Sub ListFolders(ByVal parentFolderId As String) As Task Public Sub ListFolders(ByVal parentFolderId As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists the folders found in the parent folder. This method clears populates the Folders collection.
Set parentFolderId to be an empty string to list all folders in the root folder.
If the number of folders is greater than the folder page size, ListFoldersMarker will be populated and calling ListFolders again will list the next page of folders.
Example (List All Folders in the Root Folder)
office365.ListFolders("");
ListMessages Method (Office365 Component)
Lists the messages in a folder.
Syntax
Remarks
This method lists the messages found in the specified folder. This method clears and populates the MessageInfo collection.
If the number of messages is greater than the message page size, ListMessagesMarker will be populated and calling ListMessages again will list the next page of messages.
filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a folder. filter follows the OData protocol syntax.
Example (List All Messages in a Folder)
office365.ListMessages(folderId, "");
Example (List Unread Messages in a Folder)
office365.ListMessages(folderId, "isRead eq false");
Example (List Messages from a Specific Address)
office365.ListMessages(folderId, "from/emailAddress/address eq 'specific@address.com'");
Example (List Unread Messages from a Specific Address)
office365.ListMessages(folderId, "isRead eq false and from/emailAddress/address eq 'specific@address.com'");
MoveFolder Method (Office365 Component)
Moves a folder.
Syntax
Remarks
This method moves a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder.
MoveMessage Method (Office365 Component)
Moves a message.
Syntax
Remarks
This method moves a message. destinationId refers to the folder ID where the message will be moved to.
RenameFolder Method (Office365 Component)
Renames a folder.
Syntax
Remarks
This method renames a folder. This method will not update the Folders collection.
Reply Method (Office365 Component)
Reply to a message.
Syntax
Remarks
This method can be used to quickly reply to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:
Property | Default if not set |
MessageBcc | Blank |
MessageBodyContent | Blank |
MessageBodyContentType | HTML |
MessageCc | Blank |
MessageDeliveryReceipt | False |
MessageFrom | Currently authenticated mailbox |
MessageImportance | Blank |
MessageReadReceipt | False |
MessageSubject | RE:" + original subject |
MessageTo | Original sender |
Example (Simple):
office365.ReplyAll(messageId, "Reply messageHTML");
Example (Advanced):
office365.MessageSubject = "Subject for the reply";
office365.MessageImportance = "Low";
office365.MessageCc = "Example@email.com";
office365.MessageBcc = "Example@email.com";
office365.MessageBodyContent = "Reply Message body";
office365.ReplyAll(messageId, "");
ReplyAll Method (Office365 Component)
ReplyAll to a message.
Syntax
Remarks
This method can be used to quickly reply all to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:
Property | Default if not set |
MessageBcc | Blank |
MessageBodyContent | Blank |
MessageBodyContentType | HTML |
MessageCc | Original CC recipients |
MessageDeliveryReceipt | False |
MessageFrom | Currently authenticated mailbox |
MessageImportance | Blank |
MessageReadReceipt | False |
MessageSubject | RE:" + original subject |
MessageTo | Original sender and recipients |
Example (Simple):
office365.ReplyAll(messageId, "ReplyAll messageHTML");
Example (Advanced):
office365.MessageSubject = "Subject for the reply";
office365.MessageImportance = "Low";
office365.MessageCc = "Example@email.com";
office365.MessageBcc = "Example@email.com";
office365.MessageBodyContent = "Reply Message body";
office365.ReplyAll(messageId, "");
Reset Method (Office365 Component)
This method will reset the component.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
Remarks
This method will reset the component's properties to their default values.
RetrieveAttachment Method (Office365 Component)
Retrieves a message attachment.
Syntax
public void RetrieveAttachment(string id, string attachmentId); Async Version public async Task RetrieveAttachment(string id, string attachmentId); public async Task RetrieveAttachment(string id, string attachmentId, CancellationToken cancellationToken);
Public Sub RetrieveAttachment(ByVal id As String, ByVal attachmentId As String) Async Version Public Sub RetrieveAttachment(ByVal id As String, ByVal attachmentId As String) As Task Public Sub RetrieveAttachment(ByVal id As String, ByVal attachmentId As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves an attachment. id specifies the message ID for the message the attachment is attached to.
The fetched attachment can be accessed through the Attachments collection. If the RequestNestedItemAttachments configuration setting is set to true (default false) and the attachment to be retrieved is an item attachment, the method will provide any nested attachments as well.
RetrieveMessage Method (Office365 Component)
Retrieves a message.
Syntax
public void RetrieveMessage(string id); Async Version public async Task RetrieveMessage(string id); public async Task RetrieveMessage(string id, CancellationToken cancellationToken);
Public Sub RetrieveMessage(ByVal id As String) Async Version Public Sub RetrieveMessage(ByVal id As String) As Task Public Sub RetrieveMessage(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves a message.
Information about the retrieved message can be accessed through the MessageInfo collection.
RetrieveMessageRaw Method (Office365 Component)
Retrieves the raw message of the specified message ID.
Syntax
public void RetrieveMessageRaw(string id); Async Version public async Task RetrieveMessageRaw(string id); public async Task RetrieveMessageRaw(string id, CancellationToken cancellationToken);
Public Sub RetrieveMessageRaw(ByVal id As String) Async Version Public Sub RetrieveMessageRaw(ByVal id As String) As Task Public Sub RetrieveMessageRaw(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the Message property.
Search Method (Office365 Component)
Search for messages.
Syntax
public void Search(string searchKey); Async Version public async Task Search(string searchKey); public async Task Search(string searchKey, CancellationToken cancellationToken);
Public Sub Search(ByVal searchKey As String) Async Version Public Sub Search(ByVal searchKey As String) As Task Public Sub Search(ByVal searchKey As String, cancellationToken As CancellationToken) As Task
Remarks
This method can be used to search for messages. Results are returned through the MessageInfo collection. searchKey specifies a string to be searched for.
SendCustomRequest Method (Office365 Component)
Send a custom HTTP request.
Syntax
public void SendCustomRequest(string HTTPMethod, string URL, string postData); Async Version public async Task SendCustomRequest(string HTTPMethod, string URL, string postData); public async Task SendCustomRequest(string HTTPMethod, string URL, string postData, CancellationToken cancellationToken);
Public Sub SendCustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String) Async Version Public Sub SendCustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String) As Task Public Sub SendCustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String, cancellationToken As CancellationToken) As Task
Remarks
This method can be used to send a custom HTTP request to the server.
SendDraft Method (Office365 Component)
Sends an existing draft.
Syntax
public void SendDraft(string id); Async Version public async Task SendDraft(string id); public async Task SendDraft(string id, CancellationToken cancellationToken);
Public Sub SendDraft(ByVal id As String) Async Version Public Sub SendDraft(ByVal id As String) As Task Public Sub SendDraft(ByVal id As String, cancellationToken As CancellationToken) As Task
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 collection 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.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.MessageAttachments.Add(new OLAttachment("test picture", "./test.txt"));
office365.MessageAttachments[0].IsInline = true;
office365.MessageAttachments[0].ContentId = "test1";
office365.AddAttachment(messageId, "", "");
office365.SendDraft(messageId);
SendMail Method (Office365 Component)
Sends a new email.
Syntax
public void SendMail(bool saveToSentItems); Async Version public async Task SendMail(bool saveToSentItems); public async Task SendMail(bool saveToSentItems, CancellationToken cancellationToken);
Public Sub SendMail(ByVal saveToSentItems As Boolean) Async Version Public Sub SendMail(ByVal saveToSentItems As Boolean) As Task Public Sub SendMail(ByVal saveToSentItems As Boolean, cancellationToken As CancellationToken) As Task
Remarks
This method sends a new message. Use the Message* (excluding MessageInfo collection and Message) to set the fields of the message that will be sent. To add an attachment, use the MessageAttachments collection to add the attachment information. As a note, the relevant collection are not cleared after the method is called. It is recommend to do so after calling this method.
Example: Simple Email
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.MessageSubject = "Subject";
office365.MessageBodyContentType = "html";
office365.MessageBodyContent = "<p>Body</p><img src='cid:test1'>";
office365.MessageTo = "email@example.com";
//Inline:
OLAttachment attachment1 = new OLAttachment("test picture", "./test.png");
attachment1.IsInline = true;
attachment1.ContentId = "test1";
office365.MessageAttachments.Add(attachment1);
//Normal:
OLAttachment attachment2 = new OLAttachment("test file", "./test.txt");
office365.MessageAttachments.Add(attachment2);
office365.SendMail(true);
SetAttachmentInStream Method (Office365 Component)
Sets an attachment using a stream.
Syntax
public void SetAttachmentInStream(int index, System.IO.Stream inputStream); Async Version public async Task SetAttachmentInStream(int index, System.IO.Stream inputStream); public async Task SetAttachmentInStream(int index, System.IO.Stream inputStream, CancellationToken cancellationToken);
Public Sub SetAttachmentInStream(ByVal Index As Integer, ByVal InputStream As System.IO.Stream) Async Version Public Sub SetAttachmentInStream(ByVal Index As Integer, ByVal InputStream As System.IO.Stream) As Task Public Sub SetAttachmentInStream(ByVal Index As Integer, ByVal InputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task
Remarks
This method allows for setting an attachment in the MessageAttachments collection through a stream using the InputStream parameter. The Index parameter specifies which attachment in the MessageAttachments collection the stream will affect.
Note: When multiple attachment sources are provided, the component prioritizes the input stream first, followed by the file path and finally the raw data.
Example (Adding an Attachment via Input Stream to a New Draft)
office365.MessageSubject = "Subject Text";
office365.MessageImportance = "High";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Body Text";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
String messageId = office365.MessageInfo[0].Id;
office365.MessageAttachments.Add(new OLAttachment("attachment1.txt"));
office365.SetAttachmentInStream(0, new FileStream("C:\attachment1.txt", FileMode.Open));
office365.AddAttachment(messageId, "", "");
office365.SendDraft(messageId);
Example (Adding an Attachment via Input Stream to a Message)
office365.MessageSubject = "I saw a Tree";
office365.MessageImportance = "High";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked.";
office365.MessageTo = "TreeLookOut@gmail.com";
office365.MessageAttachments.Add(new OLAttachment("attachment1.txt"));
office365.SetAttachmentInStream(0, new FileStream("C:\attachment1.txt", FileMode.Open));
office365.SendMail(true);
SetContactField Method (Office365 Component)
Sets the contact field value by JSONPath.
Syntax
public void SetContactField(int index, string jsonPath, string value, int valueType); Async Version public async Task SetContactField(int index, string jsonPath, string value, int valueType); public async Task SetContactField(int index, string jsonPath, string value, int valueType, CancellationToken cancellationToken);
Public Sub SetContactField(ByVal index As Integer, ByVal JsonPath As String, ByVal Value As String, ByVal ValueType As Integer) Async Version Public Sub SetContactField(ByVal index As Integer, ByVal JsonPath As String, ByVal Value As String, ByVal ValueType As Integer) As Task Public Sub SetContactField(ByVal index As Integer, ByVal JsonPath As String, ByVal Value As String, ByVal ValueType As Integer, cancellationToken As CancellationToken) As Task
Remarks
This method updates a specific field within the contact's JSON representation. The parameters for this method are as follows: the first parameter, index, is an integer representing the index of the contact in the Contacts collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:
- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)
- 6 (Raw)
Example (Set/Edit Fields of a Contact before Updating):
// Create a contact in the main contacts folder.
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");
// Set company name
office365.SetContactField(0, "/json/companyName", "nsoftware", 2); // 2 (String)
// Set home address
office365.SetContactField(0,
"/json/businessAddress",
"{ \"city\": \"string\", \"countryOrRegion\": \"string\", \"postalCode\": \"string\", \"state\": \"string\", \"street\": \"string\" }",
0); // 0 (Object)
office365.SetContactField(0,
"/json/emailAddresses",
"[{"name": "Garth", "address": "garth@contoso.com"}, {"name": "Garth", "address": "garth1@contoso.com"}]",
1); // 1 (Array)
// Update the contact
office365.UpdateContact(0);
Update Method (Office365 Component)
Updates a message.
Syntax
public void Update(string id); Async Version public async Task Update(string id); public async Task Update(string id, CancellationToken cancellationToken);
Public Sub Update(ByVal id As String) Async Version Public Sub Update(ByVal id As String) As Task Public Sub Update(ByVal id As String, cancellationToken As CancellationToken) As Task
Remarks
This property updates a message that has been edited in the MessageInfo collection. The id takes the message's ID that should be updated. The following values can be updated from the OLMessageInfo type:
Field | Draft Only |
Bcc | False |
BodyContent | True |
BodyContentType | True |
Cc | False |
FlagStatus | False |
From | False |
Importance | False |
isDeliveryReceiptRequested | False |
isRead | False |
isReadReceiptRequested | False |
JSON | False |
ReplyTo | True |
Subject | True |
To | False |
*Changing the JSON data will change the message as a whole.
Example (Reply Draft)
// Create the reply draft
string originalMessageId = "Message ID";
office365.CreateDraft(1, originalMessageId);
// Set the new draft MessageInfo fields with desired options
office365.MessageInfo[0].To = "email@example.com";
office365.MessageInfo[0].Subject = "Subject Text";
office365.MessageInfo[0].BodyContentType = "TEXT";
office365.MessageInfo[0].BodyContent = "Body Text";
// Update the draft
office365.Update(office365.MessageInfo[0].Id);
// Send the draft
office365.SendDraft(office365.MessageInfo[0].Id);
UpdateCategory Method (Office365 Component)
Updates a category.
Syntax
Remarks
This method changes an existing category's color. This method will not update the Categories collection.
UpdateContact Method (Office365 Component)
Updates a contact.
Syntax
public void UpdateContact(int index); Async Version public async Task UpdateContact(int index); public async Task UpdateContact(int index, CancellationToken cancellationToken);
Public Sub UpdateContact(ByVal index As Integer) Async Version Public Sub UpdateContact(ByVal index As Integer) As Task Public Sub UpdateContact(ByVal index As Integer, cancellationToken As CancellationToken) As Task
Remarks
This method allows you to update an existing contact. The index parameter specifies the position of the contact in the Contacts collection. The method uses this index to take all the data from the specified contact and update the corresponding contact on the server.
To update a contact, edit the desired contact fields within the Contacts collection. Then, call the UpdateContact method with the index of the contact. Note that changing the JSON data will overwrite the entire contact, ignoring other field edits made before setting the JSON.
The OLContact type used in the Contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add another field, you can use the SetContactField method.
Example:
office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");// Create a contact in the main contacts folder.
// Set a company name
office365.Contacts[0].CompanyName = "Volkswagen";
// Set notes
office365.Contacts[0].Notes = "testNotes";
// Set multiple phone numbers
office365.Contacts[0].PhonesCount = 2;
office365.Contacts[0].PhoneIndex = 0;
office365.Contacts[0].PhoneType = TOLPhoneTypes.ptMobile;
office365.Contacts[0].PhoneNumber = "0123456789";
office365.Contacts[0].PhoneIndex = 1;
office365.Contacts[0].PhoneType = TOLPhoneTypes.ptBusiness;
office365.Contacts[0].PhoneNumber = "9876543210";
// Set birthday
office365.SetContactField(0, "/json/birthday", "2024-05-21", 2); // The last argument is the type of the field. 2 (String)
// Set home address
office365.SetContactField(0, "/json/businessAddress", "{ \"city\": \"string\", \"countryOrRegion\": \"string\", \"postalCode\": \"string\", \"state\": \"string\", \"street\": \"string\" }", 0); // The last argument is the type of the field. 0 (Object)
// Update the contact
office365.UpdateContact(0);
AttachmentList Event (Office365 Component)
Fired when an attachment is retrieved from the server.
Syntax
public event OnAttachmentListHandler OnAttachmentList; public delegate void OnAttachmentListHandler(object sender, Office365AttachmentListEventArgs e); public class Office365AttachmentListEventArgs : EventArgs { public string Id { get; } public string Name { get; } public string ContentType { get; } public string ContentLocation { get; } public string ContentBytes { get; }
public byte[] ContentBytesB { get; } public string ContentId { get; } public string LastModifiedDateTime { get; } public bool IsInline { get; } public int Size { get; } }
Public Event OnAttachmentList As OnAttachmentListHandler Public Delegate Sub OnAttachmentListHandler(sender As Object, e As Office365AttachmentListEventArgs) Public Class Office365AttachmentListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property Name As String Public ReadOnly Property ContentType As String Public ReadOnly Property ContentLocation As String Public ReadOnly Property ContentBytes As String
Public ReadOnly Property ContentBytesB As Byte() Public ReadOnly Property ContentId As String Public ReadOnly Property LastModifiedDateTime As String Public ReadOnly Property IsInline As Boolean Public ReadOnly Property Size As Integer End Class
Remarks
The AttachmentList event is fired for each attachment retrieved from the server when ListAttachments is called.
CategoryList Event (Office365 Component)
Fired when an attachment is retrieved from the server.
Syntax
public event OnCategoryListHandler OnCategoryList; public delegate void OnCategoryListHandler(object sender, Office365CategoryListEventArgs e); public class Office365CategoryListEventArgs : EventArgs { public string Id { get; } public string DisplayName { get; } public string Color { get; } }
Public Event OnCategoryList As OnCategoryListHandler Public Delegate Sub OnCategoryListHandler(sender As Object, e As Office365CategoryListEventArgs) Public Class Office365CategoryListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property DisplayName As String Public ReadOnly Property Color As String End Class
Remarks
The CategoryList event is fired for each attachment retrieved from the server when ListCategories is called.
ContactFolderList Event (Office365 Component)
Fired when a contact folder is retrieved by the server.
Syntax
public event OnContactFolderListHandler OnContactFolderList; public delegate void OnContactFolderListHandler(object sender, Office365ContactFolderListEventArgs e); public class Office365ContactFolderListEventArgs : EventArgs { public string Id { get; } public string Name { get; } public string ParentFolderId { get; } }
Public Event OnContactFolderList As OnContactFolderListHandler Public Delegate Sub OnContactFolderListHandler(sender As Object, e As Office365ContactFolderListEventArgs) Public Class Office365ContactFolderListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property Name As String Public ReadOnly Property ParentFolderId As String End Class
Remarks
The ContactFolderList event is fired for each contact folder retrieved from the server when ListContactFolders is called.
ContactList Event (Office365 Component)
Fired when a contact is retrieved from the server.
Syntax
public event OnContactListHandler OnContactList; public delegate void OnContactListHandler(object sender, Office365ContactListEventArgs e); public class Office365ContactListEventArgs : EventArgs { public string Id { get; } public string ParentId { get; } public string DisplayName { get; } public string FirstEmail { get; } }
Public Event OnContactList As OnContactListHandler Public Delegate Sub OnContactListHandler(sender As Object, e As Office365ContactListEventArgs) Public Class Office365ContactListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property ParentId As String Public ReadOnly Property DisplayName As String Public ReadOnly Property FirstEmail As String End Class
Remarks
The ContactList event is fired for each contact retrieved from the server when ListContacts is called. This event provides the contact's Id, DisplayName, FirstEmail address, and the ParentId of the folder containing the contact.
Error Event (Office365 Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, Office365ErrorEventArgs e); public class Office365ErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As Office365ErrorEventArgs) Public Class Office365ErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FolderList Event (Office365 Component)
Fired when a folder is retrieved by the server.
Syntax
public event OnFolderListHandler OnFolderList; public delegate void OnFolderListHandler(object sender, Office365FolderListEventArgs e); public class Office365FolderListEventArgs : EventArgs { public string Id { get; } public string DisplayName { get; } public string ParentFolderId { get; } public int ChildFolderCount { get; } public int UnreadItemCount { get; } public int TotalItemCount { get; } }
Public Event OnFolderList As OnFolderListHandler Public Delegate Sub OnFolderListHandler(sender As Object, e As Office365FolderListEventArgs) Public Class Office365FolderListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property DisplayName As String Public ReadOnly Property ParentFolderId As String Public ReadOnly Property ChildFolderCount As Integer Public ReadOnly Property UnreadItemCount As Integer Public ReadOnly Property TotalItemCount As Integer End Class
Remarks
The FolderList event is fired for each folder retrieved from the server when ListFolders is called.
Log Event (Office365 Component)
This event fires once for each log message.
Syntax
public event OnLogHandler OnLog; public delegate void OnLogHandler(object sender, Office365LogEventArgs e); public class Office365LogEventArgs : EventArgs { public int LogLevel { get; } public string Message { get; } public string LogType { get; } }
Public Event OnLog As OnLogHandler Public Delegate Sub OnLogHandler(sender As Object, e As Office365LogEventArgs) Public Class Office365LogEventArgs Inherits EventArgs Public ReadOnly Property LogLevel As Integer Public ReadOnly Property Message As String Public ReadOnly Property LogType As String End Class
Remarks
This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
MessageList Event (Office365 Component)
Fired when a message is retrieved from the server.
Syntax
public event OnMessageListHandler OnMessageList; public delegate void OnMessageListHandler(object sender, Office365MessageListEventArgs e); public class Office365MessageListEventArgs : EventArgs { public string Id { get; } public string Subject { get; } public string MessageSender { get; } public string ReceivedDateTime { get; } public string SentDateTime { get; } public bool HasAttachments { get; } public string BodyContentType { get; } public string BodyContent { get; } public string BodyPreview { get; } }
Public Event OnMessageList As OnMessageListHandler Public Delegate Sub OnMessageListHandler(sender As Object, e As Office365MessageListEventArgs) Public Class Office365MessageListEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property Subject As String Public ReadOnly Property MessageSender As String Public ReadOnly Property ReceivedDateTime As String Public ReadOnly Property SentDateTime As String Public ReadOnly Property HasAttachments As Boolean Public ReadOnly Property BodyContentType As String Public ReadOnly Property BodyContent As String Public ReadOnly Property BodyPreview As String End Class
Remarks
The MessageList event is fired for each message retrieved from the server when ListMessages is called.
SSLServerAuthentication Event (Office365 Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, Office365SSLServerAuthenticationEventArgs e); public class Office365SSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As Office365SSLServerAuthenticationEventArgs) Public Class Office365SSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Office365 Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, Office365SSLStatusEventArgs e); public class Office365SSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As Office365SSLStatusEventArgs) Public Class Office365SSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
Transfer Event (Office365 Component)
This event is fired while a document transfers (delivers document).
Syntax
public event OnTransferHandler OnTransfer; public delegate void OnTransferHandler(object sender, Office365TransferEventArgs e); public class Office365TransferEventArgs : EventArgs { public int Direction { get; } public long BytesTransferred { get; } public int PercentDone { get; } public string Text { get; }
public byte[] TextB { get; } }
Public Event OnTransfer As OnTransferHandler Public Delegate Sub OnTransferHandler(sender As Object, e As Office365TransferEventArgs) Public Class Office365TransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property BytesTransferred As Long Public ReadOnly Property PercentDone As Integer Public ReadOnly Property Text As String
Public ReadOnly Property TextB As Byte() End Class
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
string (read-only)
Default: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
string (read-only)
Default: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string (read-only)
Default: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
string (read-only)
Default: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
string
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte []
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
string (read-only)
Default: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string (read-only)
Default: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
string
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Public Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 0
This field 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. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
string
Default: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.
Password
string
Default: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.
Port
int
Default: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
string
Default: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
OAuthSettings Type
The settings to use to authenticate with the service provider.
Remarks
Used to set give the component the necessary information needed to complete OAuth authentication.
Fields
AccessToken
string
Default: ""
The access token returned by the authorization server. This is set when the component makes a request to the token server.
AuthorizationCode
string
Default: ""
The authorization code that is exchanged for an access token. This is required to be set when the ClientProfile field is set to the Web profile. Otherwise, this field is for information purposes only.
AuthorizationScope
string
Default: ""
The scope request or response parameter used during authorization.
ClientId
string
Default: ""
The id of the client assigned when registering the application.
ClientProfile
CloudOAuthClientProfiles
Default: 0
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
ClientSecret
string
Default: ""
The secret value for the client assigned when registering the application.
GrantType
OAuthSettingsGrantTypes
Default: 0
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
1 (cogtImplicit) | Implicit grant type |
2 (cogtPassword) | Resource Owner Password Credentials grant type |
3 (cogtClientCredentials) | Client Credentials grant type |
RefreshToken
string
Default: ""
Specifies the refresh token received from or sent to the authorization server. This field is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the GrantType field is set to a grant that can use refresh tokens.
RequestRefreshToken
bool
Default: True
Specifies whether the component will request a refresh token during authorization. By default, this value is True.
When True, the component will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this field will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This field is only applicable when the GrantType field is set to cogtAuthorizationCode.
ReturnURL
string
Default: ""
The URL where the user (browser) returns after authenticating. This field is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this field should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
ServerAuthURL
string
Default: ""
The URL of the authorization server.
ServerTokenURL
string
Default: ""
The URL of the token server used to obtain the access token.
WebAuthURL
string (read-only)
Default: ""
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
Constructors
public OAuthSettings();
Public OAuthSettings()
OLAttachment Type
Holds information about an attachment.
Remarks
Holds information about an attachment.
Fields
AttachmentType
string (read-only)
Default: ""
This field contains the attachment type of the attachment.
ContentId
string
Default: ""
This field contains the value of the unique content identifier of the attachment.
ContentLocation
string (read-only)
Default: ""
This field contains the content location of the attachment. It is generally null, as it is no longer supported in the Microsoft Graph API.
ContentType
string (read-only)
Default: ""
This field contains the content type of the attachment.
Data
string
Default: ""
This field contains the raw data of the attachment.
DataB
byte []
Default: ""
This field contains the raw data of the attachment.
FileName
string
Default: ""
This field contains the local file name associated with the attachment.
Id
string (read-only)
Default: ""
This field contains the attachment identifier of the attachment.
InputStream
System.IO.Stream
Default: ""
If InputStream is set, the data from the specified stream will be used for the attachment.
IsInline
bool
Default: False
This field is true if the attachment is an inline attachment.
LastModifiedDate
string
Default: ""
This field contains the date and time when the attachment was last modified.
Name
string
Default: ""
This field contains the name of the attachment.
ParentIndex
string (read-only)
Default: ""
Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. This index is generated by the component rather than by Microsoft and is designed to provide an intuitive mapping of the attachment structure.
If the attachment is a root attachment, then this index will be a single integer starting at 1. For the following intermediate and leaf attachments, the index will add a new integer separated by a . char.
For example, a message may contain the following attachments.
- RootFileAttachment.txt (1)
- RootItemAttachment (2)
- IntermediateFileAttachment.txt (2.1)
- IntermediateItemAttachment (2.2)
- LeafFileAttachment.txt (2.2.1)
Size
int
Default: 0
This field contains the size in bytes of the attachment.
Constructors
public OLAttachment();
Public OLAttachment()
public OLAttachment(string fileName);
Public OLAttachment(ByVal FileName As String)
public OLAttachment(string name, string fileName);
Public OLAttachment(ByVal Name As String, ByVal FileName As String)
public OLAttachment(string name, System.IO.Stream inputStream);
Public OLAttachment(ByVal Name As String, ByVal InputStream As System.IO.Stream)
OLCategory Type
Holds information about a category.
Remarks
Holds information about a category.
Fields
Color
string (read-only)
Default: ""
This field contains the color of the category.
DisplayName
string (read-only)
Default: ""
This field contains the display name of the category.
Id
string (read-only)
Default: ""
This field contains the unique identifier of the category.
Constructors
public OLCategory();
Public OLCategory()
OLContact Type
Holds information about a contact.
Remarks
Holds information about a contact.
Fields
CompanyName
string
Default: ""
The name of the contact's company.
DisplayName
string
Default: ""
The contact's display name.
EmailAddress
string
Default: ""
The email address at the specified EmailAddressIndex. For example, when updating a contact, setting EmailAddressIndex to 0 and then assigning "example@example.com" to this field will set the first email address of the contact. Similarly, when retrieving a contact, setting EmailAddressIndex to 0 allows you to read the first email address of the contact.
EmailAddressesCount
int
Default: 0
When retrieving contacts, it indicates the number of email addresses linked to the contact. When creating or updating a contact, this field is set to the number of email addresses the contact will have.
EmailAddressIndex
int
Default: 0
Index of email address to get or set in the EmailAddress field. For example, setting EmailAddressIndex to 0 and then assigning a value to this field sets the first email address of a contact. If you are retrieving a contact, setting EmailAddressIndex to 0, will populate EmailAddress with the first email address.
Example (Set the email addresses before updating a contact)
office365.Contacts[0].EmailAddressesCount = 2;
office365.Contacts[0].EmailAddressIndex = 0;
office365.Contacts[0].EmailAddress = "email1@domain1.com"; // set the first email address of the contact
office365.Contacts[0].EmailAddressIndex = 1;
office365.Contacts[0].EmailAddress = "email2@domain2.com"; // set the second email address of the contact
office365.UpdateContact(0);
Example (Read email addresses of a retrieved contact)
office365.GetContact(contactId);
OLContact lastContact = office365.Contacts[office365.Contacts.Count - 1];
for(int i = 0; i < lastContact.EmailAddressesCount; i++){
lastContact.EmailAddressIndex = i; // set the index of the next email to read
lastContact.EmailAddress; // read the next email address of the contact
}
FirstName
string
Default: ""
The contact's first name.
Id
string (read-only)
Default: ""
The unique identifier of the contact.
JSON
string
Default: ""
A JSON representation of the contact. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.
LastName
string
Default: ""
The contact's last name.
Notes
string
Default: ""
The user's notes about the contact.
ParentId
string
Default: ""
The ID of the contact's parent folder.
PhoneIndex
int
Default: 0
Index of phone number to get or set in the PhoneNumber field. For example, setting PhoneIndex to 0 and then assigning a value to this field sets the first phone number of a contact. If you are retrieving a contact, setting PhoneIndex to 0, will populate PhoneNumber with the first phone number.
Example (Set the phone numbers before updating a contact):
office365.Contacts[0].PhonesCount = 2;
office365.Contacts[0].PhoneIndex = 0;
office365.Contacts[0].PhoneNumber = "0123456789"; // set the first email address of the contact
office365.Contacts[0].PhoneIndex = 1;
office365.Contacts[0].PhoneNumber = "9876543210"; // set the second email address of the contact
office365.UpdateContact(0);
Example (Read phone numbers of a retrieved contact):
office365.GetContact(contactId);
OLContact lastContact = office365.Contacts[office365.Contacts.Count - 1];
for(int i = 0; i < lastContact.PhonesCount; i++){
lastContact.PhoneIndex = i; // set the index of the next phone number to read
lastContact.PhoneNumber; // read the next phone number of the contact
}
PhoneNumber
string
Default: ""
This field is used to get or set a phone number at the index specified by PhoneIndex. For example, setting PhoneIndex to 0 and then assigning "0123456789" to this field sets the first phone number of the contact. Similarly, after setting PhoneIndex to 0 you can read the first phone number of the contact.
PhonesCount
int
Default: 0
Number of the contact's phone numbers.
When retrieving contacts, this field indicates the number of phone numbers linked to the contact. When updating a contact, this field is set to the number of phone numbers to be linked to the contact.
PhoneType
TOLPhoneTypes
Default: 0
The phone number type.
This field indicates the type of a contact's phone number selected by PhoneIndex. Possible values are:
- 0 (optHome)
- 1 (optBusiness)
- 2 (optMobile)
Constructors
OLContactFolder Type
Holds information about a contact folder.
Remarks
Holds information about a contact folder.
Fields
Id
string (read-only)
Default: ""
The unique identifier of the contact folder.
Name
string (read-only)
Default: ""
The display name of the contact folder.
ParentFolderId
string (read-only)
Default: ""
The unique identifier for the folder's parent.
Constructors
public OLContactFolder();
Public OLContactFolder()
OLFolder Type
Holds information about a folder.
Remarks
Holds information about a folder.
Fields
ChildFolderCount
int (read-only)
Default: 0
The number of child folders the folder has.
ChildFolders
string (read-only)
Default: ""
The child folders of the folder.
DisplayName
string (read-only)
Default: ""
The display name of the folder.
Id
string (read-only)
Default: ""
The unique identifier of the folder.
MessageRules
string (read-only)
Default: ""
The message rules of the folder.
Messages
string (read-only)
Default: ""
The messages contained in the folder.
MultiValueExtendedProperties
string (read-only)
Default: ""
The multi-value extended properties defined for the folder.
ParentFolderId
string (read-only)
Default: ""
The unique identifier for the folder's parent.
SingleValueExtendedProperties
string (read-only)
Default: ""
The single-value extended properties defined for the folder.
TotalItemCount
int (read-only)
Default: 0
The number of total items in the folder.
UnreadItemCount
int (read-only)
Default: 0
The number of unread items in the folder.
Constructors
OLMessageInfo Type
Holds information about a message.
Remarks
Holds information about a message.
Fields
Bcc
string
Default: ""
The BCc recipients of a message in a message info listing.
BodyContent
string
Default: ""
The body content of a message in a message info listing.
BodyContentType
string
Default: ""
The body content type (e.g. "HTML") of a message in a message info listing.
BodyPreview
string (read-only)
Default: ""
The body preview of a message in a message info listing.
Categories
string
Default: ""
The categories of a message in a message info listing.
Cc
string
Default: ""
The Cc recipients of a message in a message info listing.
ConversationId
string (read-only)
Default: ""
The conversation unique identifier of a message in a message info listing.
ConversationIndex
string (read-only)
Default: ""
The conversation index of a message in a message info listing.
CreatedDate
string (read-only)
Default: ""
The date created of a message in a message info listing.
DeliveryReceiptRequested
bool
Default: False
Whether or not a delivery receipt was requested for a message in a message info listing.
FlagStatus
string
Default: ""
Message flag in a message info listing. Example values include:
notFlagged | |
complete | |
flagged |
From
string (read-only)
Default: ""
The sender of a message in a message info listing.
HasAttachments
bool (read-only)
Default: False
Whether or not a message in a message info listing has attachments.
Id
string (read-only)
Default: ""
The unique identifier of a message in a message info listing set by Microsoft.
Importance
string
Default: ""
The importance of a message in a message info listing.
InferenceClassification
string (read-only)
Default: ""
The inference classification of a message in a message info listing.
IsDraft
bool (read-only)
Default: False
Whether or not a message in a message info listing is a draft.
IsRead
bool
Default: False
Whether or not a message in a message info listing has been read.
JSON
string
Default: ""
The full JSON content of a message in a message info listing.
LastModifiedDate
string (read-only)
Default: ""
The last modified date of a message in a message info listing.
MessageHeaders
string (read-only)
Default: ""
The message headers of a message in a message info listing.
MessageId
string (read-only)
Default: ""
The internet message id for the message as described by rfc2822.
ParentFolderId
string (read-only)
Default: ""
The unique identifier of the parent folder of a message in a message info listing.
ReadReceiptRequested
bool
Default: False
Whether or not a read receipt was requested for a message in a message info listing.
ReceivedDate
string (read-only)
Default: ""
The received date of a message in a message info listing.
ReplyTo
string
Default: ""
Where to send replies for a message in a message info listing.
Sender
string (read-only)
Default: ""
The sender of a message in a message info listing.
SentDate
string (read-only)
Default: ""
The date a message was sent for a message in a message info listing.
Subject
string
Default: ""
The subject of a message in a message info listing.
To
string
Default: ""
The recipients of a message in a message info listing.
WebLink
string (read-only)
Default: ""
The URL to open a message in a message info listing in Outlook on the web.
Constructors
public OLMessageInfo();
Public OLMessageInfo()
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
ProxyAuthSchemes
Default: 0
This field is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password
string
Default: ""
This field contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default: 80
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
string
Default: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
ProxySSLTypes
Default: 0
This field 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 component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
User
string
Default: ""
This field contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
Config Settings (Office365 Component)
The component 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 component, access to these internal properties is provided through the Config method.Office365 Config Settings
The default value is 2097152 (2MiBs).
The default value is 2097152 (2MiBs).
The default value is 100.
The default value is 100.
The default value is 100.
At this time, Microsoft does not support nested attachments in item attachments. Once support is added, this may be set to True to include these attachments with the AddItemAttachment request.
Example (List All Contact Folders in the Root Directory)
do
{
office365.ListContactFolders("");
} while (office365.Config("ListContactFoldersMarker").Length > 0);
The default value is 100.
component.Config("MIMEMessage" + MIME_MESSAGE);
component.SendMail();
The default value is 0.
Example:
component.Config("QueryParamCount=1");
component.Config("QueryParamName[0]=Select");
component.Config("QueryParamValue[0]=name");
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
For example, when using the Authorization Code grant type, the RefreshToken field should be set to a valid refresh token. When using the Client Credential grant type however, the component does not need any additional properties set as it can already get a new access token without user interaction.
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.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
Description | JSON XPath |
Document root | /json |
Specific element | /json/element_one |
Username Claim (Microsoft Specific) | /json/preferred_username |
Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see OAuthJWTXText.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
Additionally, this will also be updated to hold the parameters returned in the response.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the component 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 ReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.
The OAuthWebServerCertStoreType field 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 field in order to specify the certificate to be used during SSL.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Note: This is required when OAuthWebServerSSLEnabled is set to true.
Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.
0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
1 | Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java. |
2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java. |
5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java. |
6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Note: This is required when OAuthWebServerSSLEnabled is set to true.
The default value is localhost.
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.
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 component throws an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the component 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/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
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 component beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
The value is formatted as a list of paths separated by semicolons. The component 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 as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
If set to True, the component 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 component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component 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
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- 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.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components 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 applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Tells the component whether or not to use FIPS certified APIs.When set to true, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all 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 that applies to all instances of all components 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 applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components 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 applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Tells the component whether or not to use FIPS certified APIs.When set to true, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all 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 that applies to all instances of all components 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 applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (Office365 Component)
Office365 Errors
1301 | Invalid Input Error. |