Class GmailMessage

GmailMessage

رسالة في حساب Gmail الخاص بالمستخدم

الطُرق

الطريقة	نوع القيمة التي تم إرجاعها	وصف قصير
createDraftReply(body)	GmailDraft	تنشئ هذه الطريقة مسودة رسالة للردّ على مُرسِل هذه الرسالة باستخدام عنوان الردّ.
createDraftReply(body, options)	GmailDraft	تنشئ هذه الدالة مسودة رسالة للرد على مرسل هذه الرسالة باستخدام عنوان الرد، مع وسيطات اختيارية.
createDraftReplyAll(body)	GmailDraft	تنشئ هذه الطريقة رسالة مسودّة للرد على المرسِل باستخدام عنوان الرد وجميع مستلمي هذه الرسالة.
createDraftReplyAll(body, options)	GmailDraft	تنشئ هذه الطريقة رسالة مسودّة للرد على مرسل هذه الرسالة باستخدام عنوان الرد وجميع المستلمين، مع وسيطات اختيارية.
forward(recipient)	GmailMessage	تعيد توجيه هذه الرسالة إلى مستلِمين جدد.
forward(recipient, options)	GmailMessage	تعيد توجيه هذه الرسالة إلى مستلِمين جدد، مع وسيطات اختيارية.
getAttachments()	GmailAttachment[]	تعرض هذه الطريقة جميع المرفقات الخاصة بهذه الرسالة.
getAttachments(options)	GmailAttachment[]	تعرض هذه الطريقة جميع المرفقات الخاصة بهذه الرسالة.
getBcc()	String	تعرض هذه السمة المستلمين الذين تم إرسال نسخة مخفية الوجهة إليهم من هذه الرسالة، ويكونون مفصولين بفواصل.
getBody()	String	تعرض هذه الطريقة محتوى HTML الخاص بنص هذه الرسالة.
getCc()	String	تعرض هذه الطريقة المستلمين الذين تم إرسال نسخة إلى عنوان بريدهم الإلكتروني من هذه الرسالة، ويكونون مفصولين بفواصل.
getDate()	Date	تعرض هذه السمة تاريخ ووقت هذه الرسالة.
getFrom()	String	تعرض هذه السمة مُرسِل الرسالة.
getHeader(name)	String	تعرض هذه الطريقة قيمة رأس RFC 2822 مع اسم الرأس المحدّد.
getId()	String	تعرض هذه السمة رقم تعريف هذه الرسالة.
getPlainBody()	String	تعرض هذه السمة محتوى نص الرسالة بدون تنسيق HTML.
getRawContent()	String	تعرض هذه الطريقة المحتوى الأولي لهذه الرسالة.
getReplyTo()	String	تعرض هذه السمة عنوان الرد على هذه الرسالة (عادةً ما يكون هو المُرسِل).
getSubject()	String	تعرض هذه الطريقة موضوع الرسالة.
getThread()	GmailThread	تعرض هذه الطريقة سلسلة المحادثات التي تتضمّن هذه الرسالة.
getTo()	String	تعرض هذه السمة المستلمين المفصولين بفواصل لهذه الرسالة.
isDraft()	Boolean	تُستخدَم لمعرفة ما إذا كانت هذه الرسالة مسودة.
isInChats()	Boolean	تُستخدَم لمعرفة ما إذا كانت هذه الرسالة عبارة عن محادثة.
isInInbox()	Boolean	تسترد هذه الطريقة ما إذا كانت هذه الرسالة في البريد الوارد.
isInPriorityInbox()	Boolean	تعرض الدالة true إذا كانت هذه الرسالة في صندوق البريد الوارد ذي الأولوية، وتعرض false في الحالات الأخرى.
isInTrash()	Boolean	تعرض هذه الطريقة ما إذا كانت هذه الرسالة في المهملات.
isStarred()	Boolean	تعرض هذه الطريقة ما إذا كانت هذه الرسالة مميّزة بنجمة.
isUnread()	Boolean	تعرض هذه السمة ما إذا كانت هذه الرسالة غير مقروءة.
markRead()	GmailMessage	يضع علامة على الرسالة بأنّها مقروءة.
markUnread()	GmailMessage	يضع علامة على الرسالة بأنّها غير مقروءة.
moveToTrash()	GmailMessage	ينقل الرسالة إلى المهملات.
refresh()	GmailMessage	إعادة تحميل هذه الرسالة والحالة المرتبطة بها من Gmail (مفيد في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك).
reply(body)	GmailMessage	الردود على مُرسِل هذه الرسالة باستخدام عنوان الردّ
reply(body, options)	GmailMessage	الردّ على مُرسِل هذه الرسالة باستخدام عنوان الردّ، مع وسيطات اختيارية
replyAll(body)	GmailMessage	الردّ على المرسِل باستخدام عنوان الردّ وجميع مستلمي هذه الرسالة
replyAll(body, options)	GmailMessage	الرد على مرسل هذه الرسالة باستخدام عنوان الرد وجميع المستلمين، مع وسيطات اختيارية.
star()	GmailMessage	تمييز الرسالة بنجمة
unstar()	GmailMessage	إزالة النجمة من الرسالة

