Ressource : export

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

Champs Description
beginDate

Facultatif.

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

Le fuseau horaire est au format UTC (Coordinate Universal Time). Convertissez l'heure au format UTC avant de lancer une exportation de boîte aux lettres.

endDate

Facultatif.

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

Le fuseau horaire est au format UTC (Coordinate Universal Time). Convertissez l'heure au format UTC avant de lancer une exportation de boîte aux lettres.

searchQuery

Facultatif.

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

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

includeDeleted

Facultatif.

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

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

packageContent

Obligatoire.

Détermine si l'e-mail complet ou son en-tête est utilisé 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.