REST Resource: users.messages

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

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

การแสดง JSON
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string
}
ช่อง
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 ms) ซึ่งกำหนดลําดับในกล่องจดหมาย สําหรับอีเมลที่ได้รับผ่าน SMTP ปกติ ข้อมูลนี้แสดงเวลาที่ Google ยอมรับข้อความครั้งแรก ซึ่งเชื่อถือได้มากกว่าส่วนหัว Date อย่างไรก็ตาม สำหรับอีเมลที่ย้ายข้อมูลด้วย API ไคลเอ็นต์สามารถกำหนดค่าให้อิงตามส่วนหัว Date ได้

payload

object (MessagePart)

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

sizeEstimate

integer

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

raw

string (bytes format)

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

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

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

เมธอด

batchDelete

ลบข้อความหลายรายการตามรหัสข้อความ

batchModify

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

delete

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

get

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

import

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

insert

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

list

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

modify

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

send

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

trash

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

untrash

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