App Passwords

Some email providers generate a separate password for use with a specific application, rather than requiring your main account password. This is called an app password. App passwords are typically required when you have two-step verification (or similar account security) enabled on your email account and the account you are connecting does not use modern OAuth authentication.

Gmail is used as the example in this guide. Other providers such as Yahoo Mail offer similar app password functionality through their own account security settings.

If your organisation uses OAuth to connect SuiteCRM to Gmail or Microsoft 365, you do not need an app password. When setting up your personal email account, set Auth Type to OAuth instead of Basic Auth. See Email Account Setup for details, and contact your system administrator to confirm OAuth is available for your provider.

Generating an App Password (Gmail)

Enable 2-Step Verification

App passwords require 2-Step Verification to be enabled on your Google account before you can generate one.

Create an App Password

  1. In your Google Account, go to the Security section.

  2. Go to App Passwords. You may be asked to sign in again.

  3. Click the Select app drop-down and select Other (Custom name).

  4. Enter a name such as suitecrm.

  5. Click Generate.

  6. Copy the generated password from the pop-up that appears. This password will not be shown again — if you lose it, you will need to generate a new one.

Using the App Password in SuiteCRM

The generated app password is used in place of your regular email account password wherever SuiteCRM asks for one, when configuring a personal email account from your user profile.

To use an app password:

  1. Follow the steps in Email Account Setup to create a personal outbound or inbound email account.

  2. When completing the account form, set Auth Type to Basic Auth.

  3. Enter the app password in the Password field in place of your normal account password.

  4. Click Send Test Email (for an outbound account) or Test Connection Settings (for an inbound account) to verify the connection.

  5. Click Save to store the account settings.

System administrators can configure system-wide outbound email accounts using an app password from the Admin panel. This is separate from the personal account setup described here and is not covered in this guide.

Content is available under GNU Free Documentation License 1.3 or later unless otherwise noted.