Managing the Instant Messaging Email Archive

You can use Instant Messaging to archive poll, chat, conference, news channel, and alert content and email that content to end-users and administrators. You can use any email client to search and manage the archived content. This section describes the Instant Messaging email archive in the following sections:

• Enabling and Disabling the Instant Messaging Email Archive Provider

• Configuring Email Archive Settings

• Email Header Format

The Instant Messaging server caches archived records until they are emailed. If you enable email archiving, the memory requirements for the server increase. See the Sun Java Communications Suite 5 Deployment Planning Guide for information on performance tuning.

Enabling and Disabling the Instant Messaging Email Archive Provider

You enable or disable the email archive provider by modifying a parameter value in iim.conf.

To Enable the Instant Messaging Email Archive

Before You Begin

Ensure that you have enabled archiving for Instant Messaging as described in To Enable Instant Messaging Archiving.

1. Open iim.conf.

   See iim.conf File Syntax for more information.

2. Add the following line to iim.conf if it does not already exist.

   iim_server.msg_archive.provider = com.iplanet.im.server.EmailIMArchive

   The iim_server.msg_archive.provider parameter contains a comma-separated list of archive providers. If you want to enable the Portal archive in addition to the email archive for example, the parameter and its value should be entered as follows:

   iim_server.msg_archive.provider = com.iplanet.im.server.IMPSArchive, \ com.iplanet.im.server.EmailIMArchive

3. Save and close iim.conf.

4. Refresh the Instant Messaging server configuration.

   imadmin refresh

To Disable the Instant Messaging Email Archive Provider

1. Open iim.conf.

   See iim.conf File Syntax for more information.

2. Delete the com.iplanet.im.server.EmailIMArchive value from the iim_server.msg_archive.provider parameter.

3. Save and close iim.conf.

4. Refresh the Instant Messaging server configuration.

   imadmin refresh

Configuring Email Archive Settings

You can configure which administrators will receive emails containing archived instant messages. You can configure a separate list of administrators to receive polls, news, conference, alerts, or chat sessions. You can also configure Instant Messaging to use the extended RFC 822 header. Doing so allows mail clients to filter messages based on the header content.

---

Note –

If you run configure after modifying these parameters for the email archive, any values you input will be overwritten.

---

Table 18–1 describes the configuration parameters you use to define which administrators will receive email archives, as well as whether or not to use the extended RFC 822 header, and the content of that header.

Table 18–1 Email Archive Configuration Parameters

Parameter	Default Value	Description
iim_arch.admin.email	Empty String	Comma-separated list of administrator email addresses.
iim_arch.alert.admin.email	None	Comma-separated list of administrator email addresses to which all archived alert messages will be sent. This parameter overrides iim_arch.admin.email for alert messages.
iim_arch.chat.admin.email	None	Comma-separated list of administrator email addresses to which all archived chat messages will be sent. This parameter overrides iim_arch.admin.email for chat messages.
iim_arch.conference.admin.email	None	Comma-separated list of administrator email addresses to which all archived conference messages will be sent. This parameter overrides iim_arch.admin.email for conference messages.
iim_arch.poll.admin.email	None	Comma-separated list of administrator email addresses to which all archived poll messages will be sent. This parameter overrides iim_arch.admin.email for poll messages.
iim_arch.news.admin.email	None	Comma-separated list of administrator email addresses to which all archived news messages will be sent. This parameter overrides iim_arch.admin.email for news messages.
iim_arch.email.archiveheader.name	None	Name of the extended RFC 822 header.
iim_arch.email.archiveheader.value	all	Value corresponding to the header name for iim_arch.email.archiveheader.name.

To Configure Administrator Recipients and the RFC 822 Header Format for the Instant Messaging Email Archive

1. Open iim.conf.

   See iim.conf File Syntax for more information.

2. Add the parameters in Table 18–1 and appropriate values to iim.conf.

3. Refresh the server.

   imadmin refresh

Email Header Format

The RFC 822 header content for email messages containing various types of archived Instant Messaging content is described in the following sections:

• RFC 822 Email Archive Header Fields for One to One Chat

• RFC 822 Email Archive Header Fields for Private Conferences

• RFC 822 Email Archive Header Fields for Public Conferences

• RFC 822 Email Archive Header Fields for Poll Questions with Replies

• RFC 822 Email Archive Header Fields for Poll Replies Only

• RFC 822 Email Archive Header Fields for Alerts

• RFC 822 Email Archive Header Fields for News Channel Posts

RFC 822 Email Archive Header Fields for One to One Chat

From:

Chat session initiator.

To:

Receiver and any administrators configured in iim.conf. See Table 18–1 for more information.

Cc:

Chat session initiator.

Subject:

First useful message over 50 characters in length.

Date:

Creation date of the email message by the archive provider.

Reply-to:

Not used.

X-XMPP-Message-ID

Generated by the email archive provider based on the message thread.

RFC 822 Email Archive Header Fields for Private Conferences

From:

Chat session initiator.

To:

Other participants and any administrators configured in iim.conf. See Table 18–1 for more information.

Cc:

Chat session initiator.

Subject:

If a subject is set for the conference, the conference subject is used. If no subject is set, first useful message over 50 characters in length is used.

Date:

Creation date of the email message by the archive provider.

Reply-to:

Not used.

X-XMPP-Message-ID

Generated by the email archive provider based on the conference ID.

RFC 822 Email Archive Header Fields for Public Conferences

From:

Room owner in archive data.

To:

Associated mailing list, users with explicit access to the conference room, and any administrators configured in iim.conf. See Table 18–1 for more information.

Cc:

Not used.

Subject:

[Conference name] subject.

Date:

Creation date of the email message by the archive provider.

Reply-to:

Not used.

X-XMPP-Message-ID

Generated by the email archive provider based on the conference ID.

RFC 822 Email Archive Header Fields for Poll Questions with Replies

From:

Poll sender.

To:

Poll sender and any administrators configured in iim.conf. See Table 18–1 for more information.

Cc:

Not used.

Subject:

Poll question.

Date:

Creation date of the email message by the archive provider.

Reply-to:

Not used.

X-XMPP-Message-ID

Generated by the email archive provider.

RFC 822 Email Archive Header Fields for Poll Replies Only

From:

Poll sender.

To:

Poll recipients and any administrators configured in iim.conf. See Table 18–1 for more information.

Cc:

Poll sender.

Subject:

Poll question.

Date:

Creation date of the email message by the archive provider.

Reply-to:

Not used.

X-XMPP-Message-ID

Generated by the email archive provider.

RFC 822 Email Archive Header Fields for Alerts

From:

Alert sender.

To:

Alert recipients and any administrators configured in iim.conf. See Table 18–1 for more information.

Cc:

Not used.

Subject:

Alert subject.

Date:

Creation date of the email message by the archive provider.

Reply-to:

Not used.

X-XMPP-Message-ID

Generated by the email archive provider.

RFC 822 Email Archive Header Fields for News Channel Posts

From:

News channel post sender.

To:

Mailing list associated with the news channel and any administrators configured in iim.conf. See Table 18–1 for more information.

Cc:

Not used.

Subject:

News channel post subject.

Date:

Creation date of the email message by the archive provider.

Reply-to:

Not used.

X-XMPP-Message-ID

Generated by the email archive provider based on the news channel ID.