Mail configuration - Platform - BlueCat Gateway - 25.3.0

Gateway Administration Guide
ft:locale
en-US
Product name
BlueCat Gateway
Version
25.3.0

BlueCat Gateway supports Python Flask-Mail for use in custom workflows. Administrators and users can configure Mail settings in the Mail configuration page. Workflows can acquire values and information from the configured settings to send email messages and notifications to the specified recipient addresses. This lets Gateway administrators and other users update email recipients without having to be a workflow developer.

Note: By default, no built-in Gateway workflows send email notifications to recipients listed in these settings. They are provided only for use in custom workflows.

To enter Mail configuration settings:

  1. Open the Mail configuration window. (Click Settings at the bottom of the navigator on the left, expand Configurations, then click Mail configuration.)

  2. Configure the Mail settings as desired.

    For more details, see Mail configuration settings list below

  3. When you're done, click Save changes.

    To cancel your changes, click Cancel instead.

Mail configuration settings list

The Mail configuration page has the following settings.

Setting Description
Mail server The domain of the SMTP host. For example, smtp.mail.example.com.
Mail port The port number for the mail service.
Use TLS

Tick Use TLS to enable secure Internet communication with Transport Layer Security (TLS).
Use SSL

Tick Use SSL to enable SSL validation (Secure Sockets Layer).
Sign in to your mail service

Tick this checkbox if you need to sign in to your mail service. Several additional fields will appear for authentication information, such as account usernames, passwords, and password files.

Note: For security reasons, if you clear this checkbox before saving your changes, any changes you just entered or files you just added will be deleted.
Username

(Appears only if Sign in to your mail service is ticked.)

Enter the username of the Flask-Mail account that Gateway should use.
Password source

(Appears only if Sign in to your mail service is ticked.)

Select how you want to specify the password for the Flask-Mail account.

  • To upload an encrypted password file, select Encrypted file.

  • To enter the password manually, select Input value.
Encrypted file

(Appears only if Sign in to your mail service is ticked and Password source is Encrypted file.)

A file with an encrypted password that Gateway should use when signing in to the Flask-Mail account.

To add or change the encrypted password file, either drag the file onto the encrypted password file box area, or click in the box area to browse to a file. The file must be 1 MB or lower.

Tip: You can use the Encrypt password page to create an encrypted password file. For more details, see Encrypt password page.
Password

(Appears only if Use username and password is selected and Password source is Input value.)

Enter the password that Gateway should use when signing in to the Flask-Mail account.

Mail sender

 Enter the email address that BlueCat Gateway will use as the Sender when sending emails.
Mail recipients

The list of email addresses to whom notifications should be sent when using this feature.

To add a new email recipient:

  • Enter the email address for the recipient in the Mail recipients field and click the plus (+) symbol that appears to the right. (Or just press Enter).

To remove an email recipient from the list:

  • Click the X next to the email address in the list under Mail recipients.

Note: By default, no built-in Gateway workflows send email notifications to listed recipients. They are provided only for use by custom workflows.