Endpoint Download Message Attachments (Multiple Files) - Using Search Condition
Name
download_message_attachments
Description
Downloads multiple attachments for a specified search condition / mailbox / folder
Parameters
| Parameter | Required | Options | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: User ID or Email 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') |
YES | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name:
Label: SaveFolder Specify a disk folder path to save file(s) to |
YES | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name:
Label: Email Body Format |
YES |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name:
Label: MailFolderId |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name:
Label: OverwriteFile |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name:
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] |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name:
Label: Order By Order the specified column by ascending or descending order |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name:
Label: Page Size The number of records to include in each page of results |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_STR
|
varchar(255)
|
255 | |
| MessageId |
DT_STR
|
varchar(255)
|
255 | |
| Name |
DT_WSTR
|
nvarchar(500)
|
500 | |
| ContentId |
DT_STR
|
varchar(255)
|
255 | |
| ContentType |
DT_STR
|
varchar(255)
|
255 | |
| ContentLocation |
DT_STR
|
varchar(1000)
|
1000 | |
| IsInLine |
DT_BOOL
|
bit
|
||
| LastModifiedDateTime |
DT_DBTIMESTAMP
|
datetime
|
||
| Size |
DT_I4
|
int
|
||
| SavedPath |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| SavedSize |
DT_I8
|
bigint
|
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
| Required Parameters | |
|---|---|
| User ID or Email | Fill-in the parameter... |
| SaveFolder | Fill-in the parameter... |
| Optional Parameters | |
| MailFolderId | |
| OverwriteFile | True |
API Destination
| Required Parameters | |
|---|---|
| User ID or Email | Fill-in the parameter... |
| SaveFolder | Fill-in the parameter... |
| Optional Parameters | |
| MailFolderId | |
| OverwriteFile | True |
ODBC application
Use these SQL queries in your ODBC application data source:
Download multiple attachments with search condition
<p>Downloads Office 365 email attachments that match search criteria. You can combine conditions (e.g. has attachments only, sent after a date, subject contains text, from a specific sender). Supply <code>SaveFolder</code> and the search parameters in the <code>WITH</code> clause.</p>
SELECT * FROM download_message_attachments
WITH(
SaveFolder='c:\download',
OverwriteFile='True',
MailFolderId='INBOX', --or use mailbox ID
UserId='me', --or use "user-id" or use "email"
--search mail with attachments, sent after 2023-03-01, subject contains string "invoice" and from email is microsoft-noreply@microsoft.com
SearchCriteria='hasAttachments eq true and sentDateTime gt 2023-03-01 and contains(subject, ''invoice'') and from/emailAddress/address eq ''microsoft-noreply@microsoft.com'' ',
EmailBodyFormat='HTML' --or text
)
--Check this link to learn more about search conditions: https://learn.microsoft.com/en-us/graph/filter-query-parameter?tabs=http
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Download multiple attachments with search condition
<p>Downloads Office 365 email attachments that match search criteria. You can combine conditions (e.g. has attachments only, sent after a date, subject contains text, from a specific sender). Supply <code>SaveFolder</code> and the search parameters in the <code>WITH</code> clause.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM download_message_attachments
WITH(
SaveFolder=''c:\download'',
OverwriteFile=''True'',
MailFolderId=''INBOX'', --or use mailbox ID
UserId=''me'', --or use "user-id" or use "email"
--search mail with attachments, sent after 2023-03-01, subject contains string "invoice" and from email is microsoft-noreply@microsoft.com
SearchCriteria=''hasAttachments eq true and sentDateTime gt 2023-03-01 and contains(subject, ''''invoice'''') and from/emailAddress/address eq ''''microsoft-noreply@microsoft.com'''' '',
EmailBodyFormat=''HTML'' --or text
)
--Check this link to learn more about search conditions: https://learn.microsoft.com/en-us/graph/filter-query-parameter?tabs=http';
EXEC (@MyQuery) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY];