Class GmailMessage

رسالةGmail

رسالة في حساب 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 ذات الصلة:

• 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 هذا الحقل بدلاً من الوسيطة المطلوبة body. يمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImages	Object	عنصر JavaScript يحتوي على تعيين من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك استخدام المَعلمة htmlBody وأن يحتوي على إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
name	String	اسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
replyTo	String	عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (الإعداد التلقائي: عنوان البريد الإلكتروني للمستخدم)
subject	String	سطر موضوع جديد للرسالة الإلكترونية، بحد أقصى 250 حرفًا

الإرجاع

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

التفويض

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

• 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 ذات الصلة:

• 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 هذا الحقل بدلاً من الوسيطة المطلوبة body. يمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImages	Object	عنصر JavaScript يحتوي على تعيين من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك استخدام المَعلمة htmlBody وأن يحتوي على إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
name	String	اسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
replyTo	String	عنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (الإعداد التلقائي: عنوان البريد الإلكتروني للمستخدم)
subject	String	سطر موضوع جديد للرسالة الإلكترونية، بحد أقصى 250 حرفًا

الإرجاع

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

التفويض

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

• 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 ذات الصلة:

• 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 هذا الحقل بدلاً من الوسيطة المطلوبة body. يمكنك إضافة حقل 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 ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• forward(recipient)

---

getAttachments()

الحصول على جميع المرفقات لهذه الرسالة

الإرجاع

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

التفويض

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

• https://mail.google.com/

---

getAttachments(options)

الحصول على جميع المرفقات لهذه الرسالة

المعلمات

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

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

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

الإرجاع

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

التفويض

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

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• getSubject()

---

getRawContent()

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

الإرجاع

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

التفويض

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

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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: سلسلة محادثات Gmail التي تحتوي على هذه الرسالة.

التفويض

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

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• 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 هذا الحقل بدلاً من الوسيطة المطلوبة body. يمكنك إضافة حقل 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 ذات الصلة:

• 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 ذات الصلة:

• 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 هذا الحقل بدلاً من الوسيطة المطلوبة body. يمكنك إضافة حقل 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 ذات الصلة:

• 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 ذات الصلة:

• 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 ذات الصلة:

• https://mail.google.com/

انظر أيضًا

• star()