NAV

OAuth Authentication for Email Providers

In order to allow SimpleHelp to connect and send emails on your behalf using OAuth authentication a Client ID and Client Secret is required. These credentials are specific to SimpleHelp and are different to your username and password. Below are instructions on how to generate these for common platforms.

Connect to Google / GMail

In order to send email using your Google or Gmail account, you will to perform some configuration steps in the Google Developers Console. This will instruct Google to expect emails from SimpleHelp, and will allow you to configure what your users see when access is requested.

Follow these steps to configure Google OAuth 2.0 SMTP access:

  • Using your existing Google account go to the Google Developers Console.
  • Select APIs and Services
  • Press Create Project to create a new project.
  • On the left select Credentials

Google Credentials Screenshot

  • Press Create Credentials to create a new set of credentials:

Google Create Credentials Screenshot

  • Choose OAuth Client ID from the resulting menu:

Google Create Credentials Screenshot

  • Complete the following details:

X
Application Type Select Web Application
Name Any name that will help you identify this ID, such as SimpleHelp Server
Authorised Javascript Origins Enter in your SimpleHelp server URL, such as https://simplehelp.yourserver.com
Authorised redirect URIs Enter in the /oauth page of your SimpleHelp server, such as https://simplehelp.yourserver.com/oauth
  • Press Create to create your OAuth Client ID.
  • You will be presented with your new Client ID and Client Server. These values should be entered into SimpleHelp.

Azure AD, Office365, Live

  • Using your existing Microsoft account, go to the Azure Portal.
  • Select Azure Active Directory.

Microsoft Portal Screenshot

  • Select App Registrations on the left.
  • Click New Registration near the top of the page.

Microsoft New Registration Screenshot

  • Complete the following details:

X
Name Provide a name for this registration, such as SimpleHelp Server.
Redirect URI Select Web and enter in the /oauth page on your SimpleHelp server, such as https://simplehelp.yourserver.com/oauth
  • Click Register and you will be presented with a summary. Please note the Application (client) ID and note it down:

Microsoft Portal Screenshot

  • On the left, select Certificates and Secrets:

Microsoft Certificates Screenshot

  • Press New Client Secret and configure the secret with a memorable description and expiry date.
  • Immediately copy the Secret Value and note it down.
  • In the left menu select Authentication:
  • Switch Allow public client flows to Yes and click Save:

Microsoft Public Flow Screenshot

  • Select API Permissions:

Microsoft Public Flow Screenshot

  • Click on Add a Permission, Microsoft Graph, Delegated Permissions.
  • Add the following permissions: Mail.Send, User.Read.All, User.Read
  • Click Grant administrator consent for ... to grant consent for the new permissions.

You can now enter the Application (client) ID and Secret Value into SimpleHelp for the Client ID and Client Secret fields respectively.

Troubleshooting

Common Send Email Failed error messages when using Send Test Email and their solutions:

X X
Exception reading response Appears when the Client Secret is incorrect. Most often this is due to entering the Secret ID instead of the required Secret Value. Click Reconfigure Authentication to enter the correct value.
This will also appear when trying to use an account that does not have full administrative rights (but is otherwise valid).
Could not connect to SMTP host. ... (Unsupported or unrecognised SSL message). The SSL mode is incorrect: Try "Use SSL/TLS if available" to use STARTTLS (e.g. for smtp.office365.com)
invalid_client ... The OAuth client was not found. The access token has expired and cannot be refreshed. This can be due to previously working settings being changed (either in SimpleHelp or the target platform). Check your settings, trying Reconfigure Authentication if necessary.

If you are still encountering problems, extract a copy of your server log to add as an attachment and get in touch with our support team for further assistance.