Confluence メールサーバー設定手順

はじめに

ここでは、Confluence のメールサーバーの設定手順について説明します。

ご注意ください

このページでは、Confluenceからメールサーバーを利用するための設定手順について説明します。
メールサーバー自体の設定については、メールサーバーの管理者、またはシステム管理者にご確認ください。

メールサーバーを登録するには、SMTPサーバーの情報を入力する方法と、JNDIでメールサーバーの情報を指定する方法があります。

SMTPメールサーバーの作成

SMTPとは、“Simple Mail Transfer Protocol(シンプルメールトランスファープロトコル、簡易メール転送プロトコル)”のことです。
サーバー間でメール転送のための規約のことで、クライアントからメールを送信するときにも使います。ConfluenceにSMTPサーバーを設定してメール送信用に使うことができます。

Confluenceにメールサーバーを設定するには、まず管理者ユーザーでログインします。画面右上の歯車アイコンから「一般設定」を選択します。

画面左側のメニューから、「構成」の「メールサーバー」を選択してください。

「メールサーバーの表示」画面が開き、設定済みのメールサーバーがあればそのリストが表示されます。また、メールサーバーが設定されていないときは、「現在メールサーバーは設定されていません」と表示されます。
新しいメールサーバーの設定を追加するには、「新規 SMTPメールサーバーの追加」リンクをクリックします。

新しいメールサーバーを設定するための「メールサーバーの作成」画面が開きます。

「メールサーバーの作成」画面上部の「SMTPサーバー情報」の部分でメールサーバーの名前、Confluenceから送信されるメールの情報、中ほどにある「サーバーホスト名」の部分でサーバーの情報を入力します。

各項目には、以下のように入力します。

項目	既定値	設定内容
名前	SMTP サーバー	Confluence内部でSMTPサーバーを識別するための名前です。他と重複しない名前をつけてください。
差出人メールアドレス		Confluenceがメールを送信するときに使用する差出人のメールアドレスです。このアドレスから各ユーザー宛てにメールが送信されます。
差出人名	${fullname} (Confluence)	メールの送信者として表示される名前です。既定では、ユーザー名のフルネームに“(Confluence)”を追加したものになります。 “${email}”を指定するとメールアドレス、“${email.hostname}”を指定するとメールアドレスのホスト名が表示されます。
件名プレフィックス	[confluence]	メール件名の先頭に追加される文字列です。　Confluenceからの通知メールであることをユーザーが判断できるように設定してください。
サーバーホスト名		メールの送信に使用するSMTPサーバーのホスト名です。設定内容については、メールサーバーの管理者、またはシステム管理者にご確認ください。
サーバーポート	25	SMTPサーバーで使用するポート番号を指定することができます。設定内容については、メールサーバーの管理者、またはシステム管理者にご確認ください。
ユーザー名		SMTPサーバーにアクセスするためのユーザー名です。設定内容については、メールサーバーの管理者、またはシステム管理者にご確認ください。
パスワード		SMTPサーバーにアクセスするためのパスワードです。設定内容については、メールサーバーの管理者、またはシステム管理者にご確認ください。
TLSを使用		SMTPサーバがTLSを使用している場合は有効にします。設定内容については、メールサーバーの管理者、またはシステム管理者にご確認ください。

Atlassianの公開しているドキュメント「送信メール用サーバーを設定する」も参考にしてください。

ご注意ください

「JNDI Location」には何も入力しないでください。

「差出人名」以外の各項目は入力必須です。

各項目を入力できたら、「送信」ボタンをクリックすると、設定した内容をConfluenceに登録します。

JNDI Locationでメールサーバを設定する

JNDIとは、“Java Naming and Directory Interface”の略称です。JNDI形式で記述したサーバー設定を読み込ませることで、メールサーバーを設定できます。
ただし、あらかじめJNDI形式で設定を用意しておかなければなりません。

ConfluenceでJNDIを使った設定を行うには、最初にConfluenceを停止する必要があります。サービスとして動作している場合は、以下のコマンドを入力してConfluenceを停止してください。

# systemctl stop confluence.service

次に、Javaでメールを扱うためのライブラリを、(インストール先)/confluence/WEB-INF/lib ディレクトリから (インストール先)/lib ディレクトリに移動します。

