[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Peter Muir
peter at bleepbleep.org.uk
Sun Jan 28 16:58:54 EST 2007
User: pmuir
Date: 07/01/28 16:58:54
Modified: doc/reference/en/modules components.xml mail.xml
Log:
Get javax.mail.Session from JNDI if available
Revision Changes Path
1.53 +10 -0 jboss-seam/doc/reference/en/modules/components.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: components.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/components.xml,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -b -r1.52 -r1.53
--- components.xml 24 Jan 2007 21:06:50 -0000 1.52
+++ components.xml 28 Jan 2007 21:58:54 -0000 1.53
@@ -988,6 +988,16 @@
<literal>org.jboss.seam.mail.mailSession.debug</literal> — enable JavaMail debugging (very verbose)
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>org.jboss.seam.mail.mailSession.lookupService</literal> — if false, Seam won't attempt to get a Session from JNDI (by default true)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>org.jboss.seam.mail.mailSession.serviceName</literal> — the name under which the session is bound to JNDI (by default <literal>java:/Mail</literal>)
+ </para>
+ </listitem>
</itemizedlist>
</listitem>
</varlistentry>
1.5 +37 -21 jboss-seam/doc/reference/en/modules/mail.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: mail.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/mail.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- mail.xml 26 Jan 2007 11:46:20 -0000 1.4
+++ mail.xml 28 Jan 2007 21:58:54 -0000 1.5
@@ -1,20 +1,18 @@
<chapter id="mail">
- <title>Email Generation and Sending</title>
- <para>Seam now includes an optional component set for generating and sending emails.</para>
+ <title>Email</title>
+ <para>Seam now includes an optional components for templating and sending emails.</para>
<para>Email support is provided by <literal>jboss-seam-mail.jar</literal>. This JAR contains the mail JSF controls, which are used
- to construct emails, and the <literal>mailSession</literal> component, which sends the generated email.
+ to construct emails, and the <literal>mailSession</literal> manager component.
</para>
<para> The examples/mail project contains an example of the email support in action. It demonstrates proper
- deployment packaging, and it contains a number of examples that demonstrate the key email generation features
- currently supported. </para>
+ packaging, and it contains a number of example that demonstrate the key features currently supported. </para>
<section>
<title>Creating a message</title>
<para>In Seam Mail, an email is just facelet:</para>
- <programlisting>
-<m:message xmlns="http://www.w3.org/1999/xhtml"
+ <programlisting><m:message xmlns="http://www.w3.org/1999/xhtml"
xmlns:m="http://jboss.com/products/seam/mail"
xmlns:h="http://java.sun.com/jsf/html">
@@ -30,15 +28,14 @@
<p>Peter</p>
</m:body>
-</m:message>
- </programlisting>
+</m:message></programlisting>
- <para>The <literal>m:message</literal> wraps the whole message, and tells Seam to start rendering an email. Inside the
- <literal>m:message</literal> tag we use an <literal>m:from</literal> to set who the message is from, a <literal>m:to</literal> to
- specify a sender (notice how we are able to use EL just like in a normal facelet), and a <literal>m:subject</literal>.</para>
+ <para>The <literal><m:message></literal> tag wraps the whole message, and tells Seam to start rendering an email. Inside the
+ <literal><m:message></literal> tag we use an <literal><m:from></literal> tag to set who the message is from, a <literal><m:to></literal> tag to
+ specify a sender (notice how we use EL as we would in a normal facelet), and a <literal><m:subject></literal> tag.</para>
- <para>The <literal>m:body</literal> tag wraps the body of the email. You can use regular HTML tags inside the body as well as
- JSF tags</para>
+ <para>The <literal><m:body></literal> tag wraps the body of the email. You can use regular HTML tags inside the body as well as
+ JSF components.</para>
<para>So, now you have your email template, how do you go about sending it? Well, at the end of rendering the
<literal>m:message</literal> the <literal>mailSession</literal> is called to send the email, so all you have to do is
@@ -123,15 +120,34 @@
of the Java Activation Framework (distributed with seam as <literal>lib/activation.jar</literal>.</para>
<para>The Seam Email module requires the use of Facelets as the view technology. Future versions of the library
may also support the use of JSP. Additionally, it requires the use of the seam-ui package.</para>
- <para>The mailSession component uses JavaMail to talk to a 'real' SMTP server. If you have one running on localhost, then no further
- configuration is required. Otherwise, the mailSession component can be configured in <literal>components.xml</literal>. Here, we tell
- Seam to use <literal>smtp.example.com</literal> as the smtp server, see <xref linkend="components.mail"/> for all the possible properties</para>
+ <para>The <literal>mailSession</literal> component uses JavaMail to talk to a 'real' SMTP server.</para>
+
+ <section>
+ <title><literal>mailSession</literal></title>
+
+ <para>A JavaMail Session may be available via a JNDI lookup if you are working in an JEE environment. If a Session is available
+ via a JNDI lookup, Seam will simply wrap this Session. Otherwise, you can use a Seam configured Session.</para>
+
+ <para>The mailSession component's properties are described in more detail in <xref linkend="components.mail"/>.</para>
+
+ <section>
+ <title>JEE enviroments</title>
+ <para>The JBossAS <literal>deploy/mail-service.xml</literal> configures a JavaMail session binding into JNDI. The default service configuration will
+ need altering for your network. <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JavaMail">http://wiki.jboss.org/wiki/Wiki.jsp?page=JavaMail</ulink>
+ describes the service in more detail.</para>
+ </section>
+
+ <section>
+ <title>Seam configured Session</title>
+ <para>A mail session can be configured via <literal>components.xml</literal>. Here we tell Seam to use <literal>smtp.example.com</literal>
+ as the smtp server, </para>
<programlisting><![CDATA[<components xmlns="http://jboss.com/products/seam/components"
xmlns:core="http://jboss.com/products/seam/core"
xmlns:mail="http://jboss.com/products/seam/mail">
<mail:mailSession host="smtp.example.com" />
</components>]]></programlisting>
-
+ </section>
+ </section>
</section>
<section id="mail.tags">
More information about the jboss-cvs-commits
mailing list