POST SMTP Test Only (v2)

The POST /SMTPClosed Short for simple mail transfer protocol, SMTP is a protocol for sending email messages between servers./TestOnly operation sends a test email message using the existing SMTP settings configured in Keyfactor Command. This operation is intended for testing email delivery without viewing, supplying, or modifying the SMTP configuration. On success, the operation returns HTTP 200 OK with  with no content.

Note:  This operation is available only in Version 2 and does not have a Version 1 equivalent.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/smtp/test/

Table 937: POST SMTP TestOnly Input Parameters

Name In

Description
RecipientAddress Body Required. A string indicating the recipient name, in email format (for example, mjones@keyexample.com), for a test message to be sent using the SMTP configuration to confirm functionality.
Tip:  See the Keyfactor APIClosed 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflowClosed 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, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.