REST Resource: users.messages

Recurso: Message

Um e-mail.

Representação JSON 
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
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 a 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 dos rótulos 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 (ms da época), que determina a ordem na caixa de entrada. Para e-mails recebidos por SMTP, isso representa o momento 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 por API, ele pode ser configurado pelo cliente com base no cabeçalho Date.
payload

object (MessagePart)

A estrutura de e-mail analisada nas partes da mensagem.
sizeEstimate

integer

Tamanho estimado da mensagem em bytes.
raw

string (bytes format)

Toda a mensagem de e-mail 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.
classificationLabelValues[]

object (ClassificationLabelValue)

Valores do marcador de classificação na mensagem. Os esquemas de marcadores de classificação disponíveis podem ser consultados usando a API Google Drive Labels. Cada ID de marcador de classificação precisa ser exclusivo. Se IDs duplicados forem fornecidos, apenas um será mantido, e a seleção é arbitrária. Usado apenas para contas do Google Workspace.

MessagePart

Uma única parte de 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. Presente apenas se esta 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 vai conter os cabeçalhos de e-mail padrão RFC 2822, como To, From e Subject.
body

object (MessagePartBody)

O corpo da parte da mensagem, que pode estar vazio para partes de mensagens MIME de contêiner.
parts[]

object (MessagePart)

As partes da mensagem MIME secundária desta parte. Isso só se aplica a partes de mensagens MIME de contêineres, por exemplo, multipart/*. Para tipos de partes de mensagens MIME que não são 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.

ClassificationLabelValue

Marcadores de classificação aplicados à mensagem de e-mail. Os marcadores de classificação são diferentes dos marcadores da caixa de entrada do Gmail. Usado apenas para contas do Google Workspace. Saiba mais sobre os rótulos de classificação.

Representação JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Campos
labelId

string

Obrigatório. O ID do rótulo de classificação alfanumérica canônico ou bruto. Corresponde ao campo "ID" do recurso "Rótulo do Google Drive".
fields[]

object (ClassificationLabelFieldValue)

Valores de campo para o ID do rótulo de classificação especificado.

ClassificationLabelFieldValue

Valores de campo para um rótulo de classificação.

Representação JSON 
{
  "fieldId": string,
  "selection": string
}
Campos
fieldId

string

Obrigatório. O ID do campo para o valor do rótulo de classificação. Corresponde ao campo "ID" do objeto Label.Field do Google Drive.
selection

string

ID da opção de seleção. Só deve ser definido se o tipo de campo for SELECTION no objeto Label.Field do Google Drive. Corresponde ao campo "id" do recurso Label.Field.SelectionOptions do Google Drive.

Métodos

batchDelete

 Exclui várias mensagens por ID.

batchModify

 Modifica os marcadores nas mensagens especificadas.

delete

 Exclui imediatamente e de forma permanente a mensagem especificada.

get

 Recebe a mensagem especificada.

import

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

insert

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

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.