Class Mail

constructor

• new Mail(): Mail

• Returns Mail

Readonly Flags

Readonly RecipientType

Readonly systemSmtpService

address

• address(addressSettings): InternetAddress

• Returns a [[InternetAddress]]. Same as calling addressBuilder().apply(addressSettings).build()

  Parameters

  • addressSettings: InternetAddressSettings

  Returns InternetAddress

addressBuilder

• addressBuilder(): InternetAddressBuilder

• Returns a [[InternetAddressBuilder]]

  Returns InternetAddressBuilder

imap

• imap(mailStoreFn, imapSettings): void

• Provides a [[MailStore]] with protocol set to imap and port set to 143 unless replaced by imapSettings.Same as calling imapBuilder().apply(imapSettings).build().store(mailStoreFn)

  Parameters

  • mailStoreFn: ((mailStore) => void)

    • • (mailStore): void

      • Parameters

        • mailStore: MailStore

        Returns void

  • imapSettings: MailServiceSettings

  Returns void

imapBuilder

• imapBuilder(): MailServiceBuilder

• Return a [[MailServiceBuilder]] with protocol set to imap and port set to 143.Same as calling mailServiceBuilder().protocol("imap").port(143)

  Returns MailServiceBuilder

imaps

• imaps(mailStoreFn, imapsSettings): void

• Provides a [[MailStore]] with protocol set to imaps and port set to 993 unless replaced by imapsSettings.Same as calling imapsBuilder().apply(imapsSettings).build().store(mailStoreFn)

  Parameters

  • mailStoreFn: ((mailStore) => void)

    • • (mailStore): void

      • Parameters

        • mailStore: MailStore

        Returns void

  • imapsSettings: MailServiceSettings

  Returns void

imapsBuilder

• imapsBuilder(): MailServiceBuilder

• Return a [[MailServiceBuilder]] with protocol set to imap and port set to 143.Same as calling mailServiceBuilder().protocol("imaps").property("mail.imaps.starttls.enable", "true").port(993)

  Returns MailServiceBuilder

mailService

• mailService(mailServiceSettings): MailService

• Returns a [[MailServer]] using mailServiceSettingsSame as calling mailServiceBuilder().apply(mailServiceSettings).build()

  Parameters

  • mailServiceSettings: MailServiceSettings

  Returns MailService

mailServiceBuilder

• mailServiceBuilder(): MailServiceBuilder

• Returns a [[MailServerBuilder]]

  Returns MailServiceBuilder

mailTransporter

• mailTransporter(mailMessage): ((mailTransport) => void)

• Returns a function that provides a [[MailTransport]].

  Parameters

  • mailMessage: MailMessageSettings

  Returns ((mailTransport) => void)

  • • (mailTransport): void

    • Returns a function that provides a [[MailTransport]].

      Parameters

      • mailTransport: MailTransport

      Returns void

newMimeBodyPart

• newMimeBodyPart(): MimeBodyPart

• Returns a new [[MimeBodyPart]].

  Returns MimeBodyPart
• newMimeBodyPart(multipartSettings): MimeBodyPart

• Returns a new [[MimeBodyPart]] applying multipartSettings.

  Parameters

  • multipartSettings: MultipartSettings

  Returns MimeBodyPart

newMimeMultipart

• newMimeMultipart(): MimeMultipart

• Returns a new [[MimeMultipart]].

  Returns MimeMultipart
• newMimeMultipart(multipartSettings): MimeMultipart

• Returns a new [[MimeMultipart]] provided the multipartSettings.

  Parameters

  • multipartSettings: MultipartSettings

  Returns MimeMultipart

newSMTPMailMessage

• newSMTPMailMessage(mailTransport): SMTPMailMessage

• Returns a new [[SMTPMailMessage]].

  Parameters

  • mailTransport: MailTransport

  Returns SMTPMailMessage

parse

• parse(addressList): InternetAddress[]

• Returns a [[InternetAddress]] array.

  Parameters

  • addressList: string

  Returns InternetAddress[]
• parse(addressList, strict): InternetAddress[]

• Returns a [[InternetAddress]] array.

  Parameters

  • addressList: string

  • strict: boolean

  Returns InternetAddress[]

parseHeader

