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)

הודעת האימייל כולה במחרוזת בקידוד base64url ובפורמט RFC 2822. המאפיין מוחזר בתשובות 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.

Methods

batchDelete

 מחיקת הרבה הודעות לפי מזהה ההודעה.

batchModify

 שינוי התוויות של ההודעות שצוינו.

delete

 מחיקת ההודעה שצוינה באופן מיידי וסופי.

get

 אחזור ההודעה שצוינה.

import

 ייבוא הודעה לתיבת הדואר של המשתמש הזה בלבד, עם סריקת אימייל רגילה וסיווג דומה לקבלה דרך SMTP.

insert

 הוספה ישירה של הודעה לתיבת הדואר של המשתמש הזה בלבד, בדומה ל-IMAP APPEND, תוך עקיפה של רוב תהליכי הסריקה והסיווג.

list

 הצגת רשימת ההודעות בתיבת הדואר של המשתמש.

modify

 שינוי התוויות של ההודעה שצוינה.

send

 שליחת ההודעה שצוינה לנמענים בכותרות To,‏ Cc ו-Bcc.

trash

 העברת ההודעה שצוינה לאשפה.

untrash

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