10.3.2　データ送受信管理コマンド一覧

(a)　形式

DWClientUtil.bat△GETOUTBOX
   [△-recieverid△配送先ユーザID | -receivermail△配送先ユーザメールアドレス]
   [△-detail]
   [△-inprogress]
   △-fromdate△取得配送情報開始日
   △-todate△取得配送情報終了日
   △-result△実行結果ファイルパス
   △-property△コマンドプロパティファイルパス

(b)　引数

注※

配送の作成日は，ユーザが送信を開始した日です。

(c)　解説

(i)引数-detailを指定した場合について

引数-detailを指定した場合に出力される実行結果ファイルの形式を次に示します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" send-status="on-approving" create-date="2014/07/29 11:40" send-date="" shelf-life-time="2014/08/29 23:59" subject="ＸＸ開発プロジェクトの件" message="資料送付します。" total-size="2364662">
            <sender id="user1@domain1" email="user1@domain1.co.jp">
                <files>
                    <file id="130" type="file" name="ＸＸ報告書.doc" size="266752"/>
                    <file id="131" type="file" name="ＸＸ開発資料一式.zip" size="2097910"/>
                </files>
            </sender>
            <receivers>
                <receiver id="user2@domain1" to-type="TO" url="https://jp1dhserver.co.jp/receipt.jspx?servlet-action=receipt&amp;id=389&amp;cc=8014d12f457e410b09bffdfbd629dcc821d2896e" email="user2@domain1.co.jp">
                    <files>
                        <file id="130" download-date=""/>
                        <file id="131" download-date=""/>
                    </files>
                </receiver>
            </receivers>
            <approvers>
                <approver email="approver01@domain1.co.jp" id="approver01@domain1"/>
            </approvers>
        </delivery>
    </deliveries>
</data>

(ii)引数-detailを指定しなかった場合について

引数-detailを指定しなかった場合に出力される実行結果ファイルの形式を次に示します。引数-detailを指定した場合と異なり，file要素，approvers要素，message属性を出力しません。また，受信者情報はメールアドレスだけを出力します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" send-status="on-approving" create-date="2014/07/29 11:40" send-date="" shelf-life-time="2014/08/29 23:59" subject="ＸＸ開発プロジェクトの件" total-size="2364662">
            <sender id="user1@domain1" email="user1@domain1.co.jp"/>
            <receivers>
                <receiver email="user2@domain1.co.jp"/>
            </receivers>
        </delivery>
    </deliveries>
</data>

(iii)実行結果ファイル形式詳細

実行結果ファイルに出力される要素の意味を次の表に示します。なお，XMLでの特殊な記号はエンティティ参照（エスケープ文字）に置き換えて出力されます。

表10‒3　実行結果ファイルの意味

要素/属性							個数	説明
data/deliveries要素							1	常に出力されます。
	delivery要素						n	配送情報タグ
		id属性					1	配送IDが出力されます。 配送を特定するために使用します。
		send-status属性					1	配送のステータスが出力されます。 in-progress：送信中 failed：送信失敗 suspended：一時停止 on-approving：承認待ち rejected：承認却下 completed：配送済み
		create-date属性					1	配送の作成日時が出力されます。
		send-date属性					1	配送の送信日時が出力されます。 未承認の場合は出力されません。
		subject属性					1	配送の件名が出力されます。
		message属性					1	送信者の入力したメッセージが出力されます。
		shelf-life-time属性					1	保管期限が出力されます。
		total-size属性					1	総データサイズ（バイト数）が出力されます。
		sender要素					1	送信者情報タグ
			id属性				1	送信者のユーザIDが出力されます。
			email属性				1	送信者のメールアドレスが出力されます。
			files要素				1	送信ファイル/フォルダ情報タグ
				file要素			n	送信ファイル/フォルダ単位の送信ファイル/フォルダ情報タグ
					id属性		1	ファイル/フォルダのIDが出力されます。
					type属性		1	ファイル/フォルダの種別が出力されます。 ファイル："file" フォルダ："folder"
					name属性		1	ファイル/フォルダの名称が出力されます。
					size属性		1	ファイル/フォルダのサイズ（バイト数）が出力されます。
		receivers要素					1	受信者情報タグ
			receiver要素				n	受信者が出力されます。配送に複数の受信者がいる場合はその数だけ出力されます。-receiveridオプションを使用した場合もすべての受信者が出力されます。
				id属性			1	受信者のユーザIDが出力されます。
				url属性			1	受信者の開封URLが出力されます。
				to-type属性			1	受信者の宛先タイプ（TO|CC|BCC）が出力されます。
				email属性			1	受信者のメールアドレスが出力されます。
				files要素			1	受信ファイル/フォルダ情報タグ
					file要素		n	受信ファイル/フォルダの単位の受信ファイル/フォルダ情報タグ
						id属性	1	ファイル/フォルダのIDが出力されます。
						download-date属性	1	ファイル/フォルダをダウンロードした日付が出力されます。
		approvers要素					1	承認者情報タグ（承認者がいない場合はこのタグを出力しません。）
			approver要素				n	承認者単位の承認者情報タグ
				id属性			1	承認者のユーザIDが出力されます。
				email属性			1	承認者のメールアドレスが出力されます。

