Recurso: export

Nesta página, documentamos os parâmetros disponíveis para o recurso export da API Email Audit ao fazer o download de uma caixa de e-mails.

Campos Descrição
beginDate

Opcional.

A data do primeiro e-mail incluído na caixa de e-mails exportada. Se você quiser todos os e-mails a partir da criação da conta, não insira um valor nesse campo.O formato da data é YYYY-MM-dd HH:mm, em que HH é a hora do dia usando de 0 a 23 e mm são os minutos da hora usando 0 a 59.

O fuso horário está no formato UTC (Tempo Univeral Coordenado). Converta seu horário para o formato UTC antes de iniciar uma exportação da caixa de e-mails.

endDate

Opcional.

A data do último e-mail incluído na caixa de e-mails exportada. Se esse valor não for especificado, os e-mails exportados vão para a data atual. O formato de data é YYYY-MM-dd HH:mm, em que HH é a hora do dia usando 0 - 23 e mm são os minutos da hora usando 0 - 59.

O fuso horário está no formato UTC (Tempo Univeral Coordenado). Converta seu horário para o formato UTC antes de iniciar uma exportação da caixa de e-mails.

searchQuery

Opcional.

A caixa de e-mails é filtrada usando o valor searchQuery, e apenas os resultados da pesquisa filtrados ficam disponíveis para download. Essas consultas seguem as mesmas regras de pesquisa que a pesquisa avançada no Gmail.

Os parâmetros searchQuery e includeDeleted são mutuamente exclusivos. Uma consulta de pesquisa não será possível se includeDeleted = "true".

includeDeleted

Opcional.

Determina se as mensagens excluídas são incluídas ou não no arquivo de exportação da caixa de e-mails. Por padrão, o valor é "false", e as mensagens excluídas não são incluídas.

Os parâmetros searchQuery e includeDeleted são mutuamente exclusivos. Uma consulta de pesquisa não será possível se includeDeleted = "true".

packageContent

Obrigatório.

Determina se o e-mail completo ou o cabeçalho do e-mail são usados no arquivo de exportação da caixa de e-mails.

  • FULL_MESSAGE: o texto completo do e-mail, incluindo anexos, é copiado para o arquivo de exportação. Essa é a configuração padrão.
  • HEADER_ONLY: somente o cabeçalho do e-mail é copiado para o arquivo de exportação.