Author: ppenicka Date: 2013-02-04 17:22:33 -0500 (Mon, 04 Feb 2013) New Revision: 9113 Modified: epp/docs/branches/6.0/Installation_Guide/en-US/EMailServiceConfiguration.xml epp/docs/branches/6.0/Installation_Guide/en-US/Revision_History.xml Log: BZ#907639 - incorporated changes from https://docs.jboss.org/author/display/GTNPORTAL35/Send+mail+to+administra... into the Installation Guide. Modified: epp/docs/branches/6.0/Installation_Guide/en-US/EMailServiceConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Installation_Guide/en-US/EMailServiceConfiguration.xml 2013-02-04 04:54:26 UTC (rev 9112) +++ epp/docs/branches/6.0/Installation_Guide/en-US/EMailServiceConfiguration.xml 2013-02-04 22:22:33 UTC (rev 9113) @@ -8,11 +8,11 @@ <section id="sect-Reference_Guide-EMail_Service_Configuration-Overview"> <title>Overview</title> <para>JBoss Enterprise Portal Platform includes an e-mail sending service that needs to be configured - before it can function properly. This service, for instance, is used to send E-mails to users who forgot + before it can function properly. This service is used to send e-mails to users who forgot their password or username.</para> </section> <section id="sect-Reference_Guide-EMail_Service_Configuration-Parameters"> - <title>Configure Outgoing E-mail Account</title> + <title>Configuring Outgoing E-mail Account</title> <para>The e-mail service can use any SMTP account configured in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>PROFILE</replaceable>/conf/gatein/configuration.properties</filename></para> <para>The relevant section looks like:</para> @@ -25,11 +25,47 @@ gatein.email.smtp.auth=true gatein.email.smtp.socketFactory.port=465 gatein.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory</programlisting> - <para>The email service is pre-configured for GMail, so that any GMail account can be used with minimal configuration. Simply enter the full GMail address - as the username and fill in the corresponding password.</para> - <para>In corporate environments you will want to use your corporate SMTP gateway. When using it over SSL, - such as in the default configuration, you may need to configure a certificate truststore containing your SMTP server&apos;s - public certificate. Depending on the key sizes, you may then also need to install Java Cryptography Extension (JCE) - Unlimited Strength Jurisdiction Policy Files for your Java Runtime Environment.</para> + <para>The email service is pre-configured for GMail, so that any GMail account can be used with minimal configuration. To use a GMail account to send the e-mails, simply enter the full GMail address as the username and fill in the corresponding password.</para> + <para>In corporate environments, it is recommended to use a corporate SMTP gateway. When using it over SSL (the default configuration), you need to configure a certificate truststore containing your SMTP server&apos;s public certificate. Depending on the key sizes, you may then also need to install Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files for your Java Runtime Environment.</para> </section> + + <section id="sid-55379065"> + + <title><remark>BZ#907639 </remark>E-mail Notifications on User Registration</title> + <remark>This section incorporates the content located at https://docs.jboss.org/author/display/GTNPORTAL35/Send+mail+to+administra... </remark> + <para>The e-mail service can be used to send notification e-mails when a new user registers with the portal. Such notifications may be helpful to portal administrators, especially when the portal has a public registration page.</para> + <para>Sending of notification e-mails about new registered users is disabled by default. To enable the notifications, perform the following configuration procedure:</para> + <procedure> + <title>Enabling New User Notification E-mails</title> + <step> + <para> + Configure an SMTP account as described in + <xref linkend="sect-Reference_Guide-EMail_Service_Configuration-Parameters"/>. + </para> + </step> + <step> + <para> + Configure the <systemitem>PostRegistrationService</systemitem> in the + <filename>GATEIN_HOME/gatein/gatein.ear/portal.war/WEB-INF/conf/admin/admin-configuration.xml</filename> configuration file. At minimum, the following two parameters need to be altered: + </para> + <itemizedlist> + <listitem> + <para> + <emphasis role="strong">sendMailAfterRegistration</emphasis> + - boolean value determining if e-mail notifications about new registered users are enabled. It is <literal>false</literal> by default and needs to be changed to <literal>true</literal> for the e-mail notifications to be sent. + </para> + </listitem> + <listitem> + <para> + <emphasis role="strong">mailTo</emphasis> + - e-mail address to which the notifications are sent. + </para> + </listitem> + </itemizedlist> + </step> + <step> + <para>Test the configuration by restarting the server and registering a new user in the JBoss Portal Platform user interface. An e-mail will be sent to the specified e-mail address, notifying the recipient that a new user has been registered to the portal.</para> + </step> + </procedure> + </section> </section> Modified: epp/docs/branches/6.0/Installation_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/Installation_Guide/en-US/Revision_History.xml 2013-02-04 04:54:26 UTC (rev 9112) +++ epp/docs/branches/6.0/Installation_Guide/en-US/Revision_History.xml 2013-02-04 22:22:33 UTC (rev 9113) @@ -9,6 +9,20 @@ <simpara> <revhistory> <revision> + <revnumber>6.0.0-5</revnumber> + <date>Mon Feb 04 2013</date> + <author> + <firstname>Petr</firstname> + <surname>Penicka</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>BZ#907639 - incorporated changes from https://docs.jboss.org/author/display/GTNPORTAL35/Send+mail+to+administra... into the Installation Guide.</member> + </simplelist> + </revdescription> + </revision> + <revision> <revnumber>6.0.0-1</revnumber> <date>Fri Oct 12 2012</date> <author>