مستندات تفصيلية

createDraftReply(body)

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

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('Got your message');

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية

الإرجاع

GmailDraft: الرسالة المسودّة التي تم إنشاؤها حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• reply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReply(body, options)

تنشئ هذه الدالة مسودة رسالة للرد على مرسل هذه الرسالة باستخدام عنوان الرد، مع وسيطات اختيارية.

يمكن أن تحتوي الرسالة الإلكترونية على نص عادي ونص HTML. حجم الرسالة الإلكترونية (بما في ذلك العناوين) محدود.

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية
options	Object	كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسم	النوع	الوصف
attachments	BlobSource[]	مصفوفة من الملفات المراد إرسالها مع الرسالة الإلكترونية
bcc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي سيتم إرسال نسخة مخفية الوجهة إليها
cc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي يجب تضمينها في السطر "نسخة إلى"
from	String	عنوان البريد الإلكتروني الذي يجب إرسال الرسالة منه، ويجب أن يكون إحدى القيم التي تعرضها الدالة GmailApp.getAliases()
htmlBody	String	عند ضبط هذا الحقل، تستخدم الأجهزة التي يمكنها عرض HTML هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImages	Object	كائن JavaScript يحتوي على ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، وهذا يفترض أنّه يتم استخدام المَعلمة htmlBody وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
name	String	اسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم)
replyTo	String	عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم)
subject	String	سطر موضوع جديد للرسالة الإلكترونية، يصل إلى 250 حرفًا

الإرجاع

GmailDraft: الرسالة المسودّة التي تم إنشاؤها حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• reply(body, options)
• createDraftReply(body)
• createDraftReplyAll(body)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body)

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

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية

الإرجاع

GmailDraft: الرسالة المسودّة التي تم إنشاؤها حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• replyAll(body)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body, options)

---

createDraftReplyAll(body, options)

تنشئ هذه الطريقة رسالة مسودّة للرد على مرسل هذه الرسالة باستخدام عنوان الرد وجميع المستلمين، مع وسيطات اختيارية.

يمكن أن تحتوي الرسالة الإلكترونية على نص عادي ونص HTML. حجم الرسالة الإلكترونية (بما في ذلك العناوين) محدود.

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: '[e-mail]',
});

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية
options	Object	كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسم	النوع	الوصف
attachments	BlobSource[]	مصفوفة من الملفات المراد إرسالها مع الرسالة الإلكترونية
bcc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي سيتم إرسال نسخة مخفية الوجهة إليها
cc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي يجب تضمينها في السطر "نسخة إلى"
from	String	عنوان البريد الإلكتروني الذي يجب إرسال الرسالة منه، ويجب أن يكون إحدى القيم التي تعرضها الدالة GmailApp.getAliases()
htmlBody	String	عند ضبط هذا الحقل، تستخدم الأجهزة التي يمكنها عرض HTML هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImages	Object	كائن JavaScript يحتوي على ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، وهذا يفترض أنّه يتم استخدام المَعلمة htmlBody وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
name	String	اسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم)
replyTo	String	عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم)
subject	String	سطر موضوع جديد للرسالة الإلكترونية، يصل إلى 250 حرفًا

