AgileApps Support Wiki Pre Release

Registering your Application in the External Mail Server

From AgileApps Support Wiki

Using Gmail as your Mail Server

Before you configure your mailbox settings on AgileApps Client, perform the following steps to register your application in the Google Mail Server.

Registering your Application in the Google Mail Server

Notepad.png

Note:

  • You must register your application in the Google Mail Server as an OAuth Client.
  • You must create a project prior to performing the application registration process.
  1. Go to Google Developer Console.
  2. Access the email address you have registered for the external Mailbox.
  3. Click the Select a project drop-down, and then click New Project.

    Google Console Dashboard Page Project.png

  4. On the New Project window, enter the desired project name and update the location.
  5. Click CREATE. The new project is created.
  6. Click Select a project dropdown and select the newly added project.
  7. Under Quick access section, click APIs and services.
  8. On the left sidebar, click OAuth consent screen.

    APIs and Services OAuth consent screen.png

  9. OAuth consent screen: Add the basic information for the OAuth configuration.
    1. Select the External option, and then click CREATE.
    2. On the Edit app registration page, enter the following details:
      • App Information
        • App name: Enter the application name you want to register.
        • User support email: Enter the email address you have registered as the external mailbox.
        • App logo (optional): Upload the desired application logo. Allowed image formats are JPG, PNG, and BMP. Logos should be square and dimensions should be 120*120 pixels for the best results. The file size must not exceed 1 MB.
      • Developer contact information
        • Email addresses: Enter the same email address as provided in the User support email field in the App Information section.
    3. Click SAVE AND CONTINUE.

      OAuth consent screen.png

  10. Scopes: Add the scope(s).
    1. Click ADD OR REMOVE SCOPES.
    2. On the Manually add scopes field, enter https://mail.google.com/.
    3. Click ADD TO TABLE.
    4. Ensure that the checkbox of the scope that you added is selected.
    5. Click UPDATE > SAVE AND CONTINUE.
  11. Test users: Add the users.
    1. Click ADD USERS.
    2. Enter the same email ID you provided in the OAuth consent screen page.
    3. Click Add > SAVE AND CONTINUE.

      Add users Test users OAuth.png

  12. Summary: You can find the information provided in the previous tabs here.
  13. On the left sidebar, click Credentials.
  14. Click CREATE CREDENTIALS > OAuth client ID.

    CREATE Credentials OAuth client ID.png

  15. From the Application type dropdown menu, select Web application to create an OAuth client ID and client secret.
  16. Click CREATE.

    Create Client ID for web application.png

  17. The Client ID and Client secret values are generated.
    Client ID for web application.png

Notepad.png

Note: Copy the Client ID and Client secret values, and paste them into respective fields on the AgileApps OAuth configuration page.

Using Microsoft Outlook as your Mail Server

Before you configure your mailbox settings on AgileApps Client, perform the following steps to register your application in the Microsoft Mail Server.

Registering your Application in the Microsoft Mail Server

Prerequistes:

  • Ensure that the user has the required license to access the external Mailbox, that is Microsoft Outlook. For example:

    Microsoft Admin Console Licenses.png

  • Go to https://admin.microsoft.com > Users > Active users page. Search for the user in the list and select the checkbox to see information about the user.
  • Provide the license information in the Licenses and apps tab. Ensure that the IMAP and POP protocols are not in the blocked state and you must have only the Other email apps allowed text displayed in the Mail > Email apps section. The user for whom you have updated the license information is allowed to access the mailbox.

    Microsoft Admin Console Email Apps Section.png

Notepad.png

Note:
After you perform the steps mentioned in the Prerequisites section, you must wait for a minimum of 30 minutes for the changes to get synchronized and reflected.

You must register your application in the Microsoft Mail Server as an OAuth Client. You must create a project prior to performing the application registration process.

  1. Go to the Microsoft Azure portal and sign in with your credentials.
  2. Under Azure Active Directory, go to the App registrations page and click + New registration tab. Enter the following details and click Register.
    • Name: Enter your application name.
    • Supported account types: Select Accounts in any organizational directory (Any Azure AD directory – Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox) option.
    • Redirect URI: Enter the redirect URI.
  3. Under App registrations, go to the API permissions page and click + Add a permission. Select the following permissions:
    • IMAP.AccessAsUser.All
    • Offline_access
    • POP.AccessAsUser.All

      API Permissions Page Microsoft Azure Scopes.png
    Note:
    • To get the refresh token that can be used to renew the access token, you must include Offline_access scope.
  4. To locate the Client ID, perform the following steps:
  5. Under Azure Active Directory > integrationserver > App registrations > Overview window, you will see all the information about the application you have registered.
  6. You must copy the Application (client) ID and paste it into the Client ID textbox of the AgileApps Client Mailbox settings.

    Application Overview page Microsoft Azure.png

  7. Under App registrations, go to the Certificates & secrets > Client secrets tab and click + New client secret. Enter the description and expiry date and click Save. You must copy the Value that is generated and paste it into the Client Secret textbox on the AgileApps Client mailbox settings page.

    Client Secret ID - Microsoft Azure.png

    Note:
    • Do not copy the Secret ID. It is the Value you must copy and paste into the Client Secret textbox.
    • The value appears once when you register the application. Copy it immediately, after which it gets hidden.
  8. To see the Auth URL and Access Token URL, perform the following steps:
    1. Under the Azure Active Directory > integrationserver > App registrations > Overview window, click the Endpoints tab.

      Application Endpoints Page Microsoft Azure.png

    2. Copy the OAuth 2.0 authorization endpoint (v2) and paste it into the Auth URL textbox of the AgileApps Client – New Mailbox page.
    3. Copy the OAuth 2.0 token endpoint (v2) and paste it into the Access Token URL textbox of the AgileApps Client – New Mailbox page.

Previous

Next


Back to Article Index