Cloud Mail 2020 Kotlin Edition

Questions / Feedback?

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 Microsoft's Graph API. 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-VrXSsxEZu5p0pclxGdKKQ
Assign 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 = "mkk2a2M-B5TQI7o5p_N0fR-CHYVn7e3yH~";
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 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 = "I am sending an email.";
office365.MessageImportance = "Low";
office365.MessageBodyContentType = "TEXT";
office365.MessageBodyContent = "Just wanted to let you know.";
office365.MessageTo = "reader@tautology.org";

office365.CreateDraft(0, "");
string messageId = office365.MessageInfo[0].Id;

office365.SendDraft(messageId)

Receiving Messages

Information about messages fetched by the component can be accessed through the MessageInfo collection. MessageInfo is populated when the ListMessages, GetMessage, 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 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.

AttachmentsCollection of attachments listed by the server.
AuthorizationAn OAuth Authorization String.
CategoriesCollection of attachments listed by the server.
ChangeMarkerThe page marker for listing changed messages.
FirewallA set of properties related to firewall access.
FoldersCollection of folders listed by the server.
ListFoldersMarkerThe page marker for listing folders.
ListMessagesMarkerThe page marker for listing folders.
MessageAttachmentsA semicolon separated list of files to attach to a message.
MessageBccA comma separated list of recipients for blind carbon copies for a message.
MessageBodyContentThe body content for a message.
MessageBodyContentTypeThe body content type for a message.
MessageCcA comma separated list of recipients for carbon copies for a message.
MessageDeliveryReceiptWhether a message will request a Delivery Receipt.
MessageFromThe author of a message.
MessageImportanceThe importance of a message.
MessageInfoCollection of information about retrieved messages.
MessageReadReceiptWhether a message will request a Read Receipt.
MessageReplyToA mail address to reply to.
MessageSubjectThe subject of a message.
MessageToA comma separated list of recipients for a message.
NextChangeMarkerA marker indicating what page of changes to return in the future.
SelectThe 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.

AddAttachmentAdds an attachment to an existing message.
ConfigSets or retrieves a configuration setting.
CopyCreates a copy of a message.
CopyFolderCopies a folder.
CreateCategoryCreates a new category.
CreateDraftCreates a new email draft.
CreateFolderCreates a new folder.
DeleteDeletes a message.
DeleteAttachmentDeletes an Attachment.
DeleteCategoryDeletes a mail category.
DeleteFolderDeletes a Folder.
ForwardForwards a message.
GetAttachmentRetrieves a message attachment.
GetCategoryRetrieves a mail category.
GetFolderRetrieves a folder.
GetMessageRetrieves a Message.
ListAttachmentsLists all of a message's attachments.
ListCategoriesLists all mail categories.
ListChangesLists messages that have been changed within a specified folder.
ListFoldersLists the folders found in the parent folder.
ListMessagesLists the messages in a folder.
MoveFolderMoves a folder.
MoveMessageMoves a Message.
RenameFolderRenames a Folder.
ReplyReplies to a message.
ReplyAllReply All to a message.
ResetReset the component.
SearchSearch for messages.
SendCustomRequestSend a custom HTTP request.
SendDraftSends an existing Draft.
SendMailSends a new email.
UpdateUpdates a message.
UpdateCategoryUpdates a category.

Event List


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

AttachmentListFired when an attachment is retrieved from the server.
CategoryListFired when an attachment is retrieved from the server.
ErrorInformation about errors during data delivery.
FolderListFired when a folder is retrieved by the server.
LogFires once for each log message.
MessageListFired when a message is retrieved from the server.
TransferFired 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.

FolderPageSizePage size for fetching folders.
MessagePageSizePage size for fetching messages.
PreferSpecifies a preferred content header type.
QueryParamCountThe number of custom OData Query Parameters.
QueryParamName[i]The name of a custom OData Query Parameter.
QueryParamValue[i]The value of a custom OData Query Parameter.

Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Kotlin Edition - Version 20.0 [Build 7941]