22.3.2 Rules and Guidelines for Notification Messages

The following rules and guidelines apply to the supported notification messages:

• The text of most notification messages is a single blank space. (The blank space is used because Message Queue does not permit an empty message body.) The exceptions are as follows:

  • The NewMsg, UpdateMsg, and DeleteMsg messages can include a message header when configured with the maxHeaderSize parameter. You must set maxHeaderSize to a value greater than zero.

    To include a message header with a DeleteMsg message, you also must set the ExpungeHeaders parameter to a value of 1.

  • NewMsg and UpdateMsg message can include a message body when configured with the maxBodySize parameter. You must set maxBodySize to a value greater than zero.

    For NewMsg and UpdateMsg, by default the message body is not delivered (is turned off). This prevents overloading Message Queue. No other messages include a message body.

• Notification messages can be generated for changes to the INBOX alone, or to the INBOX and all other folders. The following configuration parameter allows for INBOX only (value = 0), or for both the INBOX and all other folders (value = 1):

  local.store.notifyplugin.jmqnotify.noneInbox.enable

  The default setting is to generate messages from the INBOX only (value = 0).

  There is no mechanism to select folders; all folders are included when the variable is enabled (value = 1).

• The NewMsg notification is issued only after the message is deposited in the user mailbox (as opposed to “after it was accepted by the server and queued in the message queue”).

• Messages are not generated for POP3 client access.

• All messages can be suppressed by issuing XNOTNOTIFY. For example, an IMAP script used for housekeeping only (the users are not meant to be notified) might issue it to suppress all messages.