Email Server Configuration

You can configure Control-M components to connect to email servers via the following connection types:

Secure Connection: Connects via Simple Mail Transfer Protocol Secure (SMTPS), which adds the Transport Layer Security (TLS) to SMTP to encrypt and secure data integrity.
- Connecting Control-M/EM to an Email Server via SMTPS
- Connecting Control-M/Server to an Email Server via SMTPS
Cleartext Connection: Connects via SMTP and does not encrypt data.
- Connecting Control-M/EM to an Email Server via SMTP Cleartext Login
- Connecting Control-M/Server to an Email Server via SMTP Cleartext Login

By default, Control-M components connect to email servers via SMTP cleartext login, without authentication.

Connecting Control-M/EM to an Email Server via SMTPS

This procedure describes how to connect Control-M/EM to an email server with or without authentication credentials, via SMTPS, which increases data integrity and security.

Begin

Do the following:
1. Verify that the email server parameters are correctly configured, as described in Configuring Control-M Workload Change Manager Email Notifications.
2. Verify that the email server host and port are defined by the EmailServer parameter, as described in Configuring Control-M/EM System Parameters.
Navigate to the <EM_HOME>/etc/ directory, make a copy of the mail.smtps.properties file, and save it as mail.properties in the same directory.
Do one of the following:
- Without Authentication: Open the mail.properties file in a text editor, and change the mail.smtps.auth parameter to false.
- With Authentication: Do the following:
  1. Open the mail.properties file in a text editor, and verify that the mail.smtps.auth parameter is set to true.
  2. Make a copy of the mail_auth.properties.default file, and save it as mail_auth.properties in the same directory, <EM_HOME>/etc/.
  3. Open the mail_auth.properties file and at the bottom of the file, define the following parameters:
    - bmc.mail.user=<Username>
    - bmc.mail.password=<Password>
    - bmc.mail.password_crypt=no
  4. (Optional) Do the following to encrypt the password in the mail_auth.properties file:
    1. Navigate to the <EM HOME>/bin/ directory.
    2. Run the changeMailPass utility.
    3. At the prompt, type the password.
    The changeMailPass utility encrypts the password and sets the bmc.mail.password_crypt encryption parameter to yes.
    
    In Control-M/EM 9.0.21 and higher, the changeMailPass utility uses the db_enc_key.txt encryption key. In lower versions, this utility uses the password encryption key defined in the <EM_HOME>/etc/aes.key file. For more information, see Control-M Encryption Keys.

Connecting Control-M/Server to an Email Server via SMTPS

This procedure describes how to connect Control-M/Server to an email server with or without authentication credentials, via SMTPS, which increases data integrity and security.

Begin

Do the following:
1. Verify that the local Agent email server parameters are correctly configured, as described in Email Parameters.
2. Verify that the email server host and port are defined by the SMTP_SERVER_NAME and SMTP_PORT_NUMBER parameters, as described in SMTP Parameters.
Navigate to the <Control-M/Server_Home>/ctm_server/data/ directory, make a copy of the mail.smtps.properties file, and save it as mail.properties to the same directory.
Do one of the following:
- Without Authentication: Open the mail.properties file in a text editor, and change the mail.smtps.auth parameter to false.
- With Authentication: Do the following:
  1. Open the mail.properties file in a text editor, and verify that the mail.smtps.auth parameter is set to true.
  2. From the <Control-M/Server_Home>/ctm_server/data/ directory, make a copy of the mail_auth.properties.default file, and save it as mail_auth.properties in the same directory.
  3. Open the mail_auth.properties file and at the bottom of the file, define the following parameters:
    - bmc.mail.user=<Username>
    - bmc.mail.password=<Password>
    - bmc.mail.password_crypt=no
  4. (Optional) Do the following to encrypt the password in the mail_auth.properties file:
    1. Navigate to the <Control-M/Server_Home>/scripts/ directory.
    2. Run the ctm_change_mail_pass utility.
    3. At the prompt, type the password.
    The utility encrypts the password and sets the bmc.mail.password_crypt encryption parameter to yes.
    
    In Control-M/EM 9.0.21 and higher, the ctm_change_mail_pass utility uses the db_enc_key.txt encryption key. In lower versions, this utility uses the password encryption key defined in the <Control-M/Server_Home>/etc/aes.key file. For more information, see Control-M Encryption Keys.

