EXM 構成設定

概要

設定ファイルで使用可能なデフォルトの EXM 設定の概要。

Email Experience Manager (EXM) を設定し、EXM に付属のデフォルト設定を変更するには、\App_Config\Sitecore\EmailExperience\. にある Content Management および Content Delivery インスタンスに関する EXM 設定ファイルを編集します。どのファイルでも、設定は <sitecore>/<settings> セクションにあります。

EXM は、メール メッセージをレンダリングするときに、exm サイトを使用します。デフォルトでは、exm サイトは、shell Web サイトのすべてのプロパティを継承しますが、cacheHtml='true' は例外であり、コンポーネントのキャッシュ設定が尊重されます。他のサイトと同じように設定を調整できます。これに関するドキュメントは、Sitecore.config ファイルにあります。

Sitecore.EmailExperience.ContentManagement.config ファイルには、以下の設定が含まれています。

設定

デフォルト値

説明

EXM.CheckMtaConnection

true

ディスパッチを開始する前にメッセージ転送エージェント (MTA) 接続をテストする場合は、true に設定します。

DispatchEnqueueBatchSize

300

ディスパッチ キューに追加される各バッチの受信者の数を指定します。

DispatchEnqueueThreadsNumber

4

ディスパッチ キューに受信者バッチを追加する必要があるスレッドの数を指定します。

EXM.AttachmentTotalSizeInBytes

7340032

メッセージのすべての添付ファイルの最大サイズをバイト単位で指定します。デフォルト値は 7340032 です。

EXM.CheckRecipientListsStatus

true

メール キャンペーンがディスパッチされる前に、コンタクトの予想数と実際の数が一致するかどうかを確認するには、true に設定します。この設定は、リスト ロックが無効になっている場合にのみ、有効にする必要があります。

EXM.CheckSuppressionList

true

メール メッセージを Email Cloud に送信してから受信者に送信する前に、EXM で EXM サプレッション リストをチェックする場合は、true に設定します。

メール キャンペーンに含まれる受信者ごとに最初のサプレッション リストのチェックを Email Cloud で実行する場合は、false に設定します。

この設定の値に関係なく、Email Cloud のサプレッション リストにあるコンタクトは、EXM からメール メッセージを受信しません。この設定の詳細については、「サプレッション リストを管理する」を参照してください。

EXM.DispatchBatchSize

100

各ディスパッチ スレッドで一度に処理するコンタクトの数を指定します。

EXM.EmailTestDefinitionPath

/sitecore/system/Marketing 

Control Panel/Test Lab/Emails

メール テスト定義のパスを指定します。

EXM.TasksPath

/sitecore/system/Settings/

Email/Tasks

EXM タスクを配置する場所のパスを指定します。

MaxGenerationThreads

8

メール メッセージを生成して個々の受信者に送信するために同時に実行するディスパッチ タスクの最大数を指定します。

この値を下げると、ディスパッチ中のサーバーの負荷を減らすことができます。たとえば、NumberThreads 設定と MaxGenerationThreads 設定の両方に 16 を指定した場合、16 個のディスパッチ タスクが同時に処理されます。MaxGenerationThreads 設定に 8 を指定し、NumberThreads 設定に 16 を指定した場合、8 つのディスパッチ タスクのみが同時に処理されます。他の 8 つのタスクはブロックされ、処理されるのを待ちます。

値は、NumberThreads 設定に指定された値以下でなければなりません。より高い値を指定しても、効果はありません。

注記

NumberThreads 設定と MaxGenerationThreads 設定の両方に高い値を指定した場合、メール キャンペーンのディスパッチ速度が向上しますが、CPU の負荷も高くなります。

MtaEmulation.Active

false

MTA エミュレーション モードを有効にするには、true に設定します。

MtaEmulation.MinSendTime

200

単一のメールの送信をエミュレートするために費やす最小時間をミリ秒単位で指定します。これを MtaEmulation.MaxSendTime と組み合わせて使用して、Sitecore XP から MTA へのラウンドトリップ時間の動作を模倣します。

