How to integrate Outlook Mail (Office 365) using Java

Integrate Java and Outlook Mail (Office 365)
Integrate Java and Outlook Mail (Office 365)

Learn how to quickly and efficiently connect Outlook Mail (Office 365) with Java for smooth data access.

Read and write Microsoft Outlook Mail (Office 365) data effortlessly. Send, manage, and sync messages, attachments, and folders — almost no coding required. You can do it all using the high-performance Outlook Mail (Office 365) ODBC Driver for Java (often referred to as the Outlook Mail (Office 365) Connector). How is this possible? You will connect to the ZappySys Data Gateway, which acts as a seamless bridge between the ODBC and JDBC layers. We'll walk you through the entire setup.

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Create data source in ZappySys Data Gateway

In this section we will create a data source for Outlook Mail (Office 365) in the Data Gateway. Let's follow these steps to accomplish that:

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for gateway in the Windows Start Menu and open ZappySys Data Gateway Configuration:

    Open ZappySys Data Gateway Service Manager
  3. Go to the Users tab and follow these steps to add a Data Gateway user:

    • Click the Add button
    • In the Login field enter a username, e.g., john
    • Then enter a Password
    • Check the Is Administrator checkbox
    • Click OK to save
    Data Gateway - Add User
  4. Now we are ready to add a data source:

    • Click the Add button
    • Give the Data source a name (have it handy for later)
    • Then select Native - ZappySys API Driver
    • Finally, click OK
    OutlookMailOffice365DSN
    ZappySys API Driver
    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:

    OutlookMailOffice365DSN
    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.

    Outlook Mail (Office 365) authentication

    Use delegated access (User Credentials) whenever you want to let a signed-in user work with their own resources or resources they can access. Whether it's an admin setting up policies for their entire organization or a user deleting an email in their inbox, all scenarios involving user actions should use delegated access. [API reference]

    Follow these simple steps below to create Microsoft Entra ID application with delegated access:

    WARNING: If you are planning to automate processes, we recommend that you use a Application Credentials authentication method. In case, you still need to use User Credentials, then make sure you use a system/generic account (e.g. automation@my-company.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 start to fail.
    1. Navigate to the Azure Portal and log in using your credentials.
    2. Access Microsoft Entra ID.
    3. Register a new application by going to App registrations and clicking on New registration button: Start new app registration in Microsoft Entra ID
      INFO: Find more information on how to register an application in Graph API reference.
    4. When configuration window opens, configure these fields:
      • Supported account type
        • Use Accounts in this organizational directory only, if you need access to data in your organization only.
      • Redirect URI:
        • Set the type to Public client/native (mobile & desktop).
        • Use https://zappysys.com/oauth as the URL.
      Register app in Microsoft Entra ID
    5. After registering the app, copy the Application (client) ID for later: Copy client ID of Microsoft Entra ID app
    6. Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs to use later in the configuration: Copy Auth and Token URLs in Microsoft Entra ID app
    7. Now go to SSIS package or ODBC data source and use the copied values in User Credentials authentication configuration:
      • In the Authorization URL field paste the OAuth authorization endpoint (v2) URL value you copied in the previous step.
      • In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
      • In the Client ID field paste the Application (client) ID value you copied in the previous step.
      • In the Scope field use the default value or select individual scopes, e.g.:
        • email
        • offline_access
        • 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
        • Group.Read.All
    8. Press Generate Token button to generate Access and Refresh Tokens.
    9. Optional step. Choose Default User Id from the drop down menu (if someone shared a mailbox with you).
    10. Click Test Connection to confirm the connection is working.
    11. Done! Now you are ready to use the API Connector!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to User Credentials [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    OutlookMailOffice365DSN
    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...
    Return URL Fill-in the parameter...
    Optional Parameters
    Client Secret
    Refresh Token File Path
    Login Prompt Option
    Default User Id (Select after clicking **Generate Token**) me
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429|503
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN OAuth Connection Configuration
    Outlook Mail (Office 365) authentication

    Application-only access is broader and more powerful than delegated access (User Credentials), so you should only use app-only access where needed. Use it when: 1. The application needs to run in an automated way, without user input (for example, a daily script that checks emails from certain contacts and sends automated responses). 2. The application needs to access resources belonging to multiple different users (for example, a backup or data loss prevention app might need to retrieve messages from many different chat channels, each with different participants). 3. You find yourself tempted to store credentials locally and allow the app to sign in 'as' the user or admin. [API reference]

    Follow these simple steps below to create Microsoft Entra ID application with application access permissions.

    1. Navigate to the Azure Portal and log in using your credentials.
    2. Access Microsoft Entra ID.
    3. Register a new application by going to App registrations and clicking on New registration button: Start new app registration in Microsoft Entra ID
      INFO: Find more information on how to register an application in Graph API reference.
    4. When configuration window opens, configure these fields:
      • Supported account type
        • e.g. select Accounts in this organizational directory only if you need access to data in your organization only.
      • Redirect URI:
        • Set the type to Public client/native (mobile & desktop).
        • Leave the URL field empty.
      Register app in Microsoft Entra ID
    5. After registering the app, copy the Application (client) ID for later: Copy client ID of Microsoft Entra ID app
    6. Then copy OAuth authorization endpoint (v2) & OAuth token endpoint (v2) URLs: Copy Auth and Token URLs in Microsoft Entra ID app
    7. Continue and create Client secret: Add Client secret for Microsoft Entra ID app
    8. Then copy the Client secret for later steps: Copy Client secret
    9. Continue by adding permissions for the app by going to the API permissions section, and clicking on Add a permission: Start adding permissions to Microsoft Entra ID app
    10. Select Microsoft Graph: Select Graph API permissions for Microsoft Entra ID app
    11. Then choose Application permissions option: Select app permissions for Microsoft Entra ID app
    12. Continue by adding these Mail (Outlook) permissions: Select Outlook Mail application scopes
    13. Finish by clicking Add permissions button: Add permissions to Microsoft Entra ID app
    14. Now it's time to Grant admin consent for your application: Grant admin consent for Microsoft Entra ID app
    15. Confirm all the permissions are granted: Admin consent granted successfully in Entra ID
    16. Now go to SSIS package or ODBC data source and use the copied values in Application Credentials authentication configuration:
      • In the Token URL field paste the OAuth token endpoint (v2) URL value you copied in the previous step.
      • In the Client ID field paste the Application (client) ID value you copied in the previous step.
      • In the Client Secret field paste the Client secret value you copied in the previous step.
      • Choose Default User Id from the drop down menu.
    17. Click Test Connection to confirm the connection is working.
    18. That's it! Now you can use the connector.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Application Credentials [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    OutlookMailOffice365DSN
    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...
    Default User Id Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429|503
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN OAuth Connection Configuration

  7. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

    ZappySys API Driver - 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.
    OutlookMailOffice365DSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Java to retrieve data from Outlook Mail (Office 365). Hit OK button to use this query in the next step.

    SELECT * FROM MyMessages
    Configure table/endpoint parameters in ODBC data source based on API Driver
    Some parameters configured in this window will be passed to the Outlook Mail (Office 365) API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.
  9. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Java:

    ZappySys API Driver - 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.
    OutlookMailOffice365DSN
    SELECT * FROM MyMessages
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Outlook Mail (Office 365) API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Outlook Mail (Office 365) servers).
  10. Click OK to finish creating the data source.

  11. Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:

    Data Gateway - Add firewall rule for inbound connections
    • This will initially allow all inbound traffic.
    • Click Edit IP filters to restrict access to specific IP addresses or ranges.
  12. Crucial Step: After creating or modifying the data source, you must:

    • Click the Save button to persist your changes.
    • Hit Yes when prompted to restart the Data Gateway service.

    This ensures all changes are properly applied:

    ZappySys Data Gateway - Save Changes
    Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.

Read data in Java from the DSN

  1. Java code to get the data:

    "jdbc:sqlserver://localhost:5000;databasename=OutlookMailOffice365DSN;user=john;password=test"
    Java code to Make ZappySys Driver Data Source Call

  2. When you run the code it will make the API call and read the data:
    Java code ZappySys Driver Data Source Results

  3. Here is Java program's code in text format:

    
    //Step-1: Install ZappySys ODBC PowerPack and Configure Data Gateway
    
    //Step-2:Assuming the Microsoft SQL Server JDBC Driver is in below folder
    //C:\Program Files\Microsoft Jdbc Driver 6.0 for SQL Server\sqljdbc_6.0\enu\auth\x64
    package padaone;
    
    import java.sql.*;
    
    public class zappy {
    
        public static void main(String[] args) {
    
            // Create a variable for the connection string.
            String connectionUrl = "jdbc:sqlserver://localhost:5000;databasename=OutlookMailOffice365DSN;user=test;password=test";
    
            // Declare the JDBC objects.
            Connection con = null;
            Statement stmt = null;
            ResultSet rs = null;
    
                try {
                    // Establish the connection.
                    Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
                    con = DriverManager.getConnection(connectionUrl);
    
                    // Create and execute an SQL statement that returns some data.
                    String SQL = "SELECT Country , SUM(UnitPrice * Quantity) Total " 
                               + "FROM value " 
                               + "GROUP BY Country "
                               + "WITH (SRC='https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json')";
                    stmt = con.createStatement();
                    rs = stmt.executeQuery(SQL);
    
                    // Iterate through the data in the result set and display it.
                    while (rs.next()) {
                        System.out.println(rs.getString(1) + " " + rs.getString(2));
                    }
                }
    
            // Handle any errors that may have occurred.
            catch (Exception e) {
                e.printStackTrace();
            } 
            
            finally {
                if (rs != null) try { rs.close(); } catch (Exception e) {}
                if (stmt != null) try { stmt.close(); } catch (Exception e) {}
                if (con != null) try { con.close(); } catch (Exception e) {}
            }
        }
    }

Supported Outlook Mail (Office 365) Connector actions

Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Outlook Mail (Office 365) operations directly in Java, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:

Conclusion

In this article we showed you how to connect to Outlook Mail (Office 365) in Java and integrate data without writing complex code — all of this was powered by Outlook Mail (Office 365) ODBC Driver.

Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Explore Java connectors

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

More Outlook Mail (Office 365) integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications