4.2.5 メール通知部品
機能
SMTPサーバに接続し,指定したメールアドレス,件名,および本文でメールを送信できます。また,ユーザー設定プロパティファイル(config_user.properties)のキー「mail.plugin.retry.interval」を編集することで,メール送信に失敗した場合にリトライできます。
実行時の前提条件
-
次の情報は,ビルトインサービス共有プロパティから取得されます。そのため,事前に[管理]画面の[システム設定]エリアで値を設定してください。
-
SMTPサーバのアドレス
-
ポート番号
-
ユーザーID
-
パスワード
-
通知メールの送信元
-
注意事項
-
プロパティ「toAddress」,「ccAddress」,および「bccAddress」を指定しなかった場合でも,戻り値は0になります。
-
指定するメールアドレスは,ビルトインサービス共有プロパティの値とは異なります。そのため,プロパティ「toAddress」,「ccAddress」,または「bccAddress」のどれかを必ず指定してください。
-
プロパティ「toAddress」,「ccAddress」,および「bccAddress」にメールアドレスとして有効ではない値を1つでも指定した場合,すべてのメールアドレスへのメール送信が失敗します。
-
プロパティ「mailSubject」「mailBody」では文字セット間に互換性のない文字および 機種依存文字を使用すると,文字が 「?」などに置き換わります。 必要に応じて,使用する文字を変更するか,メールのエンコード種別を変更して使用してください。
- 変換できないおそれのある文字の例
-
「~」,「¥」,「\」,「〜」,「‖」,「−」,「¢」,「£」,「¬」
-
部品の実行中にタスクを実行停止した場合は,メール通知部品の処理が完了してからタスクの状態が「失敗」または「正常終了」になります。部品の実行が終了したときのステップおよびタスクの状態は,ステップの戻り値および後続ステップ実行条件によって決まります。後続ステップ実行条件は,[ステップ作成]ダイアログボックスまたは[ステップ編集]ダイアログボックスで設定できます。
-
部品の実行中にタスクを強制停止した場合は,実行中の処理が直ちに終了され,タスクの状態が「失敗」になります。なお,[タスク]画面の[フロー]エリアに表示されるステップの戻り値は,80になります。タスクログに出力される戻り値は,強制停止したタイミングによって異なります。
バージョン
01.00.01
タグ
Mail,Notification
戻り値
戻り値 |
説明 |
---|---|
0 |
正常に終了した。 |
65 |
JP1/AOサーバとの接続に失敗した。例えば,部品実行中にJP1/AOサーバが停止された場合が該当する。 |
66 |
次のユーザーがJP1ユーザーにマッピングされている。
|
68 |
対象のジョブ実行IDに関する情報がない。 |
69 |
タスク処理エンジンの環境変数の取得に失敗した。 |
70 |
SMTPサーバとの接続に失敗した。 |
78 |
認証に失敗した。 |
79 |
メールの送信に失敗した。 |
80 |
タスクの実行を停止した。 |
81 |
部品が不正な状態で呼び出された。 |
82 |
タスク処理エンジンからの要求メッセージを正しくパースできない。 |
83 |
JP1/AOサーバの環境が壊れている。 |
84 |
指定された部品の情報が取得できない。 |
86 |
指定したプロパティ値に誤りがある。 |
127 |
そのほかのエラーが発生した。 |
プロパティ一覧
プロパティを次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
toAddress |
TOメールアドレス |
TO属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は,コンマ区切りで指定してください。 |
− |
入力 |
△ |
ccAddress |
CCメールアドレス |
CC属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は,コンマ区切りで指定してください。 |
− |
入力 |
△ |
bccAddress |
BCCメールアドレス |
BCC属性で送信するメールアドレスを1,024文字以内で指定します。複数のメールアドレスを指定する場合は,コンマ区切りで指定してください。 |
− |
入力 |
△ |
encodeType |
エンコード種別 |
メールのエンコード種別を次から指定します。
|
utf-8 |
入力 |
○ |
mailSubject |
メール件名 |
メールの件名を256文字以内で指定します。 |
− |
入力 |
△ |
mailBody |
メール本文 |
メールの本文を1,024文字以内で指定します。 |
− |
入力 |
△ |
関連トピック
-
マニュアル「JP1/AO 構築ガイド」−「ユーザー設定プロパティファイル(config_user.properties)」のトピック