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

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