Sun Microsystems Logo
Products and Services
 
Support and Training
 
 

A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
 
User Commandscreate-javamail-resource(1)


NAME

 create-javamail-resource - creates a JavaMail session resource

SYNOPSIS

 create-javamail-resource --user admin_user [--passwordfile filename] [--host host_name] [--port port_number] [--secure|-s] [--terse=false] [--echo=false] [--interactive=true] [--help] [--target target] --mailhost hostname --mailuser username --fromaddress address [--storeprotocol imap] [--storeprotocolclass com.sun.mail.imapIMAPStore] [--transprotocol smtp] [--transprotocolclass com.sun.mail.smtp.SMTPTransport] [--debug=false] [--enabled=true] [--description text] [--property (name=value)[:name=value]*] jndi_name

DESCRIPTION

The create-javamail-resource command creates a JavaMail session resource. This command is supported in remote mode only.

OPTIONS

-u --user

The authorized domain application server administrative username.

-w --password

The --password option is deprecated. Use --passwordfile instead.

--passwordfile

This option replaces the -- password option. Using the --password option on the command line or through the environment is deprecated. The --passwordfile option specifies the name of a file containing the password entries in a specified format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in capital letters. For example, to specify the domain application server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, AS_ADMIN_SAVEDMASTERPASSWORD, AS_ADMIN_MQPASSWORD, AS_ADMIN_ALIASPASSWORD, and so on.

-H --host

The machine name where the domain application server is running. The default value is localhost.

-p --port

The port number of the domain application server listening for administration requests. The default port number for Platform Edition is 4848. The default port number for Enterprise Edition is 4849.

-s --secure

If set to true, uses SSL/TLS to communicate with the domain application server.

-t --terse

Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

-e --echo

Setting to true will echo the command line statement on the standard output. Default is false.

-I --interactive

If set to true (default), only the required password options are prompted.

-h --help

Displays the help text for the command.

--target

In Enterprise Edition, specifies the target for which you are creating the JavaMail session resource. Valid values are

  • server, which creates the resource for the default server instance server and is the default value

  • domain, which creates the resource for the domain

  • cluster_name, which creates the resource for every server instance in the cluster

  • instance_name, which creates the resource for a particular server instance

--mailhost

The DNS 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.

--mailuser

The mail account 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.

--fromaddress

The email address of the default user, in the form username@host.domain.

--storeprotocol

The mail server store protocol. The default is imap. Change this value only if you have reconfigured the Application Server's mail provider to use a nondefault store protocol.

--storeprotocolclass

The mail server store protocol class name. The default is com.sun.mail.imap.IMAPStore. Change this value only if you have reconfigured the Application Server's mail provider to use a nondefault store protocol.

--transprotocol

The mail server transport protocol. The default is smtp. Change this value only if you have reconfigured the Application Server's mail provider to use a nondefault transport protocol.

--transprotocolclass

The mail server transport protocol class name. The default is com.sun.mail.smtp.SMTPTransport. Change this value only if you have reconfigured the Application Server's mail provider to use a nondefault transport protocol.

--debug

If set to true, server starts up in debug mode for this resource. If the JavaMail log level is set to FINE or finer, the debugging output will be generated and will be included in the server log file. The default value is false.

--enabled

If set to true, the resource is enabled at runtime. The default value is true.

--description

A text description of the JavaMail resource.

--property

Optional attribute name/value pairs for configuring the JavaMail resource. The JavaMail API documentation lists the properties you might want to set.

OPERANDS

jndi_name

The JNDI name of the JavaMail resource to be created. It is a recommended practice to use the naming subcontext prefix mail/ for JavaMail resources.

EXAMPLES

Example 1. Using the create-javamail-resource command

The following command creates a JavaMail resource named mail/MyMailSession. The escape character (\) is used in the --fromaddress option to distinguish the dot (.) and at sign (@). The JNDI name for a JavaMail session resource customarily includes the mail/ naming subcontext.

asadmin> create-javamail-resource --user admin 
--passwordfile passwords.txt --host fuyako --port 7070 
--mailhost localhost --mailuser sample 
--fromaddress sample\@sun\.com mail/MyMailSession
Command create-javamail-resource executed successfully.

EXIT STATUS

0

command executed successfully

1

error in executing the command

SEE ALSO

delete-javamail-resource(1), list-javamail-resources(1)


J2EE SDK 1.4Go To TopLast Changed 31 Jan 2005