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 และ URL แบบ base64url แสดงผลในคำตอบ messages.get และ drafts.get เมื่อมีการระบุพารามิเตอร์ format=RAW

สตริงที่เข้ารหัสฐาน 64

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

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