REST Resource: users.messages

Recurso: mensagem

Uma mensagem de e-mail.

Representação JSON
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string
}
Campos
id

string

O ID imutável da mensagem.

threadId

string

O ID da conversa a que a mensagem pertence. Para adicionar uma mensagem ou um rascunho a uma conversa, é preciso atender aos seguintes critérios:

  1. O threadId solicitado precisa ser especificado no Message ou no Draft.Message fornecido com sua solicitação.
  2. Os cabeçalhos References e In-Reply-To precisam ser definidos em conformidade com o padrão RFC 2822.
  3. Os cabeçalhos Subject precisam ser iguais.

labelIds[]

string

Lista de IDs de marcadores aplicados a esta mensagem.

snippet

string

Uma parte curta do texto da mensagem.

historyId

string

O ID do último registro do histórico que modificou esta mensagem.

internalDate

string (int64 format)

O carimbo de data/hora interno da criação da mensagem (época em ms), que determina a ordem na caixa de entrada. Para e-mails recebidos por SMTP normais, ele representa a hora em que a mensagem foi aceita originalmente pelo Google, o que é mais confiável do que o cabeçalho Date. No entanto, para e-mails migrados pela API, ele pode ser configurado pelo cliente para ser baseado no cabeçalho Date.

payload

object (MessagePart)

A estrutura de e-mails analisada nas partes da mensagem.

sizeEstimate

integer

Tamanho estimado em bytes da mensagem.

raw

string (bytes format)

A mensagem de e-mail inteira em uma string formatada em base64url e formatada em RFC 2822. Retornado nas respostas messages.get e drafts.get quando o parâmetro format=RAW é fornecido.

Uma string codificada em base64.

MessagePart

Uma única parte da mensagem MIME.

Representação JSON
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
Campos
partId

string

O ID imutável da parte da mensagem.

mimeType

string

O tipo MIME da parte da mensagem.

filename

string

O nome de arquivo do anexo. Presente apenas se a parte da mensagem representar um anexo.

headers[]

object (Header)

Lista de cabeçalhos nesta parte da mensagem. Para a parte da mensagem de nível superior, que representa todo o payload da mensagem, ela conterá os cabeçalhos de e-mail RFC 2822 padrão, como To, From e Subject.

body

object (MessagePartBody)

O corpo da parte da mensagem para esta parte, que pode estar vazio para as partes da mensagem MIME do contêiner.

parts[]

object (MessagePart)

As partes filhas da mensagem MIME dessa parte. Isso se aplica apenas a partes da mensagem MIME do contêiner, por exemplo, multipart/*. Para tipos de partes de mensagens MIME que não são de contêiner, como text/plain, esse campo fica vazio. Para mais informações, consulte RFC 1521 (em inglês).

Representação JSON
{
  "name": string,
  "value": string
}
Campos
name

string

O nome do cabeçalho antes do separador :. Por exemplo, To.

value

string

O valor do cabeçalho após o separador :. Por exemplo, someuser@example.com.

Métodos

batchDelete

Exclui muitas mensagens por ID.

batchModify

Modifica os marcadores nas mensagens especificadas.

delete

Exclui a mensagem especificada de forma imediata e permanente.

get

Recebe a mensagem especificada.

import

Importa uma mensagem apenas para a caixa de correio deste usuário, com verificação de entrega de e-mail padrão e classificação semelhante ao recebimento por SMTP.

insert

Insere diretamente uma mensagem apenas na caixa de e-mails deste usuário, semelhante a IMAP APPEND, ignorando a maioria das verificações e classificações.

list

Lista as mensagens na caixa de e-mails do usuário.

modify

Modifica os marcadores na mensagem especificada.

send

Envia a mensagem especificada para os destinatários nos cabeçalhos To, Cc e Bcc.

trash

Move a mensagem especificada para a lixeira.

untrash

Remove a mensagem especificada da lixeira.