الإرجاع

GmailDraft: الرسالة المسودّة التي تم إنشاؤها حديثًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• replyAll(body, options)
• createDraftReply(body)
• createDraftReply(body, options)
• createDraftReplyAll(body)

---

forward(recipient)

تعيد توجيه هذه الرسالة إلى مستلِمين جدد. يتم تحديد الحصة لحجم الرسالة الإلكترونية (بما في ذلك العناوين).

// Forward first message of first inbox thread to recipient1 & recipient2,
// both @example.com
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('[e-mail],[e-mail]');

المَعلمات

الاسم	النوع	الوصف
recipient	String	قائمة بعناوين البريد الإلكتروني مفصولة بفواصل

الإرجاع

GmailMessage: هذه الرسالة مفيدة في الربط بين الطلبات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• forward(recipient, options)

---

forward(recipient, options)

تعيد توجيه هذه الرسالة إلى مستلِمين جدد، مع وسيطات اختيارية.

يمكن أن تحتوي الرسالة الإلكترونية على نص عادي ونص HTML. يخضع حجم الرسالة الإلكترونية (بما في ذلك العناوين) لحدود الحصة.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('[e-mail],[e-mail]', {
  cc: '[e-mail]',
  bcc: '[e-mail],[e-mail]',
});

المَعلمات

الاسم	النوع	الوصف
recipient	String	قائمة بعناوين البريد الإلكتروني مفصولة بفواصل
options	Object	كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسم	النوع	الوصف
attachments	BlobSource[]	مصفوفة من الملفات المراد إرسالها مع الرسالة الإلكترونية
bcc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي سيتم إرسال نسخة مخفية الوجهة إليها
cc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي يجب تضمينها في السطر "نسخة إلى"
from	String	عنوان البريد الإلكتروني الذي يجب إرسال الرسالة منه، ويجب أن يكون إحدى القيم التي تعرضها الدالة GmailApp.getAliases()
htmlBody	String	عند ضبط هذا الحقل، تستخدم الأجهزة التي يمكنها عرض HTML هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImages	Object	كائن JavaScript يحتوي على ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، وهذا يفترض أنّه يتم استخدام المَعلمة htmlBody وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
name	String	اسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم)
noReply	Boolean	true إذا كان من المفترض إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام لا يسمح بالردّ لتثبيط المستلِمين عن الردّ على الرسائل الإلكترونية، لا يتوفّر هذا الخيار إلا لحسابات Google Workspace، وليس لمستخدمي Gmail
replyTo	String	عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم)
subject	String	سطر موضوع جديد للرسالة الإلكترونية، يصل إلى 250 حرفًا

الإرجاع

GmailMessage: هذه الرسالة مفيدة في الربط بين الطلبات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• forward(recipient)

---

getAttachments()

تعرض هذه الطريقة جميع المرفقات الخاصة بهذه الرسالة.

الإرجاع

GmailAttachment[]: مصفوفة من مرفقات Blob لهذه الرسالة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

getAttachments(options)

تعرض هذه الطريقة جميع المرفقات الخاصة بهذه الرسالة.

المَعلمات

الاسم	النوع	الوصف
options	Object	كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسم	النوع	الوصف
includeInlineImages	Boolean	true إذا كان يجب أن يتضمّن الصفيف الذي تم إرجاعه لمرفقات Blob الصور المضمّنة (القيمة التلقائية هي true).
includeAttachments	Boolean	true إذا كان يجب أن يتضمّن الصفيف الذي تم إرجاعه لمرفقات Blob المرفقات العادية (غير المضمّنة) (القيمة التلقائية هي true).

