Author: mmcallis Date: 2008-02-06 01:11:36 -0500 (Wed, 06 Feb 2008) New Revision: 9795 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml Log: revising 3.4. Setting up the Email Service Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2008-02-06 03:23:05 UTC (rev 9794) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2008-02-06 06:11:36 UTC (rev 9795) @@ -193,52 +193,62 @@ </sect2> </sect1> <sect1 id="emailConfiguration"> - <title>Setting up the email service</title> - <para>To be able to use the email service (for example to verify user emails when someone subscribes or for CMS - workflow notifications) it has to be configured correctly. To configure it, go to - <literal>jboss-portal.sar/portal-core.sar/META-INF/jboss-service.xml</literal>. - In this file, the mail module is configured like this: - <programlisting><![CDATA[<mbean - code="org.jboss.portal.core.impl.mail.MailModuleImpl" - name="portal:service=Module,type=Mail" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <depends>jboss:service=Mail</depends> - <depends>portal:service=Module,type=IdentityServiceController</depends> - <attribute name="QueueCapacity">-1</attribute> - <attribute name="Gateway">localhost</attribute> - <attribute name="SmtpUser"></attribute> - <attribute name="SmtpPassword"></attribute> - <attribute name="JavaMailDebugEnabled">false</attribute> - <attribute name="SMTPConnectionTimeout">100000</attribute> - <attribute name="SMTPTimeout">10000</attribute> - <attribute name="JNDIName">java:portal/MailModule</attribute> -</mbean>]]></programlisting> - Here you can specify a different SMTP server than localhost, then precise the SMTP username and SMTP password to - use to send emails.</para> - <para>For example, to use GMail's SMTP server: - <programlisting><![CDATA[<mbean - code="org.jboss.portal.core.impl.mail.MailModuleImpl" - name="portal:service=Module,type=Mail" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <depends>jboss:service=Mail</depends> - <depends>portal:service=Module,type=IdentityServiceController</depends> - <attribute name="QueueCapacity">-1</attribute> - <attribute name="Gateway">smtp.gmail.com</attribute> - <attribute name=&quot;SmtpUser&quot;&gt;username(a)gmail.com&lt;/attribute&gt; - <attribute name="SmtpPassword">myPassword</attribute> - <attribute name="JavaMailDebugEnabled">false</attribute> - <attribute name="SMTPConnectionTimeout">100000</attribute> - <attribute name="SMTPTimeout">10000</attribute> - <attribute name="JNDIName">java:portal/MailModule</attribute> -</mbean>]]></programlisting> + <title>Setting up the Email Service</title> + <para> + If you have a standard setup and a mail server installed, the email service should work without any extra configuration. Most Linux distributions have a mail server installed by default. The email service, for example, can be used to verify a user's email address when a user subscribes, or for CMS workflow notifications. </para> - <note><para>If you have a 'standard' setup and a mail server installed - (That's the case on most Linux distribution out of the box), it will work out of the box.</para></note> - </sect1> + <para> + The email service is configured using the <filename>$JBOSS_HOME/server/default/deploy/jboss-portal.sar/META-INF/jboss-service.xml</filename> file. The following is an example of the section which is used to configure the email service: + </para> + <para> +<screen><![CDATA[ +<mbean +code="org.jboss.portal.core.impl.mail.MailModuleImpl" +name="portal:service=Module,type=Mail" +xmbean-dd="" +xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> +<xmbean/> +<depends>jboss:service=Mail</depends> +<depends>portal:service=Module,type=IdentityServiceController</depends> +<attribute name="QueueCapacity">-1</attribute> +<attribute name="Gateway">localhost</attribute> +<attribute name="SmtpUser"></attribute> +<attribute name="SmtpPassword"></attribute> +<attribute name="JavaMailDebugEnabled">false</attribute> +<attribute name="SMTPConnectionTimeout">100000</attribute> +<attribute name="SMTPTimeout">10000</attribute> +<attribute name="JNDIName">java:portal/MailModule</attribute> +</mbean>]]> +</screen> + </para> + <para> + A different SMTP server (other than localhost) can be configured, along with a SMTP username and an SMTP password. The following is an example configuration that uses the Gmail SMTP server: + </para> + <para> +<screen><![CDATA[ +<mbean +code="org.jboss.portal.core.impl.mail.MailModuleImpl" +name="portal:service=Module,type=Mail" +xmbean-dd="" +xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> +<xmbean/> +<depends>jboss:service=Mail</depends> +<depends>portal:service=Module,type=IdentityServiceController</depends> +<attribute name="QueueCapacity">-1</attribute> +<attribute name="Gateway">smtp.gmail.com</attribute> +<attribute name=&quot;SmtpUser&quot;&gt;username(a)gmail.com&lt;/attribute&gt; +<attribute name="SmtpPassword">myPassword</attribute> +<attribute name="JavaMailDebugEnabled">false</attribute> +<attribute name="SMTPConnectionTimeout">100000</attribute> +<attribute name="SMTPTimeout">10000</attribute> +<attribute name="JNDIName">java:portal/MailModule</attribute> +</mbean>]]> +</screen> + </para> + <para> + Using this example, replace <computeroutput&gt;username(a)gmail.com&lt;/computeroutput&gt; and <computeroutput>myPassword</computeroutput> with your correct Gmail username and password. + </para> +</sect1> <sect1> <title>Setting up proxy settings</title> <para>There are a couple of scenarios where you will need your proxy to be correctly defined at the JVM