Reference

Endpoint Get My Messages [only works with User Credentials]

Name

get_my_messages

Description

Get the mail messages for the current user. [API reference]

Related Tables

MyMessages

Parameters

Parameter Required Options
Name: EmailBodyFormat

Label: Email Body Format

 YES
Option Value
html html
text text
Name: SearchCriteria

Label: Search Criteria

Data filter (e.g. somecolumn -eq 'somevalue'), you can use Date time functions for dynamic date. You can use keywords like now,today,yesterday,monthstart,monthend,yearstart,yearend,weekstart,weekend along with operator + / - [hour,minute,second,day,month,year]
Option Value
None
From specific email 'from/emailAddress/address eq 'microsoft-noreply@microsoft.com'
Has Attachments hasAttachments eq true
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
Sent after (dynamic) sentDateTime gt <>
Search by Internet MessageId contains(internetMessageId,''59e62584-e364-453a-8444-5591a324ddaa@az.centralus.production.microsoft.com'')
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'
Name: MailFolderId

Label: MailFolderId
Name: OrderBy

Label: Order By

Order the specified column by ascending or descending order
Option Value
None
AscendingOrder SomeColumn asc
DescendingOrder SomeColumn desc
Name: PageSize

Label: Page Size

The number of records to include in each page of results
Name: SelectedColumns

Label: Selected Columns

Select the individual columns to be included in the response, to reduce the response size and increase performance

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(1000) 1000
ReceivedDateTime DT_DBTIMESTAMP datetime
HasAttachments DT_BOOL bit
Subject DT_WSTR nvarchar(800) 800
BodyPreview DT_WSTR nvarchar(4000) 4000
SenderEmailAddressName DT_WSTR nvarchar(800) 800
SenderEmailAddress DT_WSTR nvarchar(800) 800
Importance DT_WSTR nvarchar(500) 500
SentDateTime DT_DBTIMESTAMP datetime
CreatedDateTime DT_DBTIMESTAMP datetime
LastModifiedDateTime DT_DBTIMESTAMP datetime
ChangeKey DT_WSTR nvarchar(1000) 1000
ToRecipients DT_WSTR nvarchar(1190) 1190
CcRecipients DT_WSTR nvarchar(1190) 1190
BccRecipients DT_WSTR nvarchar(1190) 1190
ToRecipient1 DT_WSTR nvarchar(200) 200
ToRecipient2 DT_WSTR nvarchar(200) 200
ToRecipient3 DT_WSTR nvarchar(200) 200
ToRecipient4 DT_WSTR nvarchar(200) 200
ToRecipient5 DT_WSTR nvarchar(200) 200
CcRecipient1 DT_WSTR nvarchar(200) 200
CcRecipient2 DT_WSTR nvarchar(200) 200
CcRecipient3 DT_WSTR nvarchar(200) 200
CcRecipient4 DT_WSTR nvarchar(200) 200
CcRecipient5 DT_WSTR nvarchar(200) 200
BccRecipient1 DT_WSTR nvarchar(200) 200
BccRecipient2 DT_WSTR nvarchar(200) 200
BccRecipient3 DT_WSTR nvarchar(200) 200
BccRecipient4 DT_WSTR nvarchar(200) 200
BccRecipient5 DT_WSTR nvarchar(200) 200
Categories DT_WSTR nvarchar(1000) 1000
ParentFolderId DT_WSTR nvarchar(1200) 1200
ConversationId DT_WSTR nvarchar(1200) 1200
ConversationIndex DT_WSTR nvarchar(1200) 1200
IsDeliveryReceiptRequested DT_BOOL bit
IsReadReceiptRequested DT_BOOL bit
IsRead DT_BOOL bit
IsDraft DT_BOOL bit
WebLink DT_WSTR nvarchar(4000) 4000
InferenceClassification DT_WSTR nvarchar(800) 800
InternetMessageHeaders DT_NTEXT nvarchar(MAX)
BodyContentType DT_WSTR nvarchar(500) 500
BodyContent DT_NTEXT nvarchar(MAX)
FromEmailAddressName DT_WSTR nvarchar(800) 800
FromEmailAddress DT_WSTR nvarchar(800) 800
ReplyTo DT_WSTR nvarchar(1190) 1190
UniqueBodyContentType DT_WSTR nvarchar(500) 500
UniqueBodyContent DT_NTEXT nvarchar(MAX)
FlagFlagStatus DT_WSTR nvarchar(800) 800
ODataETag DT_WSTR nvarchar(1000) 1000
InternetMessageId DT_WSTR nvarchar(1800) 1800
If the column you are looking for is missing, consider customizing Outlook Mail (Office 365) Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Outlook Mail (Office 365) Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the MyMessages table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Outlook Mail (Office 365)
Read and write Microsoft Outlook Mail (Office 365) data effortlessly. Send, manage, and sync messages, attachments, and folders — almost no coding required.
Outlook Mail (Office 365)
MyMessages
There are no parameters to configure.
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the MyMessages table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get my messages [only works with user credentials]:

