Interface IGraphClient
Contents
[
Hide
]IGraphClient interface
Represents the interface for Exchange REST client.
public interface IGraphClient : IDisposable
Properties
| Name | Description |
|---|---|
| EndPoint { get; set; } | Gets or sets Microsoft Graph REST API endpoint. If not specified, the default is “https://graph.microsoft.com”. |
| MultipleServicesTokenProvider { get; set; } | Gets or sets an object allows to retrieve OAuth access token. |
| Proxy { get; set; } | Gets or sets data to proxy access to Exchange server. |
| Resource { get; set; } | Gets or sets resource type. |
| ResourceId { get; set; } | Gets or sets resource id. For instance for users it may be user principal name (UPN) or user id |
| TenantId { get; set; } | Gets or sets tenant identifier |
| Timeout { get; set; } | Gets or sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). |
| TokenProvider { get; set; } | Gets or sets an object allows to retrieve OAuth access token. |
Methods
| Name | Description |
|---|---|
| CopyFolder(string, string) | Copy a mailfolder and its contents to another mailfolder. |
| CopyMessage(string, string) | Copy a Message to another mailfolder. |
| CopyNotebook(string, string, string) | Copies a notebook to the Notebooks folder in the destination Documents library. The folder is created if it doesn’t exist. For Copy operations, you follow an asynchronous calling pattern: First call the Copy action, and then poll the operation endpoint for the result. Permissions One of the following permissions is required to call this API. Delegated(work or school account) Notes.Create, Notes.ReadWrite, Notes.ReadWrite.All Delegated(personal Microsoft account) Notes.Create, Notes.ReadWrite Application Notes.ReadWrite.All |
| CreateAttachment(string, MapiAttachment) | Creates new attachment for specified item |
| CreateCalendarItem(string, MapiCalendar) | Creates MapiCalendar in specified calendar |
| CreateCategory(string, CategoryPreset) | Creates an OutlookCategory object in the user’s master list of categories. |
| CreateContact(string, MapiContact) | Creates contact in specified folder |
| CreateFolder(string) | Create new folder. |
| CreateFolder(string, string) | Create new folder. |
| CreateMessage(string, MailMessage) | Creates message in specified folder |
| CreateMessage(string, MapiMessage) | Creates message in specified folder |
| CreateNotebook(Notebook) | Create a new OneNote notebook. Permissions One of the following permissions is required to call this API. Delegated (work or school account) Notes.Create, Notes.ReadWrite, Notes.ReadWrite.All Delegated (personal Microsoft account) Notes.Create, Notes.ReadWrite Application Notes.ReadWrite.All |
| CreateOrUpdateOverride(ClassificationOverride) | Create an override for a sender identified by an SMTP address. Future messages from that SMTP address will be consistently classified as specified in the override. Note: - If an override already exists with the same SMTP address, then the classifyAs and name fields of that override are updated with the provided values. - The maximum number of overrides supported for a mailbox is 1000, based on unique sender SMTP addresses. Permissions: Delegated(work or school account) Mail.ReadWrite Delegated(personal Microsoft account) Mail.ReadWrite Application Mail.ReadWrite |
| CreateOrUpdateOverride(MailAddress, ClassificationType) | Create an override for a sender identified by an SMTP address. Future messages from that SMTP address will be consistently classified as specified in the override. Note: - If an override already exists with the same SMTP address, then the classifyAs and name fields of that override are updated with the provided values. - The maximum number of overrides supported for a mailbox is 1000, based on unique sender SMTP addresses. Permissions: Delegated(work or school account) Mail.ReadWrite Delegated(personal Microsoft account) Mail.ReadWrite Application Mail.ReadWrite |
| CreateRule(InboxRule) | Create a message rule by specifying a set of conditions and actions. Outlook carries out those actions if an incoming message in the user’s Inbox meets the specified conditions. Permissions: One of the following permissions is required to call this API.To learn more, including how to choose permissions, see Permissions. Delegated (work or school account) MailboxSettings.ReadWrite Delegated (personal Microsoft account) MailboxSettings.ReadWrite Application MailboxSettings.ReadWrite |
| CreateTask(MapiTask, string) | Creates Task in specified folder |
| CreateTaskList(TaskListInfo) | Creates new TaskList. |
| Delete(string) | Delete object. |
| DeleteAttachment(string) | Removes attachment |
| DeleteTaskList(string) | Delete TaskList. |
| FetchAttachment(string) | Gets attachment for specified id |
| FetchCalendarItem(string) | Gets MapiCalendar for specified id |
| FetchCategory(string) | Get the properties and relationships of the specified outlookCategory object. |
| FetchContact(string) | Gets MapiContact for specified id |
| FetchMessage(string) | Gets message in specified id |
| FetchNotebook(string) | Retrieve the properties and relationships of a notebook object. Permissions One of the following permissions is required to call this API. Delegated (work or school account) Notes.Create, Notes.Read, Notes.ReadWrite, Notes.Read.All, Notes.ReadWrite.All Delegated (personal Microsoft account) Notes.Create, Notes.Read, Notes.ReadWrite Application Notes.Read.All, Notes.ReadWrite.All |
| FetchRule(string) | Get the properties and relationships of a message rule object. Permissions One of the following permissions is required to call this API.To learn more, including how to choose permissions, see Permissions. Delegated (work or school account) MailboxSettings.Read Delegated (personal Microsoft account) MailboxSettings.Read Application MailboxSettings.Read |
| FetchTask(string) | Gets MapiTask for specified id |
| GetFolder(string) | Gets folder by an id. |
| GetOneNoteOperationStatus(string) | Get the status of a long-running OneNote operation. This applies to operations that return the Operation-Location header in the response, such as CopyNotebook, CopyToNotebook, CopyToSectionGroup, and CopyToSection. You can poll the Operation-Location endpoint until the status property returns completed or failed. If the status is completed, the resourceLocation property contains the resource endpoint URI. If the status is failed, the error and @api.diagnostics properties provide error information. |
| GetTaskList(string) | Gets TaskList by an id. |
| ListAttachments(string) | List Attachments from the parent message. |
| ListCalendarItems(string) | List MapiCalendar from the calendar. |
| ListCalendars() | List CalendarInfo items. |
| ListCategories() | Get all the categories that have been defined for the user. |
| ListContacts(string) | List MapiContact from the parent folder. |
| ListFolders() | List folders from the parent folder for folders that are displayed in normal mail clients, such as the inbox. |
| ListFolders(string) | List folders from the parent folder for folders that are displayed in normal mail clients, such as the inbox. |
| ListMessages(string) | List MessageInfo from the parent folder. |
| ListMessages(string, PageInfo, MailQuery) | List MessageInfo from the parent folder. |
| ListNotebooks() | Retrieve a list of notebook objects. Permissions One of the following permissions is required to call this API. Delegated (work or school account) Notes.Create, Notes.Read, Notes.ReadWrite, Notes.Read.All, Notes.ReadWrite.All Delegated (personal Microsoft account) Notes.Create, Notes.Read, Notes.ReadWrite Application Notes.Read.All, Notes.ReadWrite.All |
| ListOverrides() | Get the overrides that a user has set up to always classify messages from certain senders in specific ways. Each override corresponds to an SMTP address of a sender.Initially, a user does not have any overrides. Permissions: One of the following permissions is required to call this API.To learn more, including how to choose permissions, see Permissions. Delegated (work or school account) Mail.Read Delegated (personal Microsoft account) Mail.Read Application Mail.Read |
| ListRules() | Get all the messageRule objects defined for the user’s Inbox. Permissions One of the following permissions is required to call this API.To learn more, including how to choose permissions, see Permissions. Delegated (work or school account) MailboxSettings.Read Delegated (personal Microsoft account) MailboxSettings.Read Application MailboxSettings.Read |
| ListTaskLists() | List TaskList items. |
| ListTasks(string) | List MapiTask from the parent TaskList. |
| MoveFolder(string, string) | Move a mailfolder and its contents to another mailfolder. |
| MoveMessage(string, string) | Move a message to another mailfolder. |
| Send(MailMessage) | Sends email message |
| Send(MapiMessage) | Sends email message |
| Send(string) | Send a message in the draft folder. The draft message can be a new message draft, reply draft, reply-all draft, or a forward draft. The message is then saved in the Sent Items folder. |
| Send(MapiMessage, bool) | Sends email message |
| SendAsMime(MapiMessage) | Sends email message using MIME format |
| SetRead(string) | Mark message as read |
| UpdateCalendarItem(MapiCalendar) | Updates MapiCalendar |
| UpdateCalendarItem(MapiCalendar, UpdateSettings) | Updates appointment |
| UpdateCategory(OutlookCategory) | Updates pre-set color constant for specified category |
| UpdateContact(MapiContact) | Updates contact |
| UpdateFolder(FolderInfo) | Updates folder. |
| UpdateMessage(MailMessage) | Updates message |
| UpdateMessage(MapiMessage) | Updates message |
| UpdateMessage(MailMessage, UpdateSettings) | Updates message |
| UpdateMessage(MapiMessage, UpdateSettings) | Updates message |
| UpdateOverride(ClassificationOverride) | Change the classifyAs field of an override as specified. You cannot use this method to change any other fields in an ClassificationOverride instance. If an override exists for a sender and the sender changes his/her display name, you can use CreateOrUpdateOverride to force an update to the name field in the existing override. If an override exists for a sender and the sender changes his/her SMTP address, deleting the existing override and creating a new one with the new SMTP address is the only way to “update” the override for this sender. Permissions: One of the following permissions is required to call this API.To learn more, including how to choose permissions, see Permissions. Delegated (work or school account) Mail.ReadWrite Delegated (personal Microsoft account) Mail.ReadWrite Application Mail.ReadWrite |
| UpdateRule(InboxRule) | Change writable properties on a messageRule object and save the changes. Permissions One of the following permissions is required to call this API.To learn more, including how to choose permissions, see Permissions. Delegated (work or school account) MailboxSettings.ReadWrite Delegated (personal Microsoft account) MailboxSettings.ReadWrite Application MailboxSettings.ReadWrite |
| UpdateTask(MapiTask) | Updates Task |
| UpdateTask(MapiTask, UpdateSettings) | Updates Task |
| UpdateTaskList(TaskListInfo) | Updates TaskList. |
See Also
- namespace Aspose.Email.Clients.Graph
- assembly Aspose.Email