重要

受信者のユーザが削除されている場合，該当ユーザの情報を示す属性は出力されないことがあります。

(d)　実行例

DWClientUtil.bat GETOUTBOX
 -fromdate "2014/06/01" 
 -todate "2014/06/30"
 -result "C:\DWCLient\OUTBOX-result.xml"
 -property "C:\DWCLient\property.xml"

(a)　形式

DWClientUtil.bat△GETINBOX
   [△-senderid△送信元ユーザID | -sendermail△送信元メールアドレス]
   [△-detail]
   [△-inprogress]
   △-fromdate△取得配送情報開始日
   △-todate△取得配送情報終了日
   △-result△実行結果ファイルパス
   △-property△コマンドプロパティファイルパス

(b)　引数

(c)　解説

(i)引数-detailを指定した場合について

引数-detailを指定した場合に出力される実行結果ファイルの形式を次に示します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" download-status="downloaded" send-date="2014/07/29 11:43" shelf-life-time="2014/08/29 23:59" subject="ＸＸ開発プロジェクトの件" total-size="2364662">
            <sender id="user1@domain1" email="user1@domain1.co.jp">
                <files>
                    <file id="130" type="file" name="ＸＸ報告書.doc" size="266752"/>
                    <file id="131" type="file" name="ＸＸ開発資料一式.zip" size="2097910"/>
                </files>
            </sender>
            <message>資料送付します。</message>
        </delivery>
    </deliveries>
</data>

(ii)引数-detailを指定しなかった場合について

引数-detailを指定しなかった場合に出力される実行結果ファイルの形式を次に示します。引数-detailを指定した場合と異なり，file要素，message属性，total-size属性を出力しません。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<data>
    <deliveries>
        <delivery id="154" download-status="downloaded" send-date="2014/07/29 11:43" shelf-life-time="2014/08/29 23:59" subject="ＸＸ開発プロジェクトの件">
            <sender id="user1@domain1" email="user1@domain1.co.jp"/>
        </delivery>
    </deliveries>
</data>

(iii)実行結果ファイル形式詳細

実行結果ファイルに出力される要素の意味を次の表に示します。なお，XMLでの特殊な記号はエンティティ参照（エスケープ文字）に置き換えて出力されます。

表10‒5　実行結果ファイルの意味

