Skip to main content

MailerSendOptions

@webda/core

Interface: MailerSendOptions

Defined in: packages/core/src/services/abstractmailer.ts:14

Transport-agnostic options to send an email

Mailer implementations can accept additional transport specific options through the index signature

Indexable​

[key: string]: any

Transport specific options

Properties​

attachments?​

optional attachments?: any[]

Defined in: packages/core/src/services/abstractmailer.ts:52

Attachments, their format depends on the implementation

bcc?​

optional bcc?: string | string[]

Defined in: packages/core/src/services/abstractmailer.ts:32

Blind carbon copy recipients

cc?​

optional cc?: string | string[]

Defined in: packages/core/src/services/abstractmailer.ts:28

Carbon copy recipients

from?​

optional from?: string | string[]

Defined in: packages/core/src/services/abstractmailer.ts:20

Sender of the email

Implementations usually default it to their configured sender

html?​

optional html?: string

Defined in: packages/core/src/services/abstractmailer.ts:44

HTML body of the email

locale?​

optional locale?: string

Defined in: packages/core/src/services/abstractmailer.ts:64

Locale to render the template with

replacements?​

optional replacements?: Record<string, any>

Defined in: packages/core/src/services/abstractmailer.ts:60

Replacements for the template

replyTo?​

optional replyTo?: string | string[]

Defined in: packages/core/src/services/abstractmailer.ts:36

Address to reply to

subject?​

optional subject?: string

Defined in: packages/core/src/services/abstractmailer.ts:40

Subject of the email

template?​

optional template?: string

Defined in: packages/core/src/services/abstractmailer.ts:56

Template to use

text?​

optional text?: string

Defined in: packages/core/src/services/abstractmailer.ts:48

Text body of the email

to?​

optional to?: string | string[]

Defined in: packages/core/src/services/abstractmailer.ts:24

Recipients of the email