E-mail Router 構成ファイルのカスタマイズ

こんにちは。 今回はよくお問い合わせのある　E-mail Router の構成ファイル についてご紹介します。

Microsoft.Crm.Tools.EmailAgent.xml の保存場所

E-mail Router をインストールして使用する場合、E-mail Router の構成ファイルである Microsoft.Crm.Tools.EmailAgent.xml は、E-mail Router がインストールされているサーバーの以下のパス(既定)に保存されています。

Microsoft.Crm.Tools.EmailAgent.xml は、以下の E-mail Router 構成マネージャにて E-mail Router の構成時に生成される XML ファイルです。

 この構成ファイルを編集することにより、詳細設定をカスタマイズできます。
例えば、送信メールのフォーマット (既定は Utf-8) を変更することができます。
その他色々な設定をカスタマイズ可能ですので、以下に、E-mail Router の構成ファイル内に定義されている各タグについてご紹介します。

 Microsoft.Crm.Tools.EmailAgent.xml 内における定義内容

本ファイルは E-mail Router を実行するためのシステム構成とプロバイダ構成の定義を含みます。プロバイダ構成には、全プロバイダに共通の設定と各プロバイダに特有の設定があります。

以下の項目ごとに各定義の説明を記載します。 

1. システム構成
2. プロバイダ構成 (共通)
2-1. Outboundプロバイダ構成
2-2. Inboundプロバイダ構成

 注意 : 構成ファイル内に指定してある時間は、ミリセカンド単位となります。(1000 ミリセカンド = 1 秒)

各詳細は以下になります。

 1. システム構成

システム構成では、E-mail Router の基本設定を指定します。各タグの詳細は以下になります。

[補足]
E-mail Router のログは、アプリケーション イベントログに出力されます。
E-mail Router ログの設定については、以下のサポート技術情報 907490 をご参照ください。

タイトル : Microsoft Dynamics CRM でトレース機能を有効にする方法
URL : https://support.microsoft.com/kb/907490/ja-jp
セクション : Microsoft Dynamics CRM 4.0 E-mail Router

 システム構成指定箇所のサンプル XML

<SystemConfiguration>
　<MaxThreads>50</MaxThreads>
　<MaxThreadExecution>600000</MaxThreadExecution>
　<SchedulingPeriod>1000</SchedulingPeriod>
　<ConfigRefreshPeriod>5000</ConfigRefreshPeriod>
　<ConfigUpdatePeriod>300000</ConfigUpdatePeriod>
　<LogLevel>1</LogLevel>
</SystemConfiguration>

2. プロバイダ構成 (共通)

プロバイダには Outbound (送信用) と Inbound (受信用) の 2 種類があり、両プロバイダに共通の設定と各プロバイダに個別の設定があります。まずは、両プロバイダに共通の設定からご紹介します。

次に Outbound と Inbound の各プロバイダに個別の設定項目について以下にご紹介します。 

2-1. Outboundプロバイダ構成

Outbound プロバイダは、CRM からメールを送信するために使用します。 送信 E-mail Router で使用できる唯一の既定 Outbound プロバイダは SmtpPollingSendEmailProvider です。SMTP Outbound プロバイダは、指定のユーザーとキューの送信待ちのメールをダウンロードして、ローカルまたは指定された SMTP のスタックからメールを送信します。

Outbound プロバイダ用の設定項目は以下になります。

Outbound プロバイダ 指定箇所の サンプル XML

<ProviderConfiguration deploymentId="fd880e79-6f1b-4e40-aa05-628b845653fb">
   <ProviderAssembly>Microsoft.Crm.Tools.EmailProviders.dll</ProviderAssembly>
   <ProviderClass>
      Microsoft.Crm.Tools.Email.Providers.SmtpPollingSendEmailProvider
   </ProviderClass>
   <CrmServerUrl>https://ServerName/OrganizationName</CrmServerUrl>
   <CrmAuthMode>WindowsAuthentication</CrmAuthMode>
   <CrmUser>domainName\administrator</CrmUser>
   <CrmPassword>
      {2A48C4DB-F2BF-48DF-A8EF-20F531EA9BAA}:jEPrLEnKMdMI+jgjIAabJg==@0HlCR312abwYDupnkrAi8A==
   </CrmPassword>
   <EmailServer>EmailServerName</EmailServer>
   <EmailAuthMode>WindowsAuthentication</EmailAuthMode>
   <UserId>9e80ac64-c82d-dd11-8246-0013720ec2db</UserId>
   <UserId>17d87ab0-c62d-dd11-8726-0013720ec2db</UserId>
   <Target>EmailServerName</Target>
   <Direction>Outbound</Direction>
   <LogLevel>1</LogLevel>
   <CacheCapacity>1024</CacheCapacity>
   <ConnectionTimeout>300000</ConnectionTimeout>
   <PollingPeriod>60000</PollingPeriod>
   <MaxMessageCount>1000</MaxMessageCount>
   <EmailPort>25</EmailPort>
   <EmailUseSsl>false</EmailUseSsl>
   <DeliveryMethod>Network</DeliveryMethod>
   <PendingStatusDelay>30000</PendingStatusDelay>
   <SendingStatusDelay>60000</SendingStatusDelay>
   <CodePage>Utf-8</CodePage>
   <MaximumDeliveryAttempts>10</MaximumDeliveryAttempts>
   <BatchSize>5</BatchSize>
   <RequestBatchSize>5</RequestBatchSize>
