You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by ch...@apache.org on 2006/11/10 08:12:00 UTC
svn commit: r473216 -
/webservices/axis2/branches/java/1_1/xdocs/1_1/mail-configuration.html
Author: chatra
Date: Thu Nov 9 23:11:59 2006
New Revision: 473216
URL: http://svn.apache.org/viewvc?view=rev&rev=473216
Log:
minor improvements pointed out bu Karthiga
Modified:
webservices/axis2/branches/java/1_1/xdocs/1_1/mail-configuration.html
Modified: webservices/axis2/branches/java/1_1/xdocs/1_1/mail-configuration.html
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/xdocs/1_1/mail-configuration.html?view=diff&rev=473216&r1=473215&r2=473216
==============================================================================
--- webservices/axis2/branches/java/1_1/xdocs/1_1/mail-configuration.html (original)
+++ webservices/axis2/branches/java/1_1/xdocs/1_1/mail-configuration.html Thu Nov 9 23:11:59 2006
@@ -29,34 +29,40 @@
<h2>Introduction</h2>
-<p>The inner workings of the mail transport has been divided into two parts, the transport
-sender for smtp and the transport listener for pop3. The transport listener will listen to a particular email address periodically. When an email comes in it will be tunneled into an Axis2
-engine. On the other hand mail transport sender sends emails to a mail server for a particular email address.</p>
+<p>The inner workings of the mail transport has been divided into two parts,
+the transport sender for SMTP and the transport listener for POP3. The
+transport listener will listen to a particular email address periodically.
+When an email comes in it will be tunneled into an Axis2 engine. On the other
+hand, mail transport sender sends emails to a mail server for a particular
+email address.</p>
<p>Mail transport can be used against a generic mail server or it can be used
like a mailet. The simple mailet provided with Axis2 will direct any message
that is coming to a particular address into the Axis engine. The engine will
process the message and will use the Transport sender to send the reply.</p>
-<p>The mail transports has been written with the use of Sun's JavaMail and Activation jars. These should be available in your classpath to get the mail transport work.</p>
-
+<p>The mail transports have been written with the use of Sun's JavaMail and
+Activation jars. These should be available in your classpath to get the mail
+transport work.</p>
<a name="sender"></a>
<h2>Transport Sender</h2>
<p>You need to have a mail account to activate the mail functionality. This
-can either be a generic mail server or you can start up a James mail server, which will be available <a href="http://james.apache.org/">here</a>.</p>
-
-<p>JavaMail sets its properties to a Properties object. In Axis2, this has been mapped to a Parameter object. Mapping has been done as follows,</p>
+can either be a generic mail server or you can start up a James mail server,
+which will be available <a href="http://james.apache.org/">here</a>.</p>
+<p>JavaMail sets its properties to a Properties object. In Axis2, this has
+been mapped to a Parameter object. Mapping has been done as follows,</p>
<ul>
- <li>Every JavaMail property can be set to @name of the <parameter/>. Thus, SSL connection is mapped the way it is done in JavaMail</li>
- <li>Few properties, such as password etc are set to @name with the prefix "transport"</li>
+ <li>Every JavaMail property can be set to @name of the <parameter/>.
+ Thus, SSL connection is mapped the way it is done in JavaMail</li>
+ <li>Few properties, such as password etc., are set to @name with the prefix
+ "transport"</li>
</ul>
-
-<p>For a non-SSL connection, as an example,mail transport sender can be activated by adding following entry to the axis2.xml file.</p>
-
+<p>For a non-SSL connection, as an example,mail transport sender can be
+activated by adding following entry to the axis2.xml file.</p>
<source><pre> <transportSender name="mail" class="org.apache.axis2.transport.mail.MailTransportSender">
<parameter name="mail.smtp.host" locked="false">localhost</parameter>
<parameter name="mail.smtp.user" locked="false">mary</parameter>
@@ -64,11 +70,8 @@
</transportSender>
</pre>
</source>
-
-<p>In runtime tuning a client to set mail transport as easy as follows,</p>
-<source>
-<pre>
-...
+<p>In runtime tuning a client to set mail transport is as easy as follows,</p>
+<source><pre>...
Options options = new Options();
HttpTransportProperties.MailProperties mailProps
@@ -79,15 +82,12 @@
options.setProperty(HTTPConstants.MAIL_SMTP,mailProps);
-...
-</pre>
-</source>
-
-Thus, a user familiar with setting up a SSL connection, he should easily do it with the MailProperties object. For Ex: tuning the sender to talk to gmail account. This configuration should also be done with <parameter/> in Axis2.xml.
-
-<source>
-<pre>
-...
+...</pre>
+</source>Thus, a user familiar with setting up a SSL connection, should
+easily do it with the MailProperties object. For Eg.: tuning the sender to
+talk to gmail account. This configuration should also be done with
+<parameter/> in axis2.xml. <source>
+<pre>...
HttpTransportProperties.MailProperties props =
new HttpTransportProperties.MailProperties();
props.put("mail.smtp.user", "address@gmail.com");
@@ -101,17 +101,13 @@
props.put("mail.smtp.socketFactory.fallback", "false");
props.setPassword("password");
-...
-</pre>
-</source>
-
-
-<a name="receiver"></a>
+...</pre>
+</source><a name="receiver"></a>
<h2>Transport Receiver</h2>
-<p>For a non-SSL connection,as an example,mail Listener can be activated by adding the following entry to the
-axis2.xml file.</p>
+<p>For a non-SSL connection, as an example, mail Listener can be activated by
+adding the following entry to the axis2.xml file.</p>
<source><pre> <transportReceiver name="mail" class="org.apache.axis2.transport.mail.SimpleMailListener">
<parameter name="mail.pop3.host" locked="false">localhost</parameter>
<parameter name="mail.pop3.user" locked="false">bob</parameter>
@@ -120,41 +116,36 @@
</transportReceiver>
</pre>
</source>
+<p><i>Note:</i> The @name="transport.mail.replyToAddress" is an important
+parameter. It supply the Endpoint reference to the listener.</p>
-<p><i>Note:</i> The @name="transport.mail.replyToAddress" is an important parameter. It supply the Endpoint reference to the listener.</p>
-
-<p>For an advanced user, this can be set to a SSL connection. As an example, lets use this transport listener to pop from a specified gmail account.</p>
-
-<source>
-<pre>
-<transportReceiver name="mail" class="org.apache.axis2.transport.mail.SimpleMailListener">
- <parameter name="mail.pop3.host" locked="false">pop.gmail.com</parameter>
- <parameter name="mail.pop3.user" locked="false">address@gmail.com</parameter>
- <parameter name="mail.pop3.socketFactory.class" locked="false">javax.net.ssl.SSLSocketFactory</parameter>
- <parameter name="mail.pop3.socketFactory.fallback" locked="false">false</parameter>
- <parameter name="mail.pop3.port" locked="false">995</parameter>
- <parameter name="mail.pop3.socketFactory.port" locked="false">995</parameter>
- <parameter name="transport.mail.pop3.password" locked="false">password</parameter>
- <parameter name="transport.mail.replyToAddress" locked="false">address@gmail.com</parameter>
-</transportReceiver>
-
-</pre>
-</source>
-
-<a name="server"></a>
+<p>For an advanced user, this can be set to a SSL connection. As an example,
+lets use this transport listener to pop from a specified gmail account.</p>
+<source><pre><transportReceiver name="mail" class="org.apache.axis2.transport.mail.SimpleMailListener">
+ <parameter name="mail.pop3.host" locked="false">pop.gmail.com</parameter>
+ <parameter name="mail.pop3.user" locked="false">address@gmail.com</parameter>
+ <parameter name="mail.pop3.socketFactory.class" locked="false">javax.net.ssl.SSLSocketFactory</parameter>
+ <parameter name="mail.pop3.socketFactory.fallback" locked="false">false</parameter>
+ <parameter name="mail.pop3.port" locked="false">995</parameter>
+ <parameter name="mail.pop3.socketFactory.port" locked="false">995</parameter>
+ <parameter name="transport.mail.pop3.password" locked="false">password</parameter>
+ <parameter name="transport.mail.replyToAddress" locked="false">address@gmail.com</parameter>
+</transportReceiver></pre>
+</source><a name="server"></a>
<h2>Using Mail Transport in the Server Side</h2>
-<p>If the Mail Listener is need to be started as a standalone mail listener, it can be done
-with following command with the all the axis2 jars and the mail dependency
-jars in the classpath.</p>
+<p>If the Mail Listener is need to be started as a standalone mail listener,
+it can be done with following command with the all the Axis2 jars and the
+mail dependency jars in the classpath.</p>
<source><pre>java org.apache.axis2.transport.mail.SimpleMailListener repository-directory</pre>
</source><a name="client"></a>
<h2>Using Mail Transport in the Client Side</h2>
-<p>Following code segment shows how to send a one-way (IN-Only MEP) SOAP message using the
-mail transport, this needs the Transport Sender configured.</p>
+<p>The following code segment shows how to send a one-way (IN-Only MEP) SOAP
+message using the mail transport, this needs the Transport Sender
+configured.</p>
<source><pre>
OMElement payload = ....
String targetEPR = "mail:axis2@localhost/axis2/services/Foo";
@@ -177,7 +168,7 @@
<p>Download the <a href="http://james.apache.org/">Apache James</a> and start
James, connect to the James via Telnet for administrator James with the
-following code</p>
+following code:</p>
<source><pre>$telnet 127.0.0.1 4555
Trying 127.0.0.1...
Connected to localhost.localdomain (127.0.0.1).
@@ -197,20 +188,20 @@
User axis2-client added
Connection closed by foreign host.</pre>
</source>
-<p>Now James is up and running with the accounts</p>
+<p>Now James is up and running with the accounts.</p>
<a name="included"></a>
<h2>Using the Included Mail Server</h2>
<p>The inbuilt mail server can be started from the command line using the
-following piece of code when all the needed jars are in the class path.</p>
+following piece of code when all the necessary jars are in the class path.</p>
<source><pre>java org.apache.axis2.transport.mail.server.MailServer</pre>
</source>
<p>The server itself does not need any configuration or tinkering to work. A
ConfigurationContext and the ports to operate on are the only details needed.
The server will store the mails in memory against the recipient till the
recipient pops it from the server. To facilitate the use in *nix environments
-as a non root user the pop and smtp ports used by default config/test cases
+as a non root user the POP and SMTP ports used by default config/test cases
are (1024 + 25) and (1024 + 110).</p>
<hr>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org