[seam-commits] Seam SVN: r11664 - tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US.

seam-commits at lists.jboss.org seam-commits at lists.jboss.org
Tue Nov 24 00:27:46 EST 2009


Author: laubai
Date: 2009-11-24 00:27:45 -0500 (Tue, 24 Nov 2009)
New Revision: 11664

Modified:
   tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Mail.xml
Log:
Edited Mail chapter.

Modified: tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Mail.xml
===================================================================
--- tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Mail.xml	2009-11-24 04:55:22 UTC (rev 11663)
+++ tags/JBPAPP_4_3_CP07_FP_CR1a/doc/Seam_Reference_Guide/en-US/Mail.xml	2009-11-24 05:27:45 UTC (rev 11664)
@@ -1,7 +1,7 @@
 <chapter id="mail">
   <title>Email</title>
   <para>
-    Seam now includes an optional components for templating and sending emails.
+    Seam now includes an optional component for templating and sending emails.
   </para>
 
   <para>
@@ -11,13 +11,13 @@
   </para>
 
   <para>
-    The examples/mail project contains an example of the email support in 
+    The <filename>examples/mail</filename> project contains an example of the email support in 
     action. It demonstrates proper packaging, and it contains a number of 
     example that demonstrate the key features currently supported. 
   </para>
   
   <para>
-    You can also test your mail's using Seam's integration testing environment.
+    You can also test your mail using Seam's integration testing environment.
     See <xref linkend="testing.mail" />.
   </para>
     
@@ -26,7 +26,7 @@
     	
     <para>
       You don't need to learn a whole new templating language to use Seam Mail 