</ProviderConfiguration>

2-2. Inboundプロバイダ構成

Inbound プロバイダは、CRM にメールを受信するために使用します。

CRM 4.0 E-mail Router は 2 つの Inbound プロバイダ (Exchange と POP3) を提供します。この 2 つは、メールボックスに接続するために使用されるプロトコルに基づいています。その他に、転送または転送メールボックスのメールを処理する Inbound メールボックス プロバイダもあります。

Inbound プロバイダに固有の設定項目は以下になります。

Inbound プロバイダ 指定箇所の サンプル XML

<ProviderConfiguration deploymentId="fd880e79-6f1b-4e40-aa05-628b845653fb">
   <ProviderAssembly>Microsoft.Crm.Tools.EmailProviders.dll</ProviderAssembly>
   <ProviderClass>
      Microsoft.Crm.Tools.Email.Providers.ExchangePollingMailboxProvider
   </ProviderClass>
   <CrmServerUrl>https://serverName/OrganizationName</CrmServerUrl >
   <CrmAuthMode>WindowsAuthentication</CrmAuthMode>
   <CrmUser>domainName\Administrator</CrmUser>
   <CrmPassword>
      {2A48C4DB-F2BF-48DF-A8EF-20F531EA9BAA}:jEPrLEnKMdMI+jgjIAabJg==@0HlCR312abwYDupnkrAi8A==
   </CrmPassword>
   <EmailServer>https://emailServerName</EmailServer>
   <EmailAuthMode>WindowsAuthentication</EmailAuthMode>
   <EmailUser>domainName\administrator</EmailUser>
   <EmailPassword>
   {2A48C4DB-F2BF-48DF-A8EF-20F531EA9BAA}:edkflQCsqYuDjLgtvCezJg==@x3JEvQyWBlCakbJGzbgv6w==
   </EmailPassword>
   <EmailAddress>Administrator@microsoft.com</EmailAddress>
   <Target>First name Last name</Target>
   <Direction>Inbound</Direction>
   <LogLevel>1</LogLevel>
   <CacheCapacity>1024</CacheCapacity>
   <IsForwardMailbox>false</IsForwardMailbox>
   <DeleteEmails>false</DeleteEmails>
   <ConnectionTimeout>300000</ConnectionTimeout>
   <PollingPeriod>60000</PollingPeriod>
   <MaxMessageCount>1000</MaxMessageCount>
   <MessageExpiry>86400000</MessageExpiry>
   <EmailPort>80</EmailPort>
   <MoveEmails>true</MoveEmails>
</ProviderConfiguration>

以上、E-mail Router 構成のカスタマイズ時にご参照ください！

- Dynamics CRM サポート   矢野 時枝

[情報元]

タイトル : Email router configuration XML file explained
URL : https://blogs.msdn.com/crm/archive/2008/07/02/email-router-configuration-xml-file-explained.aspx

CRM SDK (英語)

　　　CRM 4.0 ソフトウェア開発キットは以下よりダウンロードできます。

　　　タイトル : Microsoft Dynamics CRM 4.0 ソフトウェア開発キット
　　　URL : https://www.microsoft.com/downloads/details.aspx?displaylang=ja&FamilyID=82e632a7-faf9-41e0-8ec1-a2662aae9dfb

　     CrmSdk4.exe を展開後、crmsdk4.chm を開くと [Microsoft Dynamics CRM SDK] のヘルプ ファイルが開きます。[System Configuration Settings] と [Provider Configuration Settings] のキーワードで検索すると、本内容でご紹介した各タグの説明のページが表示されます。