22.3.5 通知邮件属性 (Sun Java System Messaging Server 6.3 管理指南)

Sun Java System Messaging Server 6.3 管理指南

22.3.5 通知邮件属性

每个邮件都包含属性中定义的附加信息。不同的属性出现在不同的邮件中。例如，NewMsg 表示新邮件的 IMAP uid。

22.3.5.1 标准通知邮件属性

表 22–3 介绍了标准通知邮件属性。这些属性出现在所有 JMS 邮件中。

表 22–3 标准通知邮件属性


属性	数据类型	说明
`hostname`	ConstMQString	生成此邮件的计算机的主机名。
`pid`	MQInt32	生成此邮件的进程的 ID。
`process`	ConstMQString	指定生成此邮件的进程的名称。
`timestamp`	MQFloat64	指定从 epoch（GMT 时间 1970 年 1 月 1 日午夜）开始的毫秒数。

22.3.5.2 特定于特定通知邮件的属性

表 22–4 描述了特定通知邮件包含的属性。

每个邮件包含下表中属性的一个子集。有关与每个邮件相关的属性列表，请参见表 22–5。

表 22–4 特定于特定通知邮件的属性


属性	数据类型	说明
`client`	ConstMQString	与邮件相关的 Message Queue 客户端 IP 地址。
`diskquota`	MQInt32	与邮件相关的用户磁盘空间配额，以千字节为单位。值设置为 -1 表示没有配额。
`diskquotaused`	MQInt32	与邮件相关的用户磁盘空间使用量，以千字节为单位。
`hdrLen`	MQInt32	邮件标题大小。请注意，这可能不是邮件正文中标题的大小，因为此标题可能已经被截断。
`imapUid`	MQInt32	与邮件相关的 IMAP uid 属性。
`lastUid`	MQInt32	邮箱中使用的最后一个 IMAP uid 值。
`mailboxName`	ConstMQstring	与事件相关的消息存储邮箱名称。mailboxName 可以使用以下几种格式之一（其中 `uid` 是用户的唯一标识符）： `uid` — 标识默认（主）域中用户的收件箱。 `uid@domain` — 标识托管域中用户的收件箱。 `uid/mailboxname` — 标识默认域中用户的顶层邮箱。 `uid@domain/mailboxname` — 标识托管域中用户的顶层邮箱。 `uid/foldername/mailboxname` — 标识默认域中用户文件夹中的邮箱。 `uid@domain/foldername/mailboxname` — 标识托管域中用户文件夹中的邮箱。
`msgquota`	MQInt32	用户的最大邮件数配额。值设置为 -1 表示没有配额。
`newflags`	ConstMQString	用户的邮箱邮件被当前操作改变后设置的标志。在生成 `MsgFlags` 通知邮件时，此属性总是与 `oldflags` 一起出现。有关 `newflags` 的语法和值，请参见此表下面的newflags 和 oldflags 属性的语法。
`numDeleted`	MQInt32	邮箱中标记为已删除的邮件数量。此数值统计被邮箱所有者删除的邮件。如果其他用户访问此邮箱，他们在邮箱中的操作不包括在此计数内。（但是，其他用户的操作能够触发通知，如 `DeleteMsg` ）。
`numDeleted`nn	MQInt32	邮箱中为每种邮件类型指定的标记为已删除的邮件总数。如果配置了邮件类型， `numDeleted`nn 属性将包含每种邮件类型 nn 的计数。始终发送 `numDeleted` 属性；它统计所有标记为已删除的邮件的总数，包括所有类型。例如，如果 20 个邮件被标记为已删除，其中 10 个是类型 3，7 个是类型 16，而其余的不属于任何已识别的类型，则通知中包含以下属性和计数： `numDeleted=20` `numDeleted3=10` `numDeleted16=7`
`numMsgs`	MQInt32	邮箱中当前邮件总数。
`numMsgs`nn	MQInt32	邮箱中为每种邮件类型指定的当前邮件总数。如果配置了邮件类型， `numMsgs`nn 属性将包含每种邮件类型 nn 的计数。始终发送 `numMsgs` 属性，它统计邮箱中所有邮件的总数，包括所有类型。例如，如果邮箱中当前有 20 个邮件，其中 10 个是类型 3，7 个是类型 16，而其余的不属于任何已识别类型，则通知中包含以下属性和计数： `numMsgs=20` `numMsgs3=10` `numMsgs16=7`
`numSeen`	MQInt32	邮箱中标记为已读（已阅读）的邮件数。此数值统计已被邮箱所有者阅读的邮件。如果其他用户访问此邮箱，他们在邮箱中的操作不包括在此计数内。（但是，其他用户的操作能够触发通知，如 `ReadMsg`）。
`numSeen`nn	MQInt32	邮箱中为每种邮件类型指定的标记为已读（已阅读）的邮件总数。如果配置了邮件类型，`numSeen` nn 属性将包含每种邮件类型 nn 的计数。始终发送 `numSeen` 属性；它统计邮箱中所有标记为已读的邮件的总数，包括所有类型。例如，如果邮箱中有 20 个标记为已读的邮件，其中 10 个是类型 3，7 个是类型 16，而其余的不属于任何已识别类型，则通知中包含以下属性和计数： `numSeen=20` `numSeen3=10` `numSeen16=7`
`numSeenDeleted`	MQInt32	邮箱中标记为已读（已阅读）和已删除的邮件数。此数值统计已被邮箱所有者标记为已阅读和已删除的邮件。如果其他用户访问此邮箱，他们在邮箱中的操作不包括在此计数内。（但是，其他用户的操作能够触发通知，如 `ReadMsg` 和 `DeleteMsg`）。
`numSeenDeleted`nn	MQInt32	邮箱中为每种邮件类型指定的标记为已读（已阅读）和已删除的邮件总数。如果配置了邮件类型，`numSeenDeleted`nn 属性将包含每种邮件类型 nn 的计数。始终发送 `numSeenDeleted` 属性；它统计邮箱中所有标记为已读和已删除的邮件的总数，包括所有类型。例如，如果邮箱中有 20 个标记为已读和已删除的邮件，其中 10 个是类型 3，7 个是类型 16，而其余的不属于任何已识别类型，则通知中包含以下属性和计数： `numSeenDeleted=20` `numSeenDeleted3=10` `numSeenDeleted16=7`
`oldflags`	ConstMQString	用户的邮箱邮件被当前操作改变前设置的标志。在生成 `MsgFlags` 通知邮件时，此属性总是与 `newflags` 一起出现。有关 `oldflags` 的语法和值，请参见此表下面的newflags 和 oldflags 属性的语法。
`quotaRoot`	ConstMQString	此属性可以是用户名、文件名或邮件类型。
`size`	MQInt32	邮件大小。请注意，此属性可能不是邮件正文的大小，因为正文通常是邮件被截断的版本。
`uidValidity`	MQInt32	IMAP uid 有效性属性。
`userid`	ConstMQString	与邮件相关的 userid。

