Memos unofficial
POST/api/v1/instance/settings/notification:testEmail

Test notification email delivery

Tests notification email delivery using the supplied SMTP settings or the settings already stored for the instance. Set recipientEmail to choose a recipient; when omitted, the authenticated user's email address is used.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Optional email delivery settings and recipient address for the notification email test.

emailobjectoptional
Optional. SMTP email settings to test. If omitted, the stored notification email setting is used.
recipientEmailstringoptional
Optional. Recipient email address. If omitted, the current user's email address is used.

2 status codes
200Confirms that the email delivery test completed.
defaultReturns a standard error object containing an error code, developer-facing message, and optional details.
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The email settings object is optional; when omitted, the stored notification email setting is used. recipientEmail is optional and defaults to the authenticated user's email address when omitted.