リソース: 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 の 1 日の時間を表し、mm は 0 ～ 59 の 1 時間の分を表します。

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

省略可。

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

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

省略可。

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

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

必須。

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

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