Administering the Jakarta Mail Service

16 Administering the Jakarta Mail Service

Eclipse GlassFish includes the Jakarta Mail API along with Jakarta Mail service providers that allow an application component to send email notifications over the Internet and to read email from IMAP and POP3 mail servers.

The following topics are addressed here:

Instructions for accomplishing the tasks in this chapter by using the Administration Console are contained in the Administration Console online help.

About Jakarta Mail

The Jakarta Mail API is a set of abstract APIs that model a mail system. The Jakarta Mail API provides a platform-independent and protocol-independent framework to build mail and messaging applications and provide facilities for reading and sending electronic messages. Service providers implement particular protocols. Using the API you can add email capabilities to your applications. Jakarta Mail provides access from Java applications to Internet Message Access Protocol (IMAP) and Simple Mail Transfer Protocol (SMTP) capable mail servers on your network or the Internet. The API does not provide mail server functionality; you must have access to a mail server to use Jakarta Mail.

The Jakarta Mail API is implemented as an optional package in the Java platform and is also available as part of the Jakarta EE platform.

To learn more about the Jakarta Mail API, consult the Jakarta Mail web site .

Administering Jakarta Mail Resources

When you create a mail session, the server-side components and applications are enabled to access Jakarta Mail services with JNDI, using the session properties you assign for them. When creating a mail session, you can designate the mail hosts, the transport and store protocols, and the default mail user so that components that use Jakarta Mail do not have to set these properties. Applications that are heavy email users benefit because Eclipse GlassFish creates a single session object and makes the session available to any component that needs it.

Jakarta Mail settings such as the following can be specified:

  • JNDI Name. The unique name for the mail session. Use the naming sub-context prefix mail/ for Jakarta Mail resources. For example: mail/MySession

  • Mail Host. The host name of the default mail server. The connect methods of the store and transport objects use this value if a protocol-specific host property is not supplied. The name must be resolvable to an actual host name.

  • Default User. The default user name to provide when connecting to a mail server. The connect methods of the store and transport objects use this value if a protocol-specific username property is not supplied.

  • Default Return Address. The email address of the default user, in the form: username@host.domain.

  • Description. A descriptive statement for the component.

  • Session. Indicates whether or not mail session is enabled or disabled at this time

The following topics are addressed here:

To Create a Jakarta Mail Resource

Use the create-mail-resource subcommand in remote mode to create a Jakarta Mail session resource. The JNDI name for a Jakarta Mail session resource customarily includes the mail/ naming subcontext, For example: mail/MyMailSession.

  1. Ensure that the server is running. Remote subcommands require a running server.

  2. Create a Jakarta Mail resource by using the create-mail-resource subcommand.

    Information about the properties for the subcommand is included in this help page.

  3. To apply your changes, restart Eclipse GlassFish.

    See To Restart a Domain.

Example 16-1 Creating a Jakarta Mail Resource

This example creates a Jakarta Mail resource named mail/MyMailSession. The escape character (\) is used in the --fromaddress option to distinguish the dot (.) and at sign (@).

asadmin> create-mail-resource --mailhost localhost
--mailuser sample --fromaddress sample\@sun\.com mail/MyMailSession
Command create-mail-resource executed successfully.

See Also

You can also view the full syntax and options of the subcommand by typing asadmin help create-mail-resource at the command line.

To List Jakarta Mail Resources

Use the list-mail-resources subcommand in remote mode to list the existing Jakarta Mail session resources.

  1. Ensure that the server is running. Remote subcommands require a running server.

  2. List the Jakarta Mail resources by using the list-mail-resources subcommand.

Example 16-2 Listing Jakarta Mail Resources

This example lists the Jakarta Mail resources on localhost.

asadmin> list-mail-resources
mail/MyMailSession
Command list-mail-resources executed successfuly.

See Also

You can also view the full syntax and options of the subcommands by typing asadmin help list-mail-resources at the command line.

To Update a Jakarta Mail Resource

  1. List the Jakarta Mail resources by using the list-mail-resources subcommand.

  2. Modify the values for the specified Jakarta Mail source by using the set subcommand.

    The resource is identified by its dotted name.

Example 16-3 Updating a Jakarta Mail Resource

This example changes joeserver to joe.

asadmin> set server.resources.mail-resource.mail/
MyMailSession.user=joeserver.resources.mail-resource.mail/
MyMailSession.user=joe
Command set executed successfully.

To Delete a Jakarta Mail Resource

Use the delete-mail-resource subcommands in remote mode to delete a Jakarta Mail session resource.

Before You Begin

References to the specified resource must be removed before running the delete-mail-resource subcommands.

  1. Ensure that the server is running. Remote subcommands require a running server.

  2. List the Jakarta Mail resources by using the list-mail-resources subcommands.

  3. Delete a Jakarta Mail resource by using the delete-mail-resource subcommands.

  4. To apply your changes, restart Eclipse GlassFish.

    See To Restart a Domain.

Example 16-4 Deleting a Jakarta Mail Resource

This example deletes the Jakarta Mail session resource named mail/MyMailSession.

asadmin> delete-mail-resource mail/MyMailSession
Command delete-mail-resource executed successfully.

See Also

You can also view the full syntax and options of the subcommand by typing asadmin help delete-mail-resource at the command line.