REST Resource: users.messages

Ressource : Message

un e-mail ;

Représentation JSON
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Champs
id

string

ID immuable du message.

threadId

string

ID du thread auquel appartient le message. Pour ajouter un message ou un brouillon à un fil de discussion, vous devez remplir les critères suivants :

  1. Le threadId demandé doit être spécifié dans le Message ou le Draft.Message que vous fournissez avec votre demande.
  2. Les en-têtes References et In-Reply-To doivent être définis conformément à la norme RFC 2822.
  3. Les en-têtes Subject doivent correspondre.

labelIds[]

string

Liste des ID des libellés appliqués à ce message.

snippet

string

Courte partie du texte du message.

historyId

string

ID du dernier enregistrement de l'historique ayant modifié ce message.

internalDate

string (int64 format)

Code temporel de création du message interne (en ms depuis l'epoch), qui détermine l'ordre dans la boîte de réception. Pour les e-mails reçus par SMTP, cela représente l'heure à laquelle le message a été initialement accepté par Google, ce qui est plus fiable que l'en-tête Date. Toutefois, pour les e-mails migrés via l'API, le client peut configurer l'en-tête Date comme base.

payload

object (MessagePart)

Structure de l'e-mail analysée dans les parties du message.

sizeEstimate

integer

Taille estimée du message en octets.

raw

string (bytes format)

L'intégralité du message électronique sous la forme d'une chaîne encodée en base64url et au format RFC 2822. Renvoie les réponses messages.get et drafts.get lorsque le paramètre format=RAW est fourni.

Chaîne encodée en base64.

classificationLabelValues[]

object (ClassificationLabelValue)

Valeurs des libellés de classification dans le message. Vous pouvez interroger les schémas de libellés de classification disponibles à l'aide de l'API Google Drive Labels. Chaque ID de libellé de classification doit être unique. Si des ID en double sont fournis, un seul sera conservé, et la sélection est arbitraire. Uniquement utilisé pour les comptes Google Workspace.

MessagePart

Partie d'un message MIME.

Représentation JSON
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
Champs
partId

string

ID immuable de la partie du message.

mimeType

string

Type MIME de la partie du message.

filename

string

Nom du fichier de la pièce jointe. Présent uniquement si cette partie du message représente une pièce jointe.

headers[]

object (Header)

Liste des en-têtes de cette partie du message. Pour la partie du message de premier niveau, qui représente l'intégralité de la charge utile du message, elle contient les en-têtes d'e-mail RFC 2822 standards tels que To, From et Subject.

body

object (MessagePartBody)

Corps de la partie du message pour cette partie, qui peut être vide pour les parties de message MIME de conteneur.

parts[]

object (MessagePart)

Parties du message MIME enfant de cette partie. Cela ne s'applique qu'aux parties de message MIME de conteneur, par exemple multipart/*. Pour les types de parties de message MIME non conteneurs, tels que text/plain, ce champ est vide. Pour en savoir plus, consultez la norme RFC 1521.

Représentation JSON
{
  "name": string,
  "value": string
}
Champs
name

string

Nom de l'en-tête avant le séparateur :. Exemple :To

value

string

Valeur de l'en-tête après le séparateur :. Exemple :someuser@example.com

ClassificationLabelValue

Libellés de classification appliqués au message. Les libellés de classification sont différents des libellés de la boîte de réception Gmail. Uniquement utilisé pour les comptes Google Workspace. En savoir plus sur les libellés de classification

Représentation JSON
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Champs
labelId

string

Obligatoire. ID de libellé de classification alphanumérique canonique ou brut. Correspond au champ "ID" de la ressource "Libellé Google Drive".

fields[]

object (ClassificationLabelFieldValue)

Valeurs des champs pour l'ID de libellé de classification donné.

ClassificationLabelFieldValue

Valeurs de champ pour un libellé de classification.

Représentation JSON
{
  "fieldId": string,
  "selection": string
}
Champs
fieldId

string

Obligatoire. ID du champ pour la valeur du libellé de classification. Correspond au champ "ID" de l'objet Label.Field Google Drive.

selection

string

ID du choix de sélection pour l'option de sélection. Ne doit être défini que si le type de champ est SELECTION dans l'objet Label.Field Google Drive. Correspond au champ "id" de la ressource Label.Field.SelectionOptions Google Drive.

Méthodes

batchDelete

Supprime plusieurs messages par ID de message.

batchModify

Modifie les libellés des messages spécifiés.

delete

Supprime immédiatement et définitivement le message spécifié.

get

Récupère le message spécifié.

import

Importe un message dans la boîte aux lettres de cet utilisateur uniquement, avec une analyse et une classification standard des e-mails semblables à celles effectuées lors de la réception via SMTP.

insert

Insère directement un message dans la boîte aux lettres de cet utilisateur uniquement, comme IMAP APPEND, en contournant la plupart des analyses et classifications.

list

Liste les messages dans la boîte aux lettres de l'utilisateur.

modify

Modifie les libellés du message spécifié.

send

Envoie le message spécifié aux destinataires dans les en-têtes To, Cc et Bcc.

trash

Place le message spécifié dans la corbeille.

untrash

Supprime le message spécifié de la corbeille.