REST Resource: users.messages

משאב: הודעה

הודעת אימייל.

ייצוג ב-JSON 
{
  "id": string,
  "threadId": string,
  "labelIds": [
    string
  ],
  "snippet": string,
  "historyId": string,
  "internalDate": string,
  "payload": {
    object (MessagePart)
  },
  "sizeEstimate": integer,
  "raw": string,
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
שדות
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.
classificationLabelValues[]

object (ClassificationLabelValue)

ערכים של תוויות סיווג בהודעה. אפשר לשלוח שאילתות לגבי סכימות של תוויות סיווג זמינות באמצעות Google Drive Labels API. כל מזהה של תווית סיווג חייב להיות ייחודי. אם מספקים מזהים כפולים, רק אחד מהם יישמר, והבחירה היא שרירותית. האפשרות הזו זמינה רק בחשבונות Google Workspace. יש מגבלה של 20 ערכים של תוויות סיווג לכל בקשה. אם ערכי תוויות הסיווג חורגים מהמספר המקסימלי המותר, הבקשה נכשלת.

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 מסוג container.
parts[]

object (MessagePart)

החלקים של הודעת ה-MIME שמשויכים לחלק הזה. ההגדרה הזו רלוונטית רק לחלקים של הודעות MIME בקונטיינר, למשל multipart/*. בשדות של סוגי חלקים בהודעות MIME שהם לא מאגרי תגים, כמו text/plain, השדה הזה ריק. מידע נוסף זמין ב-RFC 1521.
ייצוג ב-JSON 
{
  "name": string,
  "value": string
}
שדות
name

string

השם של הכותרת לפני המפריד :. לדוגמה, To.
value

string

הערך של הכותרת אחרי המפריד :. לדוגמה, someuser@example.com.

ClassificationLabelValue

תוויות סיווג שהוחלו על הודעת האימייל. תוויות סיווג שונות מתוויות של תיבת הדואר הנכנס ב-Gmail. האפשרות הזו זמינה רק בחשבונות Google Workspace. מידע נוסף על תוויות סיווג

ייצוג ב-JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
שדות
labelId

string

חובה. מזהה התווית של הסיווג הקנוני או הגולמי, שמורכב מתווים אלפאנומריים. מיפוי לשדה המזהה של מקור המידע של תווית Google Drive.
fields[]

object (ClassificationLabelFieldValue)

ערכי השדות של מזהה תווית הסיווג שצוין.

ClassificationLabelFieldValue

ערכי השדות של תווית סיווג.

ייצוג ב-JSON 
{
  "fieldId": string,
  "selection": string
}
שדות
fieldId

string

חובה. המזהה של השדה של הערך של תווית הסיווג. מיפוי לשדה המזהה של אובייקט Label.Field ב-Google Drive.
selection

string

מזהה אפשרות הבחירה של הבחירה. השדה הזה צריך להיות מוגדר רק אם סוג השדה הוא SELECTION באובייקט Label.Field של Google Drive. מיפוי לשדה id של מקור המידע Label.Field.SelectionOptions ב-Google Drive.

Methods

batchDelete

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

batchModify

 משנה את התוויות ואת הערכים של תוויות הסיווג בהודעות שצוינו.

delete

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

get

 מקבל את ההודעה שצוינה.

import

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

insert

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

list

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

modify

 משנה את התוויות ואת הערכים של תוויות הסיווג בהודעה שצוינה.

send

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

trash

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

untrash

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