The SMTP
Short for simple mail transfer protocol, SMTP is a protocol for sending email messages between servers. component of the Keyfactor API 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. includes operations necessary to programmatically edit and retrieve the SMTP configuration profile and send a test email message. Editing the SMTP configuration profile in Keyfactor Command will only apply within the software. Only one SMTP profile may be configured.
Table 926: SMTP Operations
| Endpoint | Method | Description | Link |
|---|---|---|---|
| / | GET |
Returns information about the SMTP configuration profile. Version 1 of this operation is deprecated. When RelayUsername is configured to use a PAM secret, Version 1 GET and PUT responses return UnsupportedPAMSecret for RelayUsername because PAM secrets are supported only in Version 2. |
GET SMTP |
| / | PUT |
Updates settings for the SMTP configuration profile. Version 1 of this operation is deprecated. When RelayUsername is configured to use a PAM secret, Version 1 GET and PUT responses return UnsupportedPAMSecret for RelayUsername because PAM secrets are supported only in Version 2. |
PUT SMTP |
| /Test | POST |
Sends a test email message to confirm SMTP configuration for users with modify_and_test permissions. Version 1 of this operation is deprecated. Version 2 adds support for OAuth and PAM-based email credentials. |
POST SMTP Test |
| /TestOnly | POST | Sends a test email message to confirm SMTP configuration for users with test permissions. | POST SMTP Test Only (v2) |
Was this page helpful? Provide Feedback