
Administration Commands               create-javamail-resource(1)

NAME
     create-javamail-resource  -  creates  a   JavaMail   session
     resource

SYNOPSIS
     create-javamail-resource
     [--terse={true|false}][ --echo={true|false} ]
     [ --interactive={true|false} ] [ --host  host]
     [--port port] [--secure| -s ] [ --user  admin_user]
     [--passwordfile filename] [--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 ses-
     sion  resource.  This  command  is  supported in remote mode
     only.

OPTIONS
     -t --terse                  Indicates that any  output  data
                                 must  be very concise, typically
                                 avoiding   human-friendly   sen-
                                 tences    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 --host                   The  machine  name   where   the
                                 domain  administration server is
                                 running. The  default  value  is
                                 localhost.

Java EE 5           Last change: 30 Jan 2007                    1

Administration Commands               create-javamail-resource(1)

     -p --port                   The HTTP/S port for  administra-
                                 tion.  This is the port to which
                                 you should point your browser in
                                 order  to manage the domain. For
                                 example, http://localhost:4848.

                                 The default port number is 4848.

     -s --secure                 If set to true, uses SSL/TLS  to
                                 communicate   with   the  domain
                                 administration server.

     -u --user                   The authorized  domain  adminis-
                                 tration   server  administrative
                                 username.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify  the  --user  option  on
                                 subsequent  operations  to  this
                                 particular domain.

     --passwordfile              The --passwordfile option speci-
                                 fies  the  name,  including  the
                                 full path, of a file  containing
                                 the   password   entries   in  a
                                 specific format. The  entry  for
                                 the   password   must  have  the
                                 AS_ADMIN_ prefix followed by the
                                 password   name   in   uppercase
                                 letters.

                                 For  example,  to  specify   the
                                 domain   administration   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,       and
                                 AS_ADMIN_ALIASPASSWORD.

                                 All remote commands must specify
                                 the  admin password to authenti-
                                 cate to the  domain  administra-
                                 tion  server,  either through --

Java EE 5           Last change: 30 Jan 2007                    2

Administration Commands               create-javamail-resource(1)

                                 passwordfile or  asadmin  login,
                                 or  interactively on the command
                                 prompt. The asadmin  login  com-
                                 mand can be used only to specify
                                 the admin  password.  For  other
                                 passwords,  that  must be speci-
                                 fied for  remote  commands,  use
                                 the --passwordfile or enter them
                                 at the command prompt.

                                 If you have authenticated  to  a
                                 domain  using  the asadmin login
                                 command,  then  you   need   not
                                 specify   the   admin   password
                                 through    the    --passwordfile
                                 option  on subsequent operations
                                 to this particular domain.  How-
                                 ever, this is applicable only to
                                 AS_ADMIN_PASSWORD  option.   You
                                 will  still  need to provide the
                                 other  passwords,  for  example,
                                 AS_ADMIN_USERPASSWORD,   as  and
                                 when required by individual com-
                                 mands, such as update-file-user.

                                 For security reasons,  passwords
                                 specified   as   an  environment
                                 variable will  not  be  read  by
                                 asadmin.

                                 The    default     value     for
                                 AS_ADMIN_MASTERPASSWORD       is
                                 changeit.

     --help                      Displays the help text  for  the
                                 command.

     --target                    This option specifies the target
                                 for  which  you are creating the
                                 JavaMail session resource. Valid
                                 values are:

                                     o    server-  Specifies  the
                                          default server instance
                                          as   the   target   for
                                          creating   the JavaMail
                                          session resource.

                                     o    domain-   Specifies   a
                                          particular   domain  as

Java EE 5           Last change: 30 Jan 2007                    3

Administration Commands               create-javamail-resource(1)

                                          the target for creating
                                          the   JavaMail  session
                                          resource.

                                     o    cluster_name- Specifies
                                          a particular cluster as
                                          the target for creating
                                          the   JavaMail  session
                                          resource.

                                     o    instance_name-   Speci-
                                          fies    a    particular
                                          server instance as  the
                                          target   for   creating
                                          the  JavaMail   session
                                          resource.

     --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 name  of  the  mail  account
                                 user provided when connecting to
                                 a  mail  server.   The   connect
                                 methods  of  the Store and Tran-
                                 sport 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  mail provider
                                 to use a nondefault store proto-
                                 col.

     --storeprotocolclass        The mail server  store  protocol
                                 class   name.   The  default  is

Java EE 5           Last change: 30 Jan 2007                    4

Administration Commands               create-javamail-resource(1)

                                 com.sun.mail.imap.IMAPStore.
                                 Change  this  value  only if you
                                 have reconfigured the mail  pro-
                                 vider  to use a nondefault store
                                 protocol.

     --transprotocol             The mail server transport proto-
                                 col.   The   default   is  smtp.
                                 Change this value  only  if  you
                                 have  reconfigured the mail pro-
                                 vider to use a nondefault  tran-
                                 sport protocol.

     --transprotocolclass        The mail server transport proto-
                                 col  class  name. The default is
                                 com.sun.mail.smtp.SMTPTransport.
                                 Change  this  value  only if you
                                 have reconfigured the mail  pro-
                                 vider  to use a nondefault tran-
                                 sport protocol.

     --debug                     If  set  to  true,  the   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                Text providing some details  of
                                 the JavaMail resource.

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

OPERANDS

Java EE 5           Last change: 30 Jan 2007                    5

Administration Commands               create-javamail-resource(1)

     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 cus-
     tomarily 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)

Java EE 5           Last change: 30 Jan 2007                    6

