IM-Mail for Accel Platform / セットアップガイド 第3版 2014-04-01

5.2.1. 接続設定

5.2.1.1. 概要

im-mail-config.xml では、以下の機能についての IM-Mail(メールサービス部分)との接続設定を行います。
設定する値については、IM-Mail(メールサービス部分)の開通情報を参照して下さい。
  1. アカウント連携
  2. IM-Mail(メールサービス部分)とのシングルサインオン
  3. 未読ポートレット
フォーマットファイル(xsd) WEB-INF/schema/im-mail-config.xsd
設定場所 %PUBLIC_STORAGE_PATH%/products/im_mail/conf/im-mail-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<im-mail-config xmlns="http://intra-mart.co.jp/product/im-mail/config/im-mail-config"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
  <domains>
    <auto-sync-disabled>true</auto-sync-disabled>
    <domain name="sample.intra-mart.jp">
      <attestation-key>123456789abcdefghiABCDEFGHI</attestation-key>
      <preauth-url>https://xxxxxxxxxx/service/preauth</preauth-url>
      <preauth-key>123456789123456789abcdefghiabcdefghiABCDEFGHIABCDEFGHI</preauth-key>
      <imap-host>xxxxx.xxx</imap-host>
      <imap-port>993</imap-port>
      <imap-ssl>true</imap-ssl>
    </domain>
  </domains>
</im-mail-config>

5.2.1.2. リファレンス

5.2.1.2.1. 自動同期無効化設定

タグ名 auto-sync-disabled
アカウント連携による自動同期を無効にします。
この設定によって、ユーザ情報を更新した時の伝搬、リスナによる同期処理を抑止することができます。

注意

この設定の目的は、ユーザ情報を更新する時のパフォーマンス劣化を防ぐことです。
そのため、IM-Mail 個人設定画面や、ジョブによる同期処理には影響しません。

注意

この設定は、全てのドメインに適用されます。

【設定項目】

<domains>
  ・・・・・
  <auto-sync-disabled>true</auto-sync-disabled>
  ・・・・・
</domains>

必須項目 ×
複数設定 ×
設定値・設定する内容 自動同期を無効にする場合は true、有効にする場合は false を設定します。
単位・型 真偽値 (true/false)
省略時のデフォルト値 false
親タグ domains

5.2.1.2.2. ドメイン設定

タグ名 domain
IM-Mail 用のドメインを設定します。

【設定項目】

<domains>
  ・・・・・
  <domain name="sample.intra-mart.jp">
    ・・・・・
  </domain>
</domains>

必須項目
複数設定
設定値・設定する内容 ドメインを設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ domains

【属性】

属性名 説明 必須 デフォルト値
name ドメイン名を設定します。 なし

5.2.1.2.3. プロビジョング連携 API 用共通鍵

タグ名 attestation-key
プロビジョニング連携 API が同期処理で使用する共通鍵を設定します。
設定値は、メールサービスコントロールパネルの「ドメイン管理」-「検索」-「ドメイン情報」-「アカウント連携サービス情報」より確認することができます。
../../../../_images/mail_service_control_panel_1.png

【設定項目】

<domain name="sample.intra-mart.jp">
  ・・・・・
  <attestation-key>123456789abcdefghiABCDEFGHI</attestation-key>
  ・・・・・
</domain>

必須項目
複数設定 ×
設定値・設定する内容 プロビジョニング連携 API 用共通鍵を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ domain

5.2.1.2.4. PreAuth 共通 URL

タグ名 preauth-url
シングルサインオンで使用する PreAuth 共通 URL を設定します。

【設定項目】

<domain name="sample.intra-mart.jp">
  ・・・・・
  <preauth-url>https://xxxxxxxxxx/service/preauth</preauth-url>
  ・・・・・
</domain>

必須項目
複数設定 ×
設定値・設定する内容 PreAuth 共通 URL を設定します。 「https://xxxxxxxxxx/」の部分は、IM-Mail(メールサービス部分)開通情報の「WEBメールアクセス用URL」が相当します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ domain

5.2.1.2.5. PreAuth 共通鍵

タグ名 preauth-key
シングルサインオンで使用する PreAuth 共通鍵を設定します。
設定値は、メールサービスコントロールパネルの「ドメイン管理」-「検索」-「ドメイン情報」-「シングルサインオン連携サービス情報」より確認することができます。
../../../../_images/mail_service_control_panel_2.png

【設定項目】

<domain name="sample.intra-mart.jp">
  ・・・・・
  <preauth-key>123456789123456789abcdefghiabcdefghiABCDEFGHIABCDEFGHI</preauth-key>
  ・・・・・
</domain>

必須項目
複数設定 ×
設定値・設定する内容 PreAuth 共通鍵を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ domain

5.2.1.2.6. 未読ポートレット IMAP サーバ・IP アドレス/ホスト名

タグ名 imap-host
未読ポートレットで参照する IMAP サーバの IP アドレスまたはホスト名を設定します。

【設定項目】

<domain name="sample.intra-mart.jp">
  ・・・・・
  <imap-host>xxxxx.xxx</imap-host>
  ・・・・・
</domain>

必須項目
複数設定 ×
設定値・設定する内容 IMAP サーバの IP アドレス/ホスト名を設定します。 設定値は、IM-Mail(メールサービス部分)開通情報のPOP3(S)、SMTP(S)用ホスト名になります。
単位・型 文字列
省略時のデフォルト値 なし
親タグ domain

5.2.1.2.7. 未読ポートレット IMAP サーバ・ポート番号

タグ名 imap-port
未読ポートレットで参照する IMAP サーバのポート番号を設定します。

【設定項目】

<domain name="sample.intra-mart.jp">
  ・・・・・
  <imap-port>993</imap-port>
  ・・・・・
</domain>

必須項目
複数設定 ×
設定値・設定する内容 IMAP サーバのポート番号を設定します。通常は「993」です。
単位・型 数値
省略時のデフォルト値 なし
親タグ domain

5.2.1.2.8. 未読ポートレット IMAP サーバ・SSL 設定

タグ名 imap-ssl
未読ポートレットで参照する IMAP サーバに SSL 接続するかどうかを設定します。

【設定項目】

<domain name="sample.intra-mart.jp">
  ・・・・・
  <imap-ssl>true</imap-ssl>
  ・・・・・
</domain>

必須項目
複数設定 ×
設定値・設定する内容 IMAP サーバに SSL で接続するかどうかを設定します。
単位・型 真偽値 (true/false)
省略時のデフォルト値 なし
親タグ domain