الإرجاع

GmailAttachment[]: مصفوفة من مرفقات Blob لهذه الرسالة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

getBcc()

تعرض هذه السمة المستلمين الذين تم إرسال نسخة مخفية الوجهة إليهم من هذه الرسالة، ويكونون مفصولين بفواصل.

يكون هذا الحقل فارغًا لجميع الرسائل المستلَمة، وذلك بحسب التعريف.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBcc());                      // Log bcc'd addresses

الإرجاع

String: المستلمون الذين تم إرسال نسخة مخفية الوجهة إليهم من هذه الرسالة، مفصولين بفواصل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getTo()

---

getBody()

تعرض هذه الطريقة محتوى HTML الخاص بنص هذه الرسالة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBody());                     // Log contents of the body

الإرجاع

String: محتوى نص هذه الرسالة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getSubject()

---

getCc()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getCc());                       // Log cc'd addresses

الإرجاع

String: المستلمون الذين تم إرسال نسخة إلى عناوين بريدهم الإلكتروني من هذه الرسالة، ويتم الفصل بينهم بفواصل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getTo()

---

getDate()

تعرض هذه السمة تاريخ ووقت هذه الرسالة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getDate());  // Log date and time of the message

الإرجاع

Date: تاريخ هذه الرسالة ووقتها

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

getFrom()

تعرض هذه السمة مُرسِل الرسالة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getFrom());  // Log from address of the message

الإرجاع

String: عنوان البريد الإلكتروني لمُرسِل الرسالة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getReplyTo()

---

getHeader(name)

تعرض هذه الطريقة قيمة عنوان RFC 2822 مع اسم العنوان.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const message = thread.getMessages()[0];           // Get the first message.
Logger.log(
    message.getHeader('Message-ID'));  // Logs the Message-ID RFC 2822 header.

المَعلمات

الاسم	النوع	الوصف
name	String	اسم عنوان RFC، بدون النقطتين اللتين تفصلانه عن القيمة

الإرجاع

String: قيمة العنوان أو سلسلة فارغة إذا لم يكن العنوان متوفّرًا في الرسالة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

getId()

تعرض هذه السمة رقم تعريف هذه الرسالة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const messageById = GmailApp.getMessageById(id);
Logger.log(
    message.getSubject() === messageById.getMessage());  // Always logs true

الإرجاع

String: معرّف الرسالة

---

getPlainBody()

تعرض هذه السمة محتوى نص الرسالة بدون تنسيق HTML. هذه العملية أكثر تعقيدًا من getBody() وتستغرق وقتًا أطول.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getPlainBody());                // Log contents of the body

الإرجاع

String: يمثّل محتوى نص الرسالة العادي.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getSubject()

---

getRawContent()

تعرض هذه الطريقة المحتوى الأولي لهذه الرسالة. يعادل هذا الخيار "عرض النسخة الأصلية" في واجهة مستخدم Gmail.

الإرجاع

String: المحتوى الأولي لهذه الرسالة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

getReplyTo()

تعرض هذه السمة عنوان الرد على هذه الرسالة (عادةً ما يكون هو المُرسِل).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getReplyTo());                  // Logs reply-to address

الإرجاع

String: عنوان البريد الإلكتروني للردود

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getCc()

---

getSubject()

تعرض هذه الطريقة موضوع الرسالة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getSubject());                  // Log subject line

الإرجاع

String: موضوع هذه الرسالة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getAttachments()

---

getThread()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(
    message.getThread().getFirstMessageSubject() ===
        thread.getFirstMessageSubject(),
);  // Always logs true

الإرجاع

استبدِل GmailThread بـ GmailThread الذي يحتوي على هذه الرسالة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

getTo()

تعرض هذه السمة المستلمين المفصولين بفواصل لهذه الرسالة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getTo());  // Log the recipient of message

