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 日 0:00:00 GMT) 以降のミリ秒数を指定します。 

22.3.5.2 特定の通知メッセージに固有のプロパティー

表 22–4 は、特定の通知メッセージに含まれるプロパティーを示しています。

各メッセージには、次の表に示すプロパティーのサブセットが含まれます。各メッセージに関連付けられたプロパティーのリストについては、表 22–5 を参照してください。

表 22–4 特定の通知メッセージに固有のプロパティー

プロパティー 

データ型 

説明 

client

ConstMQString 

メッセージに関連付けられた Message Queue クライアントの IP アドレス。 

diskquota

MQInt32 

メッセージに関連付けられたユーザーのディスク制限容量 (K バイト単位)。この値が -1 に設定されている場合は、制限容量がないことを示します。 

diskquotaused

MQInt32 

メッセージに関連付けられたユーザーによって使用されたディスク容量 (K バイト単位)。 

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 などの通知がトリガーされる場合があります。

numDeletednn

MQInt32 

メッセージタイプごとに指定された、削除済みとしてマークされたメールボックス内のメッセージの総数。メッセージタイプが設定されている場合は、 

numDeletednn プロパティーに、メッセージタイプ nn ごとのカウントが含まれます。

numDeleted プロパティーは常に送信され、削除済みとしてマークされたすべてのメッセージの総数 (すべてのタイプを含む) をカウントします。

たとえば、20 件のメッセージが削除済みとしてマークされており、そのうちの 10 件がタイプ 3、7 件がタイプ 16、残りが認識されているタイプでない場合、この通知には次のプロパティーとカウントが含まれます。 

numDeleted=20

numDeleted3=10

numDeleted16=7

numMsgs

MQInt32 

現在メールボックス内にあるメッセージの総数。 

numMsgsnn

MQInt32 

メッセージタイプごとに指定された、現在メールボックス内にあるメッセージの総数。メッセージタイプが設定されている場合は、 

numMsgsnn プロパティーには、メッセージタイプ nn ごとのカウントが含まれます。

numMsgs プロパティーは常に送信され、メールボックス内のすべてのメッセージの総数 (すべてのタイプを含む) をカウントします。

たとえば、現在メールボックス内に 20 件のメッセージがあり、そのうちの 10 件がタイプ 3、7 件がタイプ 16、残りが認識されているタイプでない場合、この通知には次のプロパティーとカウントが含まれます。 

numMsgs=20

numMsgs3=10

numMsgs16=7

numSeen

MQInt32 

開封済み (読み取り済み) としてマークされたメールボックス内のメッセージの数。 

この数は、メールボックス所有者によって読み取られたメッセージをカウントします。ほかのユーザーがこのメールボックスにアクセスした場合、そのユーザーがメールボックス内で操作しても、カウントには含まれません。ただし、ほかのユーザーの操作によって、ReadMsg などの通知がトリガーされる場合があります。

numSeennn

MQInt32 

メッセージタイプごとに指定された、開封済み (読み取り済み) としてマークされたメールボックス内のメッセージの総数。メッセージタイプが設定されている場合は、numSeennn プロパティーに、メッセージタイプ nn ごとのカウントが含まれます。

numSeen プロパティーは常に送信され、開封済みとしてマークされたすべてのメッセージの総数 (すべてのタイプを含む) をカウントします。

たとえば、20 件のメッセージが開封済みとしてマークされており、そのうちの 10 件がタイプ 3、7 件がタイプ 16、残りが認識されているタイプでない場合、この通知には次のプロパティーとカウントが含まれます。 

numSeen=20

numSeen3=10

numSeen16=7

numSeenDeleted

MQInt32 

開封済み (読み取り済み) としてマークされ、かつ削除済みとしてマークされたメールボックス内のメッセージの数。 

この数は、メールボックス所有者によって読み取られ、削除されたことがマークされているメッセージをカウントします。ほかのユーザーがこのメールボックスにアクセスした場合、そのユーザーがメールボックス内で操作しても、カウントには含まれません。ただし、ほかのユーザーの操作によって、ReadMsgDeleteMsg などの通知がトリガーされる場合があります。

numSeenDeletednn

MQInt32 

メッセージタイプごとに指定された、開封済み (読み取り済み) および削除済みとしてマークされたメールボックス内のメッセージの総数。メッセージタイプが設定されている場合は、numSeenDeletednn プロパティーが、メッセージタイプ 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 文字の文字列です。文字列は次の値を持つ必要があります。

22.3.5.3 各通知メッセージに含まれるプロパティー

表 22–5 は、各通知メッセージに関連付けられたプロパティーを示しています。

たとえば、TrashMsg メッセージにどのプロパティーが適用されるかを調べるには、「ReadMsg、TrashMsg」の列タイトルを参照します。TrashMsg メッセージは、標準のプロパティーに加えて、mailboxNamenumMsgsuidValiditynumSeen、および 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

あり 

あり 

あり 

なし 

なし 

なし 

numDeletedn

あり * 

あり * 

あり * 

なし 

なし 

なし 

numMsgs

あり 

あり 

あり 

なし 

なし 

あり 

numMsgsn

あり * 

あり * 

あり * 

なし 

なし 

なし 

numSeen

あり 

あり 

あり 

なし 

なし 

なし 

numSeenn

あり * 

あり * 

あり * 

なし 

なし 

なし 

numSeenDeleted

あり 

あり 

あり 

なし 

なし 

なし 

numSeenDeletedn

あり * 

あり * 

あり * 

なし 

なし 

なし 

oldflags

なし 

なし 

なし 

あり 

なし 

なし 

Owner

なし 

あり 

なし 

なし 

なし 

なし 

pid

あり 

あり 

あり 

あり 

あり 

あり 

process

あり 

あり 

あり 

あり 

あり 

あり 

quotaRoot

なし 

なし 

なし 

なし 

なし 

あり 

size

あり 

なし 

なし 

なし 

なし 

なし 

timestamp

あり 

あり 

あり 

あり 

あり 

あり 

uidValidity

あり 

あり 

あり 

あり 

なし 

なし 

userid

なし 

あり 

なし 

なし 

あり 

あり 


注 –

* numDeletednnumMsgsnnumSeenn、および numSeenDeletedn プロパティーが通知に含まれるのは、メッセージストアでメッセージタイプが定義されている場合だけです。