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)

רשימת הכותרות בחלק של ההודעה. לחלק של ההודעה ברמה העליונה שמייצג את כל המטען הייעודי (payload) של ההודעה, הוא יכיל את כותרות האימייל הסטנדרטיות מסוג 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

 הסרת ההודעה שצוינה מהאשפה.