Outlook Mail (Office 365) Connector for ODBC
In this article you will learn how to integrate Using Outlook Mail (Office 365) Connector you will be able to connect, read, and write data from within ODBC. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to Outlook Mail (Office 365) in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Outlook Mail (Office 365) using ODBC we first need to create a DSN (Data Source) which will access data from Outlook Mail (Office 365). We will later be able to read data using ODBC. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
When the Configuration window appears give your data source a name if you haven't done that already, then select "Outlook Mail (Office 365)" from the list of Popular Connectors. If "Outlook Mail (Office 365)" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
OutlookMail(Office365)DSNOutlook Mail (Office 365) -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
OAuth App must be created in Microsoft Azure AD. These settings typically found here https://docs.microsoft.com/en-us/graph/auth-register-app-v2. [API Help..]
Steps to get Outlook Mail (Office 365) Credentials
Firstly, login into Azure Portal and there create an OAuth application:
- Go to Azure Portal and login there.
- Then go to Azure Active Directory.
- On the left side click menu item App registrations
- Then proceed with clicking New registration.
- Enter a name for your application.
- Select the account types to support with the Supported account types option.
- In Redirect URI, select Web.
- In the textbox enter https://zappysys.com/oauth as the Redirect URI or another valid redirect URL.
- Use this same Redirect URI in the Redirect URL - Must Match App Redirect URL grid row.
- Copy Client ID and paste it into the API Connection Manager configuration grid in the Client ID row.
- Click on the Endpoints link and copy the OAuth 2.0 authorization endpoint (v2) URL to the Authorization URL grid row. Usually it looks similar to this:
- https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/authorize
- Copy the OAuth 2.0 token endpoint (v2) URL to the Token URL grid row. Usually it looks similar to this:
- https://login.microsoftonline.com/daed1250-xxxx-xxxx-xxxx-ef0a982d3d1e/oauth2/v2.0/token
- Close "Endpoints" popup and create a Client Secret in the Certificates & secrets tab.
- Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
- Now lets setup permissions for the app. Click on API Permissions and on the page click Plus Sign Add Permission
- Click on Microsoft Graph API and then choose Delegated Permissions
- on Permission list page search or choose permissions as needed. We need to enable following Permissions from 3 Sections (i.e. OpenId Permissions, Mail Permissions and Users Permissions).
- Make sure you have checked below permissions (If you do not need Write feature then you can skip Write scopes)
offline_access email openid profile Mail.Read Mail.Read.Shared Mail.ReadBasic Mail.ReadBasic.Shared Mail.ReadWrite Mail.ReadWrite.Shared Mail.Send Mail.Send.Shared User.Read User.ReadBasic.All
- Click Generate Token to generate tokens.
NOTE: If you are planning to use your current data connection/token for automated processes, we recommend that you use a generic account for token generation when the login box appears (e.g. sales_automation@mycompany.com instead of bob_smith@mycompany.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will fail. Another potentially unwanted effect of using a personal token is incorrect logging; the API calls (e.g. Read, Edit, Delete, Upload) made with that token will record the specific user as performing the calls instead of an automated process.
- That's it!
Fill in all required parameters and set optional parameters if needed:
OutlookMail(Office365)DSNOutlook Mail (Office 365)User Credentials [OAuth]https://graph.microsoft.com/v1.0Required Parameters Authorization URL Fill in the parameter... Token URL Fill in the parameter... Client ID Fill in the parameter... Scope Fill in the parameter... Optional Parameters Client Secret Fill in the parameter... Refresh Token File Path Fill in the parameter... ReturnUrl - Must Match App Redirect URL Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... Login Prompt Option Fill in the parameter... OAuth App must be created in Microsoft Azure AD. These settings typically found here https://docs.microsoft.com/en-us/graph/auth-v2-service [API Help..]
Please refer to below API Reference (External Site) link for Application Credentials [OAuth]https://docs.microsoft.com/en-us/graph/auth-v2-service
Fill in all required parameters and set optional parameters if needed:
OutlookMail(Office365)DSNOutlook Mail (Office 365)Application Credentials [OAuth]https://graph.microsoft.com/v1.0Required Parameters Token URL Fill in the parameter... Client ID Fill in the parameter... Client Secret Fill in the parameter... Scope Fill in the parameter... Optional Parameters RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Outlook Mail (Office 365) Connector
Outlook Mail (Office 365) Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description |
---|---|
Table Name |
|
Parameter | Description |
---|---|
User ID or Email |
|
Parameter | Description |
---|---|
User ID or Email |
|
Parameter | Description |
---|---|
Mail Folder Id |
|
Parameter | Description |
---|---|
User ID or Email |
|
Parameter | Description |
---|---|
User ID or Email |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
Message Id |
|
||||||
Email Body Format |
|
Parameter | Description |
---|---|
User ID or Email |
|
Message ID |
|
Parameter | Description |
---|---|
User ID or Email |
|
Message ID |
|
Attachment ID |
|
Parameter | Description |
---|---|
User ID or Email |
|
Message ID |
|
Attachment ID |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
User ID or Email |
|
||||||
MailFolderId |
|
||||||
OverwriteFile |
|
||||||
SaveFolder |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Outlook Mail (Office 365) Connector Examples for ODBC Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Get messages for the current user [Read more...]
SELECT * FROM MyMessages
Get users [Read more...]
select * from Users
--Where Id='049beb7f-03e0-4b0d-825d-73567b6786e9'
Get a specific message from the current user's account by the message ID [Read more...]
SELECT * FROM MyMessages
WHERE Id='AAXkADIwNzNhODMyLTZiMTQtNDhiMC02OWQzLTc5YTY5M2IyMjk0NABGAyAAAACbj2hVuNphT74wylrfU4ixBwAbUV6IxRnpQrqzrb2WfacdAAAAAAEMAAAbUV6IxRnpQrqzrb2WfacdAAAysBnxAAA='
Get messages for a specified user [Read more...]
SELECT * FROM get_messages
WITH (UserID='firstname.lastname@domainname.com')
Get first 5 messages for a specified user [Read more...]
SELECT * FROM get_messages
WITH (UserID='firstname.lastname@domainname.com', PageSize='5')
Get all messages in a specific Mail Folder [Read more...]
SELECT * FROM get_messages
WITH (
MailFolderID='INBOX' --or use mai folder id
)
Get messages with a subject line that starts with 'Announcements for' [Read more...]
SELECT * FROM get_messages
WITH (UserID='firstname.lastname@domainname.com', SearchCriteria='startsWith(Subject,''Announcements for'')')
Get messages that have at least one attachment associated with them [Read more...]
SELECT * FROM get_messages
WITH (UserID='firstname.lastname@domainname.com', SearchCriteria='hasAttachments eq true')
Get messages that are unread [Read more...]
SELECT * FROM get_messages
WITH (UserID='firstname.lastname@domainname.com', SearchCriteria='IsRead eq false')
Get messages for the current user ordered by the time they were sent in ascending order [Read more...]
SELECT * FROM MyMessages WITH (OrderBy='sentDateTime')
Get messages for the current user ordered by the time they were sent in descending order [Read more...]
SELECT * FROM MyMessages WITH (OrderBy='sentDateTime desc')
Get messages for the current user ordered by the time they were received in ascending order [Read more...]
SELECT * FROM MyMessages WITH (OrderBy='receivedDateTime')
Get messages for the current user ordered by the time they were received in descending order [Read more...]
SELECT * FROM MyMessages WITH (OrderBy='receivedDateTime desc')
Get messages for the current user ordered by the name of the sender in ascending order [Read more...]
SELECT * FROM MyMessages WITH (OrderBy='sender/emailAddress/name')
Get messages for the current user ordered by the name of the sender in descending order [Read more...]
SELECT * FROM MyMessages WITH (OrderBy='sender/emailAddress/name desc')
Get all mail folders associated with the current user [Read more...]
SELECT * FROM MyMailFolders
Get a specific mail folder associated with the current user by its mail folder ID [Read more...]
SELECT * FROM MyMailFolders
WHERE (Id='AAMkADIwNzNhODMyLTZiMTQtNDhiMCz4OWQzLTc5YTY5M2IyMjk0NAYuAAAAAACbj2hVuNphT74wyYrfU4ixAQAbUV6IxRnpQrWzrb2WfacdAAAAAAEKAcA=')
Get all attachments linked to the specified message ID [Read more...]
SELECT * FROM get_message_attachments
WITH (MessageId='AAXkADIwNzNhODMyLTZiMTQtNDhiMC02OWQzLTc5YTY5M2IyMjk0NABGAyAAAACbj2hVuNphT74wylrfU4ixBwAbUV6IxRnpQrqzrb2WfacdAAAAAAEMAAAbUV6IxRnpQrqzrb2WfacdAAAysBnxAAA=')
Get the specified attachment by message ID and attachment ID [Read more...]
SELECT * FROM get_message_attachment
WITH (MessageId='AAXkADIwNzNhODMyLTZiMTQtNDhiMC02OWQzLTc5YTY5M2IyMjk0NABGAyAAAACbj2hVuNphT74wylrfU4ixBwAbUV6IxRnpQrqzrb2WfacdAAAAAAEMAAAbUV6IxRnpQrqzrb2WfacdAAAysBnxAAA=',
AttachmentId='AAMkADIwNzNhODMyLTZiMTQtNDhiM704OWQzLTc5YTY5M2IyMjk0NABGAAqAAACbj2hVuNphT74wylrfU4ixBwAbUV6IxRnpQrqzrb2WfacdAABBAAEMAAAbUV6IxRnpQrqzrb2WfacdAAAysB9xAAABEgAQAK6dg4NuEa5Fmn_5Tp_D_XM=')
Download the specified attachment by message ID and attachment ID and save it to a file [Read more...]
SELECT * FROM download_message_attachment
WITH (MessageId='AAMkADIwNz2hODMyLTZiMTQtNDhiMC04OWQzLTc5YTY5M2IyMjk0NABGZAAAAxCbj2hVuNphT74wylrfU4ixBwAbUV6IxRnpQ6qzrb2WfacdAAAAAAEMAAAbUb6IxRnpQrqzrb2WfacdAAAysBnxAAA=',
AttachmentId='AAMkADIwNzNhODMyLTZiMTQtNDhiMC04cWQzLTc5YTY5M2IyMjk0NABGAAAAAACbj2hVuNphTZ4wylrfU4ixBwAbUV6IxRnpQrqzrb2WfacdAAAAAAEMAA8bUV6IxRnpQrqzrb2WfacdAAAysBnxAAABEgAQAK6dg4NuEa5Fmn_5Tp_D_XM=',
TargetFilePath='C:\temp\photo.png'
)
Download multiple attchments with search condition [Read more...]
This example shows how to download Office 365 Email attachments with search criteria. In this example we used multiple conditions to search. For example search mail with attachments only, sent after 2023-03-01, subject contains string 'invoice' and email sent from microsoft-noreply@microsoft.com
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
)
Send a simple email message (with headers, HTML body, recipients, attachments and more) [Read more...]
This example shows how to send email using Office 365 API. It shows how to attach local file(s) as attachments. To send email as Text format use Text rather than HTML in BodyContentType value.
INSERT INTO MyMessages
(Subject, BodyContentType, BodyContent
, ToRecipients, CcRecipients, BccRecipients
, InternetMessageHeaders
, Attachments, Importance, IsDeliveryReceiptRequested, IsReadReceiptRequested
, SaveToSentItems)
VALUES
('Employee Reviews Scheduled', 'HTML', '<b>Hi All,</b> employee reviews have been scheduled. <span style="text-decoration: underline;">Please reflect this in your notes.</span>',
'[{ "emailAddress": { "address": "john.doe@domain.com" }}, { "emailAddress": { "address": "jane.doe@domain.com" }}]',
'[{ "emailAddress": { "address": "mary.dawson@domain.com" }}]',
'[{ "emailAddress": { "address": "ryan.connor@domain.com" }}]',
'[{ "name": "x-custom-header-group-name", "value": "Managers" }, { "name": "x-custom-header-group-id", "value":"MGR001" }]',
'[
{
"@odata.type": "#microsoft.graph.fileAttachment",
"name": "file1.txt",
"contentType": "text/plain",
"contentBytes": "<<c:\file1.txt,FUN_FILE_BASE64ENC>>"
},
{
"@odata.type": "#microsoft.graph.fileAttachment",
"name": "profile-picture.png",
"contentType": "image/png",
"contentBytes": "<<c:\profile-picture.png,FUN_FILE_BASE64ENC>>"
}
]',
'normal', 'false', 'false', 'true')
Call generic API request [Read more...]
This example shows how ot call any Office 365 / Outlook API using generic_request endpoint. This is useful when some endpoints not defined in the connector but you like to call that API.
SELECT * FROM generic_request
WITH (
URL='/users/049beb7f-03e0-4b0d-825d-73567b6786e9'
, RequestMethod='GET'
, Filter='$' --optional if you like to read from array inside document
--Try commenting below line or define static metadata (speed up API calls by not requesting columns)
, Meta='businessPhones:String(220); displayName:String(230); givenName:String(100); jobTitle:String(255); mail:String(310); mobilePhone:String(255); officeLocation:String(255); preferredLanguage:String(255); surname:String(140); userPrincipalName:String(500); id:String(360); '
)
Conclusion
In this article we discussed how to connect to Outlook Mail (Office 365) in ODBC and integrate data without any coding. Click here to Download Outlook Mail (Office 365) Connector for ODBC and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Outlook Mail (Office 365) Connector for ODBC
Documentation
More integrations
Other application integration scenarios for Outlook Mail (Office 365)
Other connectors for ODBC
Download Outlook Mail (Office 365) Connector for ODBC
Documentation
How to connect Outlook Mail (Office 365) in ODBC?
How to get Outlook Mail (Office 365) data in ODBC?
How to read Outlook Mail (Office 365) data in ODBC?
How to load Outlook Mail (Office 365) data in ODBC?
How to import Outlook Mail (Office 365) data in ODBC?
How to pull Outlook Mail (Office 365) data in ODBC?
How to push data to Outlook Mail (Office 365) in ODBC?
How to write data to Outlook Mail (Office 365) in ODBC?
How to POST data to Outlook Mail (Office 365) in ODBC?
Call Outlook Mail (Office 365) API in ODBC
Consume Outlook Mail (Office 365) API in ODBC
Outlook Mail (Office 365) ODBC Automate
Outlook Mail (Office 365) ODBC Integration
Integration Outlook Mail (Office 365) in ODBC
Consume real-time Outlook Mail (Office 365) data in ODBC
Consume real-time Outlook Mail (Office 365) API data in ODBC
Outlook Mail (Office 365) ODBC Driver | ODBC Driver for Outlook Mail (Office 365) | ODBC Outlook Mail (Office 365) Driver | SSIS Outlook Mail (Office 365) Source | SSIS Outlook Mail (Office 365) Destination
Connect Outlook Mail (Office 365) in ODBC
Load Outlook Mail (Office 365) in ODBC
Load Outlook Mail (Office 365) data in ODBC
Read Outlook Mail (Office 365) data in ODBC
Outlook Mail (Office 365) API Call in ODBC