Email configurations

3 minute readAutomation

Use this page to manage email configurations on the CloudBees CD/RO server. You must create at least one email configuration before you can send email notifications to individuals or groups.

If you have multiple users or groups in remote locations that use a different mail server, create additional email configurations to accommodate those locations if they need to receive CloudBees CD/RO notifications.

CloudBees CD/RO server settings

Before you create email configurations, your CloudBees CD/RO server settings for email notifications must be configured.

To configure CloudBees CD/RO server settings:

  1. From the CloudBees CD/RO main menu, select Administration  Server settings  Email notification. The Edit Email Notifications page displays.

  2. Review and set the following:

    Field Name Description

    Date and time format for email notifications

    Format to use for rendering date and time in email notifications.

    Protocols for SSL connections to the SMTP server

    Whitespace-separated list of protocols to enable for SSL connections to SMTP servers. Used to set the mail.smtp.ssl.protocols system property. Defaults to TLSv1.2.

    Set the 'From' header when sending email notifications

    If true, set the From header in the email message. Defaults to true.

    Date and time timezone for email notifications

    The timezone to use to render the date and time in email notifications.

  3. Select Save changes to save the settings.

Creating email configurations

To create email configurations:

  1. From the CloudBees CD/RO main menu, select Administration  Configurations  Email configurations. The Email configurations page displays.

  2. Select Add email configuration. The New email configuration pane opens.

  3. Enter information into the fields as follows:

    Field Name Description

    Name

    Unique name to identify the email configuration

    Description

    (Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

    • For example, the following HTML:

      <p> <span style="font-family: Arial;"> <i>Note:</i> For more information about the <b>abc</b> object, see <a href="https://www.google.com/">https://www.google.com</a>. </span> </p>

      renders as follows:

      <i>Note</i>: For more information about the <b>abc</b> object, see https://www.google.com.

    Mail protocol

    Specify either SMTPS or SMTP

    Mail host

    Mail server name

    Mail port

    (Optional) Port number for the mail server. For Google gmail configurations use port 587 for SMTP and port 465 for SMTPS.

    If not specified, 25 for SMTP and 465 for SMTPS are used.

    Mail from

    Email address used as the email sender address for CloudBees CD/RO notifications. This must be a fully-qualified email address (meaning that it must be of the form <name>@<domain> )

    Credential type

    Indicates whether the credentials are local or external

    Mail username

    Individual name or a generic name such as qa-test

    Mail password

    Password for the mail user name

  4. Select Save.

  5. Select Test to make sure your email configuration works:

    Enter a destination email address in the Email Configuration Test popup that opens, and then select Send.

Editing configurations

To edit email configurations:

  1. From the CloudBees CD/RO main menu, select Administration  Configurations  Email configurations. The Email configurations page displays.

  2. Select the Actions button corresponding to the email configuration, then select Details. The Edit email configuration pane opens.

  3. Update the configuration.

  4. Select Save.

Deleting configurations

To delete email configurations:

  1. From the CloudBees CD/RO main menu, select Administration  Configurations  Email configurations. The Email configurations page displays.

  2. Select the configuration name, then select Delete email configuration or select the Actions button, and then select Delete.