NOTIFY コマンド
コンセプト情報
受信者に中継する SMTPメールサーバーに電子メール通知メッセージを送信します。
構文
認証されているコマンド構文
NOTIFY SMTP SMTPUSER SMTPアカウント名 PORT ポート番号 <ENABLESSL> USER 送信元の電子メールアドレス PASSWORD 暗号化されたパスワード MAILBOX SMTPサーバー名 ADDRESS 受信者の電子メールアドレス <CC cc受信者の電子メールアドレス> <BCC bcc受信者の電子メールアドレス> SUBJECT 件名 MESSAGE メッセージテキスト <ATTACHMENT ファイルパス>
認証されていないコマンド構文
メモ
この以前のバージョンの NOTIFY コマンドは、ローカルメールシステム、または認証を必要としない SMTP メールサーバーで使用するためのものです。通常認証が必要な最新の電子メールシステムでは動作しません。
NOTIFY USER送信元の電子メールアドレス <PASSWORD暗号化されたパスワード> MAILBOXSMTPサーバー名 ADDRESS受信者の電子メールアドレス <CCcc 受信者の電子メールアドレス> <BCCbcc 受信者の電子メールアドレス> SUBJECTメッセージの件名 MESSAGE メッセージの本文テキスト <ATTACHMENT ファイルのパス>
パラメーター
名前 | 説明 |
---|---|
SMTP |
SMTP サーバー(Simple Mail Transfer Protocol サーバー)に対して認証された送信を行うことを指定します。
メモ SMTP を使用する事実上すべての新しい電子メールシステムは、認証が必要です。 以下のパラメーターを有効にするには、SMTP を指定する必要があります。
|
SMTPUSER SMTPアカウント名 |
SMTP サーバーに対して認証を行い、アクセスするためのユーザーアカウント名。 SMTPUSER を省略すると、USERによって指定された送信元電子メールアドレスを使用して、ローカルメールシステム、または認証を必要としない SMTPメールサーバーにアクセスします。 |
PORT ポート番号 |
SMTP サーバーへのアクセスに使用するポート番号。 IT部門に依頼して、使用するポートを調査しなければならない場合があります。SMTP サーバーの一般的なポート番号は次のとおりです。
SMTPUSER を使用する場合、PORT を使用する必要があります。SMTPUSER を省略した場合、PORT は省略でき、デフォルトのポート 25 が使用されます。 |
ENABLESSL 省略可能 |
セキュリティ保護された SMTP/SSL 接続を使用して SMTP サーバーにアクセスすることを指定します。 ご使用の SMTP サーバーが SSL 接続を必要とするかどうかについては、IT 部門に問い合わせることが必要になる場合があります。または、電子メールで ENABLESSL を指定したものとしないものの両方をテストで送信してみます。 |
USER 送信元の電子メールアドレス |
SMTP サーバー経由で送信する電子メール通知の送信元の電子メールアドレスを定義します。 メモ SMTP サーバーの設定によっては、USER と SMTPUSER が同じアカウントである場合とそうでない場合があります。 |
PASSWORD 暗号化されたパスワード |
SMTP サーバーのユーザーアカウントパスワード。パスワードは暗号化された文字列として指定する必要があります。 詳細については、暗号化されたパスワードの生成を参照してください。 ローカルメールシステムまたは認証を必要としない SMTP メールサーバーにアクセスするには、パスワードは不要な場合があります。 |
MAILBOX SMTPサーバー名 |
電子メールメッセージを送信するために使用する SMTP サーバーのドメイン名。例: MAILBOX "smtp.example.com" |
ADDRESS 受信者の電子メールアドレス |
1 人または複数人の受信者の電子メール アドレス。 複数人の受信者の電子メール アドレスの場合は、カンマで区切ります。最大 1020 文字を入力します。 |
CC cc 受信者の電子メールアドレス 省略可能 |
1 人または複数人のカーボン コピー受信者の電子メール アドレス。 複数人の受信者の電子メール アドレスの場合は、カンマで区切ります。最大 1000 文字を入力します。 |
BCC bcc 受信者の電子メールアドレス 省略可能 |
1 人または複数人のブラインド カーボン コピー受信者の電子メール アドレス。 複数人の受信者の電子メール アドレスの場合は、カンマで区切ります。 |
SUBJECT メッセージの件名 | 電子メール メッセージの件名。 |
MESSAGE メッセージの本文テキスト |
電子メール メッセージの本文テキスト。 メッセージはプレーン テキストのため、HTML はサポートされていません。メッセージに改行を挿入したい場合は、2 つのカラット文字 (^^) を使用します。 |
ATTACHMENT ファイルのパス 省略可能 |
1 つ以上の添付ファイルのパスとファイル名。 ファイルが Analytics プロジェクトと同じフォルダーにある場合は、パスを指定する必要はありません。 パスとファイル名を引用符で囲みます。ファイルパス にカンマで区切ったファイルのリストを入力して、複数の添付ファイルを指定します。 ATTACHMENT "result1.csv,result2.csv" メモ カンマ区切りのリストでは、カンマの後にスペースがないようにしてください。 |
例
エラー報告の電子メールを送信する
メモ
認証されたコマンド構文。
スクリプトを実行し、失敗した場合には電子メール通知を送信したいとします。NOTIFY を使って電子メール メッセージを定義し、以下の 2 つの添付ファイルを添付します。
- ログ ファイル
- エラーが記録された .fil ファイル
NOTIFY SMTP SMTPUSER "mail_admin@example.com" PORT 587 ENABLESSL USER "support@company.com" PASSWORD "9QZC2524830864..."MAILBOX "smtp.company.com" ADDRESS "script_admin@company.com" SUBJECT "エラーレポート" MESSAGE "スクリプトの処理に失敗しました。詳細を添付しました。"ATTACHMENT "Errors.fil,ACL_Demo.log"
エラー報告の電子メールを送信する
メモ
認証されていないコマンド構文。
スクリプトを実行し、失敗した場合には電子メール通知を送信したいとします。NOTIFY を使って電子メール メッセージを定義し、以下の 2 つの添付ファイルを添付します。
- ログ ファイル
- エラーが記録された .fil ファイル
NOTIFY USER "support@company.com" MAILBOX "mail.company.com" ADDRESS "script_admin@company.com" SUBJECT "エラーレポート" MESSAGE "スクリプトの処理に失敗しました。詳細を添付しました。"ATTACHMENT "Errors.fil,ACL_Demo.log"
備考
受信者と添付ファイル
NOTIFY コマンドを使用すると、1 人以上の受信者に電子メール通知メッセージを送信することができます。メッセージには、データ ファイルや Analytics プロジェクトを添付して含めることができます。
NOTIFY コマンドの一般的な使用法は、スクリプトが予期せず失敗したときに適切な担当者に警告することです。
互換性のある SMTP サーバー
NOTIFY コマンドは、SMTP(Simple Mail Transfer Protocol)をサポートするメールサーバーで使用でき、認証接続を必要とする幅広い SMTP サーバーで動作するはずです。ただし、すべての SMTP サーバーやサービスで動作するわけではありません。たとえば、NOTIFY は Gmail では動作しません。サードパーティアプリを Google アカウントに接続するには、NOTIFY がサポートするユーザー名とパスワード以上のセキュリティ構成が必要です。
一般に、NOTIFY を使用して SMTP サーバーに電子メールを正常に送信するには、 Analytics 側だけでなく SMTP サーバー側にも互換性のある構成が必要であることに注意してください。NOTIFY が接続に失敗し、電子メールを正常に送信できない場合は、IT 部門と連携して、Analytics とサーバーの間に互換性のある接続構成があることを確認してください。
暗号化されたパスワードの生成
メモ
Analytics は、サーバープロファイルのパスワード、データベースプロファイルのパスワード、またはメールサーバーのパスワードを指定または入力するときに最大 30 文字サポートしています。この長さを超えるパスワード値を指定すると、パスワードが切り詰められ、接続エラーになります。
NOTIFY コマンドの PASSWORD パラメーターとともに暗号化されたパスワード値を指定する必要があります。NOTIFY で使用するパスワードを適切に暗号化するには、Analytics のユーザーインターフェイスの[通知]ダイアログボックスにパスワードを入力する必要があります。
-
省略可能。Analytics のコマンドラインで、SET NOTIFYRETRYATTEMPTS TO 0 と入力します
NOTIFY の再試行を一時的にオフにすることで、暗号化されたパスワードの生成が高速化されます。
-
Analytics のメインメニューから[ツール > 電子メールによる通知Analytics]を選択します。
-
[通知]ダイアログボックスで、必須のフィールドをすべて記入し、必要に応じて任意のフィールドに記入します。
送信者 送信元の電子メールアドレス 必須 パスワード SMTP サーバーのユーザーアカウントパスワード(クリアテキスト)。
メモ
パスワードが 30 文字を超えると、NOTIFY コマンドは失敗します。
必須 メールボックス パス SMTPサーバー名 必須 変換先 受信者の電子メールアドレス 必須 Cc cc 受信者の電子メールアドレス 省略可能 Bcc bcc 受信者の電子メールアドレス 省略可能 件名 メッセージの件名 必須 テキスト メッセージ テキスト 必須 添付ファイル ファイルのパス 省略可能 -
[OK]をクリックします。
認証を必要とする SMTP サーバーに接続しようとすると、NOTIFY コマンドが成功したように見えても、接続の試行は(予想どおり)失敗します。
-
NOTIFY コマンドをログからコピーしてスクリプトに貼り付けます。
NOTIFY コマンドに PASSWORD の暗号化された値が格納されます。
-
スクリプトで、コピーされた NOTIFY コマンドに次のパラメーターを追加し、適切なパラメーター値を指定します。
パラメーターは、NOTIFY キーワードの直後に挿入できます。
-
SMTP
-
SMTPUSER SMTPアカウント名
-
PORT ポート番号
-
ENABLESSL(必要な場合)
-
-
以前に NOTIFY 再試行回数を 0 に指定した場合は、コマンドラインに SET NOTIFYRETRYATTEMPTS TO 5 と入力します。
再試行回数を 5 ではなく、別の回数に設定していた場合は、その該当する回数を入力します。
-
スクリプトを実行して NOTIFY コマンドをテストします。
SMTP メールサーバーで動作するようにすべての必須の値を正しく構成すると、NOTIFY コマンドは成功するようになります。
接続の試行に失敗した場合の Analytics の応答の仕方
Analytics をメール サーバーに接続できない場合は、接続の試行が 10 秒おきに 5 回繰り返されます。この自動再試行機能は、メールサーバーが一時的に利用できなくなった場合の問題に対応します。
すべての接続試行に失敗した場合、NOTIFY コマンドはキャンセルされ、ログにメッセージが書き込まれますが、コマンドを含むスクリプトは処理を続行します。
SET コマンドを使用すると、デフォルトの再試行動作を変更できます。以下を指定できます。
-
異なる接続試行回数
-
追加の接続試行なし
-
異なる試行間隔
-
NOTIFY コマンドが接続に失敗し、キャンセルされた場合のスクリプトの失敗
SET コマンドの詳細については、SET コマンドを参照してください。
SET コマンド構文 | 例および備考 |
---|---|
SET NOTIFYRETRYATTEMPTS <TO> 数 |
SET NOTIFYRETRYATTEMPTS TO 10 デフォルト設定:5 回 NOTIFY コマンドが最初の試行に失敗した後、電子メールの送信を試行する回数を指定します。0 から 255 までの数値を入力します。0 を入力すると、最初の失敗後に追加の試行は行われません。 NOTIFY コマンドが電子メールの送信に失敗することについて考えられる理由の 1 つは、電子メール サーバーを利用できないということです。 |
SET NOTIFYRETRYINTERVAL <TO> 秒数 |
SET NOTIFYRETRYINTERVAL TO 30 デフォルト設定:10 秒 NOTIFYRETRYATTEMPTS 間の秒数を指定します。1 から 255 までの数値を入力します。 |
SET NOTIFYFAILSTOP {ON|OFF} |
SET NOTIFYFAILSTOP ON デフォルト設定:OFF
メモ 電子メールの受信者が無効である場合は、NOTIFY コマンドの失敗とは見なされず、NOTIFYFAILSTOP の設定にかかわらず、スクリプトが停止することはありません。 |