Use this tab to configure email settings.
| Field | Description |
|
OAuth Flow
|
Use this field to specify the OAuth mechanism type. OAuth
mechanism types or grant types define different ways to obtain access tokens,
each suited for specific use cases.
Select from the following options:
- None: Select
this option if you prefer not to specify the OAuth mechanism type.
- Authorization
Code: This type is typically used by server-side applications. It
involves the client obtaining an authorization code from the authorization
server, which is then exchanged for an access token. This flow ensures that the
client never directly handles the user's credentials.
- Authorization Code with
PKCE (Proof Key for Code Exchange): This type is an extension to
the authorization code flow to prevent CSRF and authorization code injection
attacks. The technique involves the client first creating a secret on each
authorization request and then using that secret again when exchanging the
authorization code for an access token. This way, if the code is intercepted,
it will not be useful since the token request relies on the initial secret.
- Client
Credentials: This type is used for machine-to-machine
communication, where the client uses its own credentials to obtain an access
token.
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.
This field defaults to None.
|
| Basic SMTP Settings
|
This group box contains settings that enable you to set up your
default email server.
- 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: Select this option to enable Transport Layer Security (TLS)
encryption for your email communication.
- 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
|
This group box enables you to set up your Open Authorization
(OAuth) email server.
- Default
Sender Email: When the application sends a user an email message,
the message comes from this email address. The same email address receives an
error message when the recipient’s email address is invalid.
- Display
Name: This field displays the name of the sender for outgoing
emails.
- SMTP
Server: This field displays the host name or IP address of an
SMTP-compliant email server, for example,
smtp.yahoo.com.
- Port
: This field displays the SMTP port that the
specified SMTP server uses.
- Use
TLS: Select this option to enable TLS encryption for your email
communication.
Note: If you set
OAuth Flow to
Authorization Code,
Authorization Code with PKCE, or
Client Credentials, the fields are required.
|
| Authentication Settings
|
This group box enables you to initiate the Open Authorization
(OAuth) process from SMTP settings.
- 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.
Note: 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: Click this button to
initiate the OAuth process and retrieve a new access 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
|
Click this button to send an email message to verify that the
configured settings are accurate and that the application can successfully send
email to the user 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.