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)

الطابع الزمني لإنشاء الرسالة الداخلية (بالمللي ثانية منذ بدء الحقبة)، والذي يحدّد ترتيب الرسائل في البريد الوارد. بالنسبة إلى الرسائل الإلكترونية العادية التي تم تلقّيها عبر SMTP، يمثّل هذا الحقل الوقت الذي قبلت فيه Google الرسالة في الأصل، وهو أكثر موثوقية من العنوان Date. ومع ذلك، بالنسبة إلى الرسائل التي تم نقلها باستخدام واجهة برمجة التطبيقات، يمكن للعميل ضبطها لتستند إلى العنوان Date.

payload

object (MessagePart)

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

sizeEstimate

integer

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

raw

string (bytes format)

رسالة البريد الإلكتروني الكاملة في سلسلة منسَّقة وفقًا لمعيار RFC 2822 ومشفَّرة باستخدام base64url يتم عرضها في ردود messages.get وdrafts.get عند توفير المَعلمة format=RAW.

سلسلة مرمّزة باستخدام Base64

classificationLabelValues[]

object (ClassificationLabelValue)

قيم التصنيف في الرسالة يمكن طلب البحث عن مخططات "تسميات التصنيف" المتاحة باستخدام Google Drive Labels API. يجب أن يكون كل معرّف لتصنيف فريدًا. في حال تقديم معرّفات مكرّرة، سيتم الاحتفاظ بمعرّف واحد فقط، ويكون الاختيار عشوائيًا. يُستخدم فقط لحسابات Google Workspace.

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

ClassificationLabelValue

تصنيفات البريد الإلكتروني المطبَّقة على رسالة البريد الإلكتروني تختلف تسميات التصنيفات عن تسميات البريد الوارد في Gmail. يُستخدم فقط لحسابات Google Workspace. مزيد من المعلومات حول تصنيفات المحتوى

تمثيل JSON
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
الحقول
labelId

string

الحقل مطلوب. المعرّف الأساسي أو الأولي لتصنيف الذكاء الاصطناعي المكوّن من حروف أبجدية وأرقام يتم الربط بحقل المعرّف الخاص بمورد تصنيف Google Drive.

fields[]

object (ClassificationLabelFieldValue)

قيم الحقول لمعرّف التصنيف المحدّد

ClassificationLabelFieldValue

قيم الحقول لتصنيف

تمثيل JSON
{
  "fieldId": string,
  "selection": string
}
الحقول
fieldId

string

الحقل مطلوب. رقم تعريف الحقل الخاص بقيمة التصنيف يتم ربطها بحقل المعرّف في عنصر Label.Field في Google Drive.

selection

string

معرّف خيار التحديد يجب ضبط هذا الحقل فقط إذا كان نوع الحقل SELECTION في عنصر Label.Field في Google Drive. يتم الربط بحقل المعرّف الخاص بمورد Label.Field.SelectionOptions في Google Drive.

الطُرق

batchDelete

لحذف العديد من الرسائل باستخدام معرّف الرسالة

batchModify

تعديل التصنيفات في الرسائل المحدّدة

delete

يحذف الرسالة المحدّدة على الفور وبشكل دائم.

get

تعرض هذه الطريقة الرسالة المحدّدة.

import

يستورد رسالة إلى صندوق بريد هذا المستخدم فقط، مع فحص وتصنيف تسليم البريد الإلكتروني العادي بشكل مشابه للتلقّي عبر بروتوكول نقل البريد البسيط (SMTP).

insert

يُدرج رسالة مباشرةً في صندوق بريد هذا المستخدم فقط، على غرار IMAP APPEND، مع تجاوز معظم عمليات الفحص والتصنيف.

list

تعرض هذه الطريقة الرسائل في صندوق بريد المستخدم.

modify

تعدّل هذه الطريقة التصنيفات في الرسالة المحدّدة.

send

يرسل الرسالة المحدّدة إلى المستلمين في العناوين To وCc وBcc.

trash

تنقل هذه الطريقة الرسالة المحدّدة إلى المهملات.

untrash

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