Adding a Microsoft™ Outlook Email application
Learn how to add a Microsoft™ Outlook Email application.
Before you begin
The following list shows the prerequisites to create a Microsoft™ Outlook Email application:
- IBM RPA on premises environment.
- User with permission to manage applications. See the Checking user permissions topic to learn how to check your user permissions.
- This application only works with the Connect to Microsoft Outlook (
microsoftMailConnect
) command. - Microsoft™ Azure 🡥 account.
Procedure
Follow the steps to create a Microsoft™ Outlook Email application:
- Create an Azure Active Directory app
- Get the Client Value and Application ID
- Add the application
- Result
Create an Azure Active Directory app
-
Log in to your Azure account 🡥.
-
In the search bar, search for
Azure Active Directory
, and select it. -
From the Manage menu, click App registrations > New registration.
-
In the Name field, enter a name for your app, for example,
Microsoft Exchange app
. -
In Supported account types, click the Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox) option.
-
In the Redirect URI section, enter the following values:
- From the Select the platform list, select Web.
- In the URL field, enter the API URL, such as
https://192.158.1.38:7790
, where192.158.1.38
is the server IP and7790
is the port that is used by the IBM RPA's API, with the OAuth2 specifications/integration/oauth2
. Following are examples of valid URLs with the OAuth2 specifications:https://192.51.100.38:7790/integration/oauth2
https://api.example.com/integration/oauth2
🛈 Remember: Replace the URL with the appropriate server API URL.
-
Click Register.
Get the Client Value and Application ID
- Optional: Search for the Azure Active Directory application you created.
- From the Manage menu, click Certificates & secrets.
- Click the New client secret button.
- In the Description field, enter a description for your credential.
- In the Expire list, select the expiration date for the credential.
- Click Add.
- Copy the value in the Value column, for example,
b47ga196-5d6a-5842-be6c-13f6d6525630
. - From the Overview page, copy the Application (client) ID value, for example,
abc-xyz-3e3s-grgr234-dfedvcefger
.
Add the application
-
Log in to IBM RPA Control Center.
-
Click Applications on the main menu.
-
Click Add application.
-
In the Name field, enter the application name.
-
In the Description field, enter the application description.
-
In the Application tags field, select a tag to identify the application. The tag is used to filter applications.
-
Click Next.
-
In the Client ID field, enter the Application (client) ID you got from your Azure Active Directory application, for example,
abc-xyz-3e3s-grgr234-dfedvcefger
. -
In the Client secret field, enter the client value that you got from your Azure Active Directory application, for example,
b47ga196-5d6a-5842-be6c-13f6d6525630
. -
In the Redirect URL field, enter the redirect URL you provided to your Azure Active Directory application, for example,
https://192.51.100.38:7790/integration/oauth2
. -
In the Authorization URL field, enter
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
. -
In the Authorization Template Parameter field, enter the following code snippet:
client_id={clientId}&redirect_uri={redirectUri}&response_type=code
🛈 Remember: IBM RPA automatically replaces the values of
{clientId}
and{redirectUri}
with the values defined in Client ID and Redirect URL, respectively. -
In the Token URL field, enter
https://login.microsoftonline.com/common/oauth2/v2.0/token
. -
In the API URL field, enter
https://graph.microsoft.com/v1.0/
. -
In the Scopes field, enter:
openid email offline_access Mail.Read Mail.ReadBasic Mail.ReadWrite Mail.Send
❕ Important: If you want to access shared mailboxes, add the following scopes too:
Mail.Read.Shared Mail.Send.Shared Mail.ReadWrite.Shared
-
Click Next.
-
Review the summary of the data that you entered, and click Add.
Result
As result, you can view a notification that states that the application was added successfully. You can also see the application in the list of applications.
If it fails, you can also view a notification. In this case, review the data that you entered and retry to create the application.
What to do next
-
Create connections
Create connections to authorize an application. For more information, see Connections. -
Edit an application
To edit an application click Applications in the main menu, then click the vertical ellipsis button ⋮ > Edit.⚠ Attention: If you change the application data, you must reauthorize the connection that is bound to it.
- On IBM RPA Control Center, click the Connections menu.
- On the connection, click the vertical ellipsis button ⋮ > Re-authorize.
-
Make application obsolete
To make an application obsolete, click Applications in the main menu, then click the vertical ellipsis button ⋮ > Make obsolete.⚠ Attention: Marking an application as obsolete does not permanently remove it. All existing connections that use that application remain active, although you cannot create new connections to it.
-
Reactivate obsolete applications
To reactivate an obsolete application, in the Applications menu, click the vertical ellipsis button ⋮ > Reactivate. -
Delete applications
To delete applications that do not have connections attached to it or applications that are obsolete, in the Applications menu, click the vertical ellipsis button ⋮ > Delete.⚠ Attention: This permanently removes the application from the system.