WkfMailSettingBehaviorオブジェクト非推奨

代替オブジェクトはありません。

コンポーネント情報

コンポーネント概要

プログラムサポート/メール送信　リザーブフラグ設定クラス。
テンプレートメールの予約や停止などを行う場合に使用します。

コンストラクタの概要

WkfMailSettingBehavior () 非推奨コンストラクタ代替メソッドはありません。

メソッドの概要

返却値の型	メソッド名
String	getResult () 非推奨エラーコードを返却します。代替メソッドはありません。
String	remove () 非推奨処理失敗時にWkfMailSettingBehaviorを使用し設定された情報を削除する為に使用します。代替メソッドはありません。
String	reserveCancel () 非推奨メール予約機能の使用を取消します。代替メソッドはありません。
String	reserveRequest () 非推奨メール予約機能の使用を依頼します。代替メソッドはありません。
String	send () 非推奨メールの送信を実行します。代替メソッドはありません。
String	setStopMail (String `key`) 非推奨停止対象となるテンプレートメール情報を保持します。代替メソッドはありません。
String	setTamplateRequest (String `templatePath`) 非推奨メールテンプレートの設定を行います。代替メソッドはありません。
String	stopCancel () 非推奨テンプレートメールの送信停止を取り止めます。代替メソッドはありません。
String	stopRequest () 非推奨同一スレッド内のテンプレートメールの標準送信を停止させます。代替メソッドはありません。

コンストラクタの詳細

WkfMailSettingBehavior () 非推奨

代替メソッドはありません。

コンストラクタ

メソッドの詳細

String getResult () 非推奨

代替メソッドはありません。

エラーコードを返却します。
エラーコードは、BPWErrorCodeIFで定義された定義値です。
エラーでない場合は、””(空文字)が返却されます。

返却値

String: String エラーコード

String remove () 非推奨

代替メソッドはありません。

処理失敗時にWkfMailSettingBehaviorを使用し設定された情報を削除する為に使用します。
申請/承認等の処理が失敗した場合にこのメソッドを実行してください。
このメソッドが実行されなかった場合、設定された情報が残ってしまい、
予期しない動作を起こす可能性があります。

返却値

String: String エラーコード

String reserveCancel () 非推奨

代替メソッドはありません。

メール予約機能の使用を取消します。
reserveRequest()を使用してメール予約の設定をしてある場合、そのメール予約を取り消します。

返却値

String: String エラーコード

String reserveRequest () 非推奨

代替メソッドはありません。

メール予約機能の使用を依頼します。
処理が正常終了した場合にのみテンプレートメールが送信されるように、メール予約を行います。

返却値

String: String エラーコード

String send () 非推奨

代替メソッドはありません。

メールの送信を実行します。
送信予約されているメールがある場合に、そのメールの送信を行います。
APIを使用して申請等の処理を行っている場合に、使用します。
WkfMailSettingBehaviorを使用する場合は処理が正常終了した後に
必ず実行してください。
また、処理が失敗した場合はremove()を実行してください。

返却値

String: String エラーコード

String setStopMail (String key) 非推奨

代替メソッドはありません。

停止対象となるテンプレートメール情報を保持します。
引数には停止対象となるメールテンプレートキーを指定してください。

パラメータ

key : String: メールテンプレートキー(必須)

返却値

String: String エラーコード

String setTamplateRequest (String templatePath) 非推奨

代替メソッドはありません。

メールテンプレートの設定を行います。
テンプレートメールの送信時に送信されるメールのテンプレートを変更したいときに使用します。
StorageService からのメールテンプレート相対パスを指定してください。

パラメータ

templatePath : String: テンプレートパス(必須)

返却値

String: String エラーコード

String stopCancel () 非推奨

代替メソッドはありません。

テンプレートメールの送信停止を取り止めます。
stopRequest()を使用してテンプレートメールの送信停止の設定をしてある場合、
その送信停止の設定を取り止め、解除します。

返却値

String: String エラーコード

String stopRequest () 非推奨

代替メソッドはありません。

同一スレッド内のテンプレートメールの標準送信を停止させます。
テンプレートメールの標準送信機能を停止させたい場合に使用します。

返却値

String: String エラーコード