Interface TransportsAPI

interface TransportsAPI {
    clearCache: () => void;
    deleteEmailConfig: (
        options?: ApiCallOptions,
    ) => Promise<DeleteEmailConfigHttpResponse>;
    getEmailConfig: (
        options?: ApiCallOptions,
    ) => Promise<GetEmailConfigHttpResponse>;
    patchEmailConfig: (
        body: EmailConfigPatch,
        options?: ApiCallOptions,
    ) => Promise<PatchEmailConfigHttpResponse>;
    sendTestEmail: (
        body: Email,
        options?: ApiCallOptions,
    ) => Promise<SendTestEmailHttpResponse>;
    validateEmailConfig: (
        options?: ApiCallOptions,
    ) => Promise<ValidateEmailConfigHttpResponse>;
    verifyEmailConfigConnection: (
        options?: ApiCallOptions,
    ) => Promise<VerifyEmailConfigConnectionHttpResponse>;
}
Index

Properties

clearCache deleteEmailConfig getEmailConfig patchEmailConfig sendTestEmail validateEmailConfig verifyEmailConfigConnection

Properties

clearCache: () => void

Clears the cache for transports api requests.

Type Declaration

    • (): void

    • Clears the cache for transports api requests.

      Returns void

deleteEmailConfig: (
    options?: ApiCallOptions,
) => Promise<DeleteEmailConfigHttpResponse>

Deletes email configuration for a given tenant id (retrieved from JWT).

Type Declaration

DeleteEmailConfigHttpError

getEmailConfig: (
    options?: ApiCallOptions,
) => Promise<GetEmailConfigHttpResponse>

Returns the email configuration for a given tenant id (retrieved from JWT).

Type Declaration

GetEmailConfigHttpError

patchEmailConfig: (
    body: EmailConfigPatch,
    options?: ApiCallOptions,
) => Promise<PatchEmailConfigHttpResponse>

Patch the email configuration for a given tenant id (retrieved from JWT).

Type Declaration

Param: body

an object with the body content

PatchEmailConfigHttpError

sendTestEmail: (
    body: Email,
    options?: ApiCallOptions,
) => Promise<SendTestEmailHttpResponse>

Send a test mail with the supplied email info (subject, body, recipient). Email config from database is used for the connection.

Type Declaration

Param: body

an object with the body content

SendTestEmailHttpError

validateEmailConfig: (
    options?: ApiCallOptions,
) => Promise<ValidateEmailConfigHttpResponse>

Returns the isValid value for the email configuration for the tenant. Will return false if no email configuration exists.

Type Declaration

ValidateEmailConfigHttpError

verifyEmailConfigConnection: (
    options?: ApiCallOptions,
) => Promise<VerifyEmailConfigConnectionHttpResponse>

Verifies connection to email server for tenant provided via JWT

Type Declaration

VerifyEmailConfigConnectionHttpError

Settings

Member Visibility

On This Page

Properties