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)

The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.

payload

object ( MessagePart )

ساختار ایمیل تجزیه‌شده در بخش‌های پیام.

sizeEstimate

integer

اندازه تخمینی پیام بر حسب بایت.

raw

string ( bytes format)

کل پیام ایمیل در قالب RFC 2822 و رشته کدگذاری شده با base64url. در پاسخ‌های messages.get و drafts.get هنگام ارائه پارامتر format=RAW برگردانده می‌شود.

یک رشته کدگذاری شده با base64.

classificationLabelValues[]

object ( ClassificationLabelValue )

مقادیر برچسب طبقه‌بندی روی پیام. طرح‌های برچسب طبقه‌بندی موجود را می‌توان با استفاده از API برچسب‌های گوگل درایو جستجو کرد. هر شناسه برچسب طبقه‌بندی باید منحصر به فرد باشد. اگر شناسه‌های تکراری ارائه شوند، فقط یکی حفظ می‌شود و انتخاب دلخواه است. فقط برای حساب‌های Google Workspace استفاده می‌شود. محدودیت ۲۰ مقدار برچسب طبقه‌بندی برای هر درخواست وجود دارد. اگر مقادیر برچسب طبقه‌بندی از حداکثر تعداد مجاز بیشتر شود، درخواست با شکست مواجه می‌شود.

پیام‌پارت

یک بخش پیام 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 .

برچسب طبقه‌بندیمقدار

برچسب‌های طبقه‌بندی که روی پیام ایمیل اعمال می‌شوند. برچسب‌های طبقه‌بندی با برچسب‌های صندوق ورودی Gmail متفاوت هستند. فقط برای حساب‌های Google Workspace استفاده می‌شوند. درباره برچسب‌های طبقه‌بندی بیشتر بدانید .

نمایش JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
فیلدها
labelId

string

الزامی. شناسه برچسب طبقه‌بندی الفبایی-عددی متعارف یا خام. به فیلد شناسه منبع برچسب گوگل درایو نگاشت می‌شود.

fields[]

object ( ClassificationLabelFieldValue )

مقادیر فیلد برای شناسه برچسب طبقه‌بندی داده شده.

برچسب طبقه‌بندیمقدار فیلد

مقادیر فیلد برای برچسب طبقه‌بندی.

نمایش JSON 
{
  "fieldId": string,
  "selection": string
}
فیلدها
fieldId

string

الزامی. شناسه فیلد برای مقدار برچسب طبقه‌بندی. به فیلد شناسه شیء Label.Field گوگل درایو نگاشت می‌شود.

selection

string

شناسه انتخاب برای گزینه انتخاب. فقط در صورتی باید تنظیم شود که نوع فیلد در شیء Google Drive Label.Field SELECTION باشد. به فیلد شناسه منبع Google Drive Label.Field.SelectionOptions نگاشت می‌شود.

روش‌ها

batchDelete

 پیام‌های زیادی را بر اساس شناسه پیام حذف می‌کند.

batchModify

 برچسب‌ها و مقادیر برچسب طبقه‌بندی را برای پیام‌های مشخص‌شده اصلاح می‌کند.

delete

 پیام مشخص شده را فوراً و برای همیشه حذف می‌کند.

get

 پیام مشخص شده را دریافت می‌کند.

import

 پیامی را فقط به صندوق پستی این کاربر وارد می‌کند، با اسکن و طبقه‌بندی استاندارد ارسال ایمیل مشابه دریافت از طریق SMTP.

insert

 مستقیماً پیامی را فقط در صندوق پستی این کاربر مشابه IMAP APPEND وارد می‌کند و اکثر اسکن‌ها و طبقه‌بندی‌ها را دور می‌زند.

list

 لیست پیام‌های موجود در صندوق پستی کاربر.

modify

 برچسب‌ها و مقادیر برچسب طبقه‌بندی را برای پیام مشخص‌شده اصلاح می‌کند.

send

 پیام مشخص شده را به گیرندگان موجود در هدرهای To ، Cc و Bcc ارسال می‌کند.

trash

 پیام مشخص شده را به سطل زباله منتقل می‌کند.

untrash

 پیام مشخص شده را از سطل زباله حذف می‌کند.