Documentation
Table of Contents
1 E-mail
Overview
To configure e-mail as the delivery channel for messages, you need to configure e-mail as the media type and assign specific addresses to users.
Configuration
To configure e-mail as the media type:
- Go to Administration → Media types
- Click on Create media type (or click on E-mail in the list of pre-defined media types).
The Media type tab contains general media type attributes:
All mandatory input fields are marked with a red asterisk.
| Parameter | Description |
|---|---|
| Name | Name of the media type. |
| Type | Select Email as the type. |
| SMTP server | Set an SMTP server to handle outgoing messages. |
| SMTP server port | Set the SMTP server port to handle outgoing messages. This option is supported starting with Zabbix 3.0. |
| SMTP helo | Set a correct SMTP helo value, normally a domain name. |
| SMTP email | The address entered here will be used as the From address for the messages sent. Adding a sender display name (like "Zabbix-HQ" in Zabbix-HQ <[email protected]> in the screenshot above) with the actual e-mail address is supported since Zabbix 2.2 version. There are some restrictions on display names in Zabbix emails in comparison to what is allowed by RFC 5322, as illustrated by examples: Valid examples: [email protected] (only email address, no need to use angle brackets) Zabbix HQ <[email protected]> (display name and email address in angle brackets) ∑Ω-monitoring <[email protected]> (UTF-8 characters in display name) Invalid examples: Zabbix HQ [email protected] (display name present but no angle brackets around email address) "Zabbix\@\<H(comment)Q\>" <[email protected]> (although valid by RFC 5322, quoted pairs and comments are not supported in Zabbix emails) |
| Connection security | Select the level of connection security: None - do not use the CURLOPT_USE_SSL option STARTTLS - use the CURLOPT_USE_SSL option with CURLUSESSL_ALL value SSL/TLS - use of CURLOPT_USE_SSL is optional This option is supported starting with Zabbix 3.0. |
| SSL verify peer | Mark the checkbox to verify the SSL certificate of the SMTP server. The value of "SSLCALocation" server configuration directive should be put into CURLOPT_CAPATH for certificate validation. This sets cURL option CURLOPT_SSL_VERIFYPEER. This option is supported starting with Zabbix 3.0. |
| SSL verify host | Mark the checkbox to verify that the Common Name field or the Subject Alternate Name field of the SMTP server certificate matches. This sets cURL option CURLOPT_SSL_VERIFYHOST. This option is supported starting with Zabbix 3.0. |
| Authentication | Select the level of authentication: None - no cURL options are set (since 3.4.2) Username and password - implies "AUTH=*" leaving the choice of authentication mechanism to cURL (until 3.4.2) Normal password - CURLOPT_LOGIN_OPTIONS is set to "AUTH=PLAIN" This option is supported starting with Zabbix 3.0. |
| Username | User name to use in authentication. This sets the value of CURLOPT_USERNAME. This option is supported starting with Zabbix 3.0. |
| Password | Password to use in authentication. This sets the value of CURLOPT_PASSWORD. This option is supported starting with Zabbix 3.0. |
| Enabled | Mark the checkbox to enable the media type. |
To make SMTP authentication options available, Zabbix server should be compiled with the --with-libcurl compilation option with cURL 7.20.0 or higher.
Options
The Options tab in the e-mail media type configuration contains alert processing settings. The same set of options are configurable for other media types, too.
All media types are processed in parallel. The maximum number of concurrent sessions is configurable per media type, but the total number of alerter processes on server can only be limited by the StartAlerters parameter. Alerts generated by one trigger are processed sequentially.
| Parameter | Description |
|---|---|
| Concurrent sessions | Select the number of parallel alerter sessions for the media type: One - one session Unlimited - unlimited number of sessions Custom - select a custom number of sessions Unlimited/high values mean more parallel sessions and increased capacity for sending notifications. Unlimited/high values should be used in large environments where lots of notifications may need to be sent simultaneously. |
| Attempts | Number of attempts for trying to send a notification. Up to 10 attempts can be specified; default value is '3'. If '1' is specified Zabbix will send the notification only once and will not retry if the sending fails. |
| Retry interval | Frequency of trying to resend a notification in case the sending failed, in seconds (0-60). If '0' is specified, Zabbix will retry immediately. Time suffixes are supported, e.g. 5s, 1m. |
User media
To assign a specific address to the user:
- Go to Administration → Users
- Open the user properties form
- In Media tab, click on Add
User media attributes:
| Parameter | Description |
|---|---|
| Type | Select Email as the type. |
| Send to | Specify e-mail addresses to send the messages to. To add more than one address click on Add below the address field. If multiple e-mail addresses are specified, one e-mail will be sent to all the specified recipients. You may add the recipient display name (like "Recipient name" in Recipient name <[email protected]> in the screenshot above) with the actual e-mail address. See examples and restrictions on display name and email address in media type attribute SMTP email description. |
| When active | You can limit the time when messages are sent, for example, the working days only (1-5,09:00-18:00). See the Time period specification page for description of the format. User macros are supported. |
| Use if severity | Mark the checkboxes of trigger severities that you want to receive notifications for. Note that the default severity ('Not classified') must be checked if you want to receive notifications for non-trigger events. After saving, the selected trigger severities will be displayed in the corresponding severity colours while unselected ones will be greyed out. |
| Status | Status of the user media. Enabled - is in use. Disabled - is not being used. |