Office365 Class
Properties Methods Events Configuration Settings Errors
The Office365 class provides an easy way to manage sending and receiving mail in Microsoft 365.
Syntax
cloudmail.Office365
Remarks
This class provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the class, first set the Authorization property to a valid OAuth token. The Office365 class can be used for sending or creating new messages; retrieving, moving, or copying existing messages; creating, deleting, or copying folders; and several other functionalities supported by the Microsoft Graph API.
This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class 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 class 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 | TBD. |
| 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 class 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 class. |
| 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 class 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 class 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. |
| FolderPageSize | Page size for fetching folders. |
| MessagePageSize | Page size for fetching messages. |
| 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. |