Interface MIMEMessage

constructor

• new MIMEMessage(envctx): MIMEMessage

• Parameters

  • envctx: EnvironmentContext

  Returns MIMEMessage

boundaries

envctx

headers

messages

validContentTransferEncodings

validTypes

addAttachment

• addAttachment(opts): MIMEMessageContent

• Parameters

  • opts: AttachmentOptions

  Returns MIMEMessageContent

addMessage

• addMessage(opts): MIMEMessageContent

• Parameters

  • opts: ContentOptions

  Returns MIMEMessageContent

asEncoded

• asEncoded(): string

• Returns string

asRaw

• asRaw(): string

• Returns string

dumpTextContent

• dumpTextContent(plaintext, html, boundary): string

• Parameters

  • plaintext: undefined | MIMEMessageContent

  • html: undefined | MIMEMessageContent

  • boundary: string

  Returns string

generateBoundaries

• generateBoundaries(): void

• Returns void

getAttachments

• getAttachments(): [] | MIMEMessageContent[]

• Returns [] | MIMEMessageContent[]

getHeader

• getHeader(name): undefined | string | Mailbox

• Parameters

  • name: string

  Returns undefined | string | Mailbox

getHeaders

• getHeaders(): object

• Returns object

getInlineAttachments

• getInlineAttachments(): [] | MIMEMessageContent[]

• Returns [] | MIMEMessageContent[]

getMessageByType

• getMessageByType(type): undefined | MIMEMessageContent

• Parameters

  • type: string

  Returns undefined | MIMEMessageContent

getRecipients

• getRecipients(config?): undefined | Mailbox | Mailbox[]

• Parameters

  • Optional config: {
        type: MailboxType;
    }

    • type: MailboxType

  Returns undefined | Mailbox | Mailbox[]

getSender

• getSender(): undefined | Mailbox

• Returns undefined | Mailbox

getSubject

• getSubject(): undefined | string

• Returns undefined | string

hasAttachments

• hasAttachments(): boolean

• Returns boolean

hasInlineAttachments

• hasInlineAttachments(): boolean

• Returns boolean

isArray

• isArray(v): v is any[]

• Parameters

  • v: unknown

  Returns v is any[]

isObject

• isObject(v): v is object

• Parameters

  • v: unknown

  Returns v is object

setBcc

• setBcc(input): Mailbox[]

• Parameters

  • input: string | string[] | MailboxAddrObject | MailboxAddrObject[]

  Returns Mailbox[]

setCc

• setCc(input): Mailbox[]

• Parameters

  • input: string | string[] | MailboxAddrObject | MailboxAddrObject[]

  Returns Mailbox[]

setHeader

• setHeader(name, value): string

• Parameters

  • name: string

  • value: any

  Returns string

setHeaders

• setHeaders(obj): string[]

• Parameters

  • obj: {
        [index: string]: string;
    }

    • [index: string]: string

  Returns string[]

setRecipient

• setRecipient(input): Mailbox[]

• Parameters

  • input: string | string[] | MailboxAddrObject | MailboxAddrObject[]

  Returns Mailbox[]

setRecipients

• setRecipients(input, config): Mailbox[]

• Parameters

  • input: string | string[] | MailboxAddrObject | MailboxAddrObject[]

  • config: {
        type: MailboxType;
    }

    • type: MailboxType

  Returns Mailbox[]

setSender

• setSender(input, config?): Mailbox

• Parameters

  • input: string | MailboxAddrObject

  • Optional config: {
        type: MailboxType;
    }

    • type: MailboxType

  Returns Mailbox

setSubject

• setSubject(value): string

• Parameters

  • value: string

  Returns string

setTo

• setTo(input): Mailbox[]

• Parameters

  • input: string | string[] | MailboxAddrObject | MailboxAddrObject[]

  Returns Mailbox[]

toBase64

• toBase64(v): string

• Parameters

  • v: string

  Returns string

toBase64WebSafe

• toBase64WebSafe(v): string

• Parameters

  • v: string

  Returns string