Email Account Integration
- Anthony George
- Zoe Baldwin
- Eleanor Brodie
Owned by Anthony George
Overview
PhixFlow supports fetching and sending emails through Microsoft Office 365 Outlook and Google accounts. This page describes the setup required for both.
System Configuration Setup in PhixFlow
- On the Administration menu, access Configuration
- Check the System URL field is set to the public URL PhixFlow is accessed on by users
- For example, http://phixflowhost.com/phixflow/
- Check the System URL field is set to the public URL PhixFlow is accessed on by users
- Ensure the secure flag is set on cookies, see Install Tomcat
Microsoft Office 365 Account
Show/Hide
Email Host's Application Configuration
These steps are performed outside of PhixFlow.
An Office 365 Administrator is required to perform the following step to enable a PhixFlow instance to interact with Microsoft Office 365 Outlook.
- Open the Microsoft Entra Admin Center at https://entra.microsoft.com/#home
- Select Applications → App Registrations
- Click New Registration
- Name:
PhixFlow O365 Integration
, or another appropriate value - Supported Account types: Choose Accounts in this organizational directory only
- Redirect URI:
- Select a Platform:
Web
- URL: SystemURL+receiveTokenAuthentication.htm
e.g. http://phixflowhost.com/phixflow/receiveTokenAuthentication.htm
- Select a Platform:
- Name:
- Click Register
- Take a note of the Application (client ID)
- Click Add a certificate or secret
- Click New client secret
- Give the certificate a name
- 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.
- Ensure you create a new the secret before it expires.
- Press Add
- Take a note of the value, this is the Client Secret
Client Token Configuration in PhixFlow
- Open the Full Repository and find the Client Token Configuration, then create a new one
- In PhixFlow version 11.3+, this can be done from the application's repository
- To allow a user to authenticate, choose the User flow
- Set the Client ID to the value obtained from Entra
- Set the Client Secret to the value obtained from Entra
- Set the Base URL to https://login.microsoftonline.com/common/ or https://login.microsoftonline.com/{tenantId}
- Typically, the tenantId is your email domain, e.g. mycompany.com
- Base URL example: https://login.microsoftonline.com/MyCompany.com/
- Set the Scopes to: user.read mail.read mail.send mail.read.shared mail.send.shared openid email offline_access
- Leave Identity Claim blank
- Enable Supports Inbound Email and Supports Outbound Email, as required
Create an Email Account in PhixFlow
- Create an Email Account in the Full Repository
- In PhixFlow version 11.3+, this can be done from the application's repository
- Set a Name which you'll use to identify the email account, e.g.
Customer Service
- Toggle on Enabled
- Set the Type to
Inbound
orOutbound,
depending on your requirements For an inbound email account:
- Set Host to
outlook.office365.com
- Set the Protocol to Microsoft
- Set the Encryption to SSL/TLS
- Toggle on Use Default Port
- For the Authorisation Type, select OAuth 2
- Set the Login to the email address being monitored
- For On Email Received choose:
- Hold for collection via file collector if you want PhixFlow to monitor and hold the emails in a File Collector for later processing
- Choose Trigger an email endpoint actionflow if you want PhixFlow to monitor and process the emails using the Email Endpoint specified in Email Endpoint Action
- See Setting up an Email Endpoint
- (Optional) If you want to monitor a specific folder in Outlook, enter its name in the Folder field
- If left blank, only the Inbox will be monitored
- If using a sub folder, the folder path must be entered here, for example,
Inbox/Endpoint
- Select your Client Token Configuration
- Apply the changes
- Next to Status, click Authenticate Email Account to perform the authentication process which provides access to your Microsoft account
- Hover over More Options and select Test Configuration
- Set Host to
Google Account
Show/Hide
Email Host's Application Configuration
- Configure the application in Azure, Google Developer or similar
- Configuration parameters
- The application type is Web
- The redirect URL is yourPhixFlowInstance/receiveTokenAuthentication.htm
Client Token Configuration in PhixFlow
- Open the Full Repository and find the Client Token Configuration, then create a new one
- In PhixFlow version 11.3+, this can be done from the application's 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
- Set the Client Secret to the value obtained from Azure/Google
- Set the Auth URL to https://accounts.google.com/o/oauth2/v2/auth?prompt=&access_type=offline
- For tokens to auto renew set access_type=offline as a parameter in the URL
- Set the Token URL to https://oauth2.googleapis.com/token
- Set the Scopes to https://mail.google.com/
Google only sends a refresh token on the first authentication. If a refresh token is not received, the connection from Google must be deleted and authenticated again.
Create an Email Account in PhixFlow
- Create an Email Account in the Full Repository
- In PhixFlow version 11.3+, this can be done from the application's repository
- Set a Name which you'll use to identify the email account, e.g.
Customer Service
- Toggle on Enabled
- Set the Type to
Inbound
orOutbound,
depending on your requirements - Set Host to
imap.gmail.com
- Set the Protocol to
IMAP
- Set Authorisation Type to
OAuth2
- Select your Client Token Configuration
- Click Authenticate Email Account to perform the authentication process which provides access to your Google account
- POP, IMAP, and SMTP settings for Outlook.com - Microsoft Support
- For POP Outlook add to the properties mail.pop3s.auth.xoauth2.two.line.authentication.format=true
Troubleshooting
Show/Hide
Here are some suggestions for troubleshooting.
Is the email account being polled?
- Check the System Console. When the email address is being polled it will show in the Completed Tasks
What does the error message, "Id is malformed" mean?
- Check the Folder value and ensure this is directing to the right location in the email account. If a sub folder is being used, the values should be folderName/subFolderName
What does it mean if the error message, "AUTHENTICATE failed" shows when the Email Account is displaying AUTHENTICATED?
- Check your Email Account setup matches the above settings
- For example, for a Microsoft account, ensure the Protocol is set to Microsoft and the Authorisation Type is set to OAuth 2
Need more information on any errors you are experiencing?
- Download the Phixflow.log log files from Administration → Download Log Files, then enter
phixflow.log
in the Log files to Download field
If you need any further help, speak to our support team by using:
- Support Centre
- Contact PhixFlow
These options are available in Design Mode under the Administration menu in the top right of PhixFlow.