Documentation for Crowd 2.0.x. Documentation for other versions of Crowd is available too.

Once you have configured your mail server as described below, Crowd can send email notifications to users at specific events, such as when a user's password is reset or a server event occurs.

To customise the password notification message, please see Creating an Email Notification Template.

On this page:

Accessing the Mail Configuration Screen

To configure SMTP email,

  1. Log in to the Crowd Administration Console.
  2. Click the 'Administration' tab in the top navigation bar.
  3. Click 'Mail Configuration' in the left-hand menu.
  4. The 'Mail Configuration' screen allows you to choose between an SMTP and a JNDI mail server. Enter the details of your mail server as described below, then click the 'Update' button.

Mail Server Option 1: SMTP



Enter the details as follows:

  • Notification Email Address — The email address which will receive notifications about server events. For example, Crowd will send an email warning to this address when the number of users approaches the license limit.
  • From Email Address — Crowd will add this email address as the 'sender' on the emails generated by Crowd and sent to users.
  • Subject Prefix — The prefix which will appear at the start of the email subject, for all emails generated by Crowd. This can be useful for email client programs that offer filtering rules.
  • Mail Server Type — Select the 'SMTP Server' radio button.
  • SMTP Host — The hostname of the SMTP mail server, e.g. 'localhost' or 'smtp.acme.com'.
  • SMTP Port — The port on which the SMTP mail server listens. The default is '25'.
  • Username — The username that your Crowd server will use when it logs in to your mail server.
  • Password — The password that your Crowd server will use when it logs in to your mail server.

Mail Server Option 2: JNDI Location



Select the 'JNDI Location' if you want to connect to a mail server via a datasource managed by your application server.

Enter the details as follows:

  • Notification Email Address — The email address which will receive notifications about server events.
  • From Email Address — Crowd will add this email address as the 'sender' on the emails generated by Crowd and sent to users.
  • Subject Prefix — The prefix which will appear at the start of the email subject, for all emails generated by Crowd. This can be useful for email client programs that offer filtering rules.
  • Mail Server Type — Select the 'JNDI Location' radio button.
  • JNDI Location — The datasource name of a javax.mail.Session object which has been set up by your application server.

Configuring the JNDI Resource

For example, in Tomcat 5.5 (the default application server that is bundled with Crowd Standalone), your JNDI location would be java:comp/env/mail/CrowdMailServer, and you would add the following section in conf/server.xml or conf/Catalina/localhost/crowd.xml, inside the <Context> node:

<Context path="/crowd" docBase="${CATALINA_HOME}/crowd-webapp" reloadable="false">
  <Resource name="mail/CrowdMailServer"
    auth="Container"
    type="javax.mail.Session"
    mail.smtp.host="yourmailserver.example.com"
    mail.smtp.port="25"
    mail.transport.protocol="smtp"
    mail.smtp.auth="true"
    mail.smtp.user="your_userid"
    password="your_password"
   />
</Context>

If you have problems connecting, add a mail.debug="true" parameter, which will let you see SMTP-level details when testing the connection.

You will also need to ensure that the JavaMail classes and Java Beans Activation Framework are present in your application server's classpath.

If JavaMail is not present in your application server installation, you will receive the following error in your log file:

java.lang.NoClassDefFoundError: javax/mail/Authenticator

If the Activation Framework is not present in your application server installation, you will receive the following error in your log file:

java.lang.NoClassDefFoundError: javax/activation/DataSource

SMTP over SSL

You can encrypt email communications between Crowd and your mail server via SSL, provided your mail server supports SSL.

To do this, edit your mail server connection properties and specify starttls and SSLSocketFactory, e.g.:

<Context path="/crowd" docBase="${CATALINA_HOME}/crowd-webapp" reloadable="false">
  <Resource name="mail/CrowdMailServer"
    auth="Container"
    type="javax.mail.Session"
    mail.smtp.host="yourmailserver.example.com"
    mail.smtp.port="465"
    mail.transport.protocol="smtp"
    mail.smtp.auth="true"
    mail.smtp.user="your_userid"
    password="your_password"
    mail.smtp.starttls.enable="true"
    mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"

   />
</Context>

Additionally, as you are connecting to an SSL service, you will need to import the SMTP server certificate into a Java keystore. The process is described in Configuring Crowd to Work with SSL.

関連トピック

Crowd Documentation

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.