Class MailMessage

represent a mail message that can be sent via the MailClient

Hierarchy

MailMessage

Index

Constructors

constructor

Constructors

constructor

new MailMessage(): MailMessage
new MailMessage(obj: MailMessage | {}): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:776
Returns MailMessage
- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:778
Parameters
- obj: MailMessage | {}
Returns MailMessage

Methods

addHeader

addHeader(key: string, headers: string): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:845
Add a message header.

Parameters
- key: string
- headers: string
Returns MailMessage

getAttachment

getAttachment(): MailAttachment[]

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:785
set the list of attachments of this mail

Returns MailAttachment[]

getBcc

getBcc(): string[]

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:795
set list of bcc addresses

Returns string[]

getBounceAddress

getBounceAddress(): string

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:805
set bounce address of this mail

Returns string

getCc

getCc(): string[]

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:815
set list of cc addresses

Returns string[]

getFrom

getFrom(): string

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:835
set from address of this mail

Returns string

getHtml

getHtml(): string

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:850
set the html text of this mail

Returns string

getInlineAttachment

getInlineAttachment(): MailAttachment[]

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:860
set the list of inline attachments of this mail

Returns MailAttachment[]

getSubject

getSubject(): string

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:870
set the subject of this mail

Returns string

getText

getText(): string

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:880
set the plain text of this mail

Returns string

getTo

getTo(): string[]

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:890
set list of to addresses

Returns string[]

isFixedHeaders

isFixedHeaders(): boolean

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:825
set whether our own headers should be the only headers added to the message

Returns boolean

setAttachment

setAttachment(attachment: MailAttachment[]): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:790
set the list of attachments of this mail

Parameters
- attachment: MailAttachment[]
Returns MailMessage

setBcc

setBcc(bcc: string[]): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:800
set list of bcc addresses

Parameters
- bcc: string[]
Returns MailMessage

setBounceAddress

setBounceAddress(bounceAddress: string): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:810
set bounce address of this mail

Parameters
- bounceAddress: string
Returns MailMessage

setCc

setCc(cc: string[]): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:820
set list of cc addresses

Parameters
- cc: string[]
Returns MailMessage

setFixedHeaders

setFixedHeaders(fixedHeaders: boolean): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:830
set whether our own headers should be the only headers added to the message

Parameters
- fixedHeaders: boolean
Returns MailMessage

setFrom

setFrom(from: string): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:840
set from address of this mail

Parameters
- from: string
Returns MailMessage

setHtml

setHtml(html: string): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:855
set the html text of this mail

Parameters
- html: string
Returns MailMessage

setInlineAttachment

setInlineAttachment(inlineAttachment: MailAttachment[]): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:865
set the list of inline attachments of this mail

Parameters
- inlineAttachment: MailAttachment[]
Returns MailMessage

setSubject

setSubject(subject: string): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:875
set the subject of this mail

Parameters
- subject: string
Returns MailMessage

setText

setText(text: string): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:885
set the plain text of this mail

Parameters
- text: string
Returns MailMessage

setTo

setTo(to: string[]): MailMessage

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:895
set list of to addresses

Parameters
- to: string[]
Returns MailMessage

toJson

toJson(): {}

- Defined in io.vertx/vertx-mail-client/target/npm/options.d.ts:898
Returns {}
- [key: string]: any

Generated using TypeDoc