• parseHeader(addressList, strict): InternetAddress[]

• Returns a [[InternetAddress]] array where addressList are formatted as a mail header.

  Parameters

  • addressList: string

  • strict: boolean

  Returns InternetAddress[]

pop3

• pop3(mailStoreFn, popSettings): void

• Provides a [[MailStore]] with protocol set to pop3 and port set to 110 unless replaced by popSettings.Same as calling pop3Builder().apply(popSettings).build().store(mailStoreFn)

  Parameters

  • mailStoreFn: ((mailStore) => void)

    • • (mailStore): void

      • Parameters

        • mailStore: MailStore

        Returns void

  • popSettings: MailServiceSettings

  Returns void

pop3Builder

• pop3Builder(): MailServiceBuilder

• Return a [[MailServiceBuilder]] with protocol set to pop3 and port set to 110.Same as calling mailServiceBuilder().protocol("pop3").port(110)

  Returns MailServiceBuilder

pop3s

• pop3s(mailStoreFn, popsSettings): void

• Provides a [[MailStore]] with protocol set to pop3s and port set to 110 unless replaced by popsSettings.Same as calling pop3sBuilder().apply(popsSettings).build().store(mailStoreFn)

  Parameters

  • mailStoreFn: ((mailStore) => void)

    • • (mailStore): void

      • Parameters

        • mailStore: MailStore

        Returns void

  • popsSettings: MailServiceSettings

  Returns void

pop3sBuilder

• pop3sBuilder(): MailServiceBuilder

• Return a [[MailServiceBuilder]] with protocol set to pop3s and port set to 995.Same as calling `mailServiceBuilder().protocol("pop3s").property("mail.pop3s.starttls.enable", "true").port(995)

  Returns MailServiceBuilder

send

• send(mailMessageSettings, transportSettings?): void

• Provides a [[MailTransport]] with protocol set to smtp and port set to 25 unless replaced by transportSettings.Same as calling smtp(mailTransporter(mailMessageSettings), transportSettings) or calling smtp(mailTransporter(mailMessageSettings))

  Parameters

  • mailMessageSettings: MailMessageSettings

  • Optional transportSettings: MailServiceSettings

    If not present uses the System's mail sender

  Returns void

sendSecure

• sendSecure(transportSettings, mailMessage): void

• Provides a [[MailTransport]] with protocol set to smtps and port set to 465 unless replaced by transportSettings.Same as calling smtps(transportSettings, mailTransporter(mailMessage));

  Parameters

  • transportSettings: MailServiceSettings

  • mailMessage: MailMessageSettings

  Returns void

smtp

• smtp(mailTransporter, smtpSettings?): void

• Provides a [[MailTransport]] with protocol set to smtp and port set to 25 unless replaced by smtpSettings.Same as calling smtpBuilder().apply(smtpSettings).build().transport(mailTransporter) or calling systemSmtpService.transport(mailTransporter)

  Parameters

  • mailTransporter: ((mailTransport) => void)

    • • (mailTransport): void

      • Parameters

        • mailTransport: MailTransport

        Returns void

  • Optional smtpSettings: MailServiceSettings

    If not present uses [[systemSmtpService]]

  Returns void

smtpBuilder

• smtpBuilder(): MailServiceBuilder

• Return a [[MailServiceBuilder]] with protocol set to smtp and port set to 25.Same as calling mailServiceBuilder().protocol("smtp").port(25)

  Returns MailServiceBuilder

smtps

• smtps(smtpsSettings, mailTransporter): void

• Provides a [[MailTransport]] with protocol set to smtps and port set to 465 unless replaced by smtpsSettings.Same as calling smtpBuilder().apply(smtpSettings).build().transport(mailTransporter)

  Parameters

  • smtpsSettings: MailServiceSettings

  • mailTransporter: ((mailTransport) => void)

    • • (mailTransport): void

      • Parameters

        • mailTransport: MailTransport

        Returns void

  Returns void

smtpsBuilder

• smtpsBuilder(): MailServiceBuilder

• Return a [[MailServiceBuilder]] with protocol set to smtps and port set to 465.Same as calling mailServiceBuilder().protocol("smtps").port(465)

  Returns MailServiceBuilder