io.vertx.reactivex.ext.mail

## Class MailClient

- java.lang.Object
- - io.vertx.reactivex.ext.mail.MailClient

- Direct Known Subclasses:
    MailService

      public class MailClient
      extends Object

  SMTP mail client for Vert.x

  A simple asynchronous API for sending mails from Vert.x applications

  NOTE: This class has been automatically generated from the `original` non RX-ified interface using Vert.x codegen.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static io.vertx.lang.rx.TypeArg<MailClient>` | `__TYPE_ARG`
    `static String` | `DEFAULT_POOL_NAME` The name of the default pool

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MailClient(MailClient delegate)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` close the MailClient
    `static MailClient` | `createNonShared(Vertx vertx, MailConfig config)` create a non shared instance of the mail client
    `static MailClient` | `createShared(Vertx vertx, MailConfig config)` Like `createShared(io.vertx.reactivex.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.String)` but with the default pool name
    `static MailClient` | `createShared(Vertx vertx, MailConfig config, String poolName)` Create a Mail client which shares its connection pool with any other Mail clients created with the same pool name
    `boolean` | `equals(Object o)`
    `MailClient` | `getDelegate()`
    `int` | `hashCode()`
    `static MailClient` | `newInstance(MailClient arg)`
    `Single<MailResult>` | `rxSendMail(MailMessage email)` send a single mail via MailClient
    `MailClient` | `sendMail(MailMessage email, Handler<AsyncResult<MailResult>> resultHandler)` send a single mail via MailClient
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### __TYPE_ARG

          public static final io.vertx.lang.rx.TypeArg<MailClient> __TYPE_ARG

    - #### DEFAULT_POOL_NAME

          public static final String DEFAULT_POOL_NAME

      The name of the default pool
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### MailClient

          public MailClient(MailClient delegate)

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### getDelegate

          public MailClient getDelegate()

    - #### createNonShared

          public static MailClient createNonShared(Vertx vertx,
                                                   MailConfig config)

      create a non shared instance of the mail client
      Parameters:
        `vertx` - the Vertx instance the operation will be run in
        `config` - MailConfig configuration to be used for sending mails
      Returns:
        MailClient instance that can then be used to send multiple mails

    - #### createShared

          public static MailClient createShared(Vertx vertx,
                                                MailConfig config,
                                                String poolName)

      Create a Mail client which shares its connection pool with any other Mail clients created with the same pool name
      Parameters:
        `vertx` - the Vert.x instance
        `config` - the configuration
        `poolName` - the pool name
      Returns:
        the client

    - #### createShared

          public static MailClient createShared(Vertx vertx,
                                                MailConfig config)

      Like `createShared(io.vertx.reactivex.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.String)` but with the default pool name
      Parameters:
        `vertx` - the Vert.x instance
        `config` - the configuration
      Returns:
        the client

    - #### sendMail

          public MailClient sendMail(MailMessage email,
                                     Handler<AsyncResult<MailResult>> resultHandler)

      send a single mail via MailClient
      Parameters:
        `email` - MailMessage object containing the mail text, from/to, attachments etc
        `resultHandler` - will be called when the operation is finished or it fails (may be null to ignore the result)
      Returns:
        this MailClient instance so the method can be used fluently

    - #### rxSendMail

          public Single<MailResult> rxSendMail(MailMessage email)

      send a single mail via MailClient
      Parameters:
        `email` - MailMessage object containing the mail text, from/to, attachments etc
      Returns:
        this MailClient instance so the method can be used fluently

    - #### close

          public void close()

      close the MailClient

    - #### newInstance

          public static MailClient newInstance(MailClient arg)

Copyright © 2019 Eclipse. All rights reserved.