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

概要¶

プリザンターのリマインダーや通知機能でメールを送信するために、Amazon SES（Simple Email Service）V2 REST APIを使ったメール送信の設定方法を説明します。AWS Signature V4による認証を使用するため、AWS SDKのインストールは不要です。

注意事項¶

1. 「Mail.json」のパラメータ変更時は「パラメータ変更時の確認事項」をご確認ください。
2. セキュリティ上の理由から、AWSの認証情報は「Mail.json」に直接記述せず、環境変数で設定することを推奨します。詳細は「操作手順2.環境変数による設定（推奨）」を参照してください。
3. 一時クレデンシャル（AssumeRole / IAM Role）には有効期限があります。EC2・ECS・Lambda等でIAMロールを利用する場合は、環境変数経由で動的に取得した値を設定してください。
4. 「Mail.json」の設定変更後はプリザンターの再起動が必要です。再起動を行うまで変更は反映されません。

前提条件¶

1. 有効なAWSアカウントが必要です。
2. 使用するリージョンでAmazon SESが有効化されていること。
3. 送信元として使用するメールアドレスまたはドメインがSESで検証済みであること。
4. SESへの送信権限を持つIAM認証情報を用意してください。使用する認証方式に応じて、以下のいずれかを選択します。
   方式①：IAMユーザーの永続キー…AccessKeyIdとSecretAccessKeyが必要です。
   方式②：一時クレデンシャル（AssumeRole・IAM Role）…AccessKeyId、SecretAccessKey、SessionTokenの3つが必要です。
5. IAMユーザーまたはロールに、以下のポリシーが付与されていること。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "ses:SendEmail",
                "ses:SendRawEmail"
            ],
            "Resource": "*"
        }
    ]
}

1. （推奨）SESサンドボックスを解除し、本番アクセスをリクエスト済みであること。サンドボックスモードでは、検証済みアドレスにのみ送信可能です。

操作手順¶

1. Mail.jsonの設定¶

設定ファイル「Mail.json」を編集し、ProviderにAwsSesを指定してください。また、AwsSesセクションに認証情報とリージョンを設定してください。

方式①：IAMユーザーの永続キーを使用する場合¶

{
    "Provider": "AwsSes",
    "AwsSes": {
        "AccessKeyId": "YOUR_AWS_ACCESS_KEY_ID",
        "SecretAccessKey": "YOUR_AWS_SECRET_ACCESS_KEY",
        "SessionToken": null,
        "Region": "ap-northeast-1",
        "ConfigurationSetName": null
    },
    "FixedFrom": "noreply@example.com",
    "SupportFrom": "\"Support\" <support@example.com>"
}

方式②：一時クレデンシャル（AssumeRole・IAM Role）を使用する場合¶

{
    "Provider": "AwsSes",
    "AwsSes": {
        "AccessKeyId": "YOUR_AWS_ACCESS_KEY_ID",
        "SecretAccessKey": "YOUR_AWS_SECRET_ACCESS_KEY",
        "SessionToken": "YOUR_AWS_SESSION_TOKEN",
        "Region": "ap-northeast-1",
        "ConfigurationSetName": null
    },
    "FixedFrom": "noreply@example.com",
    "SupportFrom": "\"Support\" <support@example.com>"
}

設定項目の説明¶

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

2.環境変数による設定（推奨）¶

AWSの認証情報は、「Mail.json」の代わりに環境変数で設定できます。「Mail.json」に値が設定されている場合はそちらが優先されます。

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

対応する環境変数¶

{EnvironmentName}と{ServiceName}は「Service.json」の設定値に対応します。デフォルトのServiceNameはPleasanterです。

PowerShell（Windows）での設定方法¶

$env:Pleasanter_Mail_AwsSes_AccessKeyId = "YOUR_AWS_ACCESS_KEY_ID"
$env:Pleasanter_Mail_AwsSes_SecretAccessKey = "YOUR_AWS_SECRET_ACCESS_KEY"
# 一時クレデンシャル（方式2）使用時のみ
$env:Pleasanter_Mail_AwsSes_SessionToken = "YOUR_AWS_SESSION_TOKEN"

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

export Pleasanter_Mail_AwsSes_AccessKeyId="YOUR_AWS_ACCESS_KEY_ID"
export Pleasanter_Mail_AwsSes_SecretAccessKey="YOUR_AWS_SECRET_ACCESS_KEY"
# 一時クレデンシャル（方式2）使用時のみ
export Pleasanter_Mail_AwsSes_SessionToken="YOUR_AWS_SESSION_TOKEN"

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

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

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

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

sudo systemctl restart pleasanter

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

対応バージョン¶