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

概要¶

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

注意事項¶

1. バージョン1.5.5.0以降、Providerパラメータの追加に伴い設定方式が変更されています。既存環境からの移行についてはメール送信プロバイダー設定の移行についてを参照してください。
2. パラメータ変更時は「パラメータ変更時の確認事項」をご確認ください。
3. セキュリティ上の理由から、APIキーは「Mail.json」に直接記述せず、環境変数で設定することを推奨します。詳細は「操作手順2.環境変数による設定（推奨）」を参照してください。
4. 「Mail.json」の設定変更後はプリザンターの再起動が必要です。再起動を行うまで変更は反映されません。

前提条件¶

1. SendGridのAPIキーを用意してください。
2. 送信元として使用するメールアドレスまたはドメインが、SendGridで送信者認証（Sender Authentication）済みであることを確認してください。

操作手順¶

1. Mail.jsonの設定¶

設定ファイル「Mail.json」を編集し、ProviderにSendGridを指定してください。また、SendGridセクションのApiKeyにSendGridのAPIキーを設定してください。

{
    "Provider": "SendGrid",
    "SendGrid": {
        "ApiKey": "SG.xxxxAPIキーxxxxxx..."
    },
    "FixedFrom": "noreply@example.com",
    "SupportFrom": "\"Support\" <support@example.com>"
}

設定項目の説明¶

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

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

SendGridのAPIキーは、Mail.jsonの代わりに環境変数へ登録できます。「Mail.json」で値を指定している場合は、そちらが優先されます。

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

対応する環境変数¶

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

PowerShell（Windows）での設定方法¶

$env:Pleasanter_Mail_SendGrid_ApiKey = "SG.xxxxAPIキーxxxxxx..."

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

export Pleasanter_Mail_SendGrid_ApiKey="SG.xxxxAPIキーxxxxxx..."

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

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

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

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

sudo systemctl restart pleasanter

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

対応バージョン¶

関連情報¶

• メール送信プロバイダー設定の移行について