• Home
• io.vertx
• vertx-mail-service
• 3.9.15
• source code

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

x-mail-service.3.9.15.source-code.index.adoc Maven / Gradle / Ivy

= Vert.x Mail service (SMTP client implementation)

Vert.x service for sending SMTP emails via the vert.x event bus by
a mail service running on another machine on the local network.

== MailService

The MailService interface supports sending mails through another server running
on the local network by the event bus.

To use this project, add the following dependency to the _dependencies_ section of your build descriptor:

* Maven (in your `pom.xml`):

[source,xml,subs="+attributes"]
----

  io.vertx
  vertx-mail-service
  ${maven.version}

----

* Gradle (in your `build.gradle` file):

[source,groovy,subs="+attributes"]
----
compile io.vertx:vertx-mail-service:${maven.version}
----

=== Service client

The service client only needs the name of the service address as parameter, the
default is "vertx.mail".

[source,$lang]
----
{@link examples.MailServiceExamples#createService}
----

The behaviour of MailClient and MailService is the same, if you like you can use the
MailClient interface to store the MailService instance.

A more complete example for sending a mail via the event bus is this:

[source,$lang]
----
{@link examples.MailServiceExamples#exampleService}
----

== Service listener

To run the service listener that sends the mails, you need to start it separately
e.g. with the vertx command

[source,shell]
----
vertx run service:io.vertx.mail-service
----
or deploy the verticle inside your program.

If you have a smtp server running on the machine on port 25, you can use the default config.