POST SMTP Test
The POST /SMTP
Short for simple mail transfer protocol, SMTP is a protocol for sending email messages between servers./Test method is used to test the SMTP settings by sending a test email message. This method returns HTTP 200 OK on a success with details about the SMTP profile.
Table 576: POST SMTP Test Input Parameters
| Name | In | Description |
|---|---|---|
| Host | Body | Required. A string indicating the fully qualified domain name of your SMTP host (e.g. corpexch02.keyexample.com). |
| Id | Body | An integer indicating the Keyfactor Command reference ID of the SMTP record. This will be 1 in most environments. |
| Port | Body | Required. An integer indicating the SMTP port (e.g. 25). |
| RelayAuthenticationType | Body |
An integer indicating the type of authentication used to connect to the mail server. |
| RelayPassword | Body |
Required*. A string indicating the password of the user specified by RelayUsername if RelayAuthenticationType is set to 2. No data is output in this field on a GET. |
| RelayUsername | Body |
Required*. A string indicating the username of the account providing authentication to the mail server if RelayAuthenticationType is set to 2. The username should be provided in DOMAIN\\username format. For most mail server configurations, the username provided must have as a valid email address the email address you set in the SenderAccount parameter |
| SenderAccount | Body |
Required. A string indicating the sender for email messages delivered from Keyfactor Command, in the form of an email address (e.g. jsmith@keyexample.com). Depending on the email configuration in your environment, the sender account may need to be a valid user on your mail server or you may be able to put anything in this field. |
| SenderAddress | Body |
A string indicating the sender for email messages delivered from Keyfactor Command, in the form of an email address (e.g. jsmith@keyexample.com). This is considered deprecated and may be removed in a future release. |
| SenderName | Body |
A string indicating the name that appears as the "from" in the user's mail client (e.g. "Keyfactor Command"). This value is used for both configurations of RelayAuthenticationType. |
| TestRecipient | Body | Required. A string indicating the recipient name, in email format (e.g. mjones@keyexample.com), for a test message to be sent using the SMTP configuration to confirm functionality. |
| UseSSL | Body | A Boolean indicating that mail should be delivered over TLS TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers./SSL TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers.. Not all mail servers support this. |
Table 577: POST SMTP Test Response Data
| Name | Description |
|---|---|
| Host | A string indicating the fully qualified domain name of your SMTP host (e.g. corpexch02.keyexample.com). |
| Id | An integer indicating the Keyfactor Command reference ID of the SMTP record. This will be 1 in most environments. |
| Port | An integer indicating the SMTP port (e.g. 25). |
| RelayAuthenticationType |
An integer indicating the type of authentication used to connect to the mail server. |
| RelayUsername |
A string indicating the username of the account providing authentication to the mail server if RelayAuthenticationType is set to 2. The username should be provided in DOMAIN\\username format. For most mail server configurations, the username provided must have as a valid email address the email address you set in the SenderAccount parameter. |
| SenderAccount |
A string indicating the sender for email messages delivered from Keyfactor Command, in the form of an email address (e.g. jsmith@keyexample.com). Depending on the email configuration in your environment, the sender account may need to be a valid user on your mail server or you may be able to put anything in this field. |
| SenderName |
A string indicating the name that appears as the "from" in the user's mail client (e.g. "Keyfactor Command"). This value is used for both configurations of RelayAuthenticationType. |
| TestRecipient | A string indicating the recipient name, in email format (e.g. mjones@keyexample.com), for a test message to be sent using the SMTP configuration to confirm functionality. |
| UseSSL | A Boolean indicating that mail should be delivered over TLS/SSL. Not all mail servers support this. |
) at the top of the Keyfactor Command Management Portal page next to the Log Out button.
