22.2.2 Specifying Notification Messages that Use More Than One configutil Parameter

For most notification messages, you specify the message by running a single local.store.notifyplugin command.

However, the following notification messages are (or can be) configured with more than one local.store.notifyplugin command:

1. NewMsg

2. UpdateMsg

3. DeleteMsg

4. MsgFlags

The procedures that follow describe how to set up these notification messages.

To Configure New-Message and Updated-Message Notifications with Message Headers and Message Bodies

You can add the message headers and message bodies to the text of notification messages sent when there are new or updated email messages.

Including message headers and message bodies is optional; you can include both features, one feature only, or neither feature. The default is to send messages without message headers or message bodies.

1. Specify the new-message or updated-message notification:

   configutil -o local.store.notifyplugin.jmqnotify.NewMsg.enable -v 1

   configutil -o local.store.notifyplugin.jmqnotify.UpdateMsg.enable -v 1

   where jmqnotify is the name of the plug-in

   and -v 1 enables notifications for these messages. A value of 0 disables notifications.

2. Specify the maxHeaderSize parameter with a value greater than zero, as in the following example:

   configutil -o local.store.notifyplugin.jmqnotify.maxHeaderSize -v 1024

   where jmqnotify is the name of the plug-in

   and 1024 is the maximum size of the header to be sent. The default value of maxHeaderSize is 0, which sends no header information with the message.

3. Specify the maxBodySize parameter with a value greater than zero, as in the following example:

   configutil -o local.store.notifyplugin.jmqnotify.maxBodySize -v 1024

   where jmqnotify is the name of the plug-in

   and 5120 is the maximum size of the message body to be sent. The default value of maxBodySize is 0, which sends no body with the message.

To Configure Deleted-Message Notifications with Message Headers

You can add the message headers to the text of notification messages sent when email messages are deleted.

Including message headers is optional. The default is to send notifications without message headers.

1. Enable notifications to be sent when email messages are deleted:

   configutil -o local.store.notifyplugin.jmqnotify.DeleteMsg.enable -v 1

   where jmqnotify is the name of the plug-in

   and -v 1 enables notifications for this message. A value of 0 disables notifications.

2. Specify the ExpungeHeaders parameter:

   configutil -o local.store.notifyplugin.jmqnotify.ExpungeHeaders -v 1

   where jmqnotify is the name of the plug-in

   and -v 1 enables message headers to be carried with deleted-message notifications. The default value of ExpungeHeaders is 0, which prohibits deleted-message notifications from carrying header information.

   You must configure the ExpungeHeaders parameter to enable DeleteMsg messages to carry message headers.

3. Specify the maxHeaderSize parameter with a value greater than zero, as in the following example:

   configutil -o local.store.notifyplugin.jmqnotify.maxHeaderSize -v 1024

   where jmqnotify is the name of the plug-in

   and 1024 is the maximum size of the header to be sent. The default value of maxHeaderSize is 0, which sends no header information with the message.

22.2.2.1 Configuring Notifications for Changes in Message Status

You can configure a notification message to be sent when an email message has changed status.

Information Delivered in Message-Flag Notifications

A message-flags notification is produced whenever a status flag has changed because the email message was:

• Answered

• Flagged

• Deleted

• Seen (read)

• Draft

When a message-flags notification is sent, the notification carries the following properties:

• The flags set for the email message before its status changed

• The flags set for the email message after its status changed

This information is carried in two properties, oldflags and newflags, which are 5–character strings.

For a description of the values of these two properties, see Syntax for newflags and oldflags Properties.

Configutil Parameters Needed for Message-Flag Notifications

To enable message-flag notifications, you must configure the following configutil parameters:

• local.store.notifyplugin.MsgFlags

• local.store.notifyplugin.*.MsgFlags.enable

The first MsgFlags parameter enables the IMAP server and message store to identify and track the changing values of the status flags so that this information can be delivered in notification messages.

This parameter applies to all notification plug-ins. Therefore, you must enable the parameter if any notification plug-in uses message-flag notifications. If no plug-in uses message-flag notifications, be sure that this parameter is disabled (its default value).

The second parameter, *.MsgFlags.enable, allows message-flag notifications to be sent for a particular plug-in library.

You must configure both parameters to enable notifications for message flags.

To Enable Notifications When Message-Status Flags Have Changed

1. Enable status flags to be tracked and status information to be carried with message-flag notifications:

   configutil -o local.store.notifyplugin.MsgFlags -v 1

   where -v 1 enables message-flag information to be sent with message-flag notifications. A value of 0 disables this notification.

2. Enable message-flag notifications to be sent by a particular plug-in:

   configutil -o local.store.notifyplugin.jmqnotify.MsgFlags.enable -v 1

   where jmqnotify is the name of the plug-in

   and -v 1 enables message-flag notifications for this plug-in. A value of 0 disables notifications.