EndPoint Get Messages
Name
get_messages
Description
Get the mail messages for the specified user ID or email address.
[API Help]
Parameters
Parameter |
Label |
Required |
Options |
Description |
UserId |
User ID or Email |
YES |
|
The Microsoft Mail user ID GUID or email address for the account to read messages from. (Examples: '4ff54a77-9c09-4274-958f-83bdc0a53900' or 'first.last@domain.com')
|
SearchCriteria |
Search Criteria |
NO |
Option |
Value |
None |
|
Has Attachments, Sent After, and Subject containing 'party' |
hasAttachments eq true and sentDateTime gt 2023-03-01 and contains(subject, 'party') |
Received before |
receivedDateTime lt 2023-02-01 |
Sent after |
sentDateTime gt 2023-03-01 |
Has attachment(s) |
hasAttachments eq true |
Subject contains 'case' |
contains(subject, 'case') |
Subject starts with 'Your' |
startsWith(subject, 'Your') |
Subject does not start with 'Your' |
not(startsWith(subject, 'Your')) |
Only normal importance |
importance eq 'normal' |
Only low importance |
importance eq 'low' |
Only high importance |
importance eq 'high' |
Only if delivery receipt requested |
isDeliveryReceiptRequested eq true |
Only if delivery receipt not requested |
isDeliveryReceiptRequested eq false |
Only if read receipt requested |
isReadReceiptRequested eq true |
Only if read receipt not requested |
isReadReceiptRequested eq false |
Only if message is read |
isRead eq true |
Only if message is unread |
isRead eq false |
Only if message is a draft |
isDraft eq true |
Only if message is not a draft |
isDraft eq false |
Body content contains |
contains(body/content, 'money') |
From Sender 'John Doe' |
sender/emailAddress/name eq 'John Doe' |
|
Data filter (e.g. somecolumn -eq 'somevalue') [API Help..]
|
EmailBodyFormat |
Email Body Format |
YES |
Option |
Value |
html |
html |
text |
text |
|
|
OrderBy |
Order By |
NO |
Option |
Value |
None |
|
AscendingOrder |
SomeColumn asc |
DescendingOrder |
SomeColumn desc |
|
Order the specified column by ascending or descending order [API Help..]
|
PageSize |
Page Size |
NO |
|
The number of records to include in each page of results [API Help..]
|
SelectedColumns |
Selected Columns |
NO |
|
Select the individual columns to be included in the response, to reduce the response size and increase performance [API Help..]
|
Output Columns
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_WSTR |
1000 |
False |
|
ReceivedDateTime |
DT_WSTR |
4000 |
False |
|
HasAttachments |
DT_WSTR |
4000 |
False |
|
Subject |
DT_WSTR |
800 |
False |
|
BodyPreview |
DT_WSTR |
4000 |
False |
|
SenderEmailAddressName |
DT_WSTR |
800 |
False |
|
SenderEmailAddress |
DT_WSTR |
800 |
False |
|
Importance |
DT_WSTR |
500 |
False |
|
SentDateTime |
DT_WSTR |
4000 |
False |
|
CreatedDateTime |
DT_WSTR |
4000 |
False |
|
LastModifiedDateTime |
DT_WSTR |
4000 |
False |
|
ChangeKey |
DT_WSTR |
1000 |
False |
|
ToRecipients |
DT_WSTR |
1190 |
False |
|
CcRecipients |
DT_WSTR |
1190 |
False |
|
BccRecipients |
DT_WSTR |
1190 |
False |
|
ToRecipient1 |
DT_WSTR |
200 |
False |
|
ToRecipient2 |
DT_WSTR |
200 |
False |
|
ToRecipient3 |
DT_WSTR |
200 |
False |
|
ToRecipient4 |
DT_WSTR |
200 |
False |
|
ToRecipient5 |
DT_WSTR |
200 |
False |
|
CcRecipient1 |
DT_WSTR |
200 |
False |
|
CcRecipient2 |
DT_WSTR |
200 |
False |
|
CcRecipient3 |
DT_WSTR |
200 |
False |
|
CcRecipient4 |
DT_WSTR |
200 |
False |
|
CcRecipient5 |
DT_WSTR |
200 |
False |
|
BccRecipient1 |
DT_WSTR |
200 |
False |
|
BccRecipient2 |
DT_WSTR |
200 |
False |
|
BccRecipient3 |
DT_WSTR |
200 |
False |
|
BccRecipient4 |
DT_WSTR |
200 |
False |
|
BccRecipient5 |
DT_WSTR |
200 |
False |
|
Categories |
DT_WSTR |
1000 |
False |
|
ParentFolderId |
DT_WSTR |
1200 |
False |
|
ConversationId |
DT_WSTR |
1200 |
False |
|
ConversationIndex |
DT_WSTR |
1200 |
False |
|
IsDeliveryReceiptRequested |
DT_WSTR |
4000 |
False |
|
IsReadReceiptRequested |
DT_WSTR |
4000 |
False |
|
IsRead |
DT_WSTR |
4000 |
False |
|
IsDraft |
DT_WSTR |
4000 |
False |
|
WebLink |
DT_WSTR |
4000 |
False |
|
InferenceClassification |
DT_WSTR |
800 |
False |
|
InternetMessageHeaders |
DT_WSTR |
4000 |
False |
|
BodyContentType |
DT_WSTR |
500 |
False |
|
BodyContent |
DT_WSTR |
4000 |
False |
|
FromEmailAddressName |
DT_WSTR |
800 |
False |
|
FromEmailAddress |
DT_WSTR |
800 |
False |
|
ReplyTo |
DT_WSTR |
1190 |
False |
|
UniqueBodyContentType |
DT_WSTR |
500 |
False |
|
UniqueBodyContent |
DT_WSTR |
4000 |
False |
|
FlagFlagStatus |
DT_WSTR |
800 |
False |
|
ODataETag |
DT_WSTR |
1000 |
False |
|
InternetMessageId |
DT_WSTR |
1800 |
False |
|
Input Columns
Label |
DataType |
Length |
Raw |
Description |
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |