Ressource : export

Cette page décrit les paramètres disponibles pour la ressource export de l'API Email Audit lorsque vous téléchargez 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 recevoir tous les e-mails depuis la création du compte, ne saisissez aucune valeur dans ce champ.Le format de la date est YYYY-MM-dd HH:mm, où HH correspond à l'heure de la journée (de 0 à 23) et mm aux minutes de l'heure (de 0 à 59).

Le fuseau horaire est au format UTC (temps universel coordonné). Convertissez votre heure au format UTC avant de commencer l'exportation de la 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 associés à la date actuelle. Le format de date est YYYY-MM-dd HH:mm, où HH correspond à l'heure de la journée (de 0 à 23) et mm aux minutes de l'heure (de 0 à 59).

Le fuseau horaire est au format UTC (temps universel coordonné). Convertissez votre heure au format UTC avant de commencer l'exportation de la boîte aux lettres.

searchQuery

Facultatif.

La boîte aux lettres est filtrée à l'aide de la valeur searchQuery. Seuls les résultats de recherche filtrés sont disponibles au téléchargement. 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. Il n'est pas possible d'effectuer une requête de recherche 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 aux lettres. 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. Il n'est pas possible d'effectuer une requête de recherche si includeDeleted = "true".

packageContent

Obligatoire.

Détermine si l'adresse e-mail complète 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.