MailTemplateManager オブジェクト

メール定義情報を管理するマネージャです。

メール定義情報およびメールテンプレートファイルの登録、更新、削除、取得を行います。

 管理するメールテンプレートファイルは以下の通りです。
   [%Storage Service%]
      /workflow
          /data
              /[%ログイングループID%]
                  /[%ログイングループ単位の設定値(master-file-dir)%]
                      /mail
                          /テンプレートファイル名_[%ロケール%].xml
                          /template.xml
                          
                          [%ロケール%]
                              日本語 : ja
                              英語   : en
                              中国語 : zh
                              など
 
 メールテンプレートファイルを新規作成時、元となるテンプレートファイルが
 見つからない場合は template.xml を使用します。
 
導入されたバージョン:7.2

コンストラクタの概要
MailTemplateManager (String loginGroupId)
コンストラクタ
引数で指定したログイングループIDでメール定義情報管理マネージャを新しく生成します。

メソッドの概要
WorkflowResultInfo createMailTemplateData (Array models)
メールテンプレート情報を新規作成します。
WorkflowResultInfo createMailTemplateDataFamily (Array models)
メールテンプレート情報と配下の情報を新規作成します。
WorkflowResultInfo createMailTemplateTypeData (Array models)
メールテンプレート種別情報を新規作成します。
WorkflowResultInfo deleteMailTemplateData (Array models)
メールテンプレート情報を削除します。
WorkflowResultInfo deleteMailTemplateDataFamily (Array models)
メールテンプレート情報と配下の情報を削除します。
WorkflowResultInfo deleteMailTemplateTypeData (Array models)
メールテンプレート種別情報を削除します。
WorkflowResultInfo getMailTemplateData (String mailId)
メールテンプレート情報を全ロケール分取得します。
WorkflowResultInfo getMailTemplateDataCount (String mailId)
メールテンプレート情報の件数を全ロケール分取得します。
WorkflowResultInfo getMailTemplateDataCountWithLocale (String mailId ,String localeId)
指定したロケールIDでメールテンプレート情報の件数を取得します。
WorkflowResultInfo getMailTemplateDataFamily (String mailId)
メールテンプレート情報と配下の情報を全ロケール分取得します。
WorkflowResultInfo getMailTemplateDataFamilyWithLocale (String mailId ,String localeId)
指定したロケールIDでメールテンプレート情報と配下の情報を1件取得します。
WorkflowResultInfo getMailTemplateDataList (MailTemplateSearchConditionInfo condition)
指定した検索条件でメールテンプレート情報を検索します。
WorkflowResultInfo getMailTemplateDataListCount (MailTemplateSearchConditionInfo condition)
指定した検索条件でメールテンプレート情報の検索結果件数を取得します。
WorkflowResultInfo getMailTemplateDataListCountWithAccessRole (MailTemplateSearchConditionInfo condition ,Array accessRole)
指定した検索条件とアクセスロールでメールテンプレート情報の検索結果件数を取得します。
WorkflowResultInfo getMailTemplateDataListWithAccessRole (MailTemplateSearchConditionInfo condition ,Array accessRole)
指定した検索条件とアクセスロールでメールテンプレート情報を検索します。
WorkflowResultInfo getMailTemplateDataWithLocale (String mailId ,String localeId)
指定したロケールIDでメールテンプレート情報を1件取得します。
WorkflowResultInfo getMailTemplateTypeData (String mailId)
メールテンプレート種別情報を取得します。
WorkflowResultInfo getMailTemplateUseStatusList (ContentsVersionViewDataSearchConditionInfo condition)
指定した検索条件でメール定義利用状況情報を検索します。
WorkflowResultInfo getMailTemplateUseStatusListCount (ContentsVersionViewDataSearchConditionInfo condition)
指定した検索条件でメール定義利用状況情報の検索結果件数を取得します。
WorkflowResultInfo getReplaceStringData ()
置換文字列情報を取得します。
WorkflowResultInfo updateMailTemplateData (Array models)
メールテンプレート情報を更新します。
WorkflowResultInfo updateMailTemplateDataFamily (Array models)
メールテンプレート情報と配下の情報を更新します。
WorkflowResultInfo updateMailTemplateTypeData (Array models)
メールテンプレート種別情報を更新します。

コンストラクタの詳細
MailTemplateManager

MailTemplateManager (String loginGroupId)
コンストラクタ
引数で指定したログイングループIDでメール定義情報管理マネージャを新しく生成します。
パラメータ
loginGroupId String ログイングループID

メソッドの詳細
createMailTemplateData

WorkflowResultInfo createMailTemplateData (Array models)

メールテンプレート情報を新規作成します。

models 内にメールテンプレート種別情報を指定した場合でも、メールテンプレート種別情報は新規作成しません。
全ての情報を新規作成する場合は createMailTemplateDataFamily を使用してください。

ワークフロー上で使用可能にするためにはメールテンプレート種別情報の作成が必要です。

