Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

メールの構成

デフォルトでは、Developer Services ポータルは特定のイベントに応答してメールを送信します。例えば、新しいデベロッパがポータルに登録したとき、ポータルはデベロッパにようこそメールを自動的に送信します。また、デベロッパは、パスワードを紛失した場合、一時パスワードを含んだメールを要求できます。 

API プロバイダは、次を含む、ポータルで生成されるメールのすべての側面を操作できます。

  • ポータルで送信される自動化されたメールの書式設定
  • ポータルで使用される SMTP サーバーの指定
  • ポータル上のイベントに応答してメールを生成するルールの追加

クラウドベースのポータルからメールを送信する

デフォルトでは、Pantheon 上に展開されたクラウドベースのポータルは、ローカル MTA (postfix) を使用してメールを送信できます。この構成は、実稼働でないサーバー上でのみ使用してください。送信されたあらゆるメールは、匿名のクラウドサーバーから来て、迷惑メールとしてブロックまたはマーク付けされる可能性があるためです。

実稼働ポータルの場合は、次のいずれかのオプションを選択する必要があります。

  • 以下で説明しているように、SMTP モジュールを使用して、メールを自社の SMTP サーバーにルーティングする。
  • SendGrid や Amazon SES (Simple Email Service).のような外部メールサービスを使用する。詳細については、https://www.getpantheon.com/docs/articles/sites/code/email/ を参照してください。

オンプレミスのポータルからメールを送信する

デフォルトでは、メールは PHP mail() 関数を使用して送信されます。PHP は、ローカルシステム上の sendmail を使用してメールを送信しようとします。これは PHP の php.ini ファイルで構成できます。

実稼働ポータルの場合は、自社のメールサーバーを使用してメールをルーティングする必要があります。以下で説明している SMTP モジュールを使用して、SMTP サーバーを通じてメールを送信します。

SMTP サーバーの構成

デベロッパポータルでは、メールメッセージが送信されるように SMTP サーバーを構成する必要があります。SMTP サーバーを構成するには、最初に Drupal SMTP Authentication Support モジュールをデベロッパポータルで有効にする必要があります。

SMTP サーバーを構成すると、デベロッパポータルで送信されるすべてのメールが SMTP サーバーを使用します。 送信されるメールには、新しいデベロッパに送信されるメール、パスワードを紛失したデベロッパに送信されるメール、アカウントがブロックされたデベロッパに送信されるメールなどがあります。

SMTP サーバーを構成するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Modules」を選択します。
    「Modules」ページが開きます。
  3. SMTP Authentication Support モジュールを有効にします。
  4. 構成を保存します。
  5. モジュールが有効になったら、「Modules」ページの「SMTP Authentication Support」エントリで、「Configure」を選択します。
    SMTP Authentication Support の構成ページが表示されます。
  6. 「Turn this module on or off」で、「On」を選択します。
  7. 「SMTP server settings」領域に、次の情報を入力します。
    • SMTP server address。例えば、Gmail の送信 SMTP サーバーの場合は、smtp.gmail.com を使用します。
    • (省略可能) backup SMTP server address を入力します。この値は、必須ではありません。
    • SMTP port を入力します。このポートの値は、選択した暗号化プロトコルに基づいて異なる場合があります。例えば、Gmail の場合、このポートは、SSL を使用するときは 465、TLS を使用するときは 587 です。
    • 「None」「SSL」「TLS」のような暗号化プロトコルを選択します。
  8. 「SMTP Authentication」領域で、SMTP 認証に使用するユーザー名とパスワードを指定します。これは、SMTP サーバー上で有効なユーザー名とパスワードである必要があります。
  9. 「E-mail options」で、メールメッセージを生成するユーザーのメールアドレスと名前を入力します。これらの値は、メールの「From」のアドレスに対応します。
  10. (省略可能)「Send test e-mail message」で、ポータルからテストメッセージを送信するメールアドレスを入力します。
  11. 構成を保存します。
    構成を保存すると、テストメールが生成され、構成エラーが表示されます (存在する場合)。テストメッセージのメールボックスの受信トレイを調べて、メッセージが届くことを確認します。
  12. Drupal の管理メニューで、「Configuration」>「System」>「Site Information」を選択します。
  13. 「Site Details」で、「E-mail address」を、手順 9 で指定したメールアドレスと同じメールアドレスに設定します。
    メールを生成する Drupal モジュールは、「SMTP Authentication Support」ページの値ではなくこのフィールドを使用して、メールの「From」のアドレスを決定します。
  14. 構成を保存します。

メール通知の構成と書式設定

デベロッパアカウントの登録、削除、ブロック、ブロックの解除など、特定のアクティビティに応答して送信されるさまざまなメール通知を構成できます。

メールの「From」のアドレスを操作することもできます。

メール通知を構成するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Configuration」>「People」>「Account settings」の順に選択します。「Account settings」 ページが開きます。
  3. 「Accounts setting」ページの「E-Mails」セクションで、メール通知のタイプを選択します。例えば、「Welcome (no approval required)」を選択できます。これは、デベロッパアカウントがデベロッパの登録プロセス中に自動的に承認されたときに、メールを送信します。

  4. メール通知の「Subject」「Body」を編集します。
    フィールド (「Subject」など) にカーソルを配置し、フォームの下部にある「Browse available tokens」を選択して、フィールドで使用できるトークンの一覧を確認します。追加するトークン ([user:name]など。[user:name] はデベロッパのユーザー名に対応します) を選択できるポップアップが表示されます。
  5. 「Save configuration」 をクリックします。

メール通知の「From」の名前とアドレスを変更することもできます。

「From」の名前とアドレスを変更するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Configuration」>「System」>「SMTP Authentication Support」を選択します。「SMTP Authentication Support」ページが開きます。
  3. 「E-Mail From Address」フィールドで、「From」のメールアドレスを指定します。
  4. 「E-Mail From Name」フィールドで、「From」の名前を指定します。
  5. 「Save configuration」 をクリックします。
  6. Drupal の管理メニューで、「Configuration」>「System」>「Site information」を選択します。
  7. 手順 3 において「E-Mail Address」フィールドで使用したメールアドレスと同じメールアドレスを指定します。
  8. 「Save configuration」 をクリックします。

イベントが発生したときのメールの生成

この例は、デベロッパが新しいアプリを作成したときにメールを生成するものです。ポータル上で、メールが生成されるようにルールを構成する必要があります。詳細については、「ルールの作成と構成」を参照してください。 

ルールの一般的な使用法には、イベントへの応答時のメールの生成があります。ポータルでは、新しいデベロッパがアカウントを登録する場合など、事前定義のイベントのメール生成のサポートが組み込まれていますが、独自のルールを追加してメールを生成することもできます。例えば、デベロッパがアプリを追加、削除、または変更した場合にメールを生成できます。

このセクションには、デベロッパがアプリを登録したときにメールを生成するルールを作成する方法についての例が記載されています。必要に応じて、この手順を他のイベントの場合にメールを生成するように変更してください。

デベロッパが新しいアプリを作成したときにメールを生成するには、次の手順に従います。

  1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
  2. Drupal の管理メニューで、「Modules」 を選択します。
  3. Rules UI モジュールが有効になっていることを確認します。
  4. Drupal の管理メニューで、「Configuration」>「Workflow」>「Rules」の順に選択します。「Rules」ページが開きます。
  5. 「Add a new rule」ボタンを選択します。
  6. 「new rules」ページで、次を指定します。
    • ルールの name (例: 「Send email rule」)。
    • (省略可能) 検索用のルールを分類するために使用される tags を指定します (使用する場合)。
    • 「React on event」ドロップダウンで、「Devconnect」>「Upon creation of a developer app」の順に選択します。
  7. ルールを保存します。
    ルールを保存すると、3 つのペイン (「Events」(先ほど作成したもの)、「Conditions」「Actions」) を含んだルール編集フォームが開きます。
  8. 「Actions」で、「Add action」を選択します。
  9. 「Select the Action to Add」ドロップダウンの「System」>「send mail」を選択します。
    この選択で、メールを書式設定できるページが開きます。このフォームを使用して、メールの「To」、「Subject」、「Message」、その他のフィールドを指定します。

    各フィールドの「Replacement patterns」リンクを展開して、フィールドで使用できるパターンの一覧を確認します。例えば、「To」フィールドの「Replacement patterns」を展開すると、[app:developer] を含むパターンの一覧が表示されます。「To」フィールドでこのパターンを指定すると、メールがアプリの作成者に送信されます。    
  10. 次に示すようにフィールドを設定します。
  11. 「Save」を選択して、ルール編集ページに戻ります。
  12. 「Save changes」を選択します。

ポータル上で新しいアプリを追加して、ルールをテストします。レスポンスで、次のように表示されるメール通知を受け取ります。

Subject: App test email app created

App: test email app
API products: PremiumWeatherAPI, weatherapikey-Product
Created at: Mon, 01/27/2014 - 10:16

このルールを、デベロッパがアプリを作成するときに管理者にメールを生成するように変更します。例えば、アプリで手動の API キー承認を必要な場合に、メールで、管理者にアプリが承認保留になっていることを知らせることができます。

 

Help or comments?