Hitachi

Cosminexus V11 BPM/ESB基盤 サービスプラットフォーム リファレンス

6.13.3　メールアダプタ実行環境プロパティファイル

〈この項の構成〉

(1)　形式

　mailadp.smtp.host.name=接続するメールサーバのIPアドレスまたはホスト名
［mailadp.smtp.port=接続するメールサーバのポート番号］
 
［mailadp.user=接続するメールサーバのログインユーザ名］
　mailadp.addr.from=メールのFROMフィールドに設定するアドレス
［mailadp.addr.to=メールのTOフィールドに設定するアドレス］
［mailadp.addr.cc=メールのCCフィールドに設定するアドレス］
［mailadp.addr.bcc=メールのBCCフィールドに設定するアドレス］
［mailadp.addr.count.max=設定できるアドレスの最大数］
［mailadp.mail.body.size=メール本文のサイズ］
［mailadp.attach.path.<n>=添付ファイルの絶対パス］
［mailadp.attach.file.size=メールの添付ファイルの最大サイズ］
［mailadp.max.attach.count.per.mail=最大添付ファイル数］
［mailadp.mail.format={text/plain｜text/html｜text/xml}］
［mailadp.mail.body-text=メール本文に挿入するテキスト］
［mailadp.mail.body-filepath=メール本文に挿入するテキストのファイルのパス］
［mailadp.mail.body-filecharset={UTF-8｜MS932}］
［mailadp.subject.size=メール主題のサイズ］
［mailadp.subject.text=メール主題に挿入するテキスト］
［mailadp.smtp.encoding=メール用エンコード］
［mailadp.smtp.auth={LOGIN｜PLAIN}］
［mailadp.user.header.path=メールヘッダ定義ファイルの絶対パス］
［mailadp.account.file.path=メールアダプタアカウント定義ファイルの絶対パス］
 
［mailadp.methodtrace.level={1｜2｜3｜4｜5}］
［mailadp.methodtrace.filepath=メンテナンスログの出力先ディレクトリ］
［mailadp.methodtrace.filenum=メンテナンスログの面数］
［mailadp.methodtrace.filesize=メンテナンスログの1面当たりの最大サイズ］
 
［mailadp.messagelog.level={0｜10｜20}］
 
［mailadp.smtp.timeout=メール送信時のタイムアウト時間］
［mailadp.smtp.connectiontimeout=メールサーバ接続のタイムアウト時間］
 
［mailadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数］
［mailadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔］
 
［mailadp.exptrace.filenum=例外ログファイルの最大出力面数］
［mailadp.exptrace.filesize=例外ログファイルの最大出力ファイルサイズ］
 
［mailadp.smtps.enable={TRUE｜FALSE}］
［mailadp.smtps.starttls.enable={TRUE｜FALSE}］
［mailadp.smtps.starttls.required={TRUE｜FALSE}］

ページの先頭へ

(2)　機能

(a)　ファイルの種類

メールアダプタ実行環境プロパティファイルは，メールアダプタの構成情報を設定します。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，メールアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

プロパティファイル間で同じプロパティが指定された場合，プロパティの優先度は次のようになります。

ファイルの種類

プロパティ重複時の優先度

メールアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

高

メールアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

低

(b)　作成手順

  1. 次のテンプレートファイルを基に，メールアダプタ実行環境プロパティファイルを定義します。

    <サービスプラットフォームのインストールディレクトリ>\CSC\config\mail\templates\adpmail.properties

  2. 編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納します。

    全HCSCサーバ共通の定義の場合

    <サービスプラットフォームのインストールディレクトリ>\CSC\config\mail

    特定のHCSCサーバ用の定義の場合

    <サービスプラットフォームのインストールディレクトリ>\CSC\config\mail¥<HCSCサーバ名>

    サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

    サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

ページの先頭へ

(3)　設定できるプロパティ

(a)　サーバ情報関連

mailadp.smtp.host.name=接続するメールサーバのIPアドレスまたはホスト名

接続するメールサーバのIPアドレスまたはホスト名を指定します。このプロパティは省略できません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.smtp.port=接続するメールサーバのポート番号　〜＜数字＞((1−65535))<<25>>

接続するメールサーバのポート番号を指定します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

(b)　メール設定関連

mailadp.user=接続するメールサーバのログインユーザ名

接続するメールサーバのログインユーザ名を設定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。

使用できる半角記号を次に示します。

  • 感嘆符（!）

  • ダブルクォーテーション（"）

  • 番号記号（#）

  • ドル記号（$）

  • パーセント（%）

  • アンパサンド（&）

  • アポストロフィ（'）

  • 始め小括弧（(）

  • 終わり小括弧（)）

  • アスタリスク（*）

  • 正符号（+）

  • コンマ（,）

  • ハイフン（-）

  • ピリオド（.）

  • スラッシュ（/）

  • コロン（:）

  • セミコロン（;）

  • 左アングルブラケット（<）

  • 右アングルブラケット（>）

  • 等号（=）

  • クエスチョンマーク（?）

  • 単価記号（@）

  • 始め角括弧（[）

  • 終わり角括弧（]）

  • 円マーク（\）

  • アクサンシルコンフレックス（^）

  • アンダーバー（_）

  • アクサングラーブ（`）

  • 始め波括弧（{）

  • 終わり波括弧（}）

  • パイプライン（|）

  • 波ダッシュ（~）

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

SMTP認証の型がLOGINの場合はこのプロパティを必ず設定してください。SMTP認証の型がPLAINの場合，設定は不要です。

mailadp.addr.from=メールのFROMフィールドに設定するアドレス

送信メールのFROMフィールドに設定する有効なアドレスを指定します。このプロパティは省略できません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.to=メールのTOフィールドに設定するアドレス

送信メールのTOフィールドに設定する有効なアドレスを指定します。複数のアドレスを指定する場合は，区切り文字としてコンマ（,）を挿入してください。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.cc=メールのCCフィールドに設定するアドレス

送信メールのCCフィールドに設定する有効なアドレスを指定します。複数のアドレスを指定する場合は，区切り文字としてコンマ（,）を挿入してください。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.bcc=メールのBCCフィールドに設定するアドレス

送信メールのBCCフィールドに設定する有効なアドレスを指定します。複数のアドレスを指定する場合は，区切り文字としてコンマ（,）を挿入してください。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.count.max=設定できるアドレスの最大数　〜＜数字＞((1−768))<<768>>

アドレスフィールドに設定できるアドレスの最大数を指定します。

アドレスの最大数は，TO，CC，およびBCCフィールドに設定するアドレスの合計数を指します。同一のアドレスが複数設定されている場合，それぞれが1件としてカウントされます。

mailadp.mail.body.size=メール本文のサイズ　〜＜数字＞((1−2048000))<<1024000>>

メール本文のサイズをバイト単位で指定します。

mailadp.attach.path.<n>=添付ファイルの絶対パス

添付ファイルのパスを絶対パスで指定します。<n>には添付ファイルの数に応じて1〜100までの自然数を指定します。指定例を次に示します。

  • 添付ファイルが1つの場合

    mailadp.attach.path.1=C:\\temp\\attach1.txt

  • 添付ファイルが複数の場合

    mailadp.attach.path.1= C:\\temp\\attach1.txt
mailadp.attach.path.2= C:\\temp\\attach2.txt
：

ディレクトリ区切りは「/」または「\\」を使用します。添付ファイルを複数指定する場合，同じファイルを2つ指定したときは同じファイルが2つ添付されます。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.attach.file.size=メールの添付ファイルの最大サイズ　〜＜数字＞((0−5242880))<<5242880>>

メールの添付ファイル1つの最大サイズをバイト単位で指定します。

mailadp.max.attach.count.per.mail=最大添付ファイル数　〜＜数字＞((0−100))<<10>>

1つのメールに添付できるファイルの最大数を指定します。

mailadp.mail.format={text/plain｜text/html｜text/xml}　〜<<text/plain>>

メールのフォーマットとして，text/plain，text/htmlまたはtext/xml※を指定します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

注※

text/xmlを指定した場合，メールアダプタではプレーンテキスト形式で表示されます。

mailadp.mail.body-text=メール本文に挿入するテキスト

メール本文に挿入するテキストを設定します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.mail.body-filepath=メール本文に挿入するテキストのファイルのパス

任意のファイルパスを指定します。ここで設定したファイルのテキストがメール本文に読み込まれます。ディレクトリ区切りは「/」または「\\」を使用します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.mail.body-filecharset={UTF-8｜MS932}　〜<<UTF-8>>

mailadp.mail.body-filepathキーで指定したファイルの文字セットを指定します。大文字と小文字は区別されません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.subject.size=メール主題のサイズ　〜＜数字＞((0−80))<<80>>

メール主題のサイズを指定します。主題の文字数が指定したサイズを超えた場合，超えた文字が切り落とされます。

mailadp.subject.text=メール主題に挿入するテキスト

メール主題に挿入するテキストを指定します。設定しない場合，主題なしのメールが送信されます。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.smtp.encoding=メール用エンコード　〜<<ISO-2022-JP>>

メール用エンコードを指定します。設定されたエンコードがメール送信中に使用されます。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.smtp.auth={LOGIN｜PLAIN}　〜<<PLAIN>>

メールサーバに対する認証の型を指定します。大文字と小文字は区別されません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.user.header.path=メールヘッダ定義ファイルの絶対パス

メールヘッダ定義ファイルのパスを絶対パスで指定します。ディレクトリ区切りは「/」または「\\」を使用します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.account.file.path=メールアダプタアカウント定義ファイルの絶対パス

メールアダプタアカウント定義ファイルのパスを絶対パスで指定します。ディレクトリ区切りは「/」または「\\」を使用します。

(c)　メンテナンスログ関連

mailadp.methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

メンテナンスログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル※

1

2

3

4

5

エラー情報（例外発生原因）

○

○

○

○

○

リクエスタサービスメソッドの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

○

○

○

○

外部（BPなど）のインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

○

○

○

コンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

×

○

○

メール送信情報（メールサーバの接続，メールの詳細，メッセージトレース）

×

×

×

○

○

デバッグ情報（処理の分岐などの情報）

×

×

×

×

○
（凡例）

○：出力されます。

×：出力されません。

注※

メンテナンスログの出力レベルに4または5を指定した場合，メール送信に使用するメールアドレスが出力されます。

mailadp.methodtrace.filepath=メンテナンスログの出力先ディレクトリ

メンテナンスログの出力先ディレクトリを絶対パスで指定します。このディレクトリに例外ログも出力されます。ディレクトリ区切りは「/」または「\\」を使用します。

指定したフォルダが存在しない場合は，<J2EEサーバの作業ディレクトリ>\ejb\<J2EEサーバ名>\logs\CSCADP\MAILADP\maintenance\<サービスID>に出力されます。

なお，<J2EEサーバの作業ディレクトリ>\ejb\<J2EEサーバ名>\logsはusrconf.cfg（J2EEサーバ用オプション定義ファイル）のejb.server.log.directoryキーで変更できます。usrconf.cfgの詳細は，マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「2.2.2　usrconf.cfg（J2EEサーバ用オプション定義ファイル）」を参照してください。

mailadp.methodtrace.filenum=メンテナンスログの面数　〜＜数字＞((1−16))<<8>>

メンテナンスログの面数を指定します。

mailadp.methodtrace.filesize=メンテナンスログの1面当たりの最大サイズ　〜＜数字＞((4096−147483647))<<2097152>>

メンテナンスログの1面当たりの最大サイズをバイト単位で指定します。

(d)　メッセージログ関連

mailadp.messagelog.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力内容

出力レベル

0

10

20

エラー情報

例外または障害の発生原因

○

○

○

警告情報

発生した問題など

×

○

○

インフォメーション

電文や引数の内容

HCSC-Messagingの状態の変更（起動時や終了時）

コマンド受付時と実行完了時

イベントの通知

×

×

○
（凡例）

○：出力されます。

×：出力されません。

(e)　再接続関連

mailadp.smtp.timeout=メール送信時のタイムアウト時間　〜＜数字＞((0−3600))<<180>>

メール送信時のタイムアウト時間を秒単位で指定します。0を指定した場合は，タイムアウトしません。

このプロパティの値は，SMTPサーバへメールの送信時に使用するJavaMailのセッションプロパティ"mail.smtp.timeout"へ設定します。

mailadp.smtp.connectiontimeout=メールサーバ接続のタイムアウト時間　〜＜数字＞((0−86400))<<180>>

メールサーバ接続のタイムアウト時間を秒単位で指定します。0を指定した場合は，タイムアウトしません。

このプロパティの値は，SMTPサーバへメールの送信時に使用するJavaMailのセッションプロパティ"mail.smtp.connectiontimeout"へ設定します。

(f)　排他取得タイムアウト関連

mailadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダのファイルの共有ロックに失敗した場合のリトライ回数を指定します。

mailadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダのファイルの共有ロックに失敗した場合のリトライ間隔を秒単位で指定します。

(g)　例外ログ関連

例外ログはメンテナンスログと同じディレクトリに出力されます。出力先の指定方法についてはmailadp.methodtrace.filepathプロパティを参照してください。

mailadp.exptrace.filenum=例外ログファイルの最大出力面数　〜＜数字＞((1−16))<<8>>

例外ログファイルの最大出力面数を指定します。

mailadp.exptrace.filesize=例外ログファイルの最大出力ファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

例外ログファイルの最大出力ファイルサイズをバイト単位で指定します。

(h)　TLS関連

mailadp.smtps.enable={TRUE｜FALSE}　〜<<FALSE>>

SMTPサーバとの接続にTLSを使用するかどうかを指定します。大文字と小文字は区別されません。

  • TRUE

    TLSを使用してSMTPサーバに接続します。

  • FALSE

    TLSを使用しません。SMTPでSMTPサーバに接続します。

mailadp.smtps.starttls.enable={TRUE｜FALSE}　〜<<TRUE>>

SMTPサーバとの接続にTLSを使用する場合に，STARTTLSを使用するかどうかを指定します。mailadp.smtps.enableでTRUEを指定した場合だけ有効になります。大文字と小文字は区別されません。

  • TRUE

    STARTTLSを使用します。通常のSMTPで通信を開始し，STARTTLSで双方がTLSに対応しているか確認したあとに，TLSで再接続します。

  • FALSE

    STARTTLSを使用しません。SMTP通信がすべてTLSによって暗号化されます。

mailadp.smtps.starttls.required={TRUE｜FALSE}　〜<<FALSE>>

メールアダプタでSTARTTLSを使用する場合，接続先のSMTPサーバで次の現象が発生した際に，メールアダプタからエラーを発生させるかどうかを指定します。

  • 接続先のSMTPサーバがSTARTTLSをサポートしていない

  • 接続先のSMTPサーバでSTARTTLSの処理中にエラーが発生した

mailadp.smtps.enableとmailadp.smtps.starttls.enableの両方でTRUEを指定した場合だけ有効になります。大文字と小文字は区別されません。

  • TRUE

    メールアダプタでエラーを発生させます。

  • FALSE

    SMTPを使用してSMTPサーバに接続します。

ページの先頭へ

(4)　記述例

メールアダプタ実行環境プロパティファイルの記述例を次に示します。

mailadp.smtp.host.name=domainName.com
mailadp.smtp.port=25
mailadp.user=john
mailadp.addr.from=sampleuser@XXXXXX.com

ページの先頭へ

(5)　注意事項

ページの先頭へ

商品名称に関する表示

All Rights Reserved. Copyright (C) 2020, 2022, Hitachi, Ltd.