MtaEmulation.MaxSendTime

400

単一のメールの送信をエミュレートするために費やす最大時間をミリ秒単位で指定します。

MtaEmulation.FailProbability

0.01

エミュレーションへの接続失敗の確率を指定します。

NumberThreads

16

ディスパッチ時に使用するスレッドの数を指定します。各スレッドは、コンタクトへのメール キャンペーンの送信を担当するディスパッチ タスクを作成します。

この数は、exm/eds/connectionPoolSettings/maxPoolSize setting に等しくなければなりません。

ResetTimeout

3600

モジュールが自動メッセージを失敗とみなして再送信を試みるまでの期間を秒単位で指定します。

StandardMessages.DefaultGlobalOptOutList

共通のグローバル オプトアウト リスト。

新しいマネージャー ルートに使用する必要があるデフォルトのグローバル オプトアウト コンタクト リストのパスを指定します。

StandardMessages. SubscriptionConfirmation

<アイテムの相対パス>

コンタクトがメーリング リストに登録した後に受信するメッセージのパスを指定します。このメッセージには、サブスクリプション確認リンクが含まれています。

StandardMessages. SubscriptionNotification

<アイテムの相対パス>

コンタクトがサブスクリプション確認メッセージ内の確認リンクをクリックした後に受信するメッセージのパスを指定します。

StandardMessages. UnsubscribeNotification

<アイテムの相対パス>

コンタクトがメーリング リストからオプトアウトした後に受信するメッセージのパスを指定します。

StandardMessages.UnsubscribeFromAllNotification

<アイテムの相対パス>

コンタクトがすべてのメーリング リストからオプトアウトした後に受信するメッセージのパスを指定します。

StandardMessages.DispatchCompleted

<アイテムの相対パス>

ディスパッチ プロセスの終了時に、[ディスパッチ プロセスの通知] セクションで指定されたメール アドレスに送信する必要があるメッセージのパスを指定します。

StandardMessages.TriggeredNotification

<アイテムの相対パス>

自動メッセージのアクティベーション ステータス メッセージのパスを指定します。

Sitecore.EmailExperience.ContentDelivery.config ファイルには、以下の設定が含まれています。

設定

説明

EXM.OpenAndClickCache

1MB

重複したオープンとクリックを追跡するために使用されるキャッシュ サイズを指定します。

TrackerXConnectFacetsFacetName

XConnectFacets

使用するトラッカー ファセットの名前。

Sitecore.EmailExperience.Core.config ファイルには、以下の設定が含まれています。

設定

説明

CampaignClassification.Channel

{DDAFB85B-1511-48B8-9374-2A8A1F371645}

新しいメール キャンペーンを作成するときにメール キャンペーン アイテムに追加するチャネル ID を指定します。チャネル ID は、受信者がメッセージ内のリンクをクリックしたときにメール キャンペーンを追跡するために使用されます。

DispatchUserAgent

ECM Dispatch

ディスパッチ プロセスでメール メッセージをレンダリングするためのページを要求するために使用する UserAgent の名前を指定します。

EXM.DefaultEventSiteName

exm

送信済みのメッセージ不達メッセージなどのメール イベントをエクスペリエンス アナリティクスに関連付ける Web サイトの名前を指定します。

EXM.DuplicateProtectionInterval

300

同じメッセージとコンタクトに関連する 2 つのメール イベントについて、重複イベントとみなされるイベント間の最大間隔 (秒単位) を指定します。この時間枠内に 2 つのイベントが発生した場合、最初のメール イベントのみが保存されます。

この値は秒単位で指定されます。

EXM.Enabled

true

EXM を無効にするには、false に設定します。

EXM.IncludePIIinLogFiles

false

PII 機密データを EXM によってログに記録する場合は、値を true に変更します。

EXM.OpenHandlerPath

/sitecore%20modules/Web/EXM/

RegisterEmailOpened.ashx

メール開封イベントを処理するハンドラーのパスを指定します。

EXM.EmailValidationRegex

有効な正規表現