※(x.x.x は、インストール環境での jar ファイルのバージョン番号を表します)

ver.7.5.0 未満の場合

# cd /opt/atlassian/confluence
# mv confluence/WEB-INF/lib/javax.mail-x.x.x.jar  lib/ 
# mv confluence/WEB-INF/lib/javax.mail-api-x.x.x.jar lib/ 
# mv confluence/WEB-INF/lib/javax.activation-1.2.0.jar lib/ 
# mv confluence/WEB-INF/lib/javax.activation-api-1.2.0.jar lib/ 	
# ls lib/
annotations-api.jar  catalina-storeconfig.jar  el-api.jar                  jasper.jar                      jsp-api.jar        tomcat-dbcp.jar     tomcat-i18n-fr.jar     tomcat-i18n-ru.jar     tomcat-util-scan.jar
catalina-ant.jar     catalina-tribes.jar       javax.mail-1.6.5.jar        jaspic-api.jar                  servlet-api.jar    tomcat-i18n-cs.jar  tomcat-i18n-ja.jar     tomcat-i18n-zh-CN.jar  tomcat-util.jar
catalina-ha.jar      catalina.jar              javax.mail-api-1.6.5.jar    javax.activation-1.2.0.jar      tomcat-api.jar     tomcat-i18n-de.jar  tomcat-i18n-ko.jar     tomcat-jdbc.jar        tomcat-websocket.jar
catalina-ssi.jar     ecj-4.13.jar              jasper-el.jar               javax.activation-api-1.2.0.jar  tomcat-coyote.jar  tomcat-i18n-es.jar  tomcat-i18n-pt-BR.jar  tomcat-jni.jar         websocket-api.jar

ver.7.5.0 以降の場合

# cd /opt/atlassian/confluence
# mv confluence/WEB-INF/lib/jakarta.mail-1.6.5.jar lib/ 
# mv confluence/WEB-INF/lib/jakarta.mail-api-1.6.5.jar lib/ 
# mv confluence/WEB-INF/lib/javax.activation-1.2.0.jar lib/ 
# mv confluence/WEB-INF/lib/javax.activation-api-1.2.0.jar lib/ 	
# ls lib/
annotations-api.jar  catalina-storeconfig.jar  el-api.jar                  jasper.jar                      jsp-api.jar        tomcat-dbcp.jar     tomcat-i18n-fr.jar     tomcat-i18n-ru.jar     tomcat-util-scan.jar
catalina-ant.jar     catalina-tribes.jar       jakarta.mail-1.6.5.jar      jaspic-api.jar                  servlet-api.jar    tomcat-i18n-cs.jar  tomcat-i18n-ja.jar     tomcat-i18n-zh-CN.jar  tomcat-util.jar
catalina-ha.jar      catalina.jar              jakarta.mail-api-1.6.5.jar  javax.activation-1.2.0.jar      tomcat-api.jar     tomcat-i18n-de.jar  tomcat-i18n-ko.jar     tomcat-jdbc.jar        tomcat-websocket.jar
catalina-ssi.jar     ecj-4.13.jar              jasper-el.jar               javax.activation-api-1.2.0.jar  tomcat-coyote.jar  tomcat-i18n-es.jar  tomcat-i18n-pt-BR.jar  tomcat-jni.jar         websocket-api.jar

ご注意ください

各ライブラリファイルが存在していない場合は、以下のページにてモジュールを取得してください。

ver.7.5.0 未満の場合

https://maven.java.net/content/repositories/releases/com/sun/mail/javax.mail/1.6.2/javax.mail-1.6.2.jar
https://maven.java.net/content/repositories/releases/javax/mail/javax.mail-api/1.6.2/javax.mail-api-1.6.2.jar
https://repo1.maven.org/maven2/com/sun/activation/javax.activation/1.2.0/javax.activation-1.2.0.jar
https://repo1.maven.org/maven2/javax/activation/javax.activation-api/1.2.0/javax.activation-api-1.2.0.jar

ver.7.5.0 以降の場合

https://repo1.maven.org/maven2/com/sun/mail/jakarta.mail/1.6.5/jakarta.mail-1.6.5.jar
https://repo1.maven.org/maven2/jakarta/mail/jakarta.mail-api/1.6.5/jakarta.mail-api-1.6.5.jar
https://repo1.maven.org/maven2/com/sun/activation/javax.activation/1.2.0/javax.activation-1.2.0.jar
https://repo1.maven.org/maven2/javax/activation/javax.activation-api/1.2.0/javax.activation-api-1.2.0.jar

