/*
 *  Copyright (c) 2011-2015 The original author or authors
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *       The Eclipse Public License is available at
 *       http://www.eclipse.org/legal/epl-v10.html
 *
 *       The Apache License v2.0 is available at
 *       http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.mail;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.ext.mail.impl.MailClientImpl;

import java.util.UUID;

SMTP mail client for Vert.x

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

Author:Alexander Lehmann
/** * SMTP mail client for Vert.x * <p> * A simple asynchronous API for sending mails from Vert.x applications * * @author <a href="http://oss.lehmann.cx/">Alexander Lehmann</a> */
@VertxGen public interface MailClient {
The name of the default pool
/** * The name of the default pool */
String DEFAULT_POOL_NAME = "DEFAULT_POOL";
create a non shared instance of the mail client
Params:
  • 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
/** * create a non shared instance of the mail client * * @param vertx the Vertx instance the operation will be run in * @param config MailConfig configuration to be used for sending mails * @return MailClient instance that can then be used to send multiple mails */
static MailClient createNonShared(Vertx vertx, MailConfig config) { return new MailClientImpl(vertx, config, UUID.randomUUID().toString()); }
Create a Mail client which shares its connection pool with any other Mail clients created with the same pool name
Params:
  • vertx – the Vert.x instance
  • config – the configuration
  • poolName – the pool name
Returns:the client
/** * Create a Mail client which shares its connection pool with any other Mail clients created with the same * pool name * * @param vertx the Vert.x instance * @param config the configuration * @param poolName the pool name * @return the client */
static MailClient createShared(Vertx vertx, MailConfig config, String poolName) { return new MailClientImpl(vertx, config, poolName); }
Like createShared(Vertx, MailConfig, String) but with the default pool name
Params:
  • vertx – the Vert.x instance
  • config – the configuration
Returns:the client
/** * Like {@link #createShared(io.vertx.core.Vertx, MailConfig, String)} but with the default pool name * @param vertx the Vert.x instance * @param config the configuration * @return the client */
static MailClient createShared(Vertx vertx, MailConfig config) { return new MailClientImpl(vertx, config, DEFAULT_POOL_NAME); }
send a single mail via MailClient
Params:
  • 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
/** * send a single mail via MailClient * * @param email MailMessage object containing the mail text, from/to, attachments etc * @param resultHandler will be called when the operation is finished or it fails * (may be null to ignore the result) * @return this MailClient instance so the method can be used fluently */
@Fluent MailClient sendMail(MailMessage email, Handler<AsyncResult<MailResult>> resultHandler);
close the MailClient
/** * close the MailClient */
void close(); }