OAuth 2.0 Microsoft Exchange Email Connection
Automation has been using basic authentication for Microsoft Exchange Web Service (EWS) until now. Automation users can now access Microsoft Emails using OAuth 2.0 using Microsoft (EWS) by creating a new connection or updating an existing connection. And they can use Send and Subscribe Test APIs with Microsoft Exchange for emails
Prerequisite
A prerequisite to authenticating a user using Microsoft Exchange Web Service (EWS) API is registering an App for Provar Automation on the ActiveDirectory App Registration to generate the connection properties and grant the necessary access to retrieve the requisite data. Microsoft provides the following options to set up a Microsoft Exchange:
- Get an Office 365 Developer Site (recommended). This is the quickest way for you to get an Exchange mailbox.
- Download Exchange Server.
Steps to create an OAuth 2.0 Connection in Automation
A connection must be created to authenticate the user to integrate with Microsoft Exchange.
In the Test Settings, navigate to the Connections tab and click the plus (+) sign icon. The Add New Connection screen is displayed. Give a Connection Name.
In this example, we have given the Connection Name as MSOAuth Host. And the Connection Type as Microsoft and MS Exchange.
The Type field is now displayed as a drop-down with the default value Online Exchange Account (Deprecated) option. The Type field is an authorization assertion type, and it displays three options in the drop-down:
- Exchange 2007 or later (via EWS)
- Older version of Exchange (via IMAP)
Select the Exchange 2007 or later (via EWS) option; we’ll first see the Host field.
In the Host field, we can see two options:
a) Auto Discover
We have selected Host as Auto Discover.
In the Authenticate field, select OAuth 2.0.
Enter the values for the required fields; the Tenant ID, Client ID, Client Secret, and Redirect URL information will be available for the Provar App configured on the Microsoft ActiveDirectory App Registry.
Note: The Authorise button is enabled only after you have filled these five mandatory fields.
We have created a connection, filled in all the mandatory fields, and clicked Authorise.
The MS Exchange Authorisation screen allows users to authenticate with their Microsoft account.
Enter the user password and click Sign in.
We have authenticated our OAuth 2.0 connection; the Access Token and Refresh Token are fetched from Microsoft.
There is some validity for these tokens in the Microsoft account. If these Access Token and Refresh Token are invalidated, validity has been breached, and the Refresh Token has expired. So, the Refresh token will stop working, and an error will be displayed to the user.
Note: Since we had Revoked this token, for example, the error message is Revoked; if it would have expired, then the error message would have displayed for Expired.
If some fields are filled incorrectly or if some fields are invalidated, then the corresponding error messages will be displayed. For example, let’s say there is some change in the Client ID field; then the Access Token and Refresh Token are invalidated. And you will have to authorize the connection again.
b) Supplied Host Name
We have selected Host as the Supplied Host Name.
In this case, we have to supply a Host Name.
Note: Automation currently supports Microsoft 365 as a hostname for Outlook email; this name will always be the hostname (outlook.office365.com). Users can specify whatever hostname they want to provide.
We have supplied the Host Name, so there is no User Name field. In this case. We know where the server is deployed since we have provided the hostname.
Enter the values for the required fields; the TenantID, Client ID, Client Secret, and Redirect URL information will be available for the Automation App configured on the Microsoft ActiveDirectory App Registry.
When we click on Authorise, we must provide a username and a password.
Note: The Authorise button is enabled only after you have filled these five mandatory fields.
We have created a connection, filled in all the mandatory fields, and clicked Authorise.
The MS Exchange Authorisation screen allows users to authenticate with their Microsoft account.
Enter the password and click Sign in.
We have authenticated our OAuth 2.0 connection, and the Access Token and Refresh Token are fetched from Microsoft.
Note: The OAuth functionality only applies to the “Exchange 2007 or later (via EWS). Users will not be able to create this type of Online Exchange Account (Deprecated) connection, and if anyone has created it, they will have to manually update their connections for Online Exchange Account. Earlier, it was just displayed as an Online Exchange Account. And now, it is displayed as an Online Exchange Account(Deprecated), as displayed in the screenshot below. And, it will be removed in the future Provar releases from the type of connections.
Microsoft mail server connection via HTTP Proxy settings
Automation has now updated the mail server connection to enable a proxy connection. Earlier, if the user created a Microsoft connection, it wasn’t supported for proxy type of connections, i.e., they had to use it without any proxy. Let’s say if a user had enabled proxy on their machine, then they wouldn’t be able to use this Microsoft connection.
Automation now supports the Microsoft connection using proxy. You can enable proxy settings from Help > Network Settings. Click New to enable proxy like any HTTP Proxy or OAuth proxy or non-OAuth proxy. Now, Microsoft connections will work, if the user has enabled HTTP Proxy settings.
Email Testing Examples:
In your typical test flow where you need to test emails, you either need to send an email from your test case, receive an email triggered by some action in your testing, or both. The following email testing examples describe how to test these actions in Automation.
Sending an Email
In an email testing example, to send an email in a test case, navigate to the Messaging section of the Test Palette and drag and drop the Send Message test step into your test case.
Alternatively, you can drag the email browser into your test case and choose to Send mail from this account.
Populate the parameters as follows:
- Source Connection: The Email Connection from which you wish to send the email
- To, CC and BCC: The direct recipients, CC’s, and BCC’s you wish to include in your email
- Contents: The email body
- Subject: The email subject line
- Signature: The email signature
You can add an attachment by clicking the Parameter icon above (see circled) and populating the attachment path.
Then, save the test case.
Receiving an Email / Subscribing to an Email Connection
To receive an email in a test case, navigate to the Messaging section of the Test Palette and drag and drop the Subscribe test step into your test case.
Alternatively, drag the email browser into your test case and select Subscribe to this mail folder.
Populate the parameters as follows:
- Source Connection: The Email Connection you wish to receive email from / subscribe to.
- Folder, From, Subject: Any filters applied to the emails being read. Leave these blank if you wish to read all emails.
- Subscription Name: The variable that will contain the results of the email(s) read.
- Subscription Scope: This defines to which extent the variable scope (Subscription Name) is valid. By default, it is a “Test Case,” which implies that you can only use the details in that test case. As a user, you can define the value to (Test Run, Test Folder, Group Step, Test Step) per your requirement.
Then, save the test case.
Note: Ensure this subscribes test step is executed in your test case before the email is triggered in the execution flow.
Receiving an Email After Polling
Use the Wait For test step to receive an email after a defined period. This test step will poll the email account until a given condition is satisfied or the defined wait time has elapsed.
To use the Wait For test step, navigate to the Control section of the Test Palette and drag and drop the Wait For test step into your test case.
Populate the standard Wait For test step parameters.
When populating Condition, note that you can enter a period after the Result variable to access variables such as messageCount (see screenshot above).
Then, save the test case.
For more information, check out this course on University of Provar.
If you would like to use this connection to send the ANT Execution Reports over email, please refer to Support for Existing MS OAuth Email Connection.
- Provar Automation
- System Requirements
- Browser and Driver Recommendations
- Installing Provar Automation
- Updating Provar Automation
- Licensing Provar
- Granting Org Permissions to Provar Automation
- Optimizing Org and Connection Metadata Processing in Provar
- Using Provar Automation
- Understanding Provar’s Use of AI Service for Test Automation
- Provar Automation
- Creating a New Test Project
- Import Test Project from a File
- Import Test Project from a Remote Repository
- Import Test Project from Local Repository
- Commit a Local Test Project to Source Control
- API Testing
- Behavior-Driven Development
- Consolidating Multiple Test Execution Reports
- Creating Test Cases
- Custom Table Mapping
- Functions
- Debugging Tests
- Defining a Namespace Prefix on a Connection
- Defining Proxy Settings
- Environment Management
- Exporting Test Cases into a PDF
- Exporting Test Projects
- Japanese Language Support
- Override Auto-Retry for Test Step
- Customize Browser Driver Location
- Mapping and Executing the Lightning Article Editor in Provar
- Managing Test Steps
- Namespace Org Testing
- NitroX
- Provar Test Builder
- ProvarDX
- Refresh and Recompile
- Reintroduction of CLI License Check
- Reload Org Cache
- Reporting
- Running Tests
- Searching Provar with Find Usages
- Secrets Management and Encryption
- Setup and Teardown Test Cases
- Tags and Service Level Agreements (SLAs)
- Test Cycles
- Test Data Generation
- Test Plans
- Testing Browser – Chrome Headless
- Testing Browser Options
- Tooltip Testing
- Using the Test Palette
- Using Custom APIs
- Callable Tests
- Data-Driven Testing
- Page Objects
- Block Locator Strategies
- Introduction to XPaths
- Creating an XPath
- JavaScript Locator Support
- Label Locator Strategies
- Maintaining Page Objects
- Mapping Non-Salesforce fields
- Page Object Operations
- ProvarX™
- Refresh and Reselect Field Locators in Test Builder
- Using Java Method Annotations for Custom Objects
- Applications Testing
- Database Testing
- Document Testing
- Email Testing
- Email Testing in Automation
- Email Testing Examples
- Gmail Connection in Automation with App Password
- App Configuration for Microsoft Connection in MS Portal for OAuth 2.0
- OAuth 2.0 Microsoft Exchange Email Connection
- Support for Existing MS OAuth Email Connection
- OAuth 2.0 MS Graph Email Connection
- Create a Connection for Office 365 GCC High
- Mobile Testing
- OrchestraCMS Testing
- Salesforce CPQ Testing
- ServiceMax Testing
- Skuid Testing
- Vlocity API Testing
- Webservices Testing
- Provar Manager
- How to Use Provar Manager
- Provar Manager Setup
- Provar Manager Integrations
- Release Management
- Test Management
- Test Operations
- Provar Manager and Provar Automation
- Setting Up a Connection to Provar Manager
- Object Mapping Between Automation and Manager
- How to Upload Test Plans, Test Plan Folders, Test Plan Instances, and Test Cases
- Provar Manager Filters
- Uploading Callable Test Cases in Provar Manager
- Uploading Test Steps in Provar Manager
- How to Know if a File in Automation is Linked in Test Manager
- Test Execution Reporting
- Metadata Coverage with Manager
- Provar Grid
- DevOps
- Introduction to Provar DevOps
- Introduction to Test Scheduling
- Apache Ant
- Configuration for Sending Emails via the Automation Command Line Interface
- Continuous Integration
- AutoRABIT Salesforce DevOps in Provar Test
- Azure DevOps
- Running a Provar CI Task in Azure DevOps Pipelines
- Configuring the Automation secrets password in Microsoft Azure Pipelines
- Parallel Execution in Microsoft Azure Pipelines using Multiple build.xml Files
- Parallel Execution in Microsoft Azure Pipelines using Targets
- Parallel execution in Microsoft Azure Pipelines using Test Plans
- Bitbucket Pipelines
- CircleCI
- Copado
- Docker
- Flosum
- Gearset
- GitHub Actions
- Integrating GitHub Actions CI to Run Automation CI Task
- Remote Trigger in GitHub Actions
- Parameterization using Environment Variables in GitHub Actions
- Parallel Execution in GitHub Actions using Multiple build.xml Files
- Parallel Execution in GitHub Actions using Targets
- Parallel Execution in GitHub Actions using Test Plan
- Parallel Execution in GitHub Actions using Job Matrix
- GitLab Continuous Integration
- Travis CI
- Jenkins
- Execution Environment Security Configuration
- Provar Jenkins Plugin
- Parallel Execution
- Running Provar on Linux
- Reporting
- Salesforce DX
- Git
- Version Control
- Salesforce Testing
- Recommended Practices
- Salesforce Connection Best Practices
- Improve Your Metadata Performance
- Java 21 Upgrade
- Testing Best Practices
- Automation Planning
- Supported Testing Phases
- Provar Naming Standards
- Test Case Design
- Create records via API
- Avoid using static values
- Abort Unused Test Sessions/Runs
- Avoid Metadata performance issues
- Increase auto-retry waits for steps using a global variable
- Create different page objects for different pages
- The Best Ways to Change Callable Test Case Locations
- Working with the .testProject file and .secrets file
- Best practices for the .provarCaches folder
- Best practices for .pageObject files
- Troubleshooting
- How to Use Keytool Command for Importing Certificates
- Installing Provar After Upgrading to macOS Catalina
- Browsers
- Configurations and Permissions
- Connections
- DevOps
- Error Messages
- Provar Manager 3.0 Install Error Resolution
- Provar Manager Test Case Upload Resolution
- Administrator has Blocked Access to Client
- JavascriptException: Javascript Error
- macOS Big Sur Upgrade
- Resolving Failed to Create ChromeDriver Error
- Resolving Jenkins License Missing Error
- Resolving Metadata Timeout Errors
- Test Execution Fails – Firefox Not Installed
- Selenium 4 Upgrade
- Licensing, Installation and Firewalls
- Memory
- Test Builder and Test Cases
- Release Notes