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. وبالنسبة إلى البريد الذي تم نقله عبر واجهة برمجة التطبيقات، يمكن أن يضبطه البرنامج استنادًا إلى عنوان Date.

payload

object (MessagePart)

بنية البريد الإلكتروني المُحلّلة في أجزاء الرسالة

sizeEstimate

integer

الحجم المقدّر بالبايت للرسالة.

raw

string (bytes format)

الرسالة الإلكترونية بالكامل في سلسلة RFC 2822 مرمّزة بتنسيق 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)

قائمة بالرؤوس في هذا الجزء من الرسالة. بالنسبة إلى جزء الرسالة من المستوى الأعلى، الذي يمثل حمولة الرسالة بالكامل، سيحتوي على عناوين الرسائل الإلكترونية القياسية من نوع 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

لإزالة الرسالة المحددة من المهملات.