Outlook Mail (Office 365) Connector for Tableau

In this article you will learn how to integrate Outlook Mail (Office 365) data in Tableau without coding in just a few clicks (live / bi-directional connection to Outlook Mail (Office 365)). Outlook Mail Connector (Office 365) can be used to integrate Office 365 Outlook Mail API in your App / BI Tools. You can download attachment, read / search Emails, Users, MailFolders, Send email and more..

Using Outlook Mail (Office 365) Connector you will be able to connect, read, and write data from within Tableau. Follow the steps below to see how we would accomplish that.

Download Documentation

Create Data Source in ZappySys Data Gateway based on API Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    OutlookMail(Office365)DSN

    ZappySys Data Gateway - Add Data Source

  5. 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)DSN
    Outlook Mail (Office 365)
    ODBC DSN Template Selection

  6. 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:

    1. Go to Azure Portal and login there.
    2. Then go to Azure Active Directory.
    3. On the left side click menu item App registrations
    4. Then proceed with clicking New registration.
    5. Enter a name for your application.
    6. Select the account types to support with the Supported account types option.
    7. In Redirect URI, select Web.
    8. In the textbox enter https://zappysys.com/oauth as the Redirect URI or another valid redirect URL.
    9. Use this same Redirect URI in the Redirect URL - Must Match App Redirect URL grid row.
    10. Copy Client ID and paste it into the API Connection Manager configuration grid in the Client ID row.
    11. 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
    12. 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
    13. Close "Endpoints" popup and create a Client Secret in the Certificates & secrets tab.
    14. Proceed by clicking New client secret and setting expiration period. Copy the client secret and paste it into configuration grid in Client Secret row.
    15. Now lets setup permissions for the app. Click on API Permissions and on the page click Plus Sign Add Permission
    16. Click on Microsoft Graph API and then choose Delegated Permissions
    17. 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).
    18. 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
        
    19. 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.
    20. That's it!

    Fill in all required parameters and set optional parameters if needed:

    OutlookMail(Office365)DSN
    Outlook Mail (Office 365)
    User Credentials [OAuth]
    https://graph.microsoft.com/v1.0
    Required 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...
    ODBC DSN Oauth Connection Configuration

    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)DSN
    Outlook Mail (Office 365)
    Application Credentials [OAuth]
    https://graph.microsoft.com/v1.0
    Required 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...
    ODBC DSN Oauth Connection Configuration

  7. 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:
    ODBC ZappySys Data Source Preview

  8. Click OK to finish creating the data source.

Read data in SQL Server from the ZappySys Data Gateway

  1. To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
    SSMS SQL Server Configure Linked Server

  2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
    SSMS SQL Server Configure Linked Server User Name

  3. Optional: Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

    RPC and MSDTC Settings

    You need to enable RPC Out if you plan to use EXEC(...) AT [MY_LINKED_SERVER_NAME] rather than OPENQUERY.
    If don't enabled it, you will encounter the Server 'MY_LINKED_SERVER_NAME' is not configured for RPC error.

    Query Example:

    EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]


    If you plan to use 'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
    If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

    Query Example:

    Insert Into dbo.Products
     EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
    


  4. Finally, open a new query and execute a query we saved in one of the previous steps:

    SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');

    SSMS SQL Server Query Data Results

Create Linked Server using Code

