Skip to content

Latest commit

 

History

History
150 lines (114 loc) · 8 KB

README.adoc

File metadata and controls

150 lines (114 loc) · 8 KB
Raw

mail: E-Mail Example using CDI and JSF

The mail quickstart demonstrates how to send email using CDI and JSF and the default Mail provider that ships with {productName}.

What is it?

The mail quickstart demonstrates sending email with the use of CDI (Contexts and Dependency Injection) and JSF (JavaServer Faces) in {productNameFull}.

The mail provider is configured in the mail subsystem of the {jbossHomeName}/standalone/configuration/standalone.xml configuration file if you are running a standalone server or in the {jbossHomeName}/domain/configuration/domain.xml configuration file if you are running in a managed domain.

You can use the default mail provider that comes out of the box with {productName}. It uses your local mail relay and the default SMTP port of 25. However, this quickstart demonstrates how to define and use a custom mail provider.

This example is a web application that takes To, From, Subject, and Message Body input and sends mail to that address. The front end is a JSF page with a simple POJO backing, leveraging CDI for resource injection.

Configure an SMTP Server on Your Local Machine

This quickstart expects that you have an SMTP mail server running on your machine and configured for the default port localhost:25. To configure an SMTP mail server, consult the documentation for your operating system. It is beyond the scope of this quickstart to provide these instructions.

If you do not configure an SMTP mail server on your local machine, you will see the exception com.sun.mail.util.MailConnectException: Couldn't connect to host, port: localhost, 25; timeout -1; when you access the application and attempt to send an email.

Configure the Server

You configure the custom mail session in {productName} by running Management CLI commands. For your convenience, this quickstart batches the commands into a configure-mail-session.cli script provided in the root directory of this quickstart.

  1. Before you begin, make sure you do the following:

  2. Review the configure-mail-session.cli file in the root of this quickstart directory. This script creates custom outbound socket binding port for SMTP, POP3, and IMAP. It then creates the custom MyOtherMail mail session and configures it to use the custom outbound socket binding ports.

  3. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server:

    $ {jbossHomeName}/bin/jboss-cli.sh --connect --file=configure-mail-session.cli
    Note
    		 For Windows, use the {jbossHomeName}\bin\jboss-cli.bat script.

    You should see the following result when you run the script.

    The batch executed successfully
process-state: reload-required

  4. Stop the {productName} server.

Review the Modified Server Configuration

After stopping the server, open the {jbossHomeName}/standalone/configuration/standalone.xml file and review the changes.

The following outbound-socket-binding groups are added to the standard-sockets <socket-binding-group> element.

<socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:0}">
  ...
  </outbound-socket-binding>
  <outbound-socket-binding name="my-smtp-binding">
      <remote-destination host="localhost" port="25"/>
  </outbound-socket-binding>
  <outbound-socket-binding name="my-pop3-binding">
      <remote-destination host="localhost" port="110"/>
  </outbound-socket-binding>
  <outbound-socket-binding name="my-imap-binding">
      <remote-destination host="localhost" port="143"/>
  </outbound-socket-binding>
</socket-binding-group>

The MyOtherMail mail session is added to the mail subsystem and configured to use the custom outbound socket binding ports.

<subsystem xmlns="{MailSubsystemNamespace}">
   <mail-session name="default" jndi-name="java:jboss/mail/Default">
      <smtp-server outbound-socket-binding-ref="mail-smtp"/>
   </mail-session>
   <mail-session name="MyOtherMail" jndi-name="java:jboss/mail/MyOtherMail">
      <smtp-server password="pass" username="nobody" tls="true" outbound-socket-binding-ref="my-smtp-binding"/>
      <pop3-server outbound-socket-binding-ref="my-pop3-binding"/>
      <imap-server password="pass" username="nobody" outbound-socket-binding-ref="my-imap-binding"/>
   </mail-session>
</subsystem>

Access the Application

The application will be running at the following URL: http://localhost:8080/{artifactId}/.

Note
 If you see Error processing request in the browser when you access the application and attempt to send email, followed by javax.servlet.ServletException: com.sun.mail.util.MailConnectException: Couldn't connect to host, port: localhost, 25; timeout -1; nested exception is: java.net.ConnectException: Connction refused, make sure you followed the instructions above to Configure an SMTP Server on Your Local Machine.

This script removes the custom MyOtherMail session from the mail subsystem in the server configuration. file You should see the following result when you run the script:

The batch executed successfully
process-state: reload-required

  • Make sure you Configure an SMTP Server on Your Local Machine.

  • Make sure you configure the {productName} custom mail configuration as described above under Configure the {productName} Server. Stop the server at the end of that step.

  • To deploy the server project, right-click on the {artifactId} project and choose Run As –> Run on Server. A browser window appears that accesses the running application.

  • To undeploy the project, right-click on the {artifactId} project and choose Run As –> Maven build. Enter wildfly:undeploy for the Goals and click Run.

  • Make sure you restore the {productName} server configuration when you have completed testing this quickstart.