メールテンプレート情報にメールテンプレートファイル情報を指定している場合は
メール定義XMLファイルの新規作成を行います。
パラメータ
models Array メールテンプレート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createMailTemplateDataFamily

WorkflowResultInfo createMailTemplateDataFamily (Array models)

メールテンプレート情報と配下の情報を新規作成します。

models 内のメールテンプレート情報、メールテンプレート種別情報の指定に基づいて新規作成しますが、
データ矛盾のチェックを行いません。

models 内にメールテンプレート種別情報を指定した場合は、メールテンプレート種別情報を新規作成します。

メールテンプレート情報にメールテンプレートファイル情報を指定している場合は
メール定義XMLファイルの新規作成を行います。

メール種別によって、元となるデフォルトのテンプレートファイルを読み取り、ファイルを作成します。
パラメータ
models Array メールテンプレート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createMailTemplateTypeData

WorkflowResultInfo createMailTemplateTypeData (Array models)

メールテンプレート種別情報を新規作成します。
パラメータ
models Array メールテンプレート種別情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteMailTemplateData

WorkflowResultInfo deleteMailTemplateData (Array models)

メールテンプレート情報を削除します。

models 内にメールテンプレート種別情報を指定した場合でも、メールテンプレート種別情報は削除しません。
全ての情報を削除する場合は deleteMailTemplateDataFamily を使用してください。

メールテンプレート情報にメールテンプレートパスを指定していない場合は自動的に取得して
メール定義XMLファイルの削除を行います。
パラメータ
models Array メールテンプレート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteMailTemplateDataFamily

WorkflowResultInfo deleteMailTemplateDataFamily (Array models)

メールテンプレート情報と配下の情報を削除します。

models 内のメールテンプレート情報、メールテンプレート種別情報の指定に基づいて削除しますが、
データ矛盾のチェックを行いません。

models 内のメールテンプレートIDは必須、メールテンプレート種別情報は任意、それ以外の項目は無視します。
models 内にメールテンプレート種別情報を指定した場合は、指定のメールテンプレート種別情報を削除します。
models 内にメールテンプレート種別情報を指定しない場合は、キー情報に一致するメールテンプレート種別情報を削除します。

メールテンプレート情報にメールテンプレートパスを指定していない場合は自動的に取得して
メール定義XMLファイルの削除を行います。
パラメータ
models Array メールテンプレート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteMailTemplateTypeData

WorkflowResultInfo deleteMailTemplateTypeData (Array models)

メールテンプレート種別情報を削除します。
パラメータ
models Array メールテンプレート種別情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

getMailTemplateData

WorkflowResultInfo getMailTemplateData (String mailId)

メールテンプレート情報を全ロケール分取得します。

メールテンプレート情報の他にメールテンプレートファイル情報の取得も行います。

メールテンプレート種別情報は取得しません。
全ての情報を取得する場合は getMailTemplateDataFamily を使用してください。

登録されている全ロケール分を取得します。
ロケールの指定を行う場合は getMailTemplateDataWithLocale を使用してください。
パラメータ
mailId String メールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート情報オブジェクトの配列が設定されます。

getMailTemplateDataCount

WorkflowResultInfo getMailTemplateDataCount (String mailId)

メールテンプレート情報の件数を全ロケール分取得します。
パラメータ
mailId String メールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート情報の件数(Number)が設定されます。

getMailTemplateDataCountWithLocale

WorkflowResultInfo getMailTemplateDataCountWithLocale (String mailId ,String localeId)

指定したロケールIDでメールテンプレート情報の件数を取得します。
パラメータ
mailId String メールID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート情報の件数(Number)が設定されます。

getMailTemplateDataFamily

WorkflowResultInfo getMailTemplateDataFamily (String mailId)

メールテンプレート情報と配下の情報を全ロケール分取得します。

メールテンプレート情報の他にメールテンプレート種別情報、メールテンプレートファイル情報の取得も行います。

登録されている全ロケール分を取得します。
ロケールの指定を行う場合は getMailTemplateDataFamilyWithLocale を使用してください。
パラメータ
mailId String メールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート情報オブジェクトの配列が設定されます。

getMailTemplateDataFamilyWithLocale

WorkflowResultInfo getMailTemplateDataFamilyWithLocale (String mailId ,String localeId)

指定したロケールIDでメールテンプレート情報と配下の情報を1件取得します。

メールテンプレート情報の他にメールテンプレート種別情報、メールテンプレートファイル情報の取得も行います。
国際化対応されている情報の場合は、指定したロケールIDのみを取得します。

該当するメールテンプレート情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
mailId String メールID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート情報オブジェクトが設定されます。

getMailTemplateDataList

WorkflowResultInfo getMailTemplateDataList (MailTemplateSearchConditionInfo condition)

指定した検索条件でメールテンプレート情報を検索します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

アクセスロールの指定を行う場合は getMailTemplateDataListWithAccessRole を使用してください。
パラメータ
condition MailTemplateSearchConditionInfo メールテンプレート一覧情報検索条件オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート一覧情報オブジェクトの配列が設定されます。

getMailTemplateDataListCount

WorkflowResultInfo getMailTemplateDataListCount (MailTemplateSearchConditionInfo condition)

指定した検索条件でメールテンプレート情報の検索結果件数を取得します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

アクセスロールの指定を行う場合は getMailTemplateDataListCountWithAccessRole を使用してください。
パラメータ
condition MailTemplateSearchConditionInfo メールテンプレート一覧情報検索条件オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メール定義情報の件数(Number)が設定されます。

getMailTemplateDataListCountWithAccessRole

WorkflowResultInfo getMailTemplateDataListCountWithAccessRole (MailTemplateSearchConditionInfo condition ,Array accessRole)

指定した検索条件とアクセスロールでメールテンプレート情報の検索結果件数を取得します。

指定したアクセスロールに紐付き、参照権限があるメール定義情報を検索対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
condition MailTemplateSearchConditionInfo メールテンプレート一覧情報検索条件オブジェクト
accessRole Array アクセスロールの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メール定義情報の件数(Number)が設定されます。

getMailTemplateDataListWithAccessRole

WorkflowResultInfo getMailTemplateDataListWithAccessRole (MailTemplateSearchConditionInfo condition ,Array accessRole)

指定した検索条件とアクセスロールでメールテンプレート情報を検索します。

指定したアクセスロールに紐付き、参照権限があるメール定義情報を検索対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
condition MailTemplateSearchConditionInfo メールテンプレート一覧情報検索条件オブジェクト
accessRole Array アクセスロールの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート一覧情報オブジェクトの配列が設定されます。

getMailTemplateDataWithLocale

WorkflowResultInfo getMailTemplateDataWithLocale (String mailId ,String localeId)

指定したロケールIDでメールテンプレート情報を1件取得します。

メールテンプレート情報の他にメールテンプレートファイル情報の取得も行いますが、
メールテンプレート種別情報は取得しません。
全ての情報を取得する場合は getMailTemplateDataFamilyWithLocale を使用してください。

該当するメールテンプレート情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
mailId String メールID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート情報オブジェクトが設定されます。

getMailTemplateTypeData

WorkflowResultInfo getMailTemplateTypeData (String mailId)

メールテンプレート種別情報を取得します。
パラメータ
mailId String メールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メールテンプレート種別情報オブジェクトの配列が設定されます。

getMailTemplateUseStatusList

WorkflowResultInfo getMailTemplateUseStatusList (ContentsVersionViewDataSearchConditionInfo condition)

指定した検索条件でメール定義利用状況情報を検索します。

condition の id と、localeId は必ず設定してください。
パラメータ
condition ContentsVersionViewDataSearchConditionInfo コンテンツ・バージョンの一覧表示情報(利用状況一覧)検索条件オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、コンテンツ・バージョンの一覧表示情報(利用状況一覧)オブジェクト の配列が設定されます。

getMailTemplateUseStatusListCount

WorkflowResultInfo getMailTemplateUseStatusListCount (ContentsVersionViewDataSearchConditionInfo condition)

指定した検索条件でメール定義利用状況情報の検索結果件数を取得します。

condition の id と、localeId は必ず設定してください。
パラメータ
condition ContentsVersionViewDataSearchConditionInfo コンテンツ・バージョンの一覧表示情報(利用状況一覧)検索条件オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、メール定義利用状況情報の件数(Number)が設定されます。

getReplaceStringData

WorkflowResultInfo getReplaceStringData ()

置換文字列情報を取得します。
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、置換文字列情報オブジェクトの配列が設定されます。

updateMailTemplateData

WorkflowResultInfo updateMailTemplateData (Array models)

メールテンプレート情報を更新します。

models 内にメールテンプレート種別情報を指定した場合でも、メールテンプレート種別情報は更新しません。
全ての情報を更新する場合は updateMailTemplateDataFamily を使用してください。

メールテンプレート情報にメールテンプレートパス、メールテンプレートファイル情報を指定している場合は
メール定義XMLファイルの更新を行います。
パラメータ
models Array メールテンプレート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateMailTemplateDataFamily

WorkflowResultInfo updateMailTemplateDataFamily (Array models)

メールテンプレート情報と配下の情報を更新します。

models 内のメールテンプレート情報、メールテンプレート種別情報の指定に基づいて更新しますが、
データ矛盾のチェックを行いません。

models 内のメールID、ロケールIDは必須で、それ以外の項目は任意です。
models 内にメールテンプレート種別情報を指定した場合は、メールテンプレート種別情報を更新を行います。
メールテンプレート情報にメールテンプレートパス、メールテンプレートファイル情報を指定した場合は
メール定義XMLファイルの更新を行います。
パラメータ
models Array メールテンプレート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateMailTemplateTypeData

WorkflowResultInfo updateMailTemplateTypeData (Array models)

メールテンプレート種別情報を更新します。
パラメータ
models Array メールテンプレート種別情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。