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 وشفّرة 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

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