PPM Administrator Help System

Communication Email Tab

Use this tab to configure email settings.

Field Description
OAuth Flow Select from the following options:
  • None
  • Authorization Code
  • Authorization Code with PKCE (Proof Key for Code Exchange)
  • Client Credentials

If you select None, you must complete the Basic SMTP Settings section, and SMTP OAuth Settings section will be disabled.

If you select any other option, the Basic SMTP Settings section become optional, but the OAuth SMTP Settings and Authentication Settings sections are required.

Basic SMTP Settings If you set OAuth Flow to None, the following fields are required:
  • Default Sender Email: Use this field to enter a valid host name or IP address of the SMTP (Simple Mail Transfer Protocol) server that will be used to send emails from PPM Administrator and other PPM products. This field allows up to 254 alphanumeric characters.
  • Display Name: Use this field to enter the display name when sending email from the System Email address. This field allows up to 254 alphanumeric characters.
  • SMTP Server: Use this field to enter a valid host name or IP address of the SMTP server that will be used to send emails from PPM Administrator and other PPM products.
  • Port: Use this field to enter a port number for SMTP communication. Typically, you use port 25 for non-secure and port 587 for secure communication. This field accepts values from 0 to 65, 535.
  • Use TLS: Use this field to enter the user name that will be used to access the email server.
  • Username: Use this field to enter the user name that will be used to access the email server.
  • Password: Use this field to enter the password associated with the user name used to access the email server.
Note: The Username and Password fields are optional. The Password field is required only if the Username field contains a value.
OAuth SMTP Settings If you set OAuth Flow to Authorization Code, Authorization Code with PKCE, or Client Credentials, the following fields are required:
  • Default Sender Email
  • Display Name
  • SMTP Server
  • Port
  • Use TLS
Authentication Settings If you set OAuth Flow to Authorization Code, Authorization Code with PKCE, or Client Credentials, the following fields are required:
  • Client ID: Use this field to specify the ID of the client for the OAuth server. This value will be hidden as you enter it.
  • Client Secret: Use this field to specify the character string of the client secret manually obtained from the server. This value will be hidden as you enter it.
  • Authorization Endpoint: Use this field to specify the endpoint where the user is redirected to grant permission. Enter a valid URL. This field allows up to 500 characters.
  • Token Endpoint: Use this field to specify the endpoint used in the OAuth authorization process where a client application exchanges an authorization code for an access token. Enter a valid URL. This field allows up to 500 characters.
  • Redirect URI : Use this field to specify the specific permissions an application can request from a user. Enter a valid string value or URL. This field allows up to 500 characters and is case-sensitive.
  • Scope: Use this field to specify and limit the exact permissions or level of access that the client application is requesting from the user. Enter a valid string value or URL. This field allows up to 500 characters.

All these fields are required. If you set OAuth Flow to Client Credentials, the Authorization Endpoint and Redirect URI fields become disabled.

OAuth Token Management This group box contains the following buttons:
  • Get Auth Token: While the form is being edited, this button is disabled. Once click Save, it becomes enabled. Click this button to obtain access token.

    When you click this button, the application helps you authenticate with your email provider and safely saves your access token. If you update your SMTP settings afterward, a warning message displays to let you know that updating will delete your current OAuth token, requiring you to get a new one.

  • Token Status: <Expired or Valid>: This field displays the current state of your token. If the value is Expired, the displayed text is red. If the value is Valid, it is green.
  • Token Expires: <Token expiration date and time>: This field displays the validity period of your current token. The displayed value follows the date format set in My Preferences + Time.
Send Test Email Select this button to send an email message to verify that the configured settings are accurate and can successfully send email to the system email account.

Clicking this button send the email to the currently logged in user's email address.

Note: The Save and Cancel buttons only display and become enabled if you make any changes to the settings.