APIRef_tm_sys_smtp-server¶
mgmt/tm/sys/smtp-server
SMTP configuration
REST Endpoints
- Collection URI
/mgmt/tm/sys/smtp-server- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/sys/smtp-server/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | ||
authenticationDisabled |
boolean | false | optional | read/write | Specifies that the SMTP server does not validate users. |
authenticationEnabled |
boolean | false | optional | read/write | Specifies that the SMTP server validates users before allowing them to send mail. Specify this only if the SMTP server requires authentication. |
encryptedConnection |
string | none | optional | read/write | Specifies which type of encrypted connection the SMTP server requires in order to send mail. The default is none. |
fromAddress |
string | optional | read/write | The email address that the email is being sent from. This is the “Reply-to” address that the recipient sees. | |
localHostName |
string | optional | read/write | 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’s Hostname. | |
tmPartition |
string | Common | optional | read/write | |
password |
string | optional | read/write | The password that the SMTP server requires when validating a user. | |
passwordEncrypted |
string | optional | read/write | The password that the SMTP server requires when validating a user, in an encrypted form. | |
smtpServerHostName |
string | optional | read/write | The SMTP server host name in the format of a fully qualified domain name. | |
smtpServerPort |
integer | 25 | optional | read/write | Specifies the SMTP port number. The default is 25. |
username |
string | optional | read/write | The user name that the SMTP server requires when validating a user. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.