メール検証のために作成して使用する正規表現検証クラスを指定します。

EXM.RendererUrl

有効な URL

メール メッセージをプレビューしたり、受信者に送信したりするときに、メッセージ ソースをダウンロードするために使用するホスト名を指定します。

この値を指定しなかった場合、EXM が最初のリクエストを Sitecore に送信するときに、RendererUrl にはサーバーの URL が入力されます。値はデフォルトでは空です。

IIS.Password

12345

匿名アクセスが無効になっている場合にログインできるパスワードを指定します。

IIS.User

serviceuser

匿名アクセスが無効になっている場合にログインできるユーザー名を指定します。

MaxMessageFolderSize

50

EXM が 1 つのフォルダーに作成できるメッセージまたはメッセージ関連キャンペーン、テストなどの最大数を指定します。この数より多くのメッセージがある場合、新しいフォルダーが作成されます。

PhoneFieldName

電話番号

Sitecore ユーザー プロファイルのコンタクト電話番号を指定します。対応するフィールドが Sitecore XP のデフォルト ユーザー プロファイルに存在しないため、このプロパティは Sitecore.EmailExperience.Core.config に追加されました。カスタム ユーザー プロファイルにすでに電話番号フィールドがある場合は、この設定の値を変更する必要があります。

QueryStringKey.AnalyticsContactId

ec_contact_id

メッセージを生成するためのクエリ文字列を構築するためにモジュールによって使用されます。

QueryStringKey.EcmId

ec_id

QueryStringKey.Recipient

ec_recipient

QueryStringKey.Subscription

ec_subscr

QueryStringKey.MessageId

ec_message_id

QueryStringKey.Campaign

ec_camp

クエリ文字列でメール キャンペーンを識別するためのキーを指定します。

QueryStringKey.ContactIdentifierSource

ex_id_s

クエリ文字列でコンタクト識別子ソースのキーを指定します。

QueryStringKey.ContactIdentifierIdentifier

ex_id_i

クエリ文字列でコンタクト識別子のキーを指定します。

QueryStringKey.EmailHistoryEntryId

ec_emailid

クエリ文字列でメール履歴エントリ ID を識別するためのキーを指定します。

QueryStringKey.ec_lang

ec_lang

クエリ文字列でターゲット言語を識別するためのキーを指定します。

QueryStringKey.ec_tvi

ec_tvi

クエリ文字列でテスト バリュー インデックスを識別するためのキーを指定します。

QueryStringKey.ExmEncryptedQuery

ec_eq

モジュールのページ要求を識別するためのキーを指定します。

EXM.MessageBodyMaxCacheSize

5MB

メッセージ本文キャッシュのサイズを指定します。

QueryStringKey.OnlineVersionQueryStringKey

sc_pd_view

メール メッセージのオンライン バージョンに使用するキーを指定します。

QueryStringKey.RedirectUrl

ec_url

リダイレクト要求でターゲット URL を識別するためのキーを指定します。

EXM.UrlValidationRegex

有効な正規表現

URL 検証のために作成して使用する正規表現検証クラスを指定します。

EXM.UseContextContentLanguage

false

Marketing Operations API に Context.ContentLanguage.Name 設定を使用するには、値を true に変更します。

Sitecore.ExM.Framework.config ファイルには、以下の設定が含まれています。

設定

説明

EXM.Debug

false

Sitecore ログ ファイルで詳細ログを有効にするには、これを true に設定します。EXM 問題のトラブルシューティングに使用します。

Sitecore.EDS.Core.config ファイルには、以下の EXM 固有の設定が含まれています。

設定

デフォルト

説明

EXM.DispatchProvider.MessagesPerConnection

10000

1 回の接続で送信できるメッセージの最大数を指定します。

EDS.Core.Net.Smtp.Send.Retryer

最大 10 回の試行

EXM は、このエクスポネンシャル バックオフ リトライ手法を使用して、SMTP 経由でメッセージを送信します。このリトライ手法を設定する方法の詳細については、「EXM リトライ手法の設定」を参照してください。