-      &#8212; an email is just facelet!
+      &#8212; an email is just a facelet!
     </para>
     	
     <programlisting role="XHTML"><![CDATA[<m:message xmlns="http://www.w3.org/1999/xhtml"
@@ -90,7 +90,7 @@
    	  <title>Attachments</title>
    	  <para>
         Seam makes it easy to attach files to an email.  It supports most of 
-        the standard java types used when working with files.
+        the standard Java types used when working with files.
       </para>
    		
    	  <para>
@@ -160,7 +160,7 @@
 
       <para>
         You may be wondering what <literal>cid:#{...}</literal> does. Well, the
-        IETF specified that by putting this as the src for your image, the 
+        IETF specified that by putting this as the <varname>src</varname> for your image, the 
         attachments will be looked at when trying to locate the image (the 
         <literal>Content-ID</literal>'s must match) &#8212; magic!
       </para>
@@ -224,8 +224,7 @@
 	  <title>Templating</title>
 	    	
 	  <para>
-        The mail templating example shows that facelets templating Just Works 
-        with the Seam mail tags.
+        The mail templating example shows facelets templating working with the Seam mail tags.
       </para>
 	    	
 	  <para>
@@ -258,7 +257,7 @@
         You can also use facelets source tags in your email, but you must place
         them in a jar in <literal>WEB-INF/lib</literal> - referencing the 
         <literal>.taglib.xml</literal> from <literal>web.xml</literal> isn't 
-        reliable when using Seam Mail (if you send your mail asynchrounously 
+        reliable when using Seam Mail (if you send your mail asynchronously 
         Seam Mail doesn't have access to the full JSF or Servlet context, and 
         so doesn't know about <literal>web.xml</literal> configuration 
         parameters).
@@ -274,10 +273,10 @@
 	</section>
 	    
 	<section>
-	  <title>Internationalisation</title>
+	  <title>Internationalization</title>
 	  
       <para>
-        Seam supports sending internationalised messages.  By default, the 
+        Seam supports sending internationalized messages.  By default, the 
         encoding provided by JSF is used, but this can be overridden on the 
         template:
       </para>
@@ -329,14 +328,14 @@
       JBoss AS has a number of limitations (and isn't bundled in some versions)
       therefore we recommend using the <literal>mail-ra.rar</literal> 
       distributed with Seam is recommended (it's in the <literal>extras/</literal>
-      directory in the Seam bundle).  <literal>mail-ra.rar</literal> should 
+      directory in the Seam bundle). <literal>mail-ra.rar</literal> should 
       be placed in <literal>$JBOSS_HOME/server/default/deploy</literal>; if the
       version of JBoss AS you use already has this file, replace it.
     </para>
     
     <note>
         <title>Technology preview </title>    
-    	<para>Distributed mail-ra.rar in Seam is marked as technology preview, so standard support is not guaranteed.</para>     
+    	<para>Distributed <literal>mail-ra.rar</literal> in Seam is marked as technology preview, so standard support is not guaranteed.</para>     
     </note>
          
     
@@ -371,10 +370,10 @@
       musn't access the persistence context.
     </para>
 
-    <para>
+    <!--<para>
       You can find more information on<literal>mail-ra.rar</literal>
       at <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=InboundJavaMail">http://wiki.jboss.org/wiki/Wiki.jsp?page=InboundJavaMail</ulink>.
-    </para>
+    </para>-->
 		
     <para>
       If you aren't using JBoss AS you can still use <literal>mail-ra.rar</literal> 
@@ -428,8 +427,8 @@
           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.
+          <!--<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>
 		        
         <programlisting role="XML"><![CDATA[<components xmlns="http://jboss.com/products/seam/components"
@@ -515,7 +514,7 @@
 
     <para>
       Here we've created two users, <literal>duke</literal>, who has two email
-      addresses and an administrator with the username <literal>root</literal>.
+      addresses, and an administrator with the username <literal>root</literal>.
     </para>
  			
   </section>
@@ -580,7 +579,7 @@
         <term>&lt;m:from&gt;</term>
         <listitem>
           <para>
-            Set's the From: address for the email.  You can only have one of 
+            Sets the From: address for the email.  You can only have one of 
             these per email.
           </para>
           <itemizedlist>
@@ -603,7 +602,7 @@
         <term>&lt;m:replyTo&gt;</term>
           <listitem>
             <para>
-              Set's the Reply-to: address for the email.  You can only have one
+              Sets the Reply-to: address for the email.  You can only have one
               of these per email.
             </para>
            <itemizedlist>
@@ -642,7 +641,7 @@
         <term>&lt;m:cc&gt;</term>
           <listitem>
             <para>
-              Add a cc recipient to the email. Use multiple &lt;m:cc&gt; tags
+              Adds a carbon copy (CC) recipient to the email. Use multiple &lt;m:cc&gt; tags
               for multiple ccs. This tag can be safely placed inside a iterator
               tag such as &lt;ui:repeat&gt;.
             </para>
@@ -665,8 +664,8 @@
         <term>&lt;m:bcc&gt;</term>
           <listitem>
             <para>
-              Add a bcc recipient to the email. Use multiple &lt;m:bcc&gt; 
-              tags for multiple bccs. This tag can be safely placed inside a
+              Add a BCC recipient to the email. Use multiple &lt;m:bcc&gt; 
+              tags for multiple BCCs. This tag can be safely placed inside a
               repeat tag such as &lt;ui:repeat&gt;.
             </para>
             <itemizedlist>
@@ -753,7 +752,7 @@
                   </para>
                 </listitem>
               </itemizedlist>
-              <para>If the value attribute is ommitted:</para>
+              <para>If the value attribute is omitted:</para>
               <itemizedlist>
                 <listitem>
                   <para>
@@ -781,7 +780,7 @@
             <listitem>
               <para>
                 <literal>contentType</literal> &#8212; Specify the MIME type
-                of the attached file
+                of the attached file.
               </para>
             </listitem>
           </itemizedlist>
@@ -799,7 +798,7 @@
         <term>&lt;m:body&gt;</term>
         <listitem>
           <para>
-            Set's the body for the email.  Supports an <literal>alternative</literal>
+            Sets the body for the email.  Supports an <literal>alternative</literal>
             facet which, if an HTML email is generated can contain
             alternative text for a mail reader which doesn't support html.
           </para>



More information about the seam-commits mailing list