الإرجاع

String: مستلمو هذه الرسالة المفصولون بفواصل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getCc()

---

isDraft()

تُستخدَم لمعرفة ما إذا كانت هذه الرسالة مسودة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

الإرجاع

Boolean: تحدّد ما إذا كانت هذه الرسالة مسودة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

isInChats()

تُستخدَم لمعرفة ما إذا كانت هذه الرسالة عبارة عن محادثة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

الإرجاع

Boolean: تحدّد ما إذا كانت هذه الرسالة محادثة.

---

isInInbox()

تسترد هذه الطريقة ما إذا كانت هذه الرسالة في البريد الوارد.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

الإرجاع

استبدِل Boolean بما إذا كانت هذه الرسالة في صندوق البريد الوارد.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

isInPriorityInbox()

تعرض الدالة true إذا كانت هذه الرسالة في صندوق البريد الوارد ذي الأولوية، وتعرض false في الحالات الأخرى.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log(`is in priority inbox? ${messages[i].isInPriorityInbox()}`);
}

الإرجاع

‫Boolean: ما إذا كانت هذه الرسالة في البريد الوارد ذي الأولوية.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

isInTrash()

تعرض هذه الطريقة ما إذا كانت هذه الرسالة في المهملات.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

الإرجاع

‫Boolean: لتحديد ما إذا كانت هذه الرسالة في المهملات.

---

isStarred()

تعرض هذه الطريقة ما إذا كانت هذه الرسالة مميّزة بنجمة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

الإرجاع

Boolean: ما إذا كانت هذه الرسالة مميّزة بنجمة

---

isUnread()

تعرض هذه السمة ما إذا كانت هذه الرسالة غير مقروءة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

الإرجاع

Boolean: حالة هذه الرسالة "غير مقروءة".

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

markRead()

يضع علامة على الرسالة بأنّها مقروءة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markRead();                                // Mark as read

الإرجاع

‫GmailMessage: هذا هو GmailMessage، وهو مفيد للتسلسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• isUnread()

---

markUnread()

يضع علامة على الرسالة بأنّها غير مقروءة.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markUnread();                              // Mark as unread

الإرجاع

‫GmailMessage: هذا هو GmailMessage، وهو مفيد للتسلسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• isUnread()

---

moveToTrash()

ينقل الرسالة إلى المهملات.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.moveToTrash();                             // Move message to trash

الإرجاع

‫GmailMessage: هذا هو GmailMessage، وهو مفيد للتسلسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• isInTrash()

---

refresh()

إعادة تحميل هذه الرسالة والحالة المرتبطة بها من Gmail (مفيد في حال تغيّر التصنيفات أو حالة القراءة أو غير ذلك).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
// .. Do bunch of stuff here
message.refresh();  // Make sure it's up to date
// Do more stuff to message

الإرجاع

GmailMessage: هذه الرسالة مخصّصة للربط.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

---

reply(body)

الردود على مُرسِل هذه الرسالة باستخدام عنوان الردّ يخضع حجم الرسالة الإلكترونية (بما في ذلك العناوين) لحدود الحصة.

// Respond to author of message with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('Got your message');

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية

الإرجاع

GmailMessage: هذه الرسالة مفيدة في الربط بين الطلبات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• reply(body, options)
• replyAll(body)
• replyAll(body, options)

---

reply(body, options)

الردّ على مُرسِل هذه الرسالة باستخدام عنوان الردّ، مع وسيطات اختيارية

