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)

مُهر زمانی ایجاد پیام داخلی (دومین ثانیه)، که ترتیب را در صندوق ورودی تعیین می‌کند. برای ایمیل‌های معمولی دریافت‌شده توسط SMTP، این نشان‌دهنده زمانی است که پیام در ابتدا توسط Google پذیرفته شد، که قابل اعتمادتر از سرصفحه Date است. با این حال، برای نامه‌های منتقل‌شده توسط API، می‌توان آن را توسط مشتری پیکربندی کرد تا بر اساس سرصفحه Date باشد.

payload

object ( MessagePart )

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

sizeEstimate

integer

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

raw

string ( bytes format)

کل پیام ایمیل در یک رشته با فرمت RFC 2822 و کدگذاری شده با پایه 64url. در پاسخ‌های 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 .

روش ها

batchDelete

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

batchModify

 برچسب های روی پیام های مشخص شده را تغییر می دهد.

delete

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

get

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

import

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

insert

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

list

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

modify

 برچسب های روی پیام مشخص شده را تغییر می دهد.

send

 پیام مشخص شده را برای گیرندگان در سرصفحه های To ، Cc و Bcc می فرستد.

trash

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

untrash

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