22.3.5 Notification Message Properties (Sun Java System Messaging Server 6.3 Administration Guide)

Sun Java System Messaging Server 6.3 Administration Guide

22.3.5 Notification Message Properties

Every message carries additional information defined in properties. Different properties are present for different messages. For example, NewMsg indicates the IMAP uid of the new message.

22.3.5.1 Standard Notification Message Properties

Table 22–3 describes the standard notification message properties. These properties are present in all JMS messages.

Table 22–3 Standard Notification Message Properties


Property	Data Type	Description
`hostname`	ConstMQString	The host name of the machine that generated the message.
`pid`	MQInt32	ID of the process that generated the message.
`process`	ConstMQString	Specifies the name of the process that generated the message.
`timestamp`	MQFloat64	Specifies the number of milliseconds since the epoch (midnight GMT, January 1, 1970).

22.3.5.2 Properties Specific to Particular Notification Messages

Table 22–4 describes the properties carried with particular notification messages.

Each message includes a subset of the properties shown in the table below. For a list of the properties associated with each message, see Table 22–5.

Table 22–4 Properties Specific to Particular Notification Messages


Property	Data Type	Description
`client`	ConstMQString	The IP address of the Message Queue client associated with the message.
`diskquota`	MQInt32	The disk space quota, in kilobytes, for the user associated with the message. The value is set to -1 to indicate no quotas.
`diskquotaused`	MQInt32	The amount of disk space used by the user associated with the message, in kilobytes.
`hdrLen`	MQInt32	The size of the message header. Note that this might not be the size of the header in the message body, because it might have been truncated.
`imapUid`	MQInt32	The IMAP uid property associated with the message.
`lastUid`	MQInt32	The last IMAP uid value used in the mailbox.
`mailboxName`	ConstMQstring	The message-store mailbox name associated with the event. The mailboxName has one of the following formats (where `uid` is the user's unique identifier): `uid` — identifies the inbox of a user in the default (primary) domain. `uid@domain` — identifies the inbox of a user in a hosted domain. `uid/mailboxname` — identifies the top-level mailbox of a user in the default domain. `uid@domain/mailboxname` — identifies the top-level mailbox of a user in a hosted domain. `uid/foldername/mailboxname` — identifies a mailbox in a folder of a user in the default domain. `uid@domain/foldername/mailboxname` — identifies a mailbox in a folder of a user in a hosted domain.
`msgquota`	MQInt32	The user's quota for the maximum number of messages. The value is set to -1 to indicate no quotas.
`newflags`	ConstMQString	The flags set for the user's mailbox message after they were changed by the current operation. This property is always present, together with `oldflags`, when a `MsgFlags` notification message is produced. For the syntax and values for `newflags`, see Syntax for newflags and oldflags Properties, below this table.
`numDeleted`	MQInt32	The number of messages in the mailbox marked as deleted. This number counts the messages deleted by the mailbox owner. If other users have access to the mailbox, their actions in the mailbox are not included in this count. (However, the other users' actions can trigger notifications such as `DeleteMsg`).
`numDeleted`nn	MQInt32	The total number of messages in the mailbox marked as deleted, specified for each message type. If message types are configured, a `numDeleted`nn property carries a count for each message type nn. The `numDeleted` property is always sent; it counts the total number of all messages marked as deleted, including all types. For example, if 20 messages are marked as deleted, 10 are of type 3, 7 are of type 16, and the rest are not of any recognized type, the following properties and counts are carried with the notification: `numDeleted=20` `numDeleted3=10` `numDeleted16=7`
`numMsgs`	MQInt32	The total number of messages now in the mailbox.
`numMsgs`nn	MQInt32	The total number of messages now in the mailbox, specified for each message type. If message types are configured, a `numMsgs`nn property carries a count for each message type nn. The `numMsgs` property is always sent; it counts the total number of all messages in the mailbox, including all types. For example, if 20 messages are currently in the mailbox, 10 are of type 3, 7 are of type 16, and the rest are not of any recognized type, the following properties and counts are carried with the notification: `numMsgs=20` `numMsgs3=10` `numMsgs16=7`
`numSeen`	MQInt32	The number of messages in the mailbox marked as seen (read). This number counts the messages read by the mailbox owner. If other users have access to the mailbox, their actions in the mailbox are not included in this count. (However, the other users' actions can trigger notifications such as `ReadMsg`).
`numSeen`nn	MQInt32	The total number of messages in the mailbox marked as seen (read), specified for each message type. If message types are configured, a `numSeen`nn property carries a count for each message type nn. The `numSeen` property is always sent; it counts the total number of all messages marked as seen, including all types. For example, if 20 messages are marked as seen, 10 are of type 3, 7 are of type 16, and the rest are not of any recognized type, the following properties and counts are carried with the notification: `numSeen=20` `numSeen3=10` `numSeen16=7`
`numSeenDeleted`	MQInt32	The number of messages in the mailbox marked as seen (read) and marked as deleted. This number counts the messages marked as read and deleted by the mailbox owner. If other users have access to the mailbox, their actions in the mailbox are not included in this count. (However, the other users' actions can trigger notifications such as `ReadMsg`and `DeleteMsg`).
`numSeenDeleted`nn	MQInt32	The total number of messages in the mailbox marked as seen (read) and marked as deleted, specified for each message type. If message types are configured, a `numSeenDeleted`nn property carries a count for each message type nn. The `numSeenDeleted` property is always sent; it counts the total number of all messages marked as seen and deleted, including all types. For example, if 20 messages are marked as seen and deleted, 10 are of type 3, 7 are of type 16, and the rest are not of any recognized type, the following properties and counts are carried with the notification: `numSeenDeleted=20` `numSeenDeleted3=10` `numSeenDeleted16=7`
`oldflags`	ConstMQString	The flags set for the user's mailbox message before they were changed by the current operation. This property is always present, together with `newflags`, when a `MsgFlags` notification message is produced. For the syntax and values for `oldflags`, see Syntax for newflags and oldflags Properties, below this table.
`quotaRoot`	ConstMQString	This can be a user name, folder name, or message type.
`size`	MQInt32	The size of the message. Note that this may not be the size of message body, since the body is typically a truncated version of the message.
`uidValidity`	MQInt32	The IMAP uid validity property.
`userid`	ConstMQString	The userid associated with the message.

Note –

Subscribers should allow for undocumented properties when parsing the message reference. This allows for future compatibility when new properties are added.

Syntax for newflags and oldflags Properties

The newflags and oldflags properties are 5–character strings. The string must have the following values:

If the /answered flag is set, the first character is "A". If not, it is blank (“ “).
If the /flagged flag is set, the second character is "F". If not, it is blank (“ “).
If the /deleted flag is set, the third character is "D". If not, it is blank (“ “).
If the /seen flag is set, the fourth character is "S". If not, it is blank (“ “).
If the /draft flag is set, the fifth character is "R". If not, it is blank (“ “).

22.3.5.3 Properties Carried with Each Notification Message

Table 22–5 shows the properties associated with each notification message.

For example, to see which properties apply to a TrashMsg message, look in the column header for “ReadMsg, TrashMsg.” A TrashMsg message can use mailboxName, numMsgs, uidValidity, numSeen, and numDeleted (in addition to the standard properties).

Table 22–5 Properties Carried with Each Notification Message


Property	NewMsg, UpdateMsg	ReadMsg, TrashMsg	DeleteMsg, PurgeMsg	MsgFlags	Login, Logout	OverQuota, UnderQuota
`client`	No	No	No	No	Yes	No
`diskquota`	No	No	No	No	No	Yes
`diskquotaused`	No	No	No	No	No	Yes
`hdrLen`	Yes	No	No	Yes	No	No
`hostname`	Yes	Yes	Yes	Yes	Yes	Yes
`imapUid`	Yes	No	Yes	Yes	No	No
`lastUid`	No	No	Yes	No	No	No
`mailboxName`	Yes	Yes	Yes	Yes	No	No
`msgquota`	No	No	No	No	No	Yes
`newflags`	No	No	No	Yes	No	No
`numDeleted`	Yes	Yes	Yes	No	No	No
`numDeleted`n	Yes*	Yes*	Yes*	No	No	No
`numMsgs`	Yes	Yes	Yes	No	No	Yes
`numMsgs`n	Yes*	Yes*	Yes*	No	No	No
`numSeen`	Yes	Yes	Yes	No	No	No
`numSeen`n	Yes*	Yes*	Yes*	No	No	No
`numSeenDeleted`	Yes	Yes	Yes	No	No	No
`numSeenDeleted`n	Yes*	Yes*	Yes*	No	No	No
`oldflags`	No	No	No	Yes	No	No
`Owner`	No	Yes	No	No	No	No
`pid`	Yes	Yes	Yes	Yes	Yes	Yes
`process`	Yes	Yes	Yes	Yes	Yes	Yes
`quotaRoot`	No	No	No	No	No	Yes
`size`	Yes	No	No	No	No	No
`timestamp`	Yes	Yes	Yes	Yes	Yes	Yes
`uidValidity`	Yes	Yes	Yes	Yes	No	No
`userid`	No	Yes	No	No	Yes	Yes

Note –

* The numDeletedn, numMsgsn, numSeenn, and numSeenDeletedn properties are carried with notifications only if message types are defined in the message store.