注 –

在解析邮件引用时，订户应该允许没有记录的属性。这考虑未来添加新属性时的兼容性。

newflags 和 oldflags 属性的语法

newflags 和 oldflags 属性是 5–字符字符串。此字符串必须有以下值：

如果设置了 /answered 标志，则第一个字符为 "A"。否则，为空白 (" ")。
如果设置了 /flagged 标志，则第二个字符为 "F"。否则，为空白 (" ")。
如果设置了 /deleted 标志，则第三个字符为 "D"。否则，为空白 (" ")。
如果设置了 /seen 标志，则第四个字符为 "S"。否则，为空白 (" ")。
如果设置了 /draft 标志，则第五个字符为 "R"。否则，为空白 (" ")。

22.3.5.3 每个通知邮件包含的属性

表 22–5 显示了与每个通知邮件相关的属性。

例如，要查看哪些属性可以应用于 TrashMsg 邮件，请在列标题中查找 "ReadMsg, TrashMsg"。除了标准属性之外，TrashMsg 邮件还可以使用 mailboxName、 numMsgs、uidValidity、numSeen 和 numDeleted。

表 22–5 每个通知邮件包含的属性


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

注 –

* 只有在消息存储中定义了邮件类型，通知才会包含 numDeletedn、numMsgs n、numSeenn 和 numSeenDeletedn 属性。