リソース: export

このページでは、メールボックスをダウンロードする際に Email Audit API の export リソースで使用できるパラメータについて説明します。

フィールド 説明
beginDate

省略可。

エクスポートされたメールボックスに含まれる最初のメールの日付。アカウントの作成時からすべてのメールを取得する場合は、このフィールドに値を入力しないでください。日付の形式は YYYY-MM-dd HH:mm です。HH は 0 ～ 23 の 1 日の時刻、mm は 0 ～ 59 の 1 時間の分です。

タイムゾーンは協定世界時（UTC）形式です。メールボックスのエクスポートを開始する前に、時間を UTC 形式に変換します。
endDate

省略可。

エクスポートされたメールボックスに含まれる最後のメールの日付。この値を指定しない場合、エクスポートされたメールは現在の日付に移動します。日付形式は YYYY-MM-dd HH:mm です。HH は 0 ～ 23 を使用した時間、mm は 0 ～ 59 を使用した分です。

タイムゾーンは協定世界時（UTC）形式です。メールボックスのエクスポートを開始する前に、時間を UTC 形式に変換します。
searchQuery

省略可。

メールボックスは searchQuery 値を使用してフィルタされ、フィルタされた検索結果のみをダウンロードできます。これらのクエリは、Gmail の高度な検索と同じ検索ルールに従います。

searchQuery パラメータと includeDeleted パラメータは相互に排他的です。includeDeleted = "true" の場合、検索クエリはできません。
includeDeleted

省略可。

削除されたメッセージをメールボックスのエクスポート ファイルに含めるかどうかを指定します。デフォルトでは、値は "false" で、削除されたメッセージは含まれません。

searchQuery パラメータと includeDeleted パラメータは相互に排他的です。includeDeleted = "true" の場合、検索クエリはできません。
packageContent

必須。

メールボックスのエクスポート ファイルでメール全体を使用するか、メールのヘッダーを使用するかを決定します。

  • FULL_MESSAGE: 添付ファイルを含むメールの全文がエクスポート ファイルにコピーされます。これがデフォルト設定です。
  • HEADER_ONLY: メール ヘッダーのみがエクスポート ファイルにコピーされます。