[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Peter Muir
peter at bleepbleep.org.uk
Tue Sep 4 07:37:15 EDT 2007
User: pmuir
Date: 07/09/04 07:37:15
Modified: doc/reference/en/modules mail.xml
Log:
Better XML formatting
Revision Changes Path
1.25 +643 -468 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.24
retrieving revision 1.25
diff -u -b -r1.24 -r1.25
--- mail.xml 3 Sep 2007 12:44:17 -0000 1.24
+++ mail.xml 4 Sep 2007 11:37:15 -0000 1.25
@@ -1,18 +1,28 @@
<chapter id="mail">
<title>Email</title>
- <para>Seam now includes an optional components for templating and sending emails.</para>
+ <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> manager component.
+ <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> manager component.
</para>
- <para> The examples/mail 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>
+ The examples/mail 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>
<section>
<title>Creating a message</title>
- <para>You don't need to learn a whole new templating language to use Seam Mail—an email is just facelet!</para>
+ <para>
+ You don't need to learn a whole new templating language to use Seam Mail
+ — an email is just facelet!
+ </para>
<programlisting><![CDATA[<m:message xmlns="http://www.w3.org/1999/xhtml"
xmlns:m="http://jboss.com/products/seam/mail"
@@ -32,16 +42,26 @@
</m:message>]]></programlisting>
- <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 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
- ask Seam to render the view:</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 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 ask Seam to render the view:
+ </para>
<programlisting><![CDATA[@In(create=true)
private Renderer renderer;
@@ -56,35 +76,55 @@
}
}]]></programlisting>
- <para>If, for example, you entered an invalid email address, then an exception would be thrown, which is caught
- and then displayed to the user.</para>
+ <para>
+ If, for example, you entered an invalid email address, then an exception
+ would be thrown, which is caught and then displayed to the user.
+ </para>
<section>
<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.</para>
+ <para>
+ Seam makes it easy to attach files to an email. It supports most of
+ the standard java types used when working with files.
+ </para>
- <para>If you wanted to email the <literal>jboss-seam-mail.jar</literal>:</para>
+ <para>
+ If you wanted to email the <literal>jboss-seam-mail.jar</literal>:
+ </para>
<programlisting><![CDATA[<m:attachment value="/WEB-INF/lib/jboss-seam-mail.jar"/>]]></programlisting>
- <para>Seam will load the file from the classpath, and attach it to the email. By default it would be attached as <literal>jboss-seam-mail.jar</literal>;
- if you wanted it to have another name you would just add the <literal>fileName</literal> attribute:</para>
+ <para>
+ Seam will load the file from the classpath, and attach it to the email.
+ By default it would be attached as <literal>jboss-seam-mail.jar</literal>;
+ if you wanted it to have another name you would just add the <literal>fileName</literal> attribute:
+ </para>
<programlisting><![CDATA[<m:attachment value="/WEB-INF/lib/jboss-seam-mail.jar" fileName="this-is-so-cool.jar"/>]]></programlisting>
- <para>You could also attach a <literal>java.io.File</literal>, a <literal>java.net.URL</literal>:</para>
+ <para>
+ You could also attach a <literal>java.io.File</literal>, a <literal>java.net.URL</literal>:
+ </para>
<programlisting><![CDATA[<m:attachment value="#{numbers}"/>]]></programlisting>
- <para>Or a <literal>byte[]</literal> or a <literal>java.io.InputStream</literal>:</para>
+ <para>
+ Or a <literal>byte[]</literal> or a <literal>java.io.InputStream</literal>:
+ </para>
<programlisting><![CDATA[<m:attachment value="#{person.photo}" contentType="image/png"/>]]></programlisting>
- <para>You'll notice that for a <literal>byte[]</literal> and a <literal>java.io.InputStream</literal> you need to specify the MIME type
- of the attachment (as that information is not carried as part of the file).</para>
+ <para>
+ You'll notice that for a <literal>byte[]</literal> and a <literal>java.io.InputStream</literal>
+ you need to specify the MIME type of the attachment (as that
+ information is not carried as part of the file).
+ </para>
- <para>And it gets even better, you can attach a Seam generated PDF, or any standard JSF view, just by wrapping a
- <literal><m:attachment></literal> around the normal tags you would use:</para>
+ <para>
+ And it gets even better, you can attach a Seam generated PDF, or any
+ standard JSF view, just by wrapping a <literal><m:attachment></literal>
+ around the normal tags you would use:
+ </para>
<programlisting><![CDATA[<m:attachment fileName="tiny.pdf">
<p:document>
@@ -92,32 +132,47 @@
</p:document>
</m:attachment>]]></programlisting>
- <para>If you had a set of files you wanted to attach (for example a set of pictures loaded from a database) you can just
- use a <literal><ui:repeat></literal>:</para>
+ <para>
+ If you had a set of files you wanted to attach (for example a set of
+ pictures loaded from a database) you can just use a <literal><ui:repeat></literal>:
+ </para>
<programlisting><![CDATA[<ui:repeat value="#{people}" var="person">
<m:attachment value="#{person.photo}" contentType="image/jpeg" fileName="#{person.firstname}_#{person.lastname}.jpg"/>
</ui:repeat>]]></programlisting>
- <para>And if you want to display an attached image inline:</para>
+ <para>
+ And if you want to display an attached image inline:
+ </para>
- <programlisting><![CDATA[<m:attachment value="#{person.photo}" contentType="image/jpeg" fileName="#{person.firstname}_#{person.lastname}.jpg" status="personPhoto" disposition="inline" />
+ <programlisting><![CDATA[<m:attachment
+ value="#{person.photo}"
+ contentType="image/jpeg"
+ fileName="#{person.firstname}_#{person.lastname}.jpg"
+ status="personPhoto"
+ disposition="inline" />
<img src="cid:#{personPhoto.contentId}" />]]></programlisting>
- <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 attachments will be looked at when trying to locate the
- image (the <literal>Content-ID</literal>'s must match)
- - magic!</para>
+ <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
+ attachments will be looked at when trying to locate the image (the
+ <literal>Content-ID</literal>'s must match) — magic!
+ </para>
- <para>You must declare the attachment before trying to access the status object.</para>
+ <para>
+ You must declare the attachment before trying to access the status object.
+ </para>
</section>
<section>
<title>HTML/Text alternative part</title>
- <para>Whilst most mail readers nowadays support HTML, some don't, so you can add a plain text alternative
- to your email body:</para>
+ <para>
+ Whilst most mail readers nowadays support HTML, some don't, so you can
+ add a plain text alternative to your email body:
+ </para>
<programlisting><![CDATA[<m:body>
<f:facet name="alternative">Sorry, your email reader can't show our fancy email,
@@ -129,8 +184,11 @@
<section>
<title>Multiple recipients</title>
- <para>Often you'll want to send an email to a group of recipients (for example your users). All of the recipient
- mail tags can be placed inside a <literal><ui:repeat></literal>:</para>
+ <para>
+ Often you'll want to send an email to a group of recipients (for
+ example your users). All of the recipient mail tags can be placed
+ inside a <literal><ui:repeat></literal>:
+ </para>
<programlisting><![CDATA[<ui:repeat value="#{allUsers} var="user">
<m:to name="#{user.firstname} #{user.lastname}" address="#{user.emailAddress}" />
@@ -141,8 +199,11 @@
<section>
<title>Multiple messages</title>
- <para>Sometimes, however, you need to send a slightly different message to each recipient (e.g. a password
- reset). The best way to do this is to place the whole message inside a <literal><ui:repeat></literal>:</para>
+ <para>
+ Sometimes, however, you need to send a slightly different message to
+ each recipient (e.g. a password reset). The best way to do this is to
+ place the whole message inside a <literal><ui:repeat></literal>:
+ </para>
<programlisting><![CDATA[<ui:repeat value="#{people}" var="p">
<m:message>
@@ -157,9 +218,14 @@
<section>
<title>Templating</title>
- <para>The mail templating example shows that facelets templating Just Works with the Seam mail tags.</para>
+ <para>
+ The mail templating example shows that facelets templating Just Works
+ with the Seam mail tags.
+ </para>
- <para>Our <literal>template.xhtml</literal> contains:</para>
+ <para>
+ Our <literal>template.xhtml</literal> contains:
+ </para>
<programlisting><![CDATA[<m:message>
<m:from name="Seam" address="do-not-reply at jboss.com" />
@@ -174,50 +240,74 @@
</m:body>
</m:message>]]></programlisting>
- <para>Our <literal>templating.xhtml</literal> contains:</para>
+ <para>
+ Our <literal>templating.xhtml</literal> contains:
+ </para>
<programlisting><![CDATA[<ui:param name="subject" value="Templating with Seam Mail"/>
<ui:define name="body">
<p>This example demonstrates that you can easily use <i>facelets templating</i> in email!</p>
</ui:define>]]></programlisting>
- <para>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 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).</para>
-
- <para>If you do need more configure Facelets or JSF when sending mail, you'll need to
- override the Renderer component and do the configuration programmatically - only for
- advanced users!</para>
+ <para>
+ 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
+ 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).
+ </para>
+
+ <para>
+ If you do need more configure Facelets or JSF when sending mail, you'll
+ need to override the Renderer component and do the configuration
+ programmatically - only for advanced users!
+ </para>
</section>
<section>
<title>Internationalisation</title>
- <para>Seam supports sending internationalised messages. By default, the encoding provided by
- JSF is used, but this can be overridden on the template:</para>
+
+ <para>
+ Seam supports sending internationalised messages. By default, the
+ encoding provided by JSF is used, but this can be overridden on the
+ template:
+ </para>
+
<programlisting><![CDATA[<m:message charset="UTF-8">
...
</m:message>]]></programlisting>
- <para>The body, subject and recipient (and from) name will be encoded. You'll need to make
- sure facelets uses the correct charset for parsing your pages by setting encoding of the
- template:</para>
+
+ <para>
+ The body, subject and recipient (and from) name will be encoded.
+ You'll need to make sure facelets uses the correct charset for parsing
+ your pages by setting encoding of the template:
+ </para>
+
<programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?>]]></programlisting>
</section>
<section>
<title>Other Headers</title>
- <para>Sometimes you'll want to add other headers to your email. Seam provides support for some (see <xref linkend="mail.tags" />).
- For example, we can set the importance of the email, and ask for a read receipt:</para>
+ <para>
+ Sometimes you'll want to add other headers to your email. Seam
+ provides support for some (see <xref linkend="mail.tags" />). For
+ example, we can set the importance of the email, and ask for a read
+ receipt:
+ </para>
<programlisting><![CDATA[<m:message xmlns:m="http://jboss.com/products/seam/mail"
importance="low"
requestReadReceipt="true"/>]]></programlisting>
- <para>Otherise you can add any header to the message using the <literal><m:header></literal> tag:</para>
+ <para>
+ Otherise you can add any header to the message using the
+ <literal><m:header></literal> tag:
+ </para>
<programlisting><![CDATA[<m:header name="X-Sent-From" value="JBoss Seam"/>]]></programlisting>
@@ -226,11 +316,19 @@
</section>
<section>
<title>Receiving emails</title>
- <para>If you are using EJB then you can use a MDB (Message Driven Bean) to receive email. Seam comes with an improved version
- of <literal>mail-ra.rar</literal> as distributed in JBoss AS; until the improvements make there way into
- a released version of JBoss AS, replacing the default <literal>rar</literal> with the one distributed with Seam is
- recommended.</para>
- <para>You can configure it like this:</para>
+
+ <para>
+ If you are using EJB then you can use a MDB (Message Driven Bean) to
+ receive email. Seam comes with an improved version of <literal>mail-ra.rar</literal>
+ as distributed in JBoss AS; until the improvements make there way into
+ a released version of JBoss AS, replacing the default <literal>rar</literal>
+ with the one distributed with Seam is recommended.
+ </para>
+
+ <para>
+ You can configure it like this:
+ </para>
+
<programlisting><![CDATA[@MessageDriven(activationConfig={
@ActivationConfigProperty(propertyName="mailServer", propertyValue="localhost"),
@ActivationConfigProperty(propertyName="mailFolder", propertyValue="INBOX"),
@@ -252,49 +350,80 @@
}]]></programlisting>
- <para>Each message received will cause <literal>onMessage(Message message)</literal> to be called. Most seam
- annotations will work inside a MDB but you musn't access the persistence context.</para>
+ <para>
+ Each message received will cause <literal>onMessage(Message message)</literal>
+ to be called. Most Seam annotations will work inside a MDB but you
+ musn't access the persistence context.
+ </para>
- <para>You can find more information on the default <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>.
- The version distributed with Seam also includes a <literal>debug</literal> property to enable
- JavaMail debugging, a <literal>flush</literal> property (by default true) to disable flushing a <literal>POP3</literal>
- mailbox after successfullying delivering a message to your MDB and a <literal>port</literal> property
- to override the default TCP port. Beware that the api for this may be altered as changes make there
- way into JBoss AS.</para>
+ <para>
+ You can find more information on the default <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>.
+ The version distributed with Seam also includes a <literal>debug</literal>
+ property to enable JavaMail debugging, a <literal>flush</literal>
+ property (by default true) to disable flushing a <literal>POP3</literal>
+ mailbox after successfullying delivering a message to your MDB and a
+ <literal>port</literal> property to override the default TCP port. Beware
+ that the api for this may be altered as changes make their way into JBoss
+ AS.
+ </para>
- <para>If you aren't using JBoss AS you can still use <literal>mail-ra.rar</literal> (included with Seam in the mail directory),
- or you may find your application server includes a similar adapter.</para>
+ <para>
+ If you aren't using JBoss AS you can still use <literal>mail-ra.rar</literal>
+ (included with Seam in the mail directory), or you may find your
+ application server includes a similar adapter.
+ </para>
</section>
<section>
<title>Configuration</title>
- <para>To include Email support in your application, include <literal>jboss-seam-mail.jar</literal> in your
- WEB-INF/lib directory. If you are using JBoss AS there is no further configuration needed to use Seam's
- email support. Otherwise you need to make sure you have the JavaMail API, an implementation of the JavaMail API present
- (the API and impl used in JBoss AS are distributed with seam as <literal>lib/mail.jar</literal>), and a copy
- of the Java Activation Framework (distributed with seam as <literal>lib/activation.jar</literal>.</para>
+ <para>
+ To include Email support in your application, include <literal>jboss-seam-mail.jar</literal>
+ in your <literal>WEB-INF/lib</literal> directory. If you are using JBoss
+ AS there is no further configuration needed to use Seam's email support.
+ Otherwise you need to make sure you have the JavaMail API, an
+ implementation of the JavaMail API present (the API and impl used in
+ JBoss AS are distributed with seam as <literal>lib/mail.jar</literal>),
+ and a copy 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 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 <literal>mailSession</literal> component uses JavaMail to talk to a 'real' SMTP server.</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 or you can use a Seam configured Session.</para>
+ <para>
+ A JavaMail Session may be available via a JNDI lookup if you are
+ working in an JEE environment or 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>
+ <para>
+ The mailSession component's properties are described in more detail in
+ <xref linkend="components.mail"/>.
+ </para>
<section>
<title>JNDI lookup in JBoss AS</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>
+ <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>
<programlisting><![CDATA[<components xmlns="http://jboss.com/products/seam/components"
xmlns:core="http://jboss.com/products/seam/core"
@@ -304,15 +433,21 @@
</components>]]></programlisting>
- <para>Here we tell Seam to get the mail session bound to <literal>java:/Mail</literal> from JNDI.</para>
+ <para>
+ Here we tell Seam to get the mail session bound to
+ <literal>java:/Mail</literal> from JNDI.
+ </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>
+ <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"
@@ -328,19 +463,24 @@
<section>
<title>Meldware</title>
+
<para>
- Seam's mail examples use Meldware (from <ulink url="http://buni.org">buni.org</ulink>) as a mail
- server. Meldware is a groupware package that provides <literal>SMTP</literal>, <literal>POP3</literal>,
- <literal>IMAP</literal>, webmail, a shared calendar and an graphical admin tool; it's written as
- a JEE application so can be deployed onto JBoss AS alongside your Seam application.
+ Seam's mail examples use Meldware (from <ulink url="http://buni.org">buni.org</ulink>)
+ as a mail server. Meldware is a groupware package that provides
+ <literal>SMTP</literal>, <literal>POP3</literal>, <literal>IMAP</literal>,
+ webmail, a shared calendar and an graphical admin tool; it's written as a
+ JEE application so can be deployed onto JBoss AS alongside your Seam
+ application.
</para>
<para>
- The version of Meldware distributed with Seam (in the <literal>mail/buni-meldware</literal> folder
- is specially tailored for development - mailboxes, users and aliases (email addresses) are created
- everytime the the application deploys. If you want to use Meldware for anything more than sending
- emails in production it's recommended you a vanilla copy. To create mailboxes, users and aliaes,
- you can use the <literal>meldware</literal> component:
+ The version of Meldware distributed with Seam (in the <literal>mail/buni-meldware</literal>
+ folder is specially tailored for development - mailboxes, users and
+ aliases (email addresses) are created everytime the the application
+ deploys. If you want to use Meldware for anything more than sending
+ emails in production it's recommended you a vanilla copy. To create
+ mailboxes, users and aliaes, you can use the <literal>meldware</literal>
+ component:
</para>
<programlisting><![CDATA[<components xmlns="http://jboss.com/products/seam/components"
@@ -365,24 +505,28 @@
</components>]]></programlisting>
<para>
- Here we've created two users, <literal>duke</literal>, who has two email addresses and
- an administrator with the username <literal>root</literal>.
+ Here we've created two users, <literal>duke</literal>, who has two email
+ addresses and an administrator with the username <literal>root</literal>.
</para>
-
-
</section>
<section id="mail.tags">
<title>Tags</title>
- <para>Emails are generated using tags in the
- <literal>http://jboss.com/products/seam/mail</literal> namespace. Documents should always have the
- <literal>message</literal> tag at the root of the message. The message tag prepares Seam to generate
- an email. </para>
+ <para>
+ Emails are generated using tags in the <literal>http://jboss.com/products/seam/mail</literal>
+ namespace. Documents should always have the <literal>message</literal>
+ tag at the root of the message. The message tag prepares Seam to generate
+ an email.
+ </para>
- <para>The standard templating tags of facelets can be used as normal. Inside the body you can use any
- JSF tag which doesn't require access to external resources (stylesheets, javascript).</para>
+ <para>
+ The standard templating tags of facelets can be used as normal. Inside
+ the body you can use any JSF tag; if it requires access to external
+ resources (stylesheets, javascript) then be sure to set the
+ <literal>urlBase</literal>.
+ </para>
<variablelist>
<varlistentry>
@@ -394,25 +538,30 @@
<itemizedlist>
<listitem>
<para>
- <literal>importance</literal> — low, normal or high. By default normal, this sets the
- importance of the mail message.
+ <literal>importance</literal> — low, normal or high. By
+ default normal, this sets the importance of the mail message.
</para>
</listitem>
<listitem>
<para>
- <literal>precedence</literal> — sets the precedence of the message (e.g. bulk).
+ <literal>precedence</literal> — sets the precedence of
+ the message (e.g. bulk).
</para>
</listitem>
<listitem>
<para>
- <literal>requestReadReceipt</literal> — by default false, if set, a read receipt will be
- request will be added, with the read receipt being sent to the <literal>From:</literal> address.
+ <literal>requestReadReceipt</literal> — by default false,
+ if set, a read receipt request will be will be added, with the
+ read receipt being sent to the <literal>From:</literal>
+ address.
</para>
</listitem>
<listitem>
<para>
- <literal>urlBase</literal> — If set, the value is prepended to the <literal>requestContextPath</literal> allowing
- you to use components such as <literal><h:graphicImage></literal> in your emails.
+ <literal>urlBase</literal> — If set, the value is
+ prepended to the <literal>requestContextPath</literal> allowing
+ you to use components such as
+ <literal><h:graphicImage></literal> in your emails.
</para>
</listitem>
</itemizedlist>
@@ -422,17 +571,20 @@
<term><m:from></term>
<listitem>
<para>
- Set's the From: address for the email. You can only have one of these per email.
+ Set's the From: address for the email. You can only have one of
+ these per email.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>name</literal> — the name the email should come from.
+ <literal>name</literal> — the name the email should come
+ from.
</para>
</listitem>
<listitem>
<para>
- <literal>address</literal> — the email address the email should come from.
+ <literal>address</literal> — the email address the email
+ should come from.
</para>
</listitem>
</itemizedlist>
@@ -442,12 +594,14 @@
<term><m:replyTo></term>
<listitem>
<para>
- Set's the Reply-to: address for the email. You can only have one of these per email.
+ Set's the Reply-to: address for the email. You can only have one
+ of these per email.
</para>
<itemizedlist>
<listitem>
<para>
- <literal>address</literal> — the email address the email should come from.
+ <literal>address</literal> — the email address the email
+ should come from.
</para>
</listitem>
</itemizedlist>
@@ -457,8 +611,9 @@
<term><m:to></term>
<listitem>
<para>
- Add a recipient to the email. Use multiple <m:to> tags for multiple recipients.
- This tag can be safely placed inside a repeat tag such as <ui:repeat>.
+ Add a recipient to the email. Use multiple <m:to> tags for
+ multiple recipients. This tag can be safely placed inside a repeat
+ tag such as <ui:repeat>.
</para>
<itemizedlist>
<listitem>
@@ -478,8 +633,9 @@
<term><m:cc></term>
<listitem>
<para>
- Add a cc recipient to the email. Use multiple <m:cc> tags for multiple ccs.
- This tag can be safely placed inside a repeat tag such as <ui:repeat>.
+ Add a cc recipient to the email. Use multiple <m:cc> tags
+ for multiple ccs. This tag can be safely placed inside a iterator
+ tag such as <ui:repeat>.
</para>
<itemizedlist>
<listitem>
@@ -489,7 +645,8 @@
</listitem>
<listitem>
<para>
- <literal>address</literal> — the email address of the recipient.
+ <literal>address</literal> — the email address of the
+ recipient.
</para>
</listitem>
</itemizedlist>
@@ -499,8 +656,9 @@
<term><m:bcc></term>
<listitem>
<para>
- Add a bcc recipient to the email. Use multiple <m:bcc> tags for multiple bccs.
- This tag can be safely placed inside a repeat tag such as <ui:repeat>.
+ Add a bcc recipient to the email. Use multiple <m:bcc>
+ tags for multiple bccs. This tag can be safely placed inside a
+ repeat tag such as <ui:repeat>.
</para>
<itemizedlist>
<listitem>
@@ -510,7 +668,8 @@
</listitem>
<listitem>
<para>
- <literal>address</literal> — the email address of the recipient.
+ <literal>address</literal> — the email address of the
+ recipient.
</para>
</listitem>
</itemizedlist>
@@ -520,17 +679,19 @@
<term><m:header></term>
<listitem>
<para>
- Add a header to the email (e.g. <literal>X-Sent-From: JBoss Seam</literal>
+ Add a header to the email (e.g. <literal>X-Sent-From: JBoss Seam</literal>)
</para>
<itemizedlist>
<listitem>
<para>
- <literal>name</literal> — The name of the header to add (e.g. <literal>X-Sent-From</literal>).
+ <literal>name</literal> — The name of the header to
+ add (e.g. <literal>X-Sent-From</literal>).
</para>
</listitem>
<listitem>
<para>
- <literal>value</literal> — The value of the header to add (e.g. <literal>JBoss Seam</literal>).
+ <literal>value</literal> — The value of the header to
+ add (e.g. <literal>JBoss Seam</literal>).
</para>
</listitem>
</itemizedlist>
@@ -550,29 +711,36 @@
<itemizedlist>
<listitem>
<para>
- <literal>String</literal> — A <literal>String</literal> is interpreted as a path to file within the classpath
+ <literal>String</literal> — A <literal>String</literal>
+ is interpreted as a path to file within the classpath
</para>
</listitem>
<listitem>
<para>
- <literal>java.io.File</literal> — An EL expression can reference a <literal>File</literal> object
+ <literal>java.io.File</literal> — An EL expression
+ can reference a <literal>File</literal> object
</para>
</listitem>
<listitem>
<para>
- <literal>java.net.URL</literal> — An EL expression can reference a <literal>URL</literal> object
+ <literal>java.net.URL</literal> — An EL expression
+ can reference a <literal>URL</literal> object
</para>
</listitem>
<listitem>
<para>
- <literal>java.io.InputStream</literal> — An EL expression can reference an <literal>InputStream</literal>.
- In this case both a <literal>fileName</literal> and a <literal>contentType</literal> must be specified.
+ <literal>java.io.InputStream</literal> — An EL
+ expression can reference an <literal>InputStream</literal>.
+ In this case both a <literal>fileName</literal> and a
+ <literal>contentType</literal> must be specified.
</para>
</listitem>
<listitem>
<para>
- <literal>byte[]</literal> — An EL expression can reference an <literal>byte[]</literal>.
- In this case both a <literal>fileName</literal> and a <literal>contentType</literal> must be specified.
+ <literal>byte[]</literal> — An EL expression can
+ reference an <literal>byte[]</literal>. In this case both
+ a <literal>fileName</literal> and a
+ <literal>contentType</literal> must be specified.
</para>
</listitem>
</itemizedlist>
@@ -580,26 +748,31 @@
<itemizedlist>
<listitem>
<para>
- If this tag contains a <literal><p:document></literal> tag, the document described will be
- generated and attached to the email. A <literal>fileName</literal> should be specfied.
+ If this tag contains a <literal><p:document></literal>
+ tag, the document described will be generated and
+ attached to the email. A <literal>fileName</literal>
+ should be specfied.
</para>
</listitem>
<listitem>
<para>
- If this tag contains other JSF tags a HTML document will be generated from them
- and attached to the email. A <literal>fileName</literal> should be specfied.
+ If this tag contains other JSF tags a HTML document will
+ be generated from them and attached to the email. A
+ <literal>fileName</literal> should be specfied.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
- <literal>fileName</literal> — Specify the file name to use for the attached file.
+ <literal>fileName</literal> — Specify the file name to
+ use for the attached file.
</para>
</listitem>
<listitem>
<para>
- <literal>contentType</literal> — Specify the MIME type of the attached file
+ <literal>contentType</literal> — Specify the MIME type
+ of the attached file
</para>
</listitem>
</itemizedlist>
@@ -617,19 +790,21 @@
<term><m:body></term>
<listitem>
<para>
- Set's 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.
+ Set's 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>
<itemizedlist>
<listitem>
<para>
- <literal>type</literal> — If set to <literal>plain</literal> then a plain text email will be generated otherwise an HTML email is generated.
+ <literal>type</literal> — If set to <literal>plain</literal>
+ then a plain text email will be generated otherwise an HTML
+ email is generated.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
-
-
</section>
</chapter>
More information about the jboss-cvs-commits
mailing list