Connecting Control-M/EM to an Email Server via SMTP Cleartext Login

This procedure describes how to connect Control-M/EM to an email server with or without authentication credentials via SMTP cleartext login, which does not encrypt data.

Begin

Do the following:
1. Verify that the email server parameters are correctly configured, as described in Configuring Control-M Workload Change Manager Email Notifications.
2. Verify that the email server host and port are defined by the EmailServer parameter, as described in Configuring Control-M/EM System Parameters.
(Optional) Do the following to connect with authentication:
1. Navigate to the <EM_HOME>/etc/ directory, make a copy of the mail.smtp_no_auth.properties file, and save it as mail.properties in the same directory.
2. Open the mail.properties file in a text editor, and at the bottom of the file, add the following line:
  
  mail.smtp.auth=true
3. Make a copy of the mail_auth.properties.default file, and save it as mail_auth.properties in the same directory, <EM_HOME>/etc/.
4. Open the mail_auth.properties file and at the bottom of the file, define the following parameters:
  - bmc.mail.user=<username>
  - bmc.mail.password=<password>
  - bmc.mail.password_crypt=no
5. (Optional) Do the following to encrypt the password in the mail_auth.properties file:
  1. Navigate to the <EM HOME>/bin/ directory.
  2. Run the changeMailPass utility.
  3. At the prompt, type the password.
  The utility encrypts the password and changes the encryption status to bmc.mail.password_crypt=yes.
  
  In Control-M/EM 9.0.21 and higher, the changeMailPass utility uses the db_enc_key.txt encryption key. In earlier versions, this utility uses the password encryption key defined in the <EM_HOME>/etc/aes.key file. For more information, see Control-M Encryption Keys.

Connecting Control-M/Server to an Email Server via SMTP Cleartext Login

This procedure describes how to connect Control-M/Server to an email server with authentication credentials via SMTP cleartext login, which does not encrypt data.

Begin

Do the following:
1. Verify that the email server parameters are correctly configured, as described in Email Parameters.
2. Verify that the email server host and port are defined by the SMTP_SERVER_NAME and SMTP_PORT_NUMBER parameters, as described in SMTP Parameters.
(Optional) Do the following to connect with authentication:
1. Navigate to the <Control-M/Server_Home>/ctm_server/data/ directory, make a copy of the mail.smtp.properties file, and save it as mail.properties to the same directory.
2. Open the mail.properties file in a text editor, and at the bottom of the file, add the following line:
  
  mail.smtp.auth=true
3. From the <Control-M/Server_Home>/ctm_server/data/ directory, make a copy of the mail_auth.properties.default file, and save it as mail_auth.properties in the same directory.
4. Open the mail_auth.properties file and at the bottom of the file, define the following parameters:
  - bmc.mail.user=<username>
  - bmc.mail.password=<password>
  - bmc.mail.password_crypt=no
5. (Optional) Do the following to encrypt the password in the mail_auth.properties file:
  1. Navigate to the <Control-M/Server_Home>/scripts/ directory.
  2. Run the ctm_change_mail_pass utility.
  3. At the prompt, type the password.
  The utility encrypts the password and changes the encryption status to bmc.mail.password_crypt=yes.
  
  In Control-M/EM 9.0.21 and higher, the ctm_change_mail_pass utility uses the db_enc_key.txt encryption key. In earlier versions, this utility uses the password encryption key defined in the <Control-M/Server_Home>/etc/aes.key file. For more information, see Control-M Encryption Keys.