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	指定開始時間 (1970 年 1 月 1 日午夜 GMT) 以來的毫秒數。

22.3.5.2 特定通知郵件的專屬特性

表 22–4 說明特定通知郵件帶有的特性。

每封郵件包含下表所示的特性之子集。如需與每封郵件相關的特性清單，請參閱表 22–5。

表 22–4 特定通知郵件的專屬特性


特性	資料類型	說明
`client`	ConstMQString	與郵件相關的郵件佇列用戶端之 IP 位址。
`diskquota`	MQInt32	與郵件相關的使用者之磁碟空間配額 (以 KB 為單位)。此值設定為 -1 表示沒有配額。
`diskquotaused`	MQInt32	與郵件相關的使用者所用的磁碟空間量 (以 KB 為單位)。
`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	與郵件相關的使用者 ID。

備註 –

訂閱者解析郵件參照時，應允許未加以說明的特性。這可在未來新增特性時允許相容。

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 特性。