Management::SMTPConfiguration¶
Introduced : BIG-IP_v11.2.0
The SMTPConfiguration interface enables you to create, delete and
modify different SMTP configurations on the BIG-IP. Each SMTP
configuration item can be used in several different profiles (such as
Analytics and Classification). For example: 1. Alert notifications in
Analytics. 2. Reports exporting in both Analytics and Classification.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified SMTP configuration object. | BIG-IP_v11.2.0 |
| delete_all_smtp_configs | Deletes all SMTP configuration objects. | BIG-IP_v11.2.0 |
| delete_smtp_config | Deletes specified SMTP configuration objects. | BIG-IP_v11.2.0 |
| get_auth_enabled_state | Gets the authentication enabled flag for the specified SMTP configuration object. | BIG-IP_v11.2.0 |
| get_encrypted_connection_type | Get the encrypted connection type for the specified SMTP configuration object. | BIG-IP_v11.2.0 |
| get_from_address | Gets the email address that the eMail items will be sent from. | BIG-IP_v11.2.0 |
| get_list | Gets a list of all SMTP configuration objects. | BIG-IP_v11.2.0 |
| get_local_host_name | Get the host name used in SMTP headers. | BIG-IP_v11.2.0 |
| get_password | Gets the password that the SMTP server requires when validating a user. | BIG-IP_v11.2.0 |
| get_smtp_server_host_name | Gets the SMTP server host name. | BIG-IP_v11.2.0 |
| get_smtp_server_port | Gets the SMTP server port number. | BIG-IP_v11.2.0 |
| get_user_name | Gets the user name that the SMTP server requires when validating a user. | BIG-IP_v11.2.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.2.0 |
| set_auth_enabled_state | Sets the authentication enabled flag for the specified SMTP configuration object. Specify this only if the SMTP server requires authentication. | BIG-IP_v11.2.0 |
| set_encrypted_connection_type | Sets the encrypted connection type for the specified SMTP configuration object. | BIG-IP_v11.2.0 |
| set_from_address | Sets the email address that the eMail items will be sent from. This is the “Reply-to” address that the recipient sees. | BIG-IP_v11.2.0 |
| set_local_host_name | Sets the host name used in SMTP headers in the format of a fully qualified domain name. This setting does not refer to the BIG-IP system&aposs Hostname. | BIG-IP_v11.2.0 |
| set_password | Sets the password that the SMTP server requires when validating a user. | BIG-IP_v11.2.0 |
| set_smtp_server_host_name | Sets the SMTP server host name in the format of a fully qualified domain name. | BIG-IP_v11.2.0 |
| set_smtp_server_port | Sets the SMTP server port number. | BIG-IP_v11.2.0 |
| set_user_name | Sets the user name that the SMTP server requires when validating a user. | BIG-IP_v11.2.0 |
Enumerations¶
| Enumeration | Description |
| EncryptedConnectionType | Encrypted connection type. The enum value specifies which encryption algorithm is used for communication with the SMTP server. |
Aliases¶
| Alias | Type | Description |
| EncryptedConnectionTypeSequence | EncryptedConnectionType [] | A sequence of encrypted connection type items. |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.