In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'OutlookMail(Office365)DSN'

    USE [master]
    GO
    --///////////////////////////////////////////////////////////////////////////////////////
    --Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
    --///////////////////////////////////////////////////////////////////////////////////////

    //Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
    //Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
    //Replace Port 5000 if you configured gateway on a different port


    --1. Configure your gateway service as per this article https://zappysys.com/links?id=10036

    --2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express

    --Uncomment below if you like to drop linked server if it already exists
    --EXEC master.dbo.sp_dropserver @server=N'LS_OutlookMail(Office365)DSN', @droplogins='droplogins'

    --3. Create new linked server

    EXEC master.dbo.sp_addlinkedserver
      @server = N'LS_OutlookMail(Office365)DSN'  --Linked server name (this will be used in OPENQUERY sql
    , @srvproduct=N''
    ---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
    , @provider=N'SQLNCLI11'
    ---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
    --, @provider=N'MSOLEDBSQL'
    , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
    , @provstr=N'Network Library=DBMSSOCN;'
    , @catalog=N'OutlookMail(Office365)DSN' --Data source name you gave on Gateway service settings

    --4. Attach gateway login with linked server

    EXEC master.dbo.sp_addlinkedsrvlogin
    @rmtsrvname=N'LS_OutlookMail(Office365)DSN'  --linked server name
    , @useself=N'False'
    , @locallogin=NULL
    , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
    , @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
    GO

    --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
    EXEC sp_serveroption 'LS_OutlookMail(Office365)DSN', 'rpc', true;
    EXEC sp_serveroption 'LS_OutlookMail(Office365)DSN', 'rpc out', true;

    --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
    EXEC sp_serveroption 'LS_OutlookMail(Office365)DSN', 'remote proc transaction promotion', false;

    --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
    --EXEC sp_serveroption 'LS_OutlookMail(Office365)DSN', 'query timeout', 1200;
    GO

Create View in SQL Server

Finally, use this or similar query in a view or stored procedure, which you will be able to use in Tableau. We will create a view to return invoices:

  1. CREATE VIEW vwApiInvoices AS
     SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Invoices')

Read data in Tableau from SQL Server

Actually, we will be getting data from SQL Server which in turn will be getting data from ZappySys Data Gateway data source. Let's begin and see how to accomplish that:

  1. Open Tableau Desktop and click File > New
  2. To create new Connection click More > Microsoft SQL Server > Enter your credentials to connect to SQL Server (in our example before we used tdsuser): Tableau connect to SQL Server
  3. Once connection is created for SQL Server we can read Outlook Mail (Office 365) data 3 different ways:
    1. Query View which contains OPENQUERY to Linked Server for Outlook Mail (Office 365) data
    2. Use direct SQL Query using OPENQUERY
    3. Use Stored Procedure (Mostly useful to parameterize calls
  4. See below example to pull data from Outlook Mail (Office 365) in Tableau using SQL View approach: Create data source in Tableau
  5. Once your data sources are created you can click on Sheet1 and drag fields to create visualizations for Tableau Dashboard: Create data source in Tableau

Passing Parameters to Outlook Mail (Office 365) calls in Tableau (Dynamic SQL)

Now let's look at scenario where you have to pass parameters to build Dynamic Dashboard. You can try to insert Parameters in your Direct SQL when you build Dynamic SQL but we found some issues with that so we are going to suggest Stored Procedure approach. For more information on Known issue on Dynamic Metadata Check this post.
  1. First lets create a stored procedure in SQL Server for Parameter Example. Notice how we added WITH RESULT SETS in the code to describe metadata.
    --DROP PROC dbo.usp_GetInvoicesByCountry
    --GO
    /*
    Purpose: Parameterize Outlook Mail (Office 365) call via SQL. Call ZappySys Drivers inside SQL Server.
    */
    CREATE PROC dbo.usp_GetInvoicesByCountry
    	@country varchar(100) 
    AS 
    
    DECLARE @sql varchar(max)
    --//Escape single ticks carefully
    SET @sql =  'SELECT OrderID,CustomerID,Country,Quantity FROM $
    WITH (Src=''https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json@filter=Country eq '+ @country +'''
    	 ,Filter=''$.value[*]''
    	 ,DataFormat=''OData''
    )'
    
    DECLARE @sqlFull varchar(max)
    SET @sqlFull='SELECT * FROM OPENQUERY( [LS] , ''' + REPLACE( @sql, '''', '''''' ) + ''' )'
    PRINT @sqlFull --//For DEBUG purpose
    
    EXECUTE (@sqlFull) 
    WITH RESULT SETS ( 
     (OrderID int,CustomerID varchar(100),Country varchar(100),Quantity int) --//describe first result. If you don't do this then wont work in Tableau 
    )
    GO
    -- Example call
    EXEC dbo.usp_GetInvoicesByCountry @country='Germany'
  2. Once you create a stored procedure go to Tableau datasource and select Database which contains the stored procedure we just created.
  3. Now find your stored proc and drag it on the datasource pane. You will see parameters UI as below. You can create new parameter - Select New Parameter under Value Column. Parameterize Tableau Outlook Mail (Office 365) datasource (Stored Procedure Parameters)
  4. Thats it now you can reuse your parameterized datasource anywhere in Dashboard.
  5. If you have need to select Parameters from predefined values rather than free text then edit your parameter and select List option. Define values you like to select from as below. Allow Tableau Parameter selection from multiple values
  6. When you create Tableau Dashboard you will see Parameter dropdown (If you selected List) elase you may see Textbox to enter custom value. Tableau Dashboard Example - REST API Source with Parameterized Datasource

Firewall settings

So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.

Method-1 (Preferred)

If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.

  1. Search for gateway in start menu and open ZappySys Data Gateway.
  2. Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it). Allow Inbound Traffic - Add Firewall Rule for ZappySys Data Gateway

Method-2 Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
  1. Search for Windows Firewall Advanced Security in start menu.
  2. Under Inbound Rules > Right click and click [New Rule] >> Click Next
  3. Select Port on Rule Type >> Click Next
  4. Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
  5. Select Profile (i.e. Private, Public) >> Click Next
  6. Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
  7. Click OK to save the rule
SQL Server Firewall Allow Inbound Data Gateway

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

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. 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>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. 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';

    ZappySys Driver - Execute Custom Stored Procedure

  5. 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''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

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.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. 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'

    ZappySys Driver - Create Custom Table

  5. 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"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. 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''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

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.
 Get Tables
Get table list and its properties for Graph API    [Read more...]
 Get Table Columns
Get table list and its properties for Graph API    [Read more...]
Parameter Description
Table Name
 Get My Information
Get general information about the current user.    [Read more...]
 Get Messages
Get the mail messages for the specified user ID or email address.    [Read more...]
Parameter Description
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')
 Send Mail
Sends an email message.    [Read more...]
Parameter Description
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')
 Get My Mail Folders
Get the list of mail folders for the current user.    [Read more...]
 Get Mail Folder by Id
Get the mail folder specified by the mail folder Id.    [Read more...]
Parameter Description
Mail Folder Id The Microsoft Mail mail folder ID for the mail folder.
 Get Users
Get the list of users.    [Read more...]
 Get User by Id
Get a specific user.    [Read more...]
Parameter Description
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')
 Get Mail Folders
Get the list of mail folders for the specified user Id.    [Read more...]
Parameter Description
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')
 Get My Messages
Get the mail messages for the current user.    [Read more...]
 Get My Message by Id
Get the mail message by message Id for the specified user ID or email address.    [Read more...]
Parameter Description
Message Id The Microsoft Mail message ID GUID for the message to read. (Example: 'c3220464-7209-453c-8840-3cf4de0afaa6')
Email Body Format
Option Value
html html
text text
 Get Message Attachments
Get the list of attachments linked to the specified message Id.    [Read more...]
Parameter Description
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')
Message ID The message Id for which to get attachments from.
 Get Message Attachment
Get a specific attachment linked to the specified message Id.    [Read more...]
Parameter Description
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')
Message ID The message Id for which to get the attachment from.
Attachment ID The attachment Id for the attachment to get.
 Download Message Attachment (Single File)
Download a specific attachment linked to the specified message Id.    [Read more...]
Parameter Description
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')
Message ID The message Id for which to get the attachment from.
Attachment ID The attachment Id for the attachment to get.
 Download Message Attachments (Multiple Files) - Using Search Condition
Downloads multiple attachments for a specified search condition to select Mails    [Read more...]
Parameter Description
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')
MailFolderId
OverwriteFile
Option Value
True True
False False
SaveFolder Specify a disk folder path to save file(s) to
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Outlook Mail (Office 365) Connector Examples for Tableau 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 Tableau and integrate data without any coding. Click here to Download Outlook Mail (Office 365) Connector for Tableau 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 Tableau Documentation 

More integrations

Other application integration scenarios for Outlook Mail (Office 365)

Other connectors for Tableau


Download Outlook Mail (Office 365) Connector for Tableau Documentation

  • How to connect Outlook Mail (Office 365) in Tableau?

  • How to get Outlook Mail (Office 365) data in Tableau?

  • How to read Outlook Mail (Office 365) data in Tableau?

  • How to load Outlook Mail (Office 365) data in Tableau?

  • How to import Outlook Mail (Office 365) data in Tableau?

  • How to pull Outlook Mail (Office 365) data in Tableau?

  • How to push data to Outlook Mail (Office 365) in Tableau?

  • How to write data to Outlook Mail (Office 365) in Tableau?

  • How to POST data to Outlook Mail (Office 365) in Tableau?

  • Call Outlook Mail (Office 365) API in Tableau

  • Consume Outlook Mail (Office 365) API in Tableau

  • Outlook Mail (Office 365) Tableau Automate

  • Outlook Mail (Office 365) Tableau Integration

  • Integration Outlook Mail (Office 365) in Tableau

  • Consume real-time Outlook Mail (Office 365) data in Tableau

  • Consume real-time Outlook Mail (Office 365) API data in Tableau

  • 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 Tableau

  • Load Outlook Mail (Office 365) in Tableau

  • Load Outlook Mail (Office 365) data in Tableau

  • Read Outlook Mail (Office 365) data in Tableau

  • Outlook Mail (Office 365) API Call in Tableau