Recurso: export

Esta página documenta os parâmetros disponíveis para o recurso export da API Email Audit ao fazer o download de uma caixa de correio.

Campos Descrição
beginDate

Opcional.

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

O fuso horário está no formato de horário universal coordenado (UTC). Converta o horário para o formato UTC antes de iniciar uma exportação de caixa de correio.

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 ser enviados na data atual. O formato da data é YYYY-MM-dd HH:mm, em que HH é a hora do dia usando 0 a 23, e mm é o minuto da hora usando 0 a 59.

O fuso horário está no formato de horário universal coordenado (UTC). Converta o horário para o formato UTC antes de iniciar uma exportação de caixa de correio.

searchQuery

Opcional.

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

Os parâmetros searchQuery e includeDeleted são mutuamente exclusivos. Não é possível fazer uma consulta de pesquisa 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 correio. 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. Não é possível fazer uma consulta de pesquisa 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: apenas o cabeçalho do e-mail é copiado para o arquivo de exportação.