Ressource : export

Cette page décrit les paramètres disponibles pour la ressource export de l'API Email Audit lors du téléchargement d'une boîte de réception.

Champs Description
beginDate

Facultatif.

Date du premier e-mail inclus dans la boîte de réception exportée. Si vous souhaitez que tous les e-mails soient inclus à partir de la date de création du compte, ne saisissez aucune valeur pour ce champ.Le format de date est YYYY-MM-dd HH:mm, où HH correspond à l'heure de la journée (entre 0 et 23) et mm aux minutes de l'heure (entre 0 et 59).

Le fuseau horaire est au format UTC (temps universel coordonné). Convertissez votre heure au format UTC avant de commencer à exporter une boîte de réception.

endDate

Facultatif.

Date du dernier e-mail inclus dans la boîte de réception exportée. Si cette valeur n'est pas spécifiée, la date actuelle est utilisée pour les e-mails exportés. Le format de date est YYYY-MM-dd HH:mm, où HH correspond à l'heure de la journée (entre 0 et 23) et mm aux minutes de l'heure (entre 0 et 59).

Le fuseau horaire est au format UTC (temps universel coordonné). Convertissez votre heure au format UTC avant de commencer à exporter une boîte de réception.

searchQuery

Facultatif.

La boîte de réception est filtrée à l'aide de la valeur searchQuery, et seuls les résultats de recherche filtrés sont disponibles à télécharger. Ces requêtes suivent les mêmes règles de recherche que la recherche avancée dans Gmail.

Les paramètres searchQuery et includeDeleted s'excluent mutuellement. Une requête de recherche n'est pas possible si : includeDeleted = "true".

includeDeleted

Facultatif.

Détermine si les messages supprimés sont inclus ou non dans le fichier d'exportation de la boîte de réception. Par défaut, la valeur est "false" et les messages supprimés ne sont pas inclus.

Les paramètres searchQuery et includeDeleted s'excluent mutuellement. Une requête de recherche n'est pas possible si : includeDeleted = "true".

packageContent

Obligatoire.

Détermine si l'e-mail complet ou l'en-tête de l'e-mail sont utilisés dans le fichier d'exportation de la boîte aux lettres.

  • FULL_MESSAGE: le texte complet de l'e-mail, y compris les pièces jointes, est copié dans le fichier d'exportation. Il s'agit du paramètre par défaut.
  • HEADER_ONLY: seul l'en-tête de l'e-mail est copié dans le fichier d'exportation.