要素/属性						個数	説明
data要素						1	常に出力されます。
	delivery要素					n	配送単位の配送情報タグ
		id属性				1	配送IDが出力されます。 配送を特定するために使用します。
		download-status属性				1	配送のステータスが出力されます。 not-opened：未開封 opened：開封済み downloaded：ダウンロード済み
		send-date属性				1	送信日時が出力されます。
		shelf-life-time属性				1	保管期限が出力されます。
		subject属性				1	配送の件名が出力されます。
		total-size属性				1	総データサイズ（バイト数）が出力されます。
		sender要素				1	送信者情報タグ
			id属性			1	送信者のユーザIDが出力されます。
			email属性			1	送信者のメールアドレスが出力されます。
			files要素			1	送信ファイル/フォルダ情報タグ
				file要素		n	送信ファイル/フォルダ単位の送信ファイル/フォルダ情報タグ
					id属性	1	ファイル/フォルダのIDが出力されます。
					type属性	1	ファイル/フォルダの種別が出力されます。 ファイル："file" フォルダ："folder"
					name属性	1	ファイル/フォルダの名称が出力されます。
					size属性	1	ファイル/フォルダのサイズ（バイト数）が出力されます。
		message属性				1	送信者の入力したメッセージが出力されます。

重要

送信者のユーザが削除されている場合，該当ユーザの情報を示す属性は出力されないことがあります。

(d)　実行例

DWClientUtil.bat GETINBOX
 -fromdate "2014/06/01"
 -todate "2014/06/30"
 -result "C:\DWCLient\INBOX-result.xml"
 -property "C:\DWCLient\property.xml"

(a)　形式

DWClientUtil.bat△CANCEL
 [△-deliveryid△配送ID]
  △-property△コマンドプロパティファイルパス

(b)　引数

(c)　解説

(i)前提条件

この機能によって配送をキャンセルするためには，配送IDで指定された転送の実行ユーザが，このコマンドの実行ユーザ（-propertyオプションで指定されたプロパティファイルに記載されたユーザ）と同一ユーザである必要があります。同一ユーザでない場合はエラーとなります。

ユーザIDが同一であれば，送信／受信コマンドと配送キャンセルコマンドの実行端末は異なっていても構いません。

重要

• 配送キャンセルされた配送を再開することはできません。

• 送信／受信コマンドの実行中に，配送IDを省略した配送キャンセルを行うと，エラーが発生する場合があります。この場合，再度，配送キャンセルを実行してください。

(a)　形式

DWClientUtil.bat△DELETEDELIVERY
   △-deliveryid△配送ID
   △-property△コマンドプロパティファイルパス

(b)　引数

(c)　解説

(i)前提条件

この機能により配送を削除するためには，配送IDで指定された配送が，このコマンドの実行ユーザ（-propertyオプションで指定されたプロパティファイルに記載されたユーザ）と同一ユーザである必要があります。同一ユーザでない場合はエラーとなります。

ユーザIDが同一であれば，ファイルの送信コマンドと配送削除コマンドの実行端末は異なっていても構いません。

重要

• JP1/DH - ServerがWindows版の場合，指定した配送がダウンロード中の場合は削除できません。Linux版の場合，ダウンロード中でも配送を削除できますが，ダウンロードは継続されます。

• 配送IDが存在しない場合や，指定した配送IDの配送を削除できる権限がない場合はエラーとなります。

(a)　形式

形式を次に示します。

DWClientUtil.bat△GETRESOURCEINFO
   △-result△実行結果ファイルパス
   △-property△コマンドプロパティファイルパス

(b)　引数

リソース使用状況取得コマンドの引数を次の表に示します。

(c)　解説

リソース使用状況取得コマンドの詳細を次に示します。

(d)　実行結果ファイル形式

出力される実行結果ファイルの形式を次に示します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<information>
      <user>
            <disk-space>
                  <used>1002000000</used>
                  <limit>2000000000</limit>
            </disk-space>
      </user>
      <domain>
            <disk-space>
                  <used>10000000002</used>
                  <limit>20000000000</limit>
            </disk-space>
            <download-transfer>
                  <used>150000000000</used>
                  <limit>200000000000</limit>
            </download-transfer>
      </domain>
</information>

(e)　実行結果ファイル形式詳細

実行結果ファイルに出力される要素の意味を次の表に示します。なお，XMLでの特殊な記号はエンティティ参照（エスケープ文字）に置き換えて出力されます。

(f)　実行例

実行例を次に示します。

DWClientUtil.bat GETRESOURCEINFO
 -result "C:\DWCLient\RESOURCEINFO-result.xml"
 -property "C:\DWCLient\property.xml"