Show / Hide Table of Contents

Mail.ReadBasic

Allows the app to read email in the signed-in user's mailbox except body, previewBody, attachments and any extended properties.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 D GET /me/mailFolders
V1 D GET /me/mailFolders/{id}
V1 D GET /me/mailFolders/{id}/childFolders
V1 D GET /me/mailFolders/{id}/messages
V1 D GET /me/mailFolders/{id}/messages/{id}
V1 D GET /me/mailFolders/{id}/messages/delta
V1 D GET /me/mailFolders/delta
V1 D GET /me/messages
V1 D GET /me/messages/{id}
V1 D GET /users/{id | userPrincipalName}/mailFolders
V1 D GET /users/{id | userPrincipalName}/mailFolders/{id}
V1 D GET /users/{id | userPrincipalName}/mailFolders/{id}/childFolders
V1 D GET /users/{id | userPrincipalName}/mailFolders/{id}/messages
V1 D GET /users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}
V1 D GET /users/{id | userPrincipalName}/messages
V1 D GET /users/{id | userPrincipalName}/messages/{id}
V1 D GET /users/{id}/mailFolders/{id}/messages/delta
V1 D GET /users/{id}/mailFolders/delta

Delegate Permission

Id a4b8392a-d8d1-4954-a029-8e668a39a170
Consent Type User
Display String Read user basic mail
Description Allows the app to read email in the signed-in user's mailbox except body, previewBody, attachments and any extended properties.

Application Permission

Id 6be147d2-ea4f-4b5a-a3fa-3eab6f3c140a
Display String Read basic mail in all mailboxes
Description Allows the app to read basic mail properties in all mailboxes without a signed-in user. Includes all properties except body, previewBody, attachments and any extended properties.

Resources

mailFolder

Property Type Description
childFolderCount Int32 The number of immediate child mailFolders in the current mailFolder.
displayName String The mailFolder's display name.
id String The mailFolder's unique identifier.
isHidden Boolean Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
parentFolderId String The unique identifier for the mailFolder's parent mailFolder.
totalItemCount Int32 The number of items in the mailFolder.
unreadItemCount Int32 The number of items in the mailFolder marked as unread.

mailSearchFolder

Property Type Description
filterQuery String The OData query to filter the messages.
includeNestedFolders Boolean Indicates how the mailbox folder hierarchy should be traversed in the search. true means that a deep search should be done to include child folders in the hierarchy of each folder explicitly specified in sourceFolderIds. false means a shallow search of only each of the folders explicitly specified in sourceFolderIds.
isSupported Boolean Indicates whether a search folder is editable using REST APIs.
sourceFolderIds String collection The mailbox folders that should be mined.

mention

Property Type Description
application String The name of the application where the mention is created. Optional. Not used and defaulted as null for message.
clientReference String A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.
createdBy emailAddress The email information of the user who made the mention.
createdDateTime DateTimeOffset The date and time that the mention is created on the client.
deepLink String A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.
id String The unique identifier of a mention in a resource instance.
mentioned emailAddress The email information of the mentioned person. Required.
mentionText String Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.
serverCreatedDateTime DateTimeOffset The date and time that the mention is created on the server. Optional. Not used and defaulted as null for **m

message

Property Type Description
bccRecipients recipient collection The Bcc: recipients for the message.
body itemBody The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
bodyPreview String The first 255 characters of the message body. It is in text format.
categories String collection The categories associated with the message.
ccRecipients recipient collection The Cc: recipients for the message.
changeKey String The version of the message.
conversationId String The ID of the conversation the email belongs to.
conversationIndex Edm.Binary Indicates the position of the message within the conversation.
createdDateTime DateTimeOffset The date and time the message was created.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
flag followupFlag The flag value that indicates the status, start date, due date, or completion date for the message.
from recipient The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
hasAttachments Boolean Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src="cid:[email protected]">.
id String Unique identifier for the message. !INCLUDE [outlook-beta-id] Read-only.
importance importance The importance of the message. The possible values are: low, normal, and high.
inferenceClassification inferenceClassificationType The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.
internetMessageHeaders internetMessageHeader collection A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message.

Returned only on applying a $select query option. Read-only.
internetMessageId String The message ID in the format specified by RFC2822.
isDeliveryReceiptRequested Boolean Indicates whether a read receipt is requested for the message.
isDraft Boolean Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
isRead Boolean Indicates whether the message has been read.
isReadReceiptRequested Boolean Indicates whether a read receipt is requested for the message.
lastModifiedDateTime DateTimeOffset The date and time the message was last changed.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
parentFolderId String The unique identifier for the message's parent mailFolder.
receivedDateTime DateTimeOffset The date and time the message was received.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
replyTo recipient collection The email addresses to use when replying.
sender recipient The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
sentDateTime DateTimeOffset The date and time the message was sent.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
subject String The subject of the message.
toRecipients recipient collection The To: recipients for the message.
uniqueBody itemBody The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format.
webLink String The URL to open the message in Outlook on the web.

You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser will show the message in the Outlook on the web review pane.

The message will open in the browser if you are logged in to your mailbox via Outlook on the web. You will be prompted to login if you are not already logged in with the browser.

This URL cannot be accessed from within an iFrame.
In This Article
Back to top Created by merill | Submit feedback