Configuring JIRA to Send SMTP Mail

2. Specify the Host Name or JNDI Location

The second part of the screen specifies the Server Details of the SMTP server to which JIRA will send mail. There are two ways you can do this. Either:

• specify the Host Name of your mail server;
  or:
• specify the JNDI Location— that is, use JNDI to look up a mail server that you have preconfigured in your application server. This has the following advantages:
  • Better security: the mail details are not available to JIRA administrators through the JIRA administration interface, and are not stored in JIRA backup files.
  • More SMTP options: for instance, you could switch to RSET instead of NOOP for testing connections by setting the mail.smtp.userset property.
  • Centralised management: mail details are configured in the same place as database details, and may be configured through your application server administration tools.

Specify the Host Name

Most people configure SMTP details directly in JIRA. The form fields are as follows:

Once done, click 'Update' and then "Send a Test Email" to test the connection details.

Specify and configure a JNDI Location

As an alternative to specifying mail details directly in JIRA, you can configure them in your application server, and then look up a preconfigured mail session via JNDI.

On the 'Add SMTP Mail Server' screen (see above), complete the following form field:

The JNDI Location will depend on your application server and configuration. For example, in Tomcat 6 (the default application server that is bundled with JIRA Standalone ), your JNDI Location would be java:comp/env/mail/JiraMailServer, and you would add the following section in conf/server.xml , inside the <Context> node:

<Context path="" docBase="${catalina.home}/atlassian-jira" reloadable="false">
     ....

     <Resource name="mail/JiraMailServer"
       auth="Container"
       type="javax.mail.Session"
       mail.smtp.host="mail.yourcompany.com"
       mail.smtp.port="25"
       mail.transport.protocol="smtp"
       mail.smtp.auth="true"
       mail.smtp.user="jirauser"
       password="mypassword"
       />
       </Context>

Or if you don't require authentication (e.g. if you are sending via localhost, or only internally within the company):

<Context path="" docBase="${catalina.home}/atlassian-jira" reloadable="false">
     ....

     <Resource name="mail/JiraMailServer"
       auth="Container"
       type="javax.mail.Session"
       mail.smtp.host="localhost"
       mail.smtp.port="25"
       mail.transport.protocol="smtp"
       />
       </Context>

The format for other application servers will be similar. For details please see the Transaction Factory documentation.

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

JavaMail クラスの移動

You will also need to ensure that the JavaMail classes are present in your application server's classpath, and do not conflict with JIRA's copy. This is necessary because the application server is establishing the SMTP connection, not JIRA, and the application server will not see the JARs in JIRA's classloader.

Some operating systems may ship the JavaMail classes with application servers (eg. Tomcat in Red Hat Enterprise Linux). This may conflict with JIRA's copy of the JavaMail classes, resulting in errors like:

java.lang.NoClassDefFoundError: javax/mail/Authenticator

または

java.lang.IllegalArgumentException: Mail server at location [java:comp/env/mail/JiraMailServer] is not
         of required type javax.mail.Session.

Lighter app servers — Tomcat (including JIRA Standalone) — do not always come with JavaMail.

競合を防ぐため、アプリケーションサーバーの lib/ ディレクトリを確認します。

• If the application server already contains mail-1.4.1.jar and activation-1.1.1.jar, then just remove WEB-INF/lib/mail-1.4.1.jar and WEB-INF/lib/activation-1.1.1.jar from the JIRA webapp.
• If the application server does not contain mail-1.4.1.jar and activation-1.1.1.jar, then move JIRA's WEB-INF/lib/mail-1.4.1.jar and WEB-INF/lib/activation-1.1.1.jar into the application server's lib/ directory.

SMTP over SSL

メールサーバーが SSL をサポートしている場合、JIRA とメールサーバーの間の電子メール通信を、SSL 経由で暗号化できます。 

Firstly, you will need to import the SMTP server certificate into a Java keystore. The process is described on the Connecting to SSL Services page.

Secondly, edit your mail server connection properties and specify starttls and SSLSocketFactory. From {$JIRA_INSTALL}/conf/server.xml (this example uses Gmail's server):

<Resource name="mail/GmailSmtpServer"
   auth="Container"
   type="javax.mail.Session"
   mail.smtp.host="smtp.gmail.com"
   mail.smtp.port="465"
   mail.smtp.auth="true"
   mail.smtp.user="myusername@gmail.com"
   password="mypassword"
   mail.smtp.starttls.enable="true"
   mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"
 />

トラブルシューティング

A useful tip for debugging mail-related problems in JIRA is to set the -Dmail.debug=true property on startup. This will cause protocol-level details of JIRA's email interactions to be logged. Additionally, turning up JIRA's log level will show when the service is running and how mails are processed.

一般的な問題

• If JIRA doesn't appear to be creating or sending emails or creating issues and comments from email, your JIRA instance could be experiencing OutOfMemory errors. Please check your log files for OutOfMemory errors. If there are OutOfMemory errors, please restart JIRA and investigate the errors.
• If you find some incoming emails simply disappear, check that you haven't accidentally started a second copy of JIRA (eg. in a staging environment) which is downloading and deleting mails. See the Restoring Data page for flags you should set to prevent mail being processed.
• If you receive 'Mail Relay' errors, make sure you have specified the Username and Password in the 'SMTP Host' section of the configuration screen.

ヘルプの活用

If you cannot resolve a problem yourself, please create a support case in the 'JIRA' project and we will assist.