REST Resource: users.messages

Recurso: Message

Un mensaje de correo electrónico

Representación 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

Es el ID inmutable del mensaje.
threadId

string

ID del subproceso al que pertenece el mensaje. Para agregar un mensaje o un borrador a un hilo, se deben cumplir los siguientes criterios:

  1. El threadId solicitado debe especificarse en el Message o el Draft.Message que proporciones con tu solicitud.
  2. Los encabezados References y In-Reply-To deben establecerse de conformidad con el estándar RFC 2822.
  3. Los encabezados Subject deben coincidir.
labelIds[]

string

Es la lista de IDs de las etiquetas aplicadas a este mensaje.
snippet

string

Es una parte breve del texto del mensaje.
historyId

string

Es el ID del último registro del historial que modificó este mensaje.
internalDate

string (int64 format)

Es la marca de tiempo interna de creación del mensaje (ms de época), que determina el orden en la carpeta Recibidos. En el caso de los correos electrónicos normales recibidos por SMTP, esto representa la hora en que Google aceptó originalmente el mensaje, que es más confiable que el encabezado Date. Sin embargo, en el caso del correo electrónico migrado a la API, se puede configurar por cliente para que se base en el encabezado Date.
payload

object (MessagePart)

Es la estructura de correo electrónico analizada en las partes del mensaje.
sizeEstimate

integer

Tamaño estimado del mensaje en bytes.
raw

string (bytes format)

Es todo el mensaje de correo electrónico en una cadena con formato RFC 2822 y codificación base64url. Se devuelve en las respuestas de messages.get y drafts.get cuando se proporciona el parámetro format=RAW.

String codificada en base64.
classificationLabelValues[]

object (ClassificationLabelValue)

Son los valores de las etiquetas de clasificación del mensaje. Los esquemas de etiquetas de clasificación disponibles se pueden consultar con la API de Google Drive Labels. Cada ID de etiqueta de clasificación debe ser único. Si se proporcionan IDs duplicados, solo se conservará uno, y la selección será arbitraria. Solo se usa para las cuentas de Google Workspace.

MessagePart

Es una sola parte de un mensaje MIME.

Representación JSON 
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
Campos
partId

string

Es el ID inmutable de la parte del mensaje.
mimeType

string

Es el tipo de MIME de la parte del mensaje.
filename

string

Nombre del archivo adjunto. Solo está presente si esta parte del mensaje representa un adjunto.
headers[]

object (Header)

Es la lista de encabezados de esta parte del mensaje. En el caso de la parte del mensaje de nivel superior, que representa toda la carga útil del mensaje, contendrá los encabezados de correo electrónico estándar de RFC 2822, como To, From y Subject.
body

object (MessagePartBody)

Es el cuerpo de la parte del mensaje para esta parte, que puede estar vacío para las partes del mensaje MIME del contenedor.
parts[]

object (MessagePart)

Son las partes secundarias del mensaje MIME de esta parte. Esto solo se aplica a las partes de mensajes MIME de contenedores, por ejemplo, multipart/*. Para los tipos de partes de mensajes MIME que no son contenedores, como text/plain, este campo está vacío. Para obtener más información, consulta RFC 1521.
Representación JSON 
{
  "name": string,
  "value": string
}
Campos
name

string

Nombre del encabezado antes del separador :. Por ejemplo, To
value

string

Valor del encabezado después del separador :. Por ejemplo, someuser@example.com

ClassificationLabelValue

Son las etiquetas de clasificación que se aplicaron al mensaje de correo electrónico. Las etiquetas de clasificación son diferentes de las etiquetas de la carpeta Recibidos de Gmail. Solo se usa para las cuentas de Google Workspace. Obtén más información sobre las etiquetas de clasificación.

Representación JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Campos
labelId

string

Obligatorio. Es el ID de etiqueta de clasificación alfanumérico canónico o sin procesar. Se asigna al campo ID del recurso de la etiqueta de Google Drive.
fields[]

object (ClassificationLabelFieldValue)

Son los valores de los campos para el ID de etiqueta de clasificación determinado.

ClassificationLabelFieldValue

Son los valores de campo de una etiqueta de clasificación.

Representación JSON 
{
  "fieldId": string,
  "selection": string
}
Campos
fieldId

string

Obligatorio. Es el ID del campo para el valor de la etiqueta de clasificación. Se asigna al campo ID del objeto Label.Field de Google Drive.
selection

string

Es el ID de la opción de selección. Solo se debe establecer si el tipo de campo es SELECTION en el objeto Label.Field de Google Drive. Se asigna al campo id del recurso Label.Field.SelectionOptions de Google Drive.

Métodos

batchDelete

 Borra muchos mensajes por ID.

batchModify

 Modifica las etiquetas de los mensajes especificados.

delete

 Borra de forma inmediata y permanente el mensaje especificado.

get

 Obtiene el mensaje especificado.

import

 Importa un mensaje solo a la casilla de correo de este usuario, con la clasificación y el análisis de entrega de correo electrónico estándar similares a los de la recepción a través de SMTP.

insert

 Inserta directamente un mensaje solo en el buzón de este usuario, de forma similar a IMAP APPEND, y omite la mayoría de los procesos de análisis y clasificación.

list

 Enumera los mensajes de la casilla de correo del usuario.

modify

 Modifica las etiquetas del mensaje especificado.

send

 Envía el mensaje especificado a los destinatarios en los encabezados To, Cc y Bcc.

trash

 Mueve el mensaje especificado a la papelera.

untrash

 Quita el mensaje especificado de la papelera.