Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MailMessage

represent a mail message that can be sent via the MailClient

Hierarchy

  • MailMessage

Index

Constructors

constructor

  • Returns MailMessage

  • Parameters

    Returns MailMessage

Methods

addHeader

  • Add a message header.

    Parameters

    • key: string
    • headers: string

    Returns MailMessage

getAttachment

  • set the list of attachments of this mail

    Returns MailAttachment

getBcc

  • getBcc(): string
  • set list of bcc addresses

    Returns string

getBounceAddress

  • getBounceAddress(): string
  • set bounce address of this mail

    Returns string

getCc

  • getCc(): string
  • set list of cc addresses

    Returns string

getFrom

  • getFrom(): string
  • set from address of this mail

    Returns string

getHtml

  • getHtml(): string
  • set the html text of this mail

    Returns string

getInlineAttachment

  • set the list of inline attachments of this mail

    Returns MailAttachment

getSubject

  • getSubject(): string
  • set the subject of this mail

    Returns string

getText

  • getText(): string
  • set the plain text of this mail

    Returns string

getTo

  • getTo(): string
  • set list of to addresses

    Returns string

isFixedHeaders

  • isFixedHeaders(): boolean
  • set whether our own headers should be the only headers added to the message

    Returns boolean

setAttachment

  • set the list of attachments of this mail

    Parameters

    Returns MailMessage

setBcc

  • set list of bcc addresses

    Parameters

    • bcc: string

    Returns MailMessage

setBounceAddress

  • set bounce address of this mail

    Parameters

    • bounceAddress: string

    Returns MailMessage

setCc

  • set list of cc addresses

    Parameters

    • cc: string

    Returns MailMessage

setFixedHeaders

  • set whether our own headers should be the only headers added to the message

    Parameters

    • fixedHeaders: boolean

    Returns MailMessage

setFrom

  • set from address of this mail

    Parameters

    • from: string

    Returns MailMessage

setHtml

  • set the html text of this mail

    Parameters

    • html: string

    Returns MailMessage

setInlineAttachment

  • set the list of inline attachments of this mail

    Parameters

    Returns MailMessage

setSubject

  • set the subject of this mail

    Parameters

    • subject: string

    Returns MailMessage

setText

  • set the plain text of this mail

    Parameters

    • text: string

    Returns MailMessage

setTo

  • set list of to addresses

    Parameters

    • to: string

    Returns MailMessage

Generated using TypeDoc