EDS.Core.Net.Smtp.ValidateConnection.Retryer

3 回の再試行

EXM は、このリトライ手法を使用して、接続プールから SMTP 接続を取得して検証します。

Sitecore.EDS.Providers.CustomSmtp.config ファイルには、以下の設定が含まれています。

要素

設定

説明

proxySettings

enabled

プロキシ サーバー経由で SMTP サーバーに要求するには、true に設定します。

hostName

プロキシ サーバーの IP アドレスまたは DNS 名を指定します。

authMethod

プロキシ サーバーの HTTP 認証方法を指定します。有効な値は Basic および NTLM です。

password

プロキシ サーバーにログインするときに使用するパスワードを指定します。SOCKS4 プロキシ タイプの場合、この値は無視されます。

username

プロキシ サーバーにログインするときに使用するユーザー名を指定します。

port

プロキシ サーバーのポートを指定します。

connectionType

プロキシ サーバーのタイプを指定します。有効な値は次のとおりです。

  • None

  • HTTP

  • SOCKS4

  • SOCKS5

smtpSettings

server

SMTP サーバーのアドレスまたは IP アドレスを指定します。

port

SMTP サーバーのポート番号を指定します。

loginDomain

SMTP サーバーにログインするときに使用するドメインを指定します。

userName

SMTP サーバーにログインするときに使用するユーザー名を指定します。

password

SMTP サーバーにアクセスするためのパスワードを指定します。

authenticationMethod

SMTP 認証方式を指定します。有効な値は次のとおりです。

  • NONE

  • LOGIN

  • PLAIN

  • CRAMMD5

  • NTLM

startTls

メールを認証して送信する前に SSL/TLS 接続の使用を有効にするには、true に設定します。

proxySetting

プロキシ サーバー経由で SMTP サーバーに要求するためのプロキシ設定を指定します。

connectionPoolSettings

maxPoolSize

接続プールに作成できる接続数を指定します。

この数は、Sitecore.EmailExperience.ContentManagement.config ファイルの NumberThreads 設定に等しくなければなりません。

maxConnectionRetries

プールから接続を取得するために許可される最大再試行回数を指定します。

指定された再試行回数内に接続が取得されない場合、接続タイムアウト例外がログ ファイルに記録されます。

maxConnectionIdleTime

接続がプールから削除されるまでの最後の接続使用からの時間を指定します。

maxConnectionWaitTime

前回の試行が失敗した場合に、接続プールが特定の接続の取得に費やす最大時間を指定します。

接続プールが指定された時間を超えると、接続タイムアウト例外がログ ファイルに記録されます。

delayBetweenConnectionRetries

接続プールが接続の取得を再試行するまでの遅延時間を指定します。

Sitecore.EDS.Providers.CustomSmtp.Sync.config ファイルには、以下の設定が含まれています。

要素

設定

説明

pop3Setting

server

POP3 サーバーの IP アドレスまたは DNS 名を指定します。

port

POP3 サーバーのポートを指定します。

userName

POP3 サーバーにログインするときに使用するユーザー名を指定します。

password

POP3 サーバーにログインするときに使用するパスワードを指定します。

useSsl

POP3 サーバーでメッセージの送信に SSL を使用する場合は、true に設定します。

startTls

バウンスを認証および取得する前に TLS 接続を使用するには、true に設定します。

proxySettings

プロキシ サーバー経由で POP3 サーバーに要求するためのプロキシ設定を指定します。

receiversCollection

settings

POP3 設定コレクションを指定します。

bounceInspector

メッセージ MIME をバウンスとして検証し、バウンスのタイプを決定するインスペクターを指定します。

environmentIdentifier

Sitecore インスタンスを識別するために使用する環境識別子を指定します。

Scheduling

agent

POP3 バウンスを同期するエージェントを指定します。

method

実行する必要のあるエージェント クラスのメソッド名を指定します。

interval

エージェントを実行する間隔を TimeSpan として指定します。

receviersCollection

バウンス コレクションに複数の Pop3 アカウントを提供することにより、受信者コレクションを指定します。