プリザンターからメールを送信できるように設定する

概要¶

プリザンターのリマインダーや通知機能でメールを送信するために、SMTPサーバを使ったメール送信の設定方法を説明します。

注意事項¶

1. パラメータ変更時は「パラメータ変更時の確認事項」を確認してください。
2. セキュリティ上の理由から、SmtpUserNameおよびSmtpPasswordは「Mail.json」に直接記述せず、環境変数で設定することを推奨します。詳細は「2. 環境変数による設定（任意）」を参照してください。
3. Mail.jsonの設定変更後はプリザンターの再起動が必要です。再起動を行うまで変更は反映されません。

前提条件¶

1. 利用するSMTPサーバのホスト名・ポート番号・認証情報（ユーザ名・パスワード）を用意してください。

操作手順¶

1. Mail.jsonの設定¶

設定ファイル「Mail.json」を編集し、Providerに"Smtp"を指定してください。

{
    "Provider": "Smtp",
    "SmtpHost": "smtp.example.com",
    "SmtpPort": 587,
    "SmtpUserName": "user@example.com",
    "SmtpPassword": "password",
    "SmtpEnableSsl": true,
    "FixedFrom": "noreply@example.com",
    "SupportFrom": "support@example.com"
}

設定項目の説明¶

各パラメータの詳細については「Mail.json」を参照してください。

2. 環境変数による設定（任意）¶

SmtpUserNameおよびSmtpPasswordはMail.jsonの代わりに環境変数へ登録できます。Mail.jsonで値を指定している場合は、そちらが優先されます。

プリザンターはMail.jsonの値が空（""）またはnullの場合にのみ、環境変数から取得します。

対応する環境変数¶

{EnvironmentName}と{Name}は「Service.json」のパラメータEnvironmentName、Nameの各設定値に対応します。既定のNameは"Implem.Pleasanter"です。

下記は、Service.jsonのEnvironmentNameに"Pleasanter"を設定した場合の例です。

PowerShell（Windows）での設定方法¶

$env:Pleasanter_Mail_SmtpUserName = "user@example.com"
$env:Pleasanter_Mail_SmtpPassword = "password"

bash（LinuxまたはmacOS）での設定方法¶

export Pleasanter_Mail_SmtpUserName="user@example.com"
export Pleasanter_Mail_SmtpPassword="password"

3. プリザンターの再起動¶

設定変更を反映するため、プリザンターを再起動してください。

Windows環境の場合は、IISを再起動してください。

Linux環境の場合は、下記のコマンドでサービスを再起動してください。

sudo systemctl restart pleasanter

Microsoft Azure環境の場合は、App Serviceを再起動してください。

対応バージョン¶

関連情報¶

• Mail.json
• メール送信プロバイダー設定の移行について
• パラメータ変更時の確認事項
• Service.json