vertx-lang-scala-docs_2.12 3.4.2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package mail
  Definition Classes
    ext
- MailAttachment
- MailClient
- MailConfig
- MailMessage
- MailResult

c

io.vertx.scala.ext.mail

# MailConfig 

###
Companion object MailConfig

#### class MailConfig extends AnyRef

represents the configuration of a mail service with mail server hostname, port, security options, login options and login/password

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MailConfig
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new MailConfig(_asJava: ext.mail.MailConfig)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: ext.mail.MailConfig
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
9.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
10.  def getAuthMethods: String
11.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
12.  def getHostname: String
13.  def getKeyStore: String
14.  def getKeyStorePassword: String
15.  def getLogin: LoginOption
16.  def getMaxPoolSize: Int
17.  def getOwnHostname: String
18.  def getPassword: String
19.  def getPort: Int
20.  def getStarttls: StartTLSOptions
21.  def getUsername: String
22.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
23.  def isAllowRcptErrors: Boolean
24.  def isDisableEsmtp: Boolean
25.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
26.  def isKeepAlive: Boolean
27.  def isSsl: Boolean
28.  def isTrustAll: Boolean
29.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
30.  final def notify(): Unit
    Definition Classes
      AnyRef
31.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
32.  def setAllowRcptErrors(value: Boolean): MailConfig

    set if sending allows rcpt errors

    set if sending allows rcpt errors

    if true, the mail will be sent to the recipients that the server accepted, if any

33.  def setAuthMethods(value: String): MailConfig

    set string of allowed auth methods.

    set string of allowed auth methods. if set only these methods will be used if the server supports them. If null or empty all supported methods may be used

34.  def setDisableEsmtp(value: Boolean): MailConfig

    set if ESMTP should be tried as first command (EHLO)

    set if ESMTP should be tried as first command (EHLO)

    rfc 1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use old SMTP. If there is a server that does not support EHLO and does not give an error code back, the connection should be closed and retried with HELO. We do not do that and rather support turning off ESMTP with a setting. The odds of this actually happening are very small since the client will not connect to arbitrary smtp hosts on the internet. Since the client knows that is connects to a host that doesn't support ESMTP/EHLO in that way, the property has to be set to false.

35.  def setHostname(value: String): MailConfig

    Set the hostname of the smtp server.

36.  def setKeepAlive(value: Boolean): MailConfig

    set if connection pool is enabled default is true

    set if connection pool is enabled default is true

    if the connection pooling is disabled, the max number of sockets is enforced nevertheless

37.  def setKeyStore(value: String): MailConfig

    get the key store filename to be used when opening SMTP connections

    get the key store filename to be used when opening SMTP connections

    if not set, an options object will be created based on other settings (ssl and trustAll)

38.  def setKeyStorePassword(value: String): MailConfig

    get the key store password to be used when opening SMTP connections

39.  def setLogin(value: LoginOption): MailConfig

    Set the login mode for the connection.

    Set the login mode for the connection.

    Either DISABLED, OPTIONAL or REQUIRED

40.  def setMaxPoolSize(value: Int): MailConfig

    set the max allowed number of open connections to the mail server if not set the default is 10

41.  def setOwnHostname(value: String): MailConfig

    set the hostname to be used for HELO/EHLO and the Message-ID

42.  def setPassword(value: String): MailConfig

    Set the password for the login.

43.  def setPort(value: Int): MailConfig

    Set the port of the smtp server.

44.  def setSsl(value: Boolean): MailConfig

    Set the sslOnConnect mode for the connection.

45.  def setStarttls(value: StartTLSOptions): MailConfig

    Set the tls security mode for the connection.

    Set the tls security mode for the connection.

    Either NONE, OPTIONAL or REQUIRED

46.  def setTrustAll(value: Boolean): MailConfig

    set whether to trust all certificates on ssl connect the option is also applied to STARTTLS operation

47.  def setUsername(value: String): MailConfig

    Set the username for the login.

48.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
49.  def toString(): String
    Definition Classes
      AnyRef → Any
50.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
51.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
52.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped