Class Mail

constructor

• new Mail(): Bluestep.Mail.Mail

  Returns Bluestep.Mail.Mail

ReadonlyFlags

ReadonlyRecipientType

ReadonlysystemSmtpService

address

• address(addressSettings: InternetAddressSettings): 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: (mailStore: MailStore) => void,
      imapSettings: MailServiceSettings,
  ): 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: MailStore) => 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: (mailStore: MailStore) => void,
      imapsSettings: MailServiceSettings,
  ): 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: MailStore) => 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: 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: MailMessageSettings,
  ): (mailTransport: MailTransport) => void

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

  Parameters

  • mailMessage: MailMessageSettings

  Returns (mailTransport: MailTransport) => void

newMimeBodyPart

• newMimeBodyPart(): MimeBodyPart

  Returns a new [[MimeBodyPart]].

  Returns MimeBodyPart
• newMimeBodyPart(multipartSettings: MultipartSettings): MimeBodyPart

  Returns a new [[MimeBodyPart]] applying multipartSettings.

  Parameters

  • multipartSettings: MultipartSettings

  Returns MimeBodyPart

newMimeMultipart

• newMimeMultipart(): MimeMultipart

  Returns a new [[MimeMultipart]].

  Returns MimeMultipart
• newMimeMultipart(multipartSettings: MultipartSettings): MimeMultipart

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

  Parameters

  • multipartSettings: MultipartSettings

  Returns MimeMultipart

newSMTPMailMessage

• newSMTPMailMessage(mailTransport: MailTransport): SMTPMailMessage

  Returns a new [[SMTPMailMessage]].

  Parameters

  • mailTransport: MailTransport

  Returns SMTPMailMessage

parse

• parse(addressList: string): InternetAddress[]

  Returns a [[InternetAddress]] array.

  Parameters

  • addressList: string

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

  Returns a [[InternetAddress]] array.

  Parameters

  • addressList: string
  • strict: boolean

  Returns InternetAddress[]

parseHeader

• parseHeader(addressList: string, strict: boolean): InternetAddress[]

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

  Parameters

  • addressList: string
  • strict: boolean

  Returns InternetAddress[]

pop3

• pop3(
      mailStoreFn: (mailStore: MailStore) => void,
      popSettings: MailServiceSettings,
  ): 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: MailStore) => 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: (mailStore: MailStore) => void,
      popsSettings: MailServiceSettings,
  ): 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: MailStore) => 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: MailMessageSettings,
      transportSettings?: MailServiceSettings,
  ): 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
  • OptionaltransportSettings: MailServiceSettings

    If not present uses the System's mail sender

  Returns void

sendSecure

• sendSecure(
      transportSettings: MailServiceSettings,
      mailMessage: MailMessageSettings,
  ): 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: (mailTransport: MailTransport) => void,
      smtpSettings?: MailServiceSettings,
  ): 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: MailTransport) => void
  • OptionalsmtpSettings: 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: MailServiceSettings,
      mailTransporter: (mailTransport: MailTransport) => void,
  ): 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: MailTransport) => 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