REST Resource: users.messages

Resource: Message

Pesan email.

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

string

ID pesan yang tidak dapat diubah.

threadId

string

ID rangkaian pesan tempat pesan berada. Untuk menambahkan pesan atau draf ke rangkaian pesan, kriteria berikut harus dipenuhi:

  1. threadId yang diminta harus ditentukan pada Message atau Draft.Message yang Anda berikan dengan permintaan Anda.
  2. Header References dan In-Reply-To harus ditetapkan sesuai dengan standar RFC 2822.
  3. Header Subject harus cocok.

labelIds[]

string

Daftar ID label yang diterapkan ke pesan ini.

snippet

string

Bagian singkat dari teks pesan.

historyId

string

ID catatan histori terakhir yang mengubah pesan ini.

internalDate

string (int64 format)

Stempel waktu pembuatan pesan internal (epoch ms), yang menentukan pengurutan di kotak masuk. Untuk email yang diterima melalui SMTP normal, ini menunjukkan waktu saat pesan diterima oleh Google, yang lebih andal daripada header Date. Namun, untuk email yang dimigrasikan melalui API, email dapat dikonfigurasi oleh klien agar didasarkan pada header Date.

payload

object (MessagePart)

Struktur email yang diuraikan di bagian pesan.

sizeEstimate

integer

Perkiraan ukuran pesan dalam byte.

raw

string (bytes format)

Seluruh pesan email dalam string berenkode base64url dan berformat RFC 2822. Ditampilkan dalam respons messages.get dan drafts.get saat parameter format=RAW diberikan.

String berenkode base64.

classificationLabelValues[]

object (ClassificationLabelValue)

Nilai Label Klasifikasi pada pesan. Skema Label Klasifikasi yang Tersedia dapat dikueri menggunakan Google Drive Labels API. Setiap ID label klasifikasi harus unik. Jika ID duplikat diberikan, hanya satu yang akan dipertahankan, dan pemilihan bersifat arbitrer. Hanya digunakan untuk akun Google Workspace.

MessagePart

Satu bagian pesan MIME.

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

string

ID bagian pesan yang tidak dapat diubah.

mimeType

string

Jenis MIME bagian pesan.

filename

string

Nama file lampiran. Hanya ada jika bagian pesan ini menampilkan lampiran.

headers[]

object (Header)

Daftar header di bagian pesan ini. Untuk bagian pesan tingkat teratas, yang merepresentasikan seluruh payload pesan, bagian ini akan berisi header email RFC 2822 standar seperti To, From, dan Subject.

body

object (MessagePartBody)

Isi bagian pesan untuk bagian ini, yang mungkin kosong untuk bagian pesan MIME penampung.

parts[]

object (MessagePart)

Bagian pesan MIME turunan dari bagian ini. Ini hanya berlaku untuk bagian pesan MIME container, misalnya multipart/*. Untuk jenis bagian pesan MIME non-penampung, seperti text/plain, kolom ini kosong. Untuk mengetahui informasi selengkapnya, lihat RFC 1521.

Representasi JSON
{
  "name": string,
  "value": string
}
Kolom
name

string

Nama header sebelum pemisah :. Misalnya, To.

value

string

Nilai header setelah pemisah :. Misalnya, someuser@example.com.

ClassificationLabelValue

Label Klasifikasi yang diterapkan ke pesan email. Label Klasifikasi berbeda dengan label kotak masuk Gmail. Hanya digunakan untuk akun Google Workspace. Pelajari label klasifikasi lebih lanjut.

Representasi JSON
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Kolom
labelId

string

Wajib. ID label klasifikasi alfanumerik kanonis atau mentah. Dipetakan ke kolom ID resource Label Google Drive.

fields[]

object (ClassificationLabelFieldValue)

Nilai kolom untuk ID label klasifikasi tertentu.

ClassificationLabelFieldValue

Nilai kolom untuk label klasifikasi.

Representasi JSON
{
  "fieldId": string,
  "selection": string
}
Kolom
fieldId

string

Wajib. ID kolom untuk Nilai Label Klasifikasi. Dipetakan ke kolom ID objek Label.Field Google Drive.

selection

string

ID pilihan seleksi untuk opsi seleksi. Hanya boleh disetel jika jenis kolom adalah SELECTION di objek Label.Field Google Drive. Dipetakan ke kolom ID resource Label.Field.SelectionOptions Google Drive.

Metode

batchDelete

Menghapus banyak pesan berdasarkan ID pesan.

batchModify

Mengubah label pada pesan tertentu.

delete

Segera menghapus pesan tertentu secara permanen.

get

Mendapatkan pesan yang ditentukan.

import

Mengimpor pesan hanya ke kotak surat pengguna ini, dengan pemindaian dan klasifikasi pengiriman email standar yang serupa dengan penerimaan melalui SMTP.

insert

Memasukkan pesan secara langsung ke kotak surat pengguna ini saja, mirip dengan IMAP APPEND, dengan melewati sebagian besar pemindaian dan klasifikasi.

list

Mencantumkan pesan di kotak surat pengguna.

modify

Mengubah label pada pesan yang ditentukan.

send

Mengirim pesan yang ditentukan ke penerima di header To, Cc, dan Bcc.

trash

Memindahkan pesan yang ditentukan ke sampah.

untrash

Menghapus pesan tertentu dari sampah.