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 Draft.Message fornecido com sua solicitação.
  2. Os cabeçalhos References e In-Reply-To precisam ser definidos de acordo com o padrão RFC 2822.
  3. Os cabeçalhos Subject precisam ser correspondentes.

labelIds[]

string

Lista de IDs dos marcadores aplicados a esta mensagem.

snippet

string

É uma parte curta do texto da mensagem.

historyId

string

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

internalDate

string (int64 format)

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

payload

object (MessagePart)

A estrutura de e-mail 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 RFC 2822 e codificada em base64url. 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 do arquivo do anexo. Só estará presente se esta parte da mensagem representar um anexo.

headers[]

object (Header)

Lista de cabeçalhos nesta parte da mensagem. A parte de nível superior da mensagem, que representa todo o payload da mensagem, contém os cabeçalhos de e-mail RFC 2822 padrão, como To, From e Subject.

body

object (MessagePartBody)

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

parts[]

object (MessagePart)

As partes da mensagem MIME filha dessa parte. Isso só se aplica 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êineres, como text/plain, esse campo fica vazio. Para mais informações, consulte a 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 de forma imediata e permanente a mensagem especificada.

get

Recebe a mensagem especificada.

import

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

insert

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

list

Lista as mensagens na caixa de correio do usuário.

modify

Modifica os marcadores na mensagem especificada.

send

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

trash

Move a mensagem especificada para a lixeira.

untrash

Remove a mensagem especificada da lixeira.