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

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