API Destination - Outlook Mail (Office 365)
Read and write Microsoft Outlook Mail (Office 365) data effortlessly. Send, manage, and sync messages, attachments, and folders — almost no coding required.
Outlook Mail (Office 365)
MyMessages
Select
There are no parameters to configure.
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read messages for the current user

<p>Gets all messages for the current user's mailbox. Use <code>MyMessages</code> to list every message in the default folder.</p> 

SELECT * FROM MyMessages

Read messages ordered by sent time (ascending)

<p>Gets messages ordered by sent date/time ascending. Use <code>OrderBy='sentDateTime'</code> in the <code>WITH</code> clause.</p> 

SELECT * FROM MyMessages WITH (OrderBy='sentDateTime')

Read messages ordered by sent time (descending)

<p>Gets messages ordered by sent date/time descending. Use <code>OrderBy='sentDateTime desc'</code> in the <code>WITH</code> clause.</p> 

SELECT * FROM MyMessages WITH (OrderBy='sentDateTime desc')

Read messages ordered by received time (ascending)

<p>Gets messages ordered by received date/time ascending. Use <code>OrderBy='receivedDateTime'</code> in the <code>WITH</code> clause.</p> 

SELECT * FROM MyMessages WITH (OrderBy='receivedDateTime')

Read messages ordered by received time (descending)

<p>Gets messages ordered by received date/time descending. Use <code>OrderBy='receivedDateTime desc'</code> in the <code>WITH</code> clause.</p> 

SELECT * FROM MyMessages WITH (OrderBy='receivedDateTime desc')

Read messages ordered by sender name (ascending)

<p>Gets messages ordered by sender name ascending. Use <code>OrderBy='sender/emailAddress/name'</code> in the <code>WITH</code> clause.</p> 

SELECT * FROM MyMessages WITH (OrderBy='sender/emailAddress/name')

Read messages ordered by sender name (descending)

<p>Gets messages ordered by sender name descending. Use <code>OrderBy='sender/emailAddress/name desc'</code> in the <code>WITH</code> clause.</p> 

SELECT * FROM MyMessages WITH (OrderBy='sender/emailAddress/name desc')

get_my_messages endpoint belongs to MyMessages table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read messages for the current user

<p>Gets all messages for the current user's mailbox. Use <code>MyMessages</code> to list every message in the default folder.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

Read messages ordered by sent time (ascending)

<p>Gets messages ordered by sent date/time ascending. Use <code>OrderBy='sentDateTime'</code> in the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages WITH (OrderBy=''sentDateTime'')';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

Read messages ordered by sent time (descending)

<p>Gets messages ordered by sent date/time descending. Use <code>OrderBy='sentDateTime desc'</code> in the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages WITH (OrderBy=''sentDateTime desc'')';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

Read messages ordered by received time (ascending)

<p>Gets messages ordered by received date/time ascending. Use <code>OrderBy='receivedDateTime'</code> in the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages WITH (OrderBy=''receivedDateTime'')';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

Read messages ordered by received time (descending)

<p>Gets messages ordered by received date/time descending. Use <code>OrderBy='receivedDateTime desc'</code> in the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages WITH (OrderBy=''receivedDateTime desc'')';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

Read messages ordered by sender name (ascending)

<p>Gets messages ordered by sender name ascending. Use <code>OrderBy='sender/emailAddress/name'</code> in the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages WITH (OrderBy=''sender/emailAddress/name'')';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

Read messages ordered by sender name (descending)

<p>Gets messages ordered by sender name descending. Use <code>OrderBy='sender/emailAddress/name desc'</code> in the <code>WITH</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM MyMessages WITH (OrderBy=''sender/emailAddress/name desc'')';

EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];

get_my_messages endpoint belongs to MyMessages table(s), and can therefore be used via those table(s).