Type Members

1.  case class Content(parts: MimeBodyPart*) extends Product with Serializable

   Represents the content of the e-mail message, composed of individual MimeBodyPart instances.

   Represents the content of the e-mail message, composed of individual MimeBodyPart instances. For easier use, helper methods to add specific content are available, such as html() for adding HTML or attachFile() to add file attachment.

   parts

   parts of the message content (represented by MimeBodyPart instances)

2.  case class ContentDisposition(disposition: String, params: Map[String, String] = Map.empty[String, String]) extends MessageHeader with Product with Serializable

   Represents the Content-Disposition RFC 822 message header, with the given header value and optional header parameters.

   Represents the Content-Disposition RFC 822 message header, with the given header value and optional header parameters.

   disposition

   value of the header

   params

   parameters of the header

   See also

   http://www.iana.org/assignments/cont-disp/cont-disp.xhtml

3.  case class CustomHeader(name: String, value: String) extends MessageHeader with Product with Serializable

   General RFC 822 header, allowing to create any e-mail message header, which is not directly supported by the Mailer's API.

   General RFC 822 header, allowing to create any e-mail message header, which is not directly supported by the Mailer's API.

   name

   header name

   value

   header value

4.  case class Debug(debug: Boolean = false) extends Prop with Product with Serializable

   Enables the debug mode.

   Enables the debug mode.

   debug

   The initial debug mode. Default is false.

5.  case class HeaderParam(name: String, value: String) extends Product with Serializable
6.  case class Host(host: String) extends Prop with Product with Serializable

   Represents the JavaMail property mail.host.

   Represents the JavaMail property mail.host.

   host

   The default host name of the mail server for both Stores and Transports. Used if the mail.protocol.host property (set by SmtpAddress)isn't set.

7.  trait Mailer extends AnyRef

   Represents the Mailer itself, with methods for opening/closing the connection and sending the message (com.github.jurajburian.mailer.Message)

8.  case class Message(from: InternetAddress, subject: String, content: Content, to: Seq[InternetAddress] = Seq.empty[InternetAddress], cc: Seq[InternetAddress] = Seq.empty[InternetAddress], bcc: Seq[InternetAddress] = Seq.empty[InternetAddress], replyTo: Option[InternetAddress] = None, replyToAll: Option[Boolean] = None, headers: Seq[MessageHeader] = Seq.empty[MessageHeader]) extends Product with Serializable

   Represents the e-mail message itself.

   Represents the e-mail message itself.

   from

   e-mail sender address

   subject

   e-mail subject text

   content

   e-mail content, represented by the instance of com.github.jurajburian.mailer.Content class

   to

   set of e-mail receiver addresses

   cc

   set of e-mail carbon copy receiver addresses

   bcc

   set of e-mail blind carbon copy receiver addresses

   replyTo

   address used to reply this message (optional)

   replyToAll

   whether the new message will be addressed to all recipients of this message

   headers

   message headers (RFC 822)

9.  trait MessageHeader extends AnyRef

   Represents RFC 822 header of the e-mail message.

   Represents RFC 822 header of the e-mail message. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must have been encoded by the caller as per the rules of RFC 2047.

10.  case class MimeAddressStrict(mimeAddressStrict: String) extends Prop with Product with Serializable

    Represents the JavaMail property mail.mime.address.strict.

    Represents the JavaMail property mail.mime.address.strict.

    mimeAddressStrict

    The MimeMessage class uses the InternetAddress method parseHeader to parse headers in messages. This property controls the strict flag passed to the parseHeader method. The default is true.

11.  class MimeMessage extends jakarta.mail.internet.MimeMessage
12.  trait Prop extends AnyRef

    Represents the set of one or more JavaMail properties.

13.  case class Property(key: String, value: String) extends Prop with Product with Serializable

    General property, allowing to add any JavaMail property which is not directly supported by the Mailer's API.

    General property, allowing to add any JavaMail property which is not directly supported by the Mailer's API.

    key

    property key

    value

    property value

14.  trait SessionFactory extends AnyRef

    Represents the factory, used to create JavaMail session with selected properties.

15.  case class SmtpAddress(host: String, port: Int = 25) extends Prop with Product with Serializable

    Represents the combination of properties mail.smtp.host and mail.smtp.form.

    Represents the combination of properties mail.smtp.host and mail.smtp.form.

    host

    The SMTP server to connect to.

    port

    The SMTP server port to connect to, if the connect() method doesn't explicitly specify one. Defaults to 25.

16.  case class SmtpConnectionTimeout(timeout: Int) extends Prop with Product with Serializable

    Represents the JavaMail property mail.smtp.connectiontimeout.

    Represents the JavaMail property mail.smtp.connectiontimeout.

    timeout

    Socket connection timeout value in milliseconds. Default is infinite timeout.

17.  case class SmtpFrom(from: String) extends Prop with Product with Serializable

    Represents the JavaMail property mail.smtp.from.

    Represents the JavaMail property mail.smtp.from.

    from

    Email address to use for SMTP MAIL command. This sets the envelope return address. Defaults to msg.getFrom() or InternetAddress.getLocalAddress().

18.  case class SmtpStartTls(enable: Boolean = true, required: Boolean = false) extends Prop with Product with Serializable

    Represents the set of JavaMail properties mail.smtp.starttls.enable and mail.smtp.starttls.required.

    Represents the set of JavaMail properties mail.smtp.starttls.enable and mail.smtp.starttls.required. If called without specifying the parameters, mail.smtp.starttls.enable is set to true and mail.smtp.starttls.required to false.

    enable

    If true, enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. If not set, defaults to false.

    required

    If true, requires the use of the STARTTLS command. If the server doesn't support the STARTTLS command, or the command fails, the connect method will fail. If not set, defaults to false.

19.  case class SmtpTimeout(timeout: Int) extends Prop with Product with Serializable

    Represents the JavaMail property mail.smtp.timeout.

    Represents the JavaMail property mail.smtp.timeout.

    timeout

    Socket I/O timeout value in milliseconds. Default is infinite timeout.

20.  case class SmtpUser(user: String) extends Prop with Product with Serializable

    Represents the JavaMail property mail.smtp.user.

    Represents the JavaMail property mail.smtp.user.

    user

    The user name to use when connecting to mail servers using the specified protocol. Overrides the mail.user property.

21.  case class StoreProtocol(protocol: String) extends Prop with Product with Serializable

    Represents the JavaMail property mail.store.protocol.

    Represents the JavaMail property mail.store.protocol.

    protocol

    Specifies the default message access protocol. The Session method getStore() returns a Store object that implements this protocol. By default the first Store provider in the configuration files is returned.

22.  case class TransportProtocol(protocol: String = "smtp") extends Prop with Product with Serializable

    Represents the JavaMail property mail.transport.protocol.

    Represents the JavaMail property mail.transport.protocol.

    protocol

    Specifies the default message transport protocol. The Session method getTransport() returns a Transport object that implements this protocol. By default the first Transport provider in the configuration files is returned.

23.  case class User(user: String) extends Prop with Product with Serializable

    Represents the JavaMail property mail.user.

    Represents the JavaMail property mail.user.

    user

    The default user name to use when connecting to the mail server. Used if the mail.protocol.user property isn't set.