ご注意ください

ファイルはコピーではなく移動してください。

ご注意ください

上のコマンド例は、Linuxインストーラ版Confluenceをデフォルトのオプションでインストールした場合のものです。
インストール先を変更していたり、別のバージョンのConfluenceをお使いのときは、パスを読み替えてください。

Confluenceのインストール時にコンテキストルートなどの設定を行った server.xml に、メールサーバーの設定を追加します。
/opt/atlassian/confluence/conf/server.xml をエディタで開き、以下のように編集してください。

/opt/atlassian/confluence/conf/server.xml

(省略)

<Context path="" docBase="../confluence" debug="0" reloadable="false" useHttpOnly="true">
    <!-- Logging configuration for Confluence is specified in confluence/WEB-INF/classes/log4j.properties -->
    <Manager pathname="" />

    <Resource name="mail/Session"                                         ←この行を追加
        auth="Container"                                                  ←この行を追加
        type="javax.mail.Session"                                         ←この行を追加
        mail.smtp.host="(メールサーバー名)"                               ←この行を追加
        mail.smtp.port="(ポート番号)"                                     ←この行を追加
        mail.smtp.auth="true"                                             ←この行を追加
        mail.smtp.user="(ユーザー名)"                                     ←この行を追加
        password="(パスワード)"                                           ←この行を追加
        mail.smtp.starttls.enable="true"                                  ←この行を追加
        mail.transport.protocol="smtps"                                   ←この行を追加
        mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"    ←この行を追加
    />                                                                    ←この行を追加
</Context>
 
(省略)

server.xml の変更を保存したら、Confluenceを起動します。サービスとして登録しているときは以下のコマンドです。

# systemctl start confluence.service

Confluenceが起動したら、管理者としてログインし、管理コンソールから「構成」の「メールサーバー」を選択します。「メールサーバーの表示」画面が開いたら「新規 SMTP メールサーバーの追加」リンクをクリックします。

項目	既定値	設定内容
名前	SMTP サーバー	Confluence内部でSMTPサーバーを識別するための名前です。他と重複しない名前をつけてください。
差出人アドレス		Confluenceがメールを送信するときに使用する差出人のメールアドレスです。このアドレスから各ユーザー宛てにメールが送信されます。
差出人名	${fullname} (Confluence)	メールの送信者として表示される名前です。既定では、ユーザー名のフルネームに“(Confluence)”を追加したものになります。 “${email}”を指定するとメールアドレス、“${email.hostname}”を指定するとメールアドレスのホスト名が表示されます。
件名のプレフィックス	[confluence]	メール件名の先頭に追加される文字列です。このConfluenceからの通知メールであることをユーザーが判断できるように設定してください。
JNDI Location		JNDI形式の設定のある場所を指定します。今回は例として、server.xmlで、nameを"mail/Session"に設定していますので、 "java:comp/env/mail/Session" を入力します。

Atlassianの公開しているドキュメント「Confluence ディストリビューション用のメールセッションを設定する」も参照してください。

ご注意ください

「SMTPサーバーホスト名」「ユーザー名」「パスワード」には何も入力しないでください。

差出人名以外の各項目は入力必須です。

各項目を入力できたら、「送信」ボタンをクリックすると、設定した内容をConfluenceに登録します。

テストメールの送信

登録したメールサーバーの設定に誤りがないか確認するため、テストメールを送信できます。
「メールサーバーの表示」画面で、「テストメールの送信」リンクをクリックします。

「テストメールの送信」画面が表示されるので、「To」(宛て先)や「Subject」(件名)、「Message」(本文)などを指定して「送信」ボタンをクリックします。「Message Type」(形式)ドロップダウンリストで、テキストメールとHTMLメールを切り換えることができます。

テストメールの送信結果は「Log」に表示されます。正常に送信できたときは以下のように表示されます。

Your test message has been sent successfully to <「To」で指定したメールアドレス>.

送信できなかったときは、以下のようにエラーメッセージが表示されます。内容を確認して、誤りを修正してください。

An error has occurred with sending the test email:
(省略)