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

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