@morojs/moro / MailAdapter

Interface: MailAdapter

Defined in: src/core/mail/types.ts:197

Base mail adapter interface

Methods

close()?

optional close(): Promise<void>

Defined in: src/core/mail/types.ts:221

Close adapter connections

Returns

Promise<void>

getName()

getName(): string

Defined in: src/core/mail/types.ts:226

Get adapter name

Returns

string

initialize()

initialize(config): Promise<void>

Defined in: src/core/mail/types.ts:201

Initialize the adapter with configuration

Parameters

config

any

Returns

Promise<void>

send()

send(options): Promise<MailResult>

Defined in: src/core/mail/types.ts:206

Send an email

Parameters

options

MailOptions

Returns

Promise<MailResult>

sendBulk()?

optional sendBulk(options): Promise<MailResult[]>

Defined in: src/core/mail/types.ts:211

Send multiple emails in bulk

Parameters

options

MailOptions[]

Returns

Promise<MailResult[]>

verify()?

optional verify(): Promise<boolean>

Defined in: src/core/mail/types.ts:216

Verify adapter connection

Returns

Promise<boolean>