The GET /SMTP
Short for simple mail transfer protocol, SMTP is a protocol for sending email messages between servers. method is used to retrieve the SMTP configuration profile from Keyfactor Command. This method returns HTTP 200 OK on a success with details about the SMTP profile. Only one profile may be configured. There are no input parameters for this method.
An endpoint is a URL that enables the API to gain access to resources on a server. has been deprecated. It is retained for backwards compatibility, but all new development should use version 2. For more information about versioning, see Versioning.Version 2 of the GET /SMTP method provides support for the use of PAM for the email user credentials.
Table 827: GET SMTP Response Data V2
| 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. The default is 0 (zero). |
| RelayPassword |
An object indicating the password information to use for authentication along with the RelayUsername if the RelayAuthenticationType is 2 (Explicit Credentials). Due to its sensitive nature, this value is not returned in responses. |
| RelayUsername |
An object indicating the username information to use for authentication along with the RelayPassword if the RelayAuthenticationType is 2 (Explicit Credentials). |
| 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. |
| UseSSL | A Boolean indicating that mail should be delivered over TLS/SSL. Not all mail servers support this. |
Table 828: GET SMTP Response Data V2
| 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. The default is 0 (zero). |
| RelayPassword |
An object indicating the password information to use for authentication along with the RelayUsername if the RelayAuthenticationType is 2 (Explicit Credentials). Due to its sensitive nature, this value is not returned in responses. |
| RelayUsername |
An object indicating the username information to use for authentication along with the RelayPassword if the RelayAuthenticationType is 2 (Explicit Credentials). |
| 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. |
| UseSSL | A Boolean indicating that mail should be delivered over TLS/SSL. Not all mail servers support this. |
Version 1 of the GET /SMTP method includes similar capabilities to version 2, except that it does not support PAM. Configuring credentials with PAM and then using the v1 method to return the SMTP information will result in an error in the RelayUsername value.
Table 829: GET SMTP Response Data V1
| 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. |
| SenderAddress |
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 |
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. |
| UseSSL | A Boolean indicating that mail should be delivered over TLS/SSL. Not all mail servers support this. |
An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (
) at the top of the Management Portal page next to the Log Out button.Was this page helpful? Provide Feedback