リソース: export

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

フィールド 説明
beginDate

省略可。

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

タイムゾーンは、協定世界時(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: メールのヘッダーのみがエクスポート ファイルにコピーされます。