يمكن أن تحتوي الرسالة الإلكترونية على نص عادي ونص HTML. يخضع حجم الرسالة الإلكترونية (بما في ذلك العناوين) لحدود الحصة.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية
options	Object	كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسم	النوع	الوصف
attachments	BlobSource[]	مصفوفة من الملفات المراد إرسالها مع الرسالة الإلكترونية
bcc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي سيتم إرسال نسخة مخفية الوجهة إليها
cc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي يجب تضمينها في السطر "نسخة إلى"
from	String	عنوان البريد الإلكتروني الذي يجب إرسال الرسالة منه، ويجب أن يكون إحدى القيم التي تعرضها الدالة GmailApp.getAliases()
htmlBody	String	عند ضبط هذا الحقل، تستخدم الأجهزة التي يمكنها عرض HTML هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImages	Object	كائن JavaScript يحتوي على ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، وهذا يفترض أنّه يتم استخدام المَعلمة htmlBody وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
name	String	اسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم)
noReply	Boolean	true إذا كان من المفترض إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام لا يسمح بالردّ لتثبيط المستلِمين عن الردّ على الرسائل الإلكترونية، لا يتوفّر هذا الخيار إلا لحسابات Google Workspace، وليس لمستخدمي Gmail
replyTo	String	عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم)
subject	String	سطر موضوع جديد للرسالة الإلكترونية، يصل إلى 250 حرفًا

الإرجاع

GmailMessage: هذه الرسالة مفيدة في الربط بين الطلبات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• reply(body)
• replyAll(body)
• replyAll(body, options)

---

replyAll(body)

الردّ على المرسِل باستخدام عنوان الردّ وجميع مستلمي هذه الرسالة يبلغ حجم الرسالة الإلكترونية (بما في ذلك العناوين) محدود الحصة.

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('Got your message');

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية

الإرجاع

GmailMessage: هذه الرسالة مفيدة في الربط بين العمليات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• reply(body)
• reply(body, options)
• replyAll(body, options)

---

replyAll(body, options)

الرد على مرسل هذه الرسالة باستخدام عنوان الرد وجميع المستلمين، مع وسيطات اختيارية.

يمكن أن تحتوي الرسالة الإلكترونية على نص عادي ونص HTML. يخضع حجم الرسالة الإلكترونية (بما في ذلك العناوين) لحدود الحصة.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

المَعلمات

الاسم	النوع	الوصف
body	String	نص الرسالة الإلكترونية
options	Object	كائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه.

المعلمات المتقدمة

الاسم	النوع	الوصف
attachments	BlobSource[]	مصفوفة من الملفات المراد إرسالها مع الرسالة الإلكترونية
bcc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي سيتم إرسال نسخة مخفية الوجهة إليها
cc	String	قائمة قيم مفصولة بفاصلة لعناوين البريد الإلكتروني التي يجب تضمينها في السطر "نسخة إلى"
from	String	عنوان البريد الإلكتروني الذي يجب إرسال الرسالة منه، ويجب أن يكون إحدى القيم التي تعرضها الدالة GmailApp.getAliases()
htmlBody	String	عند ضبط هذا الحقل، تستخدم الأجهزة التي يمكنها عرض HTML هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImages	Object	كائن JavaScript يحتوي على ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، وهذا يفترض أنّه يتم استخدام المَعلمة htmlBody وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
name	String	اسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم)
noReply	Boolean	true إذا كان من المفترض إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام لا يسمح بالردّ لتثبيط المستلِمين عن الردّ على الرسائل الإلكترونية، لا يتوفّر هذا الخيار إلا لحسابات Google Workspace، وليس لمستخدمي Gmail
replyTo	String	عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم)
subject	String	سطر موضوع جديد للرسالة الإلكترونية، يصل إلى 250 حرفًا

الإرجاع

GmailMessage: هذه الرسالة مفيدة في الربط بين الطلبات.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• reply(body)
• reply(body, options)
• replyAll(body)

---

star()

تمييز الرسالة بنجمة

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.star();                                    // Star the message

الإرجاع

‫GmailMessage: هذا هو GmailMessage، وهو مفيد للتسلسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• unstar()

---

unstar()

إزالة النجمة من الرسالة

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.unstar();                                  // Unstar the message

الإرجاع

‫GmailMessage: هذا هو GmailMessage، وهو مفيد للتسلسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة REST API ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• star()