Type Alias TransportsAPI

type TransportsAPI = {
    clearCache: typeof clearCache;
    deleteEmailConfig: typeof deleteEmailConfig;
    getEmailConfig: typeof getEmailConfig;
    patchEmailConfig: typeof patchEmailConfig;
    sendTestEmail: typeof sendTestEmail;
    validateEmailConfig: typeof validateEmailConfig;
    verifyEmailConfigConnection: typeof verifyEmailConfigConnection;
}
Index

Properties

clearCache deleteEmailConfig getEmailConfig patchEmailConfig sendTestEmail validateEmailConfig verifyEmailConfigConnection

Properties

clearCache: typeof clearCache

Clears the cache for transports api requests.

deleteEmailConfig: typeof deleteEmailConfig

Deletes the email configuration for the tenant.

DeleteEmailConfigHttpError

getEmailConfig: typeof getEmailConfig

Returns the current email configuration and configuration status for the tenant.

GetEmailConfigHttpError

patchEmailConfig: typeof patchEmailConfig

Patch the email configuration for the tenant.

Param: body

an object with the body content

PatchEmailConfigHttpError

sendTestEmail: typeof sendTestEmail

Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).

Param: body

an object with the body content

SendTestEmailHttpError

validateEmailConfig: typeof validateEmailConfig

Returns the current isValid value for the email configuration for the tenant. Does not attempt to connect to a server to verify the connection or send a test email. Will return false if no email configuration exists.

ValidateEmailConfigHttpError

verifyEmailConfigConnection: typeof verifyEmailConfigConnection

Attempts to verify connection to email server using a low-level protocol handshake to confirm the server is reachable and the credentials are valid, without sending a test email.

VerifyEmailConfigConnectionHttpError

Settings

Member Visibility

On This Page

Properties