Office365 Component
Properties Methods Events Configuration Settings Errors
The Office365 component provides an easy way to manage sending and receiving mail in Microsoft 365.
Syntax
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 component or a separate process. Once complete you should have an authorization string which looks like:
Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQAssign this value to the Authorization property before attempting any operations. For Example:
Oauth oauth = new Oauth();
oauth.ClientId = "3c65828c-6376-4286-91b5-2381c3904a97";
oauth.ClientSecret = "fMI7Q~SmDkDGujXXQkKtaNE5hBQID0SIBmmwP";
oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth.AuthorizationScope = "user.read mail.readwrite mail.send mailboxsettings.readwrite";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
office365.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Sending Messages
There are two methods for sending new messages using the Office365 component. The SendMail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the SendDraft method. In both cases the properties of the new message are assigned through the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.).
Sending a Message with SendDraft:
office365.MessageSubject = "Subject Text";
office365.MessageImportance = "Low";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Body Text.";
office365.MessageTo = "email@example.com";
office365.CreateDraft(0, "");
string messageId = office365.MessageInfo[0].Id;
office365.SendDraft(messageId);
There are also methods for replying or forwarding messages using the Office365 component. The Reply, ReplyAll, and Forward method will send a reply or forward directly. Similarly, you can create a reply or forward draft and then send an existing draft using the SendDraft method. Unlike creating a new message, only the direct methods use the Message properties (MessageSubject, MessageBodyContent, MessageCc, etc.). When using CreateDraft, the draft must first be made then updated using the MessageInfo 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, FetchMessage, Search, or ListChanges methods are called.
The ListMessages and ListChanges methods will respectively list the messages or changed messages in a folder specified by a folderId. To get the ID of a folder, folders can be traversed and read using the ListFolders method and the 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. |
Firewall | A set of properties related to firewall access. |
Folders | Collection of folders listed by the server. |
ListFoldersMarker | The page marker for listing folders. |
ListMessagesMarker | The page marker for listing folders. |
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. |
Proxy | A set of properties related to proxy access. |
Select | The parts of a message that should be retrieved. |
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 an attachment to an existing message. |
config | Sets or retrieves a configuration setting. |
copy | Creates a copy of a message. |
copyFolder | Copies a folder. |
createCategory | Creates a new category. |
createDraft | Creates a new email draft. |
createFolder | Creates a new folder. |
delete | Deletes a message. |
deleteAttachment | Deletes an attachment. |
deleteCategory | Deletes a mail category. |
deleteFolder | Deletes a folder. |
fetchAttachment | Retrieves a message attachment. |
fetchMessage | Retrieves a message. |
fetchMessageRaw | Retrieves the raw message of the specified message ID. |
forward | Forward a message. |
getCategory | Retrieves a mail category. |
getFolder | Retrieves a folder. |
listAttachments | Lists all of a message's attachments. |
listCategories | Lists all mail categories. |
listChanges | Lists messages that have been changed within a specified 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 | Reset the component. |
search | Search for messages. |
sendCustomRequest | Send a custom HTTP request. |
sendDraft | Sends an existing draft. |
sendMail | Sends a new email. |
update | Updates a message. |
updateCategory | Updates a category. |
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. |
Error | Information about errors during data delivery. |
FolderList | Fired when a folder is retrieved by the server. |
Log | Fires once for each log message. |
MessageList | Fired when a message is retrieved from the server. |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AttachmentFragmentSize | Size of fragments when uploading large attachments. |
AttachmentSimpleUploadLimit | The threshold to use simple uploads. |
FetchMIMEMessage | Fetch MIME encoded message. |
FolderPageSize | Page size for fetching 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. |
UserId | Sets the Id of a shared mailbox to connect to. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XText | The text of the current element. |
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. |
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. |
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 (IPPort 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. |
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 use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
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. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
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. |