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
}
Trường
id

string

Mã nhận dạng bất biến của thông báo.
threadId

string

Mã của chuỗi thư chứa thư. Để thêm một thư hoặc bản nháp vào một chuỗi thư, 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 của mình.
  2. Các tiêu đề References và In-Reply-To phải được đặt theo tiêu chuẩn RFC 2822.
  3. Các tiêu đề Subject phải khớp nhau.
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 tin nhắn này.
internalDate

string (int64 format)

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

object (MessagePart)

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

integer

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

string (bytes format)

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

Chuỗi được mã hoá base64.

MessagePart

Một phần của thư MIME.

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 bất biến của phần thông báo.
mimeType

string

Loại MIME của phần thư.
filename

string

Tên tệp của tệp đính kèm. Chỉ hiển thị nếu phần này của thư đại diện cho một tệp đính kèm.
headers[]

object (Header)

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

object (MessagePartBody)

Nội dung phần của 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ư MIME con của phần này. Điều này chỉ áp dụng cho các phần thư MIME trong vùng chứa, ví dụ: multipart/*. Đối với các loại phần của thông báo MIME không phải vùng chứa, chẳng hạn như text/plain, trường này 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.

Phương thức

batchDelete

 Xoá nhiều thư theo mã nhận dạng 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

 Chỉ nhập thư vào hộp thư của người dùng này, với việc quét và phân loại thư gửi qua email tiêu chuẩn tương tự như nhận qua SMTP.

insert

 Chèn trực tiếp thư chỉ vào hộp thư tương tự như IMAP APPEND của người dùng này, bỏ qua hầu hết các bước 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 các 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

 Chuyển thư được chỉ định vào thùng rác.

untrash

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