REST Resource: users.messages

Tài nguyên: Thông báo

Một email.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Trường
id

string

Mã nhận dạng không thay đổi của thư.
threadId

string

Mã nhận dạng của chuỗi thư mà thư thuộc về. Để thêm tin nhắn hoặc bản nháp vào một chuỗi, bạn phải đáp ứng các tiêu chí sau:

  1. Bạn phải chỉ định threadId được yêu cầu trên Message hoặc Draft.Message mà bạn cung cấp cùng với yêu cầu.
  2. Bạn phải đặt tiêu đề References và In-Reply-To theo tiêu chuẩn RFC 2822.
  3. Tiêu đề Subject phải khớp.
labelIds[]

string

Danh sách mã nhận dạng của các nhãn được áp dụng cho thư này.
snippet

string

Một phần ngắn của nội dung tin nhắn.
historyId

string

Mã của bản ghi nhật ký gần đây nhất đã sửa đổi thông báo này.
internalDate

string (int64 format)

Dấu thời gian tạo thông báo nội bộ (epoch ms), xác định thứ tự trong hộp thư đến. Đối với email nhận được qua SMTP thông thường, trường này biểu thị thời điểm Google chấp nhận thư ban đầu, đáng tin cậy hơn tiêu đề Date. Tuy nhiên, đối với thư được di chuyển bằng API, máy khách có thể định cấu hình để dựa trên tiêu đề Date.
payload

object (MessagePart)

Cấu trúc email được phân tích cú pháp trong các phần của thư.
sizeEstimate

integer

Kích thước ước tính của thư tính bằng byte.
raw

string (bytes format)

Toàn bộ thư email ở định dạng RFC 2822 và chuỗi được mã hoá base64url. Trả về trong các phản hồi messages.get và drafts.get khi tham số format=RAW được cung cấp.

Một chuỗi được mã hoá base64.
classificationLabelValues[]

object (ClassificationLabelValue)

Giá trị Nhãn phân loại trên thư. Bạn có thể truy vấn các giản đồ Nhãn phân loại hiện có bằng API Nhãn của Google Drive. Mỗi mã nhận dạng nhãn phân loại phải là duy nhất. Nếu bạn cung cấp các mã nhận dạng trùng lặp, thì hệ thống sẽ chỉ giữ lại một mã nhận dạng và lựa chọn này là tuỳ ý. Chỉ dùng cho tài khoản Google Workspace.

MessagePart

Một phần thông báo MIME duy nhất.

Biểu diễn dưới dạng JSON 
{
  "partId": string,
  "mimeType": string,
  "filename": string,
  "headers": [
    {
      object (Header)
    }
  ],
  "body": {
    object (MessagePartBody)
  },
  "parts": [
    {
      object (MessagePart)
    }
  ]
}
Trường
partId

string

Mã nhận dạng không đổi của phần thư.
mimeType

string

Loại MIME của phần thông báo.
filename

string

Tên tệp của tệp đính kèm. Chỉ xuất hiện nếu phần thông báo này đại diện cho một tệp đính kèm.
headers[]

object (Header)

Danh sách tiêu đề trên phần thư này. Đối với phần thư cấp cao nhất, đại diện cho toàn bộ tải trọng thư, phần này sẽ chứa các tiêu đề email RFC 2822 tiêu chuẩn, chẳng hạn như To, From và Subject.
body

object (MessagePartBody)

Nội dung phần thư cho phần này, có thể trống đối với các phần thư MIME của vùng chứa.
parts[]

object (MessagePart)

Các phần thông báo MIME con của phần này. Điều này chỉ áp dụng cho các phần thông báo MIME của vùng chứa, ví dụ: multipart/*. Đối với các loại phần thông báo MIME không phải vùng chứa, chẳng hạn như text/plain, trường này sẽ trống. Để biết thêm thông tin, hãy xem RFC 1521.
Biểu diễn dưới dạng JSON 
{
  "name": string,
  "value": string
}
Trường
name

string

Tên của tiêu đề trước dấu phân cách :. Ví dụ: To.
value

string

Giá trị của tiêu đề sau dấu phân cách :. Ví dụ: someuser@example.com.

ClassificationLabelValue

Nhãn phân loại được áp dụng cho thư email. Nhãn phân loại khác với nhãn trong hộp thư đến của Gmail. Chỉ dùng cho tài khoản Google Workspace. Tìm hiểu thêm về nhãn phân loại.

Biểu diễn dưới dạng JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Trường
labelId

string

Bắt buộc. Mã nhận dạng nhãn phân loại chữ và số nguyên tắc hoặc thô. Ánh xạ đến trường mã nhận dạng của tài nguyên Nhãn trên Google Drive.
fields[]

object (ClassificationLabelFieldValue)

Giá trị trường cho mã nhãn phân loại đã cho.

ClassificationLabelFieldValue

Giá trị trường cho nhãn phân loại.

Biểu diễn dưới dạng JSON 
{
  "fieldId": string,
  "selection": string
}
Trường
fieldId

string

Bắt buộc. Mã nhận dạng trường cho Giá trị nhãn phân loại. Liên kết đến trường mã nhận dạng của đối tượng Label.Field Google Drive.
selection

string

Mã lựa chọn cho lựa chọn. Bạn chỉ nên đặt nếu loại trường là SELECTION trong đối tượng Label.Field của Google Drive. Liên kết đến trường mã nhận dạng của tài nguyên Label.Field.SelectionOptions trên Google Drive.

Phương thức

batchDelete

 Xoá nhiều thư theo mã thư.

batchModify

 Sửa đổi nhãn trên các thư được chỉ định.

delete

 Xoá ngay lập tức và vĩnh viễn thư được chỉ định.

get

 Lấy thông báo đã chỉ định.

import

 Nhập một thư chỉ vào hộp thư của người dùng này, với tính năng quét và phân loại thư tiêu chuẩn tương tự như khi nhận qua SMTP.

insert

 Chèn trực tiếp một thư vào hộp thư của riêng người dùng này, tương tự như IMAP APPEND, bỏ qua hầu hết các quy trình quét và phân loại.

list

 Liệt kê các thư trong hộp thư của người dùng.

modify

 Sửa đổi nhãn trên thư được chỉ định.

send

 Gửi thư được chỉ định đến người nhận trong tiêu đề To, Cc và Bcc.

trash

 Di chuyển thư đã chỉ định vào thùng rác.

untrash

 Xoá thư chỉ định khỏi thùng rác.