REST Resource: users.messages

แหล่งข้อมูล: ข้อความ

ข้อความอีเมล

การแสดง JSON 
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
ช่อง
id

string

รหัสที่เปลี่ยนแปลงไม่ได้ของข้อความ
threadId

string

รหัสของชุดข้อความที่ข้อความเป็นสมาชิก หากต้องการเพิ่มข้อความหรือฉบับร่างลงในเธรด คุณต้องมีคุณสมบัติตรงตามเกณฑ์ต่อไปนี้

  1. ต้องระบุ threadId ที่ขอใน Message หรือ Draft.Message ที่คุณส่งมาพร้อมกับคำขอ
  2. ต้องตั้งค่าส่วนหัว References และ In-Reply-To ให้เป็นไปตามมาตรฐาน RFC 2822
  3. ส่วนหัว Subject ต้องตรงกัน
labelIds[]

string

รายการรหัสของป้ายกำกับที่ใช้กับข้อความนี้
snippet

string

ข้อความบางส่วนของข้อความ
historyId

string

รหัสของบันทึกประวัติล่าสุดที่แก้ไขข้อความนี้
internalDate

string (int64 format)

การประทับเวลาการสร้างข้อความภายใน (มิลลิวินาทีตั้งแต่ Epoch) ซึ่งกำหนดลำดับในกล่องจดหมาย สำหรับอีเมลที่ได้รับผ่าน SMTP ปกติ ฟิลด์นี้จะแสดงเวลาที่ Google ยอมรับข้อความในตอนแรก ซึ่งเชื่อถือได้มากกว่าส่วนหัว Date อย่างไรก็ตาม สำหรับอีเมลที่ย้ายข้อมูลผ่าน API ไคลเอ็นต์สามารถกำหนดค่าให้ใช้ส่วนหัว Date ได้
payload

object (MessagePart)

โครงสร้างอีเมลที่แยกวิเคราะห์แล้วในส่วนของข้อความ
sizeEstimate

integer

ขนาดโดยประมาณของข้อความเป็นไบต์
raw

string (bytes format)

ข้อความอีเมลทั้งหมดในสตริงที่จัดรูปแบบ RFC 2822 และเข้ารหัส base64url แสดงในคำตอบ messages.get และ drafts.get เมื่อระบุพารามิเตอร์ format=RAW

สตริงที่เข้ารหัส Base64
classificationLabelValues[]

object (ClassificationLabelValue)

ค่าป้ายกำกับการแยกประเภทในข้อความ คุณสามารถค้นหาสคีมาป้ายกำกับการแยกประเภทที่มีอยู่ได้โดยใช้ Google Drive Labels API รหัสป้ายกำกับการแยกประเภทแต่ละรายการต้องไม่ซ้ำกัน หากระบุรหัสที่ซ้ำกัน ระบบจะเก็บไว้เพียงรหัสเดียวและจะเลือกโดยพลการ ใช้สำหรับบัญชี Google Workspace เท่านั้น

MessagePart

ส่วนข้อความ MIME เดียว

การแสดง JSON 
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
ช่อง
partId

string

รหัสที่เปลี่ยนแปลงไม่ได้ของส่วนข้อความ
mimeType

string

ประเภท MIME ของส่วนข้อความ
filename

string

ชื่อไฟล์ของไฟล์แนบ จะแสดงก็ต่อเมื่อส่วนของข้อความนี้แสดงถึงไฟล์แนบ
headers[]

object (Header)

รายการส่วนหัวในส่วนข้อความนี้ สำหรับส่วนข้อความระดับบนสุดซึ่งแสดงถึงเพย์โหลดของข้อความทั้งหมด จะมีส่วนหัวอีเมล RFC 2822 มาตรฐาน เช่น To, From และ Subject
body

object (MessagePartBody)

เนื้อความของส่วนข้อความสำหรับส่วนนี้ ซึ่งอาจว่างเปล่าสำหรับส่วนข้อความ MIME ของคอนเทนเนอร์
parts[]

object (MessagePart)

ส่วนข้อความ MIME ย่อยของส่วนนี้ ซึ่งจะมีผลกับส่วนข้อความ MIME ของคอนเทนเนอร์เท่านั้น เช่น multipart/* สำหรับประเภทชิ้นส่วนข้อความ MIME ที่ไม่ใช่คอนเทนเนอร์ เช่น text/plain ฟิลด์นี้จะว่างเปล่า ดูข้อมูลเพิ่มเติมได้ที่ RFC 1521
การแสดง JSON 
{
  "name": string,
  "value": string
}
ช่อง
name

string

ชื่อของส่วนหัวก่อน:ตัวคั่น เช่น To
value

string

ค่าของส่วนหัวหลังตัวคั่น : เช่น someuser@example.com

ClassificationLabelValue

ป้ายกำกับการแยกประเภทที่ใช้กับข้อความอีเมล ป้ายกำกับการแยกประเภทแตกต่างจากป้ายกำกับกล่องจดหมาย Gmail ใช้สำหรับบัญชี Google Workspace เท่านั้น ดูข้อมูลเพิ่มเติมเกี่ยวกับป้ายกำกับการแยกประเภท

การแสดง JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
ช่อง
labelId

string

ต้องระบุ รหัสป้ายกำกับการจัดประเภทที่เป็นตัวอักษรและตัวเลขแบบ Canonical หรือแบบดิบ แมปกับฟิลด์รหัสของทรัพยากรป้ายกำกับของ Google ไดรฟ์
fields[]

object (ClassificationLabelFieldValue)

ค่าฟิลด์สำหรับรหัสป้ายกำกับการแยกประเภทที่ระบุ

ClassificationLabelFieldValue

ค่าฟิลด์สำหรับป้ายกำกับการแยกประเภท

การแสดง JSON 
{
  "fieldId": string,
  "selection": string
}
ช่อง
fieldId

string

ต้องระบุ รหัสฟิลด์สำหรับค่าป้ายกำกับการแยกประเภท แมปกับฟิลด์ ID ของออบเจ็กต์ Label.Field ใน Google ไดรฟ์
selection

string

รหัสตัวเลือกการเลือกสำหรับตัวเลือกการเลือก ควรตั้งค่าเฉพาะในกรณีที่ประเภทฟิลด์เป็น SELECTION ในออบเจ็กต์ Label.Field ของ Google ไดรฟ์ แมปกับฟิลด์รหัสของLabel.Field.SelectionOptionsทรัพยากร Google ไดรฟ์

เมธอด

batchDelete

 ลบข้อความจำนวนมากตามรหัสข้อความ

batchModify

 แก้ไขป้ายกำกับในข้อความที่ระบุ

delete

 ลบข้อความที่ระบุอย่างถาวรทันที

get

 รับข้อความที่ระบุ

import

 นำเข้าข้อความไปยังกล่องจดหมายของผู้ใช้รายนี้เท่านั้น โดยมีการสแกนและการจัดประเภทการนำส่งอีเมลมาตรฐานคล้ายกับการรับผ่าน SMTP

insert

 แทรกข้อความลงในกล่องจดหมายของผู้ใช้รายนี้โดยตรงเท่านั้น ซึ่งคล้ายกับ IMAP APPEND โดยข้ามการสแกนและการจัดประเภทส่วนใหญ่

list

 แสดงรายการข้อความในกล่องจดหมายของผู้ใช้

modify

 แก้ไขป้ายกำกับในข้อความที่ระบุ

send

 ส่งข้อความที่ระบุไปยังผู้รับในส่วนหัว To, Cc และ Bcc

trash

 ย้ายข้อความที่ระบุไปที่ถังขยะ

untrash

 นำข้อความที่ระบุออกจากถังขยะ