@morojs/moro

@morojs/moro / BaseMailAdapter

Abstract Class: BaseMailAdapter

Defined in: src/core/mail/mail-adapter.ts:10

Abstract base class for mail adapters Provides common functionality and interface

Extended by

• ConsoleAdapter
• NodemailerAdapter
• SendGridAdapter
• SESAdapter
• ResendAdapter

Implements

• MailAdapter

Constructors

Constructor

new BaseMailAdapter(): BaseMailAdapter

Returns

BaseMailAdapter

Properties

config

protected config: any

Defined in: src/core/mail/mail-adapter.ts:11

initialized

protected initialized: boolean = false

Defined in: src/core/mail/mail-adapter.ts:12

Methods

close()

close(): Promise<void>

Defined in: src/core/mail/mail-adapter.ts:69

Close adapter connections (optional)

Returns

Promise<void>

Implementation of

MailAdapter.close

ensureInitialized()

protected ensureInitialized(): void

Defined in: src/core/mail/mail-adapter.ts:110

Check if adapter is initialized

Returns

void

getName()

abstract getName(): string

Defined in: src/core/mail/mail-adapter.ts:30

Get adapter name (must be implemented by subclasses)

Returns

string

Implementation of

MailAdapter.getName

initialize()

initialize(config): Promise<void>

Defined in: src/core/mail/mail-adapter.ts:17

Initialize adapter with configuration

Parameters

config

any

Returns

Promise<void>

Implementation of

MailAdapter.initialize

normalizeAddress()

protected normalizeAddress(address): object

Defined in: src/core/mail/mail-adapter.ts:76

Normalize email address

Parameters

address

string | { email: string; name?: string; }

Returns

object

email

email: string

name?

optional name: string

normalizeAddresses()

protected normalizeAddresses(addresses): object[]

Defined in: src/core/mail/mail-adapter.ts:89

Normalize email addresses array

Parameters

addresses

string | string[] | { email: string; name?: string; } | object[]

Returns

object[]

send()

abstract send(options): Promise<MailResult>

Defined in: src/core/mail/mail-adapter.ts:25

Send an email (must be implemented by subclasses)

Parameters

options

MailOptions

Returns

Promise<MailResult>

Implementation of

MailAdapter.send

sendBulk()

sendBulk(options): Promise<MailResult[]>

Defined in: src/core/mail/mail-adapter.ts:37

Send multiple emails in bulk Default implementation sends one by one Override for better performance

Parameters

options

MailOptions[]

Returns

Promise<MailResult[]>

Implementation of

MailAdapter.sendBulk

verify()

verify(): Promise<boolean>

Defined in: src/core/mail/mail-adapter.ts:62

Verify adapter connection (optional)

Returns

Promise<boolean>

Implementation of

MailAdapter.verify