MessageDetailsReport タグ

メッセージの詳細レポートは、<MessageDetailsReport> タグを含む XML メッセージです。このレポートは、レポート・ヘッダとそれに続くオプションの <message> タグから構成されます。各レポートのヘッダは、次のタグから構成されます。

<MessageDetailsReport> タグのサブタグ	説明
<message>	レポートの本文は <message> タグのリストから構成されます。<message> タグのサブタグは、選択条件を満たすメッセージごとに特定の詳細情報を表示します。メッセージが選択されていない場合や、元の要求で詳細要素が指定されていない場合は、<message> タグはレポートに含まれません。それ以外の場合は、メッセージごとに独自の <message> タグがあります。
<messageCount>	要求の選択条件を満たすメッセージの数。
<requestId>	レポートを生成した要求の ID。
<statusDescription>	レポートが生成された理由の簡単な説明。
<UTCDateline>	レポートが生成された時刻と日付。

Message タグ

<message> タグのサブタグ	説明
<address>	メッセージのアドレス。myclient\myqueue などです。
<contentSize>	メッセージのサイズ。テキスト・メッセージの場合は文字数、バイナリ・メッセージの場合はバイト数です。
<expires>	メッセージが配信されない場合に期限切れとなる日付と時刻。
<kind>	メッセージがバイナリ (1) であるか、テキスト (2) であるかを示します。
<messageId>	新規メッセージのメッセージ ID。メッセージ・ヘッダを参照してください。
<originator>	メッセージの発信者のメッセージ・ストア ID。
<priority>	0 ～ 9 の整数で指定したメッセージの優先度。0 は優先度が最も低く、9 は最も高いことを表します。
<property>	メッセージのプロパティ。メッセージ・プロパティを参照してください。
<status>	メッセージの現在のステータス。ステータス・コードは事前に定義されたメッセージ・プロパティで定義されています。
<statusTime>	メッセージが現在のステータスになった時刻。これは現地時刻です。
<transmissionStatus>	メッセージの同期ステータス。次のいずれかの値を取ります。 0 - メッセージは、目的の受信側メッセージ・ストアに転送されていません。 1 - メッセージは、目的の受信側メッセージ・ストアに転送済みです。 2 - 受信先および送信元のメッセージ・ストアが同じであるため、転送は不要です。 3 - メッセージは目的の受信先に転送されましたが、まだ受信確認されていません。メッセージ転送が中断された可能性があるため、QAnywhere がメッセージを再転送する可能性があります。

例

次に、メッセージの詳細レポートの例を示します。

<?xml version="1.0" encoding="UTF-8"?>
<MessageDetailsReport>
 <requestId>testReport</requestId>
 <UTCDatetime>Mon Jan 16 15:03:04 EST 2006</UTCDatetime>
 <statusDescription>Scheduled report</statusDescription>
 <messageCount>1</messageCount>
 <message>
  <messageId>ID:26080b8927f83f9722357eab0a0628eb</messageId>
  <status>60</status>
  <property>
   <name>myPropName</name>
   <value>myPropVal</value>
  </property>
 </message>
</MessageDetailsReport>

次の <condition> タグは、 (msgId=ID:144... OR msgId=ID225...) AND (status=pending) AND (kind=textmessage) AND (値が 'myVal' のプロパティ 'myProp' を含む) という探索条件を満たすメッセージを選択します。

<condition>
 <messageId>ID:144d7e44dc2d7e1d</messageId>
 <messageId>ID:22578sd5dsd99s8e</messageId>
 <status>1</status>
 <kind>text</kind>
 <property>myProp=myVal</property>
</condition>

ワンタイム要求は、<schedule> タグが指定されていない要求です。ワンタイム要求は、1 つのレポートを生成する場合に使用され、レポートが送信されると削除されます。次の要求では、現在サーバ上に置かれている優先度 9 のすべてのメッセージについて、メッセージ ID、ステータス、送信先アドレスを表示するレポートを 1 つ生成します。

<?xml version="1.0" encoding="UTF-8"?>
<actions>
 <MessageDetailsRequest>
  <request>
   <requestId>testRequest</client>
   <condition>
    <priority>9</priority>
   </condition>
   <messageId/>
   <status/>
   <address/>
  </request>
 </MessageDetailsRequest>
</actions>

次のメッセージの詳細要求サンプルでは、メッセージ ID とメッセージ・ステータスを含むレポートを生成します。

<?xml version="1.0" encoding="UTF-8"?>
<actions>
  <MessageDetailsRequest>
    <!-- ... -->
    <messageId />
    <status />
  </MessageDetailsRequest>
</actions>