Download multiple messages as .EML files with search filters

Searches for messages by condition and downloads each as an .EML file (RFC 822 / MIME). Supply User Id, MailFolder Id, optional search conditions, and SaveFolder. Each message is saved as its own file; files can be opened in most email clients and include attachments.

Standard SQL query example

This is the base query accepted by the connector. To execute it in SQL Server, you have to pass it to the Data Gateway via a Linked Server. See how to accomplish this using the examples below.

SELECT * FROM download_messages_by_search
WITH(
	  SaveFolder='c:\download',	 --save as *.eml files
	  OverwriteFile='True',
 	  MailFolderId='INBOX', --or use mailbox folder Id (see get_mailfolders endpoint)
	  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''  ',
)

--Check this link to learn more about search conditions: https://learn.microsoft.com/en-us/graph/filter-query-parameter?tabs=http

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY], 'SELECT * FROM download_messages_by_search
WITH(
	  SaveFolder=''c:\download'',	 --save as *.eml files
	  OverwriteFile=''True'',
 	  MailFolderId=''INBOX'', --or use mailbox folder Id (see get_mailfolders endpoint)
	  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''''  '',
)

--Check this link to learn more about search conditions: https://learn.microsoft.com/en-us/graph/filter-query-parameter?tabs=http')

Using EXEC in SQL Server (handling larger SQL text)

The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements. This often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).

Fortunately, starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT [LS_TO_OUTLOOK_MAIL_OFFICE_365_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM download_messages_by_search
WITH(
	  SaveFolder=''c:\download'',	 --save as *.eml files
	  OverwriteFile=''True'',
 	  MailFolderId=''INBOX'', --or use mailbox folder Id (see get_mailfolders endpoint)
	  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''''  '',
)

--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]