REST Resource: users.messages

Zasób: Message

e-maila,

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

string

Stały identyfikator wiadomości.

threadId

string

Identyfikator wątku, do którego należy wiadomość. Aby dodać wiadomość lub wersję roboczą do wątku, musisz spełnić te kryteria:

  1. Żądany threadId musi być określony w pliku Message lub Draft.Message, który przesyłasz wraz z żądaniem.
  2. Nagłówki ReferencesIn-Reply-To muszą być ustawione zgodnie ze standardem RFC 2822.
  3. Nagłówki Subject muszą być zgodne.

labelIds[]

string

Lista identyfikatorów etykiet zastosowanych do tej wiadomości.

snippet

string

Krótki fragment tekstu wiadomości.

historyId

string

Identyfikator ostatniego rekordu historii, który zmodyfikował tę wiadomość.

internalDate

string (int64 format)

Sygnatura czasowa utworzenia wiadomości wewnętrznej (w milisekundach od początku epoki), która określa kolejność w skrzynce odbiorczej. W przypadku zwykłych e-maili odebranych przez SMTP jest to czas, w którym wiadomość została pierwotnie zaakceptowana przez Google. Jest to bardziej wiarygodne niż nagłówek Date. W przypadku poczty przeniesionej za pomocą interfejsu API klient może jednak skonfigurować ją tak, aby była oparta na nagłówku Date.

payload

object (MessagePart)

Przeanalizowana struktura e-maila w częściach wiadomości.

sizeEstimate

integer

Szacunkowy rozmiar wiadomości w bajtach.

raw

string (bytes format)

Cała wiadomość e-mail w formacie RFC 2822 i zakodowana w base64url. Zwracany w odpowiedziach messages.getdrafts.get, gdy podany jest parametr format=RAW.

Ciąg znaków zakodowany w formacie Base64.

classificationLabelValues[]

object (ClassificationLabelValue)

wartości etykiety klasyfikacji w wiadomości; Dostępne schematy etykiet klasyfikacji można wyszukiwać za pomocą interfejsu Google Drive Labels API. Każdy identyfikator etykiety klasyfikacji musi być unikalny. Jeśli podasz zduplikowane identyfikatory, tylko jeden z nich zostanie zachowany, a wybór jest arbitralny. Używane tylko w przypadku kont Google Workspace.

MessagePart

Pojedyncza część wiadomości MIME.

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

string

Stały identyfikator części wiadomości.

mimeType

string

Typ MIME części wiadomości.

filename

string

Nazwa pliku załącznika. Występuje tylko wtedy, gdy ta część wiadomości reprezentuje załącznik.

headers[]

object (Header)

Lista nagłówków w tej części wiadomości. W przypadku części wiadomości najwyższego poziomu, która reprezentuje cały ładunek wiadomości, będzie ona zawierać standardowe nagłówki e-maila RFC 2822, takie jak To, FromSubject.

body

object (MessagePartBody)

Treść części wiadomości, która może być pusta w przypadku części wiadomości MIME będących kontenerami.

parts[]

object (MessagePart)

Podrzędne części wiadomości MIME tej części. Dotyczy to tylko części wiadomości MIME kontenera, np. multipart/*. W przypadku typów części wiadomości MIME, które nie są kontenerami, np. text/plain, to pole jest puste. Więcej informacji znajdziesz w dokumencie RFC 1521.

Zapis JSON
{
  "name": string,
  "value": string
}
Pola
name

string

Nazwa nagłówka przed separatorem :. Na przykład: To.

value

string

Wartość nagłówka po separatorze :. Na przykład: someuser@example.com.

ClassificationLabelValue

Etykiety klasyfikacji zastosowane do wiadomości e-mail. Etykiety klasyfikacji różnią się od etykiet w skrzynce odbiorczej Gmaila. Używane tylko w przypadku kont Google Workspace. Więcej informacji o etykietach klasyfikacji

Zapis JSON
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Pola
labelId

string

Wymagane. Kanoniczny lub pierwotny alfanumeryczny identyfikator etykiety klasyfikacji. Odpowiada polu ID zasobu etykiety Dysku Google.

fields[]

object (ClassificationLabelFieldValue)

Wartości pól dla danego identyfikatora etykiety klasyfikacji.

ClassificationLabelFieldValue

Wartości pól etykiety klasyfikacji.

Zapis JSON
{
  "fieldId": string,
  "selection": string
}
Pola
fieldId

string

Wymagane. Identyfikator pola wartości etykiety klasyfikacji. Odpowiada polu ID obiektu Label.Field na Dysku Google.

selection

string

Identyfikator wyboru opcji wyboru. Należy ustawić tylko wtedy, gdy typ pola to SELECTION w obiekcie Label.Field Dysku Google. Odpowiada polu id zasobu Label.Field.SelectionOptions Dysku Google.

Metody

batchDelete

Usuwa wiele wiadomości według identyfikatora wiadomości.

batchModify

Modyfikuje etykiety określonych wiadomości.

delete

Natychmiast i trwale usuwa określoną wiadomość.

get

Pobiera określoną wiadomość.

import

Importuje wiadomość tylko do skrzynki pocztowej tego użytkownika, ze standardowym skanowaniem i klasyfikacją dostarczania e-maili podobną do odbierania przez SMTP.

insert

Bezpośrednie wstawianie wiadomości tylko do skrzynki pocztowej tego użytkownika, podobnie jak w przypadku IMAP APPEND, z pominięciem większości skanowania i klasyfikacji.

list

Wyświetla listę wiadomości w skrzynce pocztowej użytkownika.

modify

Modyfikuje etykiety określonej wiadomości.

send

Wysyła określoną wiadomość do odbiorców w nagłówkach To, Cc i Bcc.

trash

Przenosi określoną wiadomość do kosza.

untrash

Usuwa z kosza określoną wiadomość.