Configuring the mail server

Health check event notifications and scheduled reports can use the same mail server. If you use the CLI to configure the server, you must use two separate sets of CLI commands. The mail server settings are described in the following table.

System mail server settings

Web UI Field	Health Check CLI Parameter	Report CLI Parameter	Description
Enable email	—	—	Enables the email delivery of health check notifications and scheduled reports.
Mail hub	mailhub	server	The hostname or IP address of the mail server.
Port	mailhub-port	port	The SMTP port used to send the emails. The default is 25.
Domain	domain	domain	The domain name from which emails will appear to come. The default is the active domain for the appliance.
Return Addr	return-addr	return-addr	Health check parameter: The username or fully qualified return address from which emails are sent. If the string contains the @ character, it is considered fully qualified. Otherwise, it is considered a username, and by default takes the form <username>@<hostname>.<domain>. The default username is do-not-reply. Report parameter: The fully qualified return address from which emails are sent.
Incl. hostname	return-host	—	Whether the appliance hostname is included in the return address. If it is excluded, the return address takes the form <username>@<domain>. This setting is ignored if the provided return address is fully qualified.

Prerequisites

Operator or Admin access

Configuring the mail server using the Web UI

Use the Email Settings page to configure settings for the mail server.

To configure the mail server:

Click the Settings tab.
Click Email on the sidebar.
Specify settings as described in System mail server settings .
Click Update to save your changes.

Configuring the mail server for health check notifications using the CLI

Use the CLI commands in this topic to configure the mail server that sends health check notifications. See System mail server settings for a description of each parameter.

Note
See Configuring email recipients using the CLI for information about configuring the notification recipients. See Configuring system event notifications using the CLI for information about configuring the events that trigger notifications.

To configure the mail server for system notifications:

Go to CLI configuration mode:

hostname > enable
hostname # configure terminal

Specify the hostname or IP address of the mail server:

hostname (config) # email mailhub {<hostname> | <IPv4 or IPv6 address>}

Specify the SMTP port used by the mail server to send notifications:
```
hostname (config) # email mailhub-port <port>
```
Specify the domain name from which emails will appear to come:
```
hostname (config) # email domain <domainName>
```
Specify the username or fully qualified return address from which emails are sent:
```
hostname (config) # email return-addr {<username> | <returnAddress>}
```
(Optional) Include the hostname of the mail server in the return address:
```
hostname (config) # email return-host
```
Verify your changes:
```
hostname (config) # show email
```
Save your changes:
```
hostname (config) # write memory
```

Note
To remove a configuration or restore a default setting, append no to the command. For example, to exclude the hostname in the return address, use the no email return-host command, and to restore the default domain name, use the no email domain command.

Examples

In this example, the return address is not fully qualified, so the hostname ("hostname") and domain are appended to it.

hostname (config) # email mailhub 10.1.0.0
hostname (config) # email domain mail.acme.com
hostname (config) # email return-addr admin
hostname (config) # show email
Mail hub:          10.1.0.0
Mail hub port:     25
Domain override:   mail.acme.com
Return address:    admin
Include hostname in return address: yes

Current reply address: admin@hostname.mail.acme.com
...

In this example, the return address is fully qualified, so the hostname and domain are not included.

hostname (config) # email mailhub 10.1.0.0
hostname (config) # email domain mail.acme.com
hostname (config) # email return-addr notify@acme.com
hostname (config) # show email
Mail hub:          10.2.0.0
Mail hub port:     25
Domain override:   mail.acme.com
Return address:    notify@acme.com
Include hostname in return address: yes

Current reply address: notify@acme.com
...

In this example, all settings are restored to their default values.

hostname (config) # show email
Mail hub:          10.3.0.0
Mail hub port:     26
Domain override:   mailhost.acme.com
Return address:    admin
Include hostname in return address: no

Current reply address: admin@hostname.mailhost.acme.com
...

hostname (config) # no email mailhub
hostname (config) # no email mailhub-port
hostname (config) # no email return-addr
hostname (config) # email return-host
hostname (config) # show email
Mail hub: 
Mail hub port:     25
Domain override:   
Return address:    do-not-reply
Include hostname in return address: yes

Current reply address: do-not-reply@hostname.acme.com
...

Configuring the mail server for scheduled reports using the CLI

Use the CLI commands in this topic to configure the mail server that sends scheduled reports. See System mail server settings for a description of each parameter.

Important
If you use the CLI to configure the mail server, the changes will not appear on the Email Settings page in the Web UI.

Note
See Adding and removing scheduled report recipients for information about configuring the report recipients using the CLI.

To configure the mail server for scheduled reports:

Go to CLI configuration mode:

hostname > enable
hostname # configure terminal

Specify the hostname or IP address of the mail server:

hostname (config) report email smtp server {<hostname> | <ipAddress>}

Specify the SMTP port used by the mail server to send reports:
```
hostname (config) # report email smtp port <port>
```
Specify the domain name from which emails will appear to come:
```
hostname (config) # report email smtp domain <domainName>
```
Specify the fully qualified return address from which emails are sent:
```
hostname (config) # report email smtp return-addr <returnAddress>
```
Verify your changes:
```
hostname (config) # show report email
```
Save the configuration:
```
hostname (config) # write memory
```

Note
To remove a configuration or restore the default setting, append no to the command. For example, to restore the default return address, use the no report email return-addr command, and to remove the configured domain name, use the no report email smtp domain command.

Examples

In this example, the email server is configured to send scheduled reports.

hostname (config) # report email server 10.4.0.0
hostname (config) # report email smtp domain mailer.acme.com
hostname (config) # report email smtp return-addr reports@acme.com
hostname (config) # show report email

Report email configurations:
        SMTP server: 10.4.0.0   
        SMTP server port: 25
        SMTP Domain: mailer.acme.com
        SMTP Return addr: reports@acme.com
        ...

In this example, all configuration settings are restored to their default values.

hostname (config) # show report email

Report email configurations:
        SMTP server: 10.4.0.0
        SMTP server port: 26
        SMTP Domain: acme.com
        SMTP Return addr: admin@acme.com
        ...
hostname (config) # no email report smtp server
hostname (config) # no email report smtp port
hostname (config) # no email report smtp domain
hostname (config) # no email report smtp return-addr
hostname (config) # show report email

Report email configurations:
        SMTP server: 
        SMTP server port: 25
        SMTP Domain: 
        SMTP Return addr: do-not-reply
        ...