メール連携設定ファイル(メールアドレス.ini)
メール連携設定ファイルは、電子メールからのデータ登録機能を利用する場合に作成します。メールの内容をLMISに取り込むための設定を記述します。
本設定ファイルはLMIS画面から設定の作成・変更・削除が可能です。操作方法については、「メール受信機能の設定」を参照してください。
メール連携設定ファイル(メールアドレス.ini)の基本情報、記述形式、定義内容、定義例などについて説明します。
<目次>
- 1 ファイルの基本情報
- 2 記述形式
- 3 定義内容
- 3.1 区切り文字設定
- 3.2 添付ファイル設定
- 3.3 メール承認設定
- 3.4 レコード新規登録設定
- 3.5 入力値の切り捨て設定
- 3.6 メール処理形式設定
- 3.7 HTMLメール解析設定
- 3.8 ルーティング設定
- 3.9 活動履歴情報登録セクション
- 3.10 変数定義セクション
- 3.11 レコード更新セクション
- 4 定義例
- 5 メール連携設定ファイルの評価の流れ
- 6 注意事項
- 7 参考情報
ファイルの基本情報
項目 | 内容 |
---|---|
ファイル名 | 使用するメールアドレス.ini 例:sample@a1b2c3d4e5f6g7h8i9j0.apex.salesforce.com.ini 組織のアドレスにお客様ドメインのメールアドレスを登録している場合は、「お客様ドメインのメールアドレス.ini」としてください。 |
ファイル名(CC取り込み用の場合) | 使用するメールアドレス.cc 例:sample2@a1b2c3d4e5f6g7h8i9j0.apex.salesforce.com.cc |
ファイル保管先 | LMISドキュメントフォルダ |
フォーマット | テキスト形式ファイル |
文字コード | UTF-8(BOMなし) |
ファイル反映のタイミング | 本ファイルをLMIS上に配置したときに反映します。 |
記述形式
パラメータの値の1文字目には記号を指定します。指定した記号によって、値が以下のとおりに変換されます。
なお、特記事項に記載がない場合、大文字/小文字を区別しません。
記号 | 変換方法 | 特記事項 |
---|---|---|
$ | 文字列に変換します。 | 指定された文字列は大文字/小文字を区別します。 |
# | 数値に変換します。 例:commentkeyLine=#3 | |
_ (アンダーバー) | TRUE、FALSEのいずれかに変換します。 例:approvalMail=_TRUE | |
@ | メール項目から、パラメータに設定可能な値に変換します。指定できるのは以下の項目です。
例1:ox_txt_subject__c=@subject 上記のように指定した場合、メールの件名から値を取得しレコードの件名に設定されます。 例2:ox_txt_subject__c=@header(Message-ID) 上記のように指定した場合、メールヘッダのMassage-IDの値を取得します。 |
|
? | メール本文または件名から特定キーワード間の値を取得します。以下の形式で記述します。 ?(開始キーワード,終了キーワード,取得場所) 終了キーワードに以下の値が設定可能です。省略値は¥nです。
取得場所に以下の値が設定可能です。省略値は@bodyです。
例1:?(START,END,@body) 上記のように指定した場合、メール本文中のSTARTという文字列からENDという文字列間の値を取得します。 終了キーワードを指定しない、または¥nを指定すると、開始キーワードから改行までの値を取得します。 例2:?(START,¥n,@body) または ?(START,,@body) 上記のように指定した場合、メール本文中のSTARTという文字列から次の改行までの文字列の値を取得します。 例3:?(START,@endbody,@body) 上記のように指定した場合、メール本文中のSTARTという文字列からメール本文の末尾(改行含む)までの文字列の値を取得します。 |
|
& | オブジェクトを指定し、対象項目の値を取得します。条件値には、データの値を直接指定するか、@マーク、?マーク、変数名、API参照名の併用が可能です。 以下の形式で記述します。 &オブジェクト名(条件項目名,条件値,取得項目) 例1:&User(Username,xxx@unirita.co.jp,ID) 例2:&Contact(Email,@MAIL,NAME) |
|
API参照名 | すでに項目に設定した値を使用したい場合は、API参照名を設定することで、同一の値を取得できます。 以下の形式で記述します。 例: ox_txt_subject__c = @SUBJECT ox_ltx_content__c = ox_txt_subject__c 上記のように指定した場合、メール件名がレコードの件名に設定され、レコードの件名に設定された値が内容に設定されます。 |
|
:(変数名) | 複数の項目に同じ値を使用したい場合は、変数を使用することで、同一の値を取得できます。 以下の形式で記述します。 例: ox_txt_subject__c=:VARSUBJECT ox_ltx_content_c=:VARSUBJECT [VARIABLE] VARSUBJECT=@SUBJECT 上記のように指定した場合、メールの件名がレコードの件名、および内容にそれぞれ設定されます。 |
|
date | 日付型に変換します。条件値には、@SUBJECT、@BODY、?マーク、変数名、API参照名の併用が可能です。 以下の形式で記述します。 date(条件値,フォーマット) 例:date(@BODY,yyyy年MM月dd日) |
条件値で日付ではない値を変換しようとした場合、メール連携が失敗する可能性があるのでご注意ください |
datetime | 日付/時間型に変換します。条件値には、@SUBJECT、@BODY、?マーク、変数名、API参照名の併用が可能です。 以下の形式で記述します。 datetime(条件値,フォーマット) 例:datetime(@BODY,yyyy年MM月dd日 HH時mm分) 2つ目の引数には、条件値で指定される文字に対応するフォーマットを指定します。 |
|
number | 数値型に変換します。条件値には@SUBJECT、@BODY、?マーク、変数名、API参照名の併用が可能です。 以下の形式で記述します。 number(条件値) 例:number(?(START,END,@body)) 上記のように指定した場合、メール本文中のSTARTという文字列からENDという文字列間の値を取得し、数値型に変換します。
|
|
定義内容
メール連携設定ファイルは、以下の設定、セクションで構成されます。
区切り文字設定
添付ファイル設定
メール承認設定
レコード新規登録設定
入力値の切り捨て設定
メール処理形式設定
HTMLメール解析設定
ルーティング設定
活動履歴情報登録セクション
変数定義セクション
レコード更新セクション
各設定、およびセクションの属性に定義する内容について説明します。
区切り文字設定
本ファイルで使用する区切り文字を変更したい場合は、以下の区切り文字設定の属性を記述します。
パラメータを記載しない場合、省略値が設定されます。
属性 | 説明 | 省略可否 | 省略値 |
---|---|---|---|
delimiter | 本ファイルの区切り文字を指定します。 ここで指定した区切り文字で、パラメータと値を区切ります。 例: delimiter=: approvalMail:_TRUE | ○ | '=' |
添付ファイル設定
添付ファイルの登録方法を変更したい場合は、以下の添付ファイル設定の属性を記述します。
パラメータを記載しない場合、省略値が設定されます。
attachment | メールに添付ファイルがある場合の動作を指定します。
例:attachment=PARENT | ○ | TASK |
attachmentPlace | メールに添付ファイルがある場合に、そのファイルを登録するオブジェクトを指定します。
例:attachmentPlace=FILE この設定は、attachmentパラメータが「PARENT」に指定されている場合のみ有効です。 | ○ | ATTACHMENT |
メール承認設定
メール承認機能を利用する場合に、メール承認の設定を記述します。
属性 | 説明 | 省略可否 | 省略値 |
---|---|---|---|
approvalMail | メール承認機能を使用するかを指定します。
| ○ | _FALSE |
approvalkeyLine | 承認/否認が判断される行数を指定します。 例:approvalkeyLine=#2 なお、メール本文の空行および半角スペース、全角スペース、タブのみの行は、行数としてカウントされません。 | ○ | #1 |
commentkeyLine | 各オブジェクトの「活動履歴」に記載されるコメント内容を記載する行数を指定します。 例:commentkeyLine=#3 なお、メール本文の空行および半角スペース、全角スペース、タブのみの行は、行数としてカウントされません。 | ○ | #2 |
quote | メールの引用記号をカンマ区切りで記述します。引用記号で始まる行は、メール本文の行数としてカウントしません。 例:quote=>,:,| なお、カンマとカンマの間にスペースがある場合は、それも含めて引用記号とみなします。 | ○ |
レコード新規登録設定
電子メールからのデータ登録機能を利用する場合に、登録するオブジェクトとAPI参照名を記述します。
属性 | 説明 | 省略可否 |
---|---|---|
object | 登録するオブジェクトを指定します。 | × |
項目のAPI参照名 | 登録したい項目のAPI参照名をパラメータ名とし、値を設定します。 API参照名には、「SMOC__」を付けず「ox_」以降の文字列を指定してください。 API参照名が不正な場合、メール連携処理が失敗します。 値の設定に、変数を利用できます。変数を利用する場合は、「:変数名」の形式で設定してください。 | × |
入力値の切り捨て設定
入力値の切り捨て有無の属性を記述します。
属性 | 説明 | 省略可否 | 省略値 |
---|---|---|---|
fieldTruncation | 文字列長を超えた入力値を、最大文字列長に切り捨てて格納します。
例:fieldTruncation=ON 本設定がOFFの状態で文字列長を超えた入力があった場合、メール連携処理が失敗します。 | ○ | OFF |
メール処理形式設定
テキストメールおよびHTMLメールの処理有無の属性を記述します。
属性 | 説明 | 省略可否 | 省略値 |
---|---|---|---|
receiveTEXT | テキストメールの処理有無を指定します。
例:receiveTEXT=ON | ○ | ON |
receiveHTML | HTMLメールの処理有無などを指定します。
例:receiveHTML=ON | ○ | ON |
recieveHTMLの詳細は以下となります。
パラメータ名 | HTMLメール処理 | メール本文(@Body) | 記述形式 |
---|---|---|---|
ON | 処理する | HTMLメール解析設定で変換して連携 | すべて使用可能 |
DIRECT | 処理する | HTMLタグありで連携 | (?,&)が使用不可 |
OFF | 処理しない | - | - |
PARSE | 処理する | HTMLタグありで連携 | ?:常に件名から取得します。 その他の記述形式は「ON」と同様に動作します。 |
HTMLメール解析設定
メール処理形式設定で、HTMLの処理有無をONにした場合は、HTMLメールが解析、変換されます。
HTMLメールのタグ、テキストの装飾の設定を記述します。
属性 | 説明 | 省略可否 |
---|---|---|
タグ名_start | タグの開始時に挿入する文字列を以下の形式で指定します。 空白スペースは空白スペースを記載します。 | ○ |
タグ名_end | タグの終了時に挿入する文字列を以下の形式で指定します。 空白スペースは空白スペースを記載します。 | ○ |
上記の例のように指定した場合、以下のように変換されます。
変換前 | 変換後 |
---|---|
<div>aaa</div> | ・aaa。 |
指定を省略した場合のHTMLタグの省略値を以下に示します。
タグ | タグの用途 | 開始時挿入 | 終了時挿入 |
---|---|---|---|
hr | 横罫線 | 改行 | |
br | 改行 | 改行 | |
td | テーブルセル | 半角スペース | |
th | テーブルヘッダーセル | 半角スペース | |
label | ラベル | 半角スペース | |
div | ブロック | 改行 | |
tr | テーブル行 | 改行 | |
p | 段落 | 改行 | |
li | リスト | 改行 | |
h1 | 見出し | 改行 | |
h2 | 見出し | 改行 | |
h3 | 見出し | 改行 | |
h4 | 見出し | 改行 | |
h5 | 見出し | 改行 | |
h6 | 見出し | 改行 |
ルーティング設定
メールルーティングの追加設定(ルーティング先の指定および送信元の指定)を実施したい場合は、以下のルーティング設定の属性を記述します。
パラメータを記載しない場合、省略値が設定されます。
属性 | 説明 | 省略可否 | 省略値 |
---|---|---|---|
successRouting | メールサービス受信時、処理が成功した場合のルーティング先を指定します。 複数のアドレスを指定する場合は、「;」区切りで指定します。 | ○ | なし |
errorRouting | メールサービス受信時、処理が失敗した場合のルーティング先を指定します。 複数のアドレスを指定する場合は、「;」区切りで指定します。 | ○ | @mail(送信元) |
routingFrom | メールサービスの受信時、ルーティング先に送るメールの送信元を指定します。 例:routingFrom=zzzz@unirita.co.jp 組織のアドレスとして登録されているアドレスのみ指定可能です。 | 〇 | メールサービスアドレスで指定した「コンテキストユーザ」※1 |
活動履歴情報登録セクション
メール送信によって作成される活動履歴内容を変更したい場合は、以下の活動履歴情報登録セクションの属性を記述します。
このセクションでの指定を省略した場合は、標準の内容で活動履歴が登録されます。
属性 | 説明 | 特記事項 |
---|---|---|
[ACTIVITY] | 活動履歴の登録内容を更新したい場合に指定します。 | 省略可能です。 |
ToDo項目のAPI参照名 | 登録したい項目のAPI参照名をパラメータ名とし、値を設定します。 API参照名が不正な場合、メール連携処理が失敗します。 値の設定に、変数を利用できます。変数を利用する場合は、「:変数名」の形式で設定してください。 以下の項目は指定できません。
|
|
targetMailBody | 更新する対象を特定するためのレコード番号を、メールの「件名」ではなく、メールの「本文」から取得する場合に指定します。 例:targetMailBody=ON この値がONの時は、件名にレコード番号が指定されていても無視します。 | 省略可能です。 省略時値はOFF。 |
targetSearchUpToDown | 更新する対象を特定するためのレコード番号をメール本文から取得するときに、本文の先頭から検索するかどうかを指定します。 ・ON:レコード番号をメール本文の上から下の方に向かって検索して、最初に見つかったものを選択します。 ・OFF:レコード番号をメール本文の下から上の方に向かって検索します、最初に見つかったものを選択します。 例:targetSearchUpToDown=ON この設定は、targetMailBodyがON以外のときは無効です。 | 省略可能です。 省略時値はON。 |
変数定義セクション
複数の項目に同じ値を使用したい場合や、レコード更新セクションにて、レコードの条件を指定する場合に、以下の変数定義セクションの属性を記述します。
変数を使用しない場合、このセクションは省略可能です。
属性 | 説明 | 特記事項 |
---|---|---|
[VARIABLE] | 複数の項目に同じ値を使用したい場合や、レコード更新セクションにて、レコードの条件を指定する場合に指定します。 | 省略可能です。 |
変数名 | 変数名をパラメータ名として、値を設定します。 例: VARSUBJECT=@SUBJECT
|
|
レコード更新セクション
以下のような場合に、本セクションの属性を記述します。
インシデント管理に関するメールの受信によって、別のオブジェクトのレコードを更新したい場合。
メールの受信によって、複数のレコードを更新したい場合。
属性 | 説明 | 特記事項 |
---|---|---|
[UPDATEXXXX] | 特定のレコードを更新したい場合に指定します。 | 省略可能です。 |
EXECUTE | 該当のレコード更新セクションを利用するかどうかを、数式形式で指定します。 |
|
TARGET | レコード更新セクションに必ず指定します。 更新したいレコードの項目、および条件を、SOQL形式で指定します。 値の設定に、変数を利用できます。変数を利用する場合は、「:変数名」の形式で設定してください。 例:活動履歴情報を登録せず、イベント管理レコードを更新する時
例:イベント管理レコードに関連するインシデント管理レコードを、すべて更新する時 |
|
更新対象オブジェクトの項目のAPI参照名 | 更新する項目のAPI参照名をパラメータ名とし、値を設定します。 API参照名が不正な場合、メール連携処理が失敗します。 値の設定に、変数を利用できます。変数を利用する場合は、「:変数名」の形式で設定してください。 例: ox_ltx_content__c=@body |
|
定義例
#メール承認設定セクション
delimiter=
approvalMail=_FALSE
approvalkeyLine=#1
commentkeyLine=#3
quote=>,:,|
attachment=PARENT
#レコード新規登録設定
object=ox_obj_incident__c
ox_txt_subject__c=@subject
ox_ltx_content__c=@body
ox_ref_customerInfo__c=&Contact(Email,@MAIL, ID )
ox_sel_inquiry__c=$メール
#入力値の切り捨て設定
fieldTruncation=ON
#メール処理形式設定
receiveTEXT=ON
receiveHTML=ON
#HTMLメール解析設定
div_start=・
div_end=。
#ルーティング設定
successRouting=zzzz@unirita.co.jp
errorRouting=@mail
#活動履歴情報登録セクション
#[ACTIVITY]
#sample_addText__c=@subject
#sample_addBody__c=@body
#変数定義セクション
#[VARIABLE]
#SUBJECT=@subject
#MAIL=@MAIL
#CONTACTID=&Contact(Email,@MAIL, ID )
#INCID=&ox_obj_incident__c(Name,?([,:,@subject), ID )
#レコード更新セクション01
#[UPDATE01]
#EXECUTE=TRUE
#TARGET=SELECT ID,ox_ltx_content__c FROM ox_obj_incident__c WHERE ID = ':INCID'
#ox_ltx_content__c=@body
#レコード更新セクション02
#[UPDATE02]
#EXECUTE=TRUE
#TARGET=SELECT ID,ox_ltx_content__c FROM ox_obj_change__c WHERE ox_ref_incNumber__c = ':INCID'
#ox_ltx_content__c=@body
メール連携設定ファイルの評価の流れ
メール連携設定ファイルの評価の流れを、以下に説明します。
1.基本的な設定の評価
a.メール承認設定の評価
b.ルーティング設定の評価
c.メール処理形式設定の評価
d.HTMLメール解析設定の評価
e.入力値の切り捨て設定の評価
2.変数定義セクションの評価
以降の処理で使用する、変数を評価します。
3.レコード更新セクションの評価
レコード更新セクションが初めに評価されます。
更新対象レコードが存在しない場合は、次の評価に移ります。
4.レコードの新規登録、または活動履歴情報の登録
メールの件名を評価して、レコードを新規登録するか、活動履歴情報を登録するかが評価されます。
評価後、該当のセクションの内容が評価されて、処理が実施されます。
a.レコード新規登録設定の評価
レコード新規登録設定の内容に従って、レコードが登録されます。
b.活動履歴情報登録セクションの評価
活動履歴情報登録セクションの内容に従って、活動履歴情報が主レコードに関連付けて登録されます。
注意事項
必ずUTF-8形式で保存してください。UTF-8形式以外の文字コードで保存した場合、正しく設定されないことがあります。
パラメータを省略する場合には、属性を削除するか値を空白にします。
レコード更新セクションによってレコードが更新された場合、メールの対となるレコード(メールを受信したことの証跡)がいずれのレコードにも残りません。
参考情報
電子メールからのデータ登録機能を利用する設定については、「電子メールからのデータ登録の利用」を参照してください。
Salesforce Filesを組織で利用する場合の操作の詳細は「Salesforce Filesを利用する」を参照してください。
本設定ファイルはLMIS画面から設定の作成・変更・削除が可能です。操作方法については、「メール受信機能の設定」を参照してください。