Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameadministration
nopaneltrue

Overview

OAuth authentication required for Office 365 for new tenants is supported by PhixFlowPhixFlow supports fetching and sending emails through Microsoft Office 365 Outlook and Google accounts. This page describes the setup required for both.

Table of Contents

System Configuration Setup in PhixFlow

  1. On the Ensure that the System Configuration → 
    Insert excerpt
    Check the following
    _administration
    _administration
    nopaneltrue
    menu, access  
    Insert excerpt
    _system_config
    _system_config
    nopaneltrue
    1. Check the System URL field is set to the public URL PhixFlow is accessed on by users.
      1. For example, http://phixflowhost.com/phixflow/
  2. Ensure the secure flag is set on cookies, see Install Tomcat

Host's Application Configuration

Microsoft Office 365

Expand
titleMicrosoft Office 365

An Office 365 Administrator is required to perform the following step to enable a PhixFlow instance to interact with Microsoft Office 365 Outlook.

  1. Open the Microsoft Entra Admin Center at https://entra.microsoft.com/#home
  2. Select ApplicationsApp Registrations
  3. Click New Registration
    1. Name: PhixFlow O365 Integration, or another appropriate value
    2. Supported Account types: Choose Accounts in this organizational directory only
    3. Redirect URI:
      1. Select a Platform: Web 
      2. URL: SystemURL+receiveTokenAuthentication.htm
        e.g. http://phixflowhost.com/phixflow/receiveTokenAuthentication.htm
  4. Click Register
  5. Take a note of the Application (client ID)
  6. Click Add a certificate or secret
  7. Click New client secret
    1. Give the certificate a name
    2. Set the expires time, after which the secret has to be refreshed. Either use the default 180 days, or pick an alternative value such as 730 days.
      1. Ensure you create a new the secret before it expires.
    3. Press Add
    4. Take a note of the value, this is the Client Secret 

Google

Expand
titleGoogle
  1. Configure the application in Azure, Google Developer or similar
    1. https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth
    2. https://learn.microsoft.com/en-us/power-platform/admin/connect-gmail-oauth2
  2. Configuration parameters
  3. The application type is Web
.
  1. The redirect URL is yourPhixFlowInstance/receiveTokenAuthentication.htm
    1. For example, http://phixflowhost.com/phixflow/receiveTokenAuthentication.htm

Client Token Configuration in PhixFlow

In PhixFlow create a

Client Token

Configuration

Configurations are created in PhixFlow from the Full Repository.

  • To allow a user to authenticate choose the User flow
  • Set the Client ID to the value obtained from Azure/Google. You may require assistance from your IT Team for this.
  • Client Secret to the value obtained from Azure/Google. You may require assistance from your IT Team for this.
  • Google
  • Auth URL https://accounts.google.com/o/oauth2/v2/auth?prompt=&access_type=offline
    1. For tokens to auto renew set access_type=offline as a parameter in the URL
  • Token URL https://oauth2.googleapis.com/token
  • Scopes https://mail.google.com/
  • Warning

    Google only sends a refresh token on the first authentication so if you don’t get a refresh token you have to delete the connection from Google and authenticate again.

    Microsoft
  • Base URL https://login.microsoftonline.com/common/ or https://login.microsoftonline.com/{tenantId}
    1. For example https://login.microsoftonline.com/MyCompany.com/
  • Scopes, recommended setup: Code Blockhttps://outlook.office.com/SMTP.Send https://outlook.office.com/POP.AccessAsUser.All https://outlook.office.com/IMAP.AccessAsUser.All offline_access openid email

    Insert excerpt
    Client Token Configuration
    Client Token Configuration
    nameFullPage
    nopaneltrue

    Create an Email Account in PhixFlow

    1. Create an Email Account in the Full Repository.
    2. Set Toggle on Enabled
    3. Set the Type to Inbound or Outbound depending on your requirements.

    Microsoft Office 365

    Expand
    titleMicrosoft Office 365

    For an inbound email account:

    1. Set the Protocol to Microsoft
    2. After setting the Authorisation Type, set the Login to the account email address 
    3. Set the On Email Received
    4. Select your Client Token Configuration
    5. Click
      Insert excerpt
      _emailConfiguration
      _emailConfiguration
      nameicon
      nopaneltrue
       Authenticate Email Account to perform the authentication process which provides access to your Microsoft account

    Google

    Click
    Expand
    titleGoogle
    1. Set Authorisation Type to OAuth2
    2. Select your
    client token configuration.
    1. Client Token Configuration
    2. Click
      Insert excerpt
      _emailConfiguration
      _emailConfiguration
      nameicon
      nopaneltrue
      Authenticate Email Account to perform the authentication process which provides access to your Google
    /Microsoft
    1. account
    .
      1. Image ModifiedPOP, IMAP, and SMTP settings for Outlook.com - Microsoft Support
      2. For POP Outlook add to the properties mail.pop3s.auth.xoauth2.two.line.authentication.format=true
    Image Removed

    Image Added