[jbpm-commits] JBoss JBPM SVN: r4529 - jbpm4/branches/email/modules/userguide/src/main/docbook/en/modules.
do-not-reply at jboss.org
do-not-reply at jboss.org
Thu Apr 9 18:31:14 EDT 2009
Author: bradsdavis
Date: 2009-04-09 18:31:14 -0400 (Thu, 09 Apr 2009)
New Revision: 4529
Added:
jbpm4/branches/email/modules/userguide/src/main/docbook/en/modules/ch09-Emails.xml
Log:
Beginnings of the email documentation.
Added: jbpm4/branches/email/modules/userguide/src/main/docbook/en/modules/ch09-Emails.xml
===================================================================
--- jbpm4/branches/email/modules/userguide/src/main/docbook/en/modules/ch09-Emails.xml (rev 0)
+++ jbpm4/branches/email/modules/userguide/src/main/docbook/en/modules/ch09-Emails.xml 2009-04-09 22:31:14 UTC (rev 4529)
@@ -0,0 +1,114 @@
+<chapter id="emails">
+ <title>Email Support</title>
+ <para>
+ This chapter explains Email Support provided within jBPM 4.
+ </para>
+
+
+ <section id="mailinjpdl">
+ <title>Mail in jPDL</title>
+ </section>
+ <section id="scriptableemails">
+ <title>Producers</title>
+ </section>
+ <section id="emailtemplates">
+ <title>Templates</title>
+ </section>
+ <section id="serverconfiguration">
+ <title>Server Configuration</title>
+ <para>Mail Server configuration is provided within jbpm.cfg.xml The <emphasis role="bold">mail-server</emphasis> tag describes an SMTP mail server capable of sending email messages.
+ Because jBPM uses JavaMail to send mail, all properties supported by JavaMail are also exposed to jBPM. Within the subtag of <emphasis role="bold">mail-server</emphasis>, the SMTP properties must be provided as described in the example below.</para>
+ <para>
+ See the Sun JavaMail API for more information on supported properties. <ulink url="http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html">Sun SMTP Properties</ulink>
+ </para>
+ <programlisting><![CDATA[
+<objects>
+ <mail-session>
+ <mail-server>
+ <session-properties>
+ <property name='mail.host' value='localhost' />
+ ...
+ </session-properties>
+ </mail-server>
+ </mail-session>
+</objects>]]></programlisting>
+ <section id="serverconfigurationmultipl">
+ <title>Multiple Mail Servers</title>
+ <para>Multiple SMTP server support has been added to jBPM 4 to support many organizational server structures.
+ This is useful for organizations who have both internal and external SMTP servers, for example.</para>
+ <para>
+ To setup multiple SMTP mail servers, provide multiple mail servers within the jBPM configuration, as described below.
+
+ Note that the tag <emphasis role="bold">address-filter</emphasis> has been added to filter which domains are serviced by each mail server.
+ The mail filter accepts regular expressions to determine if an address is to be sent by a given server.
+ </para>
+ <para>See the Sun Pattern API for more information on supported RegEx expressions. <ulink url="http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html">Sun Pattern JavaDoc</ulink>
+ </para>
+ <programlisting><objects>
+ <mail-session>
+ <mail-server><emphasis role="bold">
+ <address-filter>
+ <include>.+ at jbpm.org</include>
+ </address-filter></emphasis>
+ <session-properties>
+ <property name='mail.host' value='internal.host.url' />
+ ...
+ </session-properties>
+ </mail-server>
+ <mail-server><emphasis role="bold">
+ <address-filter>
+ <exclude>.+ at jbpm.org</exclude>
+ </address-filter></emphasis>
+ <session-properties>
+ <property name='mail.host' value='external.host.url' />
+ ...
+ </session-properties>
+ </mail-server>
+ </mail-session>
+</objects></programlisting>
+ <para>
+ The include/excude logic includes an address if it is explicitly included and not explicitly excluded.
+
+ The include/exclude logic within the address filter is described below.
+
+ <table><title>Address Filter</title>
+ <tgroup cols="3" rowsep="1" colsep="1">
+ <thead>
+ <row>
+ <entry>Property</entry>
+ <entry>Multiple</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>include</literal></entry>
+ <entry>0</entry>
+ <entry>If no includes are present, the address filter will include all email addresses.</entry>
+ </row>
+ <row>
+ <entry><literal>include</literal></entry>
+ <entry>1..X</entry>
+ <entry>If one or more includes are present, the address filter will include only email addresses matching the include patterns provided.</entry>
+ </row>
+ <row>
+ <entry><literal>exclude</literal></entry>
+ <entry>0</entry>
+ <entry>If no excludes are present, no addresses are explicitly excluded.</entry>
+ </row>
+ <row>
+ <entry><literal>exclude</literal></entry>
+ <entry>1..X</entry>
+ <entry>If one or more excludes are present, the address filter will explicitly exclude only email addresses matching the exclude patterns provided.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </section>
+ </section>
+ <section id="extensibility">
+ <title>Extension Points</title>
+ </section>
+
+</chapter>
\ No newline at end of file
More information about the jbpm-commits
mailing list