REST Resource: users.messages

Ressource: Nachricht

Eine E‑Mail-Nachricht.

JSON-Darstellung
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Felder
id

string

Die unveränderliche ID der Nachricht.

threadId

string

Die ID des Threads, zu dem die Nachricht gehört. Damit Sie einem Thread eine Nachricht oder einen Entwurf hinzufügen können, müssen die folgenden Kriterien erfüllt sein:

  1. Die angeforderte threadId muss auf der Message oder Draft.Message angegeben sein, die Sie mit Ihrer Anfrage einreichen.
  2. Die Header References und In-Reply-To müssen gemäß dem Standard RFC 2822 festgelegt werden.
  3. Die Subject-Header müssen übereinstimmen.

labelIds[]

string

Liste der IDs der Labels, die auf diese Nachricht angewendet wurden.

snippet

string

Ein kurzer Teil des Nachrichtentexts.

historyId

string

Die ID des letzten Verlaufsdatensatzes, mit dem diese Nachricht geändert wurde.

internalDate

string (int64 format)

Der interne Zeitstempel für die Erstellung der Nachricht (Epochen-Millisekunden), der die Reihenfolge im Posteingang bestimmt. Bei normalen über SMTP empfangenen E‑Mails wird hier die Zeit angegeben, zu der die Nachricht ursprünglich von Google akzeptiert wurde. Das ist zuverlässiger als der Date-Header. Bei per API migrierten E-Mails kann die Konfiguration jedoch clientseitig auf dem Date-Header basieren.

payload

object (MessagePart)

Die geparste E‑Mail-Struktur in den Nachrichtenteilen.

sizeEstimate

integer

Geschätzte Größe der Nachricht in Byte.

raw

string (bytes format)

Die gesamte E‑Mail-Nachricht als RFC 2822-formatierter und base64url-codierter String. Wird in messages.get- und drafts.get-Antworten zurückgegeben, wenn der Parameter format=RAW angegeben wird.

Ein base64-codierter String.

classificationLabelValues[]

object (ClassificationLabelValue)

Werte für Klassifizierungslabel in der Nachricht. Verfügbare Schemas für Klassifizierungslabels können mit der Google Drive Labels API abgefragt werden. Jede ID für ein Klassifikationslabel muss eindeutig sein. Wenn doppelte IDs angegeben werden, wird nur eine beibehalten. Die Auswahl erfolgt willkürlich. Wird nur für Google Workspace-Konten verwendet.

MessagePart

Ein einzelner MIME-Nachrichtenteil.

JSON-Darstellung
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
Felder
partId

string

Die unveränderliche ID des Nachrichtenteils.

mimeType

string

Der MIME-Typ des Nachrichtenteils.

filename

string

Der Dateiname des Anhangs. Nur vorhanden, wenn dieser Nachrichtenteil eine Anlage darstellt.

headers[]

object (Header)

Liste der Header für diesen Nachrichtenteil. Für den obersten Nachrichtenteil, der die gesamte Nachrichtennutzlast darstellt, enthält er die standardmäßigen RFC 2822-E-Mail-Headern wie To, From und Subject.

body

object (MessagePartBody)

Der Nachrichtenteil für diesen Teil, der für Container-MIME-Nachrichtenteile leer sein kann.

parts[]

object (MessagePart)

Die untergeordneten MIME-Nachrichtenteile dieses Teils. Dies gilt nur für Container-MIME-Nachrichtenteile, z. B. multipart/*. Bei MIME-Nachrichtenteiltypen, die keine Container sind, z. B. text/plain, ist dieses Feld leer. Weitere Informationen finden Sie unter RFC 1521.

JSON-Darstellung
{
  "name": string,
  "value": string
}
Felder
name

string

Der Name des Headers vor dem Trennzeichen :. Beispiel: To.

value

string

Der Wert des Headers nach dem Trennzeichen :. Beispiel: someuser@example.com.

ClassificationLabelValue

Auf die E‑Mail-Nachricht angewendete Klassifizierungslabel. Klassifizierungslabels unterscheiden sich von Gmail-Posteingangslabels. Wird nur für Google Workspace-Konten verwendet. Weitere Informationen zu Klassifizierungslabels

JSON-Darstellung
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Felder
labelId

string

Erforderlich. Die kanonische oder rohe alphanumerische ID des Klassifizierungslabels. Entspricht dem Feld „ID“ der Google Drive-Labelressource.

fields[]

object (ClassificationLabelFieldValue)

Feldwerte für die angegebene ID des Klassifizierungslabels.

ClassificationLabelFieldValue

Feldwerte für ein Klassifizierungslabel.

JSON-Darstellung
{
  "fieldId": string,
  "selection": string
}
Felder
fieldId

string

Erforderlich. Die Feld-ID für den Wert des Klassifizierungslabels. Entspricht dem Feld „ID“ des Google Drive-Objekts Label.Field.

selection

string

ID der Auswahloption für die Auswahl. Sollte nur festgelegt werden, wenn der Feldtyp SELECTION im Google Drive-Objekt Label.Field ist. Entspricht dem Feld „id“ der Google Drive-Ressource Label.Field.SelectionOptions.

Methoden

batchDelete

Löscht viele Nachrichten anhand der Nachrichten-ID.

batchModify

Ändert die Labels der angegebenen Nachrichten.

delete

Löscht die angegebene Nachricht sofort und endgültig.

get

Ruft die angegebene Nachricht ab.

import

Importiert eine Nachricht nur in das Postfach dieses Nutzers. Die Nachricht wird wie bei einem Empfang über SMTP gescannt und klassifiziert.

insert

Fügt eine Nachricht direkt in das Postfach dieses Nutzers ein, ähnlich wie IMAP APPEND. Dabei werden die meisten Scan- und Klassifizierungsprozesse umgangen.

list

Listet die Nachrichten im Postfach des Nutzers auf.

modify

Ändert die Labels der angegebenen Nachricht.

send

Sendet die angegebene Nachricht an die Empfänger in den Headern To, Cc und Bcc.

trash

Verschiebt die angegebene Nachricht in den Papierkorb.

untrash

Entfernt die angegebene Nachricht aus dem Papierkorb.