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يحصل على المستلمين المفصولين بفواصل bcc'd في هذه الرسالة.
getBody()Stringيحصل على محتوى HTML لنص هذه الرسالة.
getCc()Stringيحصل على المستلمين المفصولين بفاصلة cc'd على هذه الرسالة.
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.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


createDraftReply(body, options)

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

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

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه.

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

الاسمالنوعالوصف
attachmentsBlobSource[]مصفوفة من الملفات لإرسالها عبر الرسالة الإلكترونية
bccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة مخفية الوجهة
ccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة
fromStringالعنوان الذي يجب إرسال الرسالة الإلكترونية منه، والذي يجب أن يكون إحدى القيم التي يعرضها GmailApp.getAliases()
htmlBodyStringعند الضبط، تستخدم الأجهزة القادرة على عرض HTML بدلاً من وسيطة النص الأساسي المطلوبة، ويمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة لبريدك الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على عملية ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك أنّه يتم استخدام المعلّمة htmlBody وتتضمن إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />.
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم's)
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الرد التلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم's)
subjectStringسطر موضوع جديد للرسالة الإلكترونية

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


createDraftReplyAll(body)

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

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

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


createDraftReplyAll(body, options)

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

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

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

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه.

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

الاسمالنوعالوصف
attachmentsBlobSource[]مصفوفة من الملفات لإرسالها عبر الرسالة الإلكترونية
bccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة مخفية الوجهة
ccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة
fromStringالعنوان الذي يجب إرسال الرسالة الإلكترونية منه، والذي يجب أن يكون إحدى القيم التي يعرضها GmailApp.getAliases()
htmlBodyStringعند الضبط، تستخدم الأجهزة القادرة على عرض HTML بدلاً من وسيطة النص الأساسي المطلوبة، ويمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة لبريدك الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على عملية ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك أنّه يتم استخدام المعلّمة htmlBody وتتضمن إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />.
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم's)
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الرد التلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم's)
subjectStringسطر موضوع جديد للرسالة الإلكترونية

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


forward(recipient)

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

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

المعلّمات

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

تذكرة ذهاب وعودة

GmailMessage - هذه الرسالة، مفيدة في السلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


forward(recipient, options)

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

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

المعلّمات

الاسمالنوعالوصف
recipientStringقائمة بعناوين البريد الإلكتروني مفصولة بفواصل.
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه.

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

الاسمالنوعالوصف
attachmentsBlobSource[]مصفوفة من الملفات لإرسالها عبر الرسالة الإلكترونية
bccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة مخفية الوجهة
ccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة
fromStringالعنوان الذي يجب إرسال الرسالة الإلكترونية منه، والذي يجب أن يكون إحدى القيم التي يعرضها GmailApp.getAliases()
htmlBodyStringعند الضبط، تستخدم الأجهزة القادرة على عرض HTML بدلاً من وسيطة النص الأساسي المطلوبة، ويمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة لبريدك الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على عملية ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك أنّه يتم استخدام المعلّمة htmlBody وتتضمن إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />.
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم's)
noReplyBooleantrue إذا كان يجب إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام بلا رد لمنع العملاء من الرد على الرسائل الإلكترونية، هذا الخيار متاح فقط لحسابات Google Workspace، وليس لمستخدمي Gmail
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الرد التلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم's)
subjectStringسطر موضوع جديد للرسالة الإلكترونية

تذكرة ذهاب وعودة

GmailMessage - هذه الرسالة، مفيدة في السلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getAttachments()

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

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

getAttachments(options)

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

المعلّمات

الاسمالنوعالوصف
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه.

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

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

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

getBcc()

يحصل على المستلمين المفصولين بفواصل bcc'd في هذه الرسالة.

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

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

تذكرة ذهاب وعودة

String — المستلمون المفصولون بفاصلة bcc'd في هذه الرسالة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getBody()

يحصل على محتوى HTML لنص هذه الرسالة.

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

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getCc()

يحصل على المستلمين المفصولين بفاصلة cc'd على هذه الرسالة.

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

تذكرة ذهاب وعودة

String — المستلمون المفصولون بفاصلة cc'd في هذه الرسالة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getDate()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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()

يحصل على مُرسِل هذه الرسالة.

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

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getHeader(name)

يحصل على قيمة عنوان RFC 2822 نظرًا إلى اسم العنوان.

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

المعلّمات

الاسمالنوعالوصف
nameStringاسم عنوان RFC بدون فصله بنقطتين.

تذكرة ذهاب وعودة

String — قيمة العنوان، أو سلسلة فارغة إذا لم يكن العنوان موجودًا في الرسالة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

getId()

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

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

تذكرة ذهاب وعودة

String — رقم تعريف الرسالة


getPlainBody()

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

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

تذكرة ذهاب وعودة

String — محتوى النص العادي لهذه الرسالة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getRawContent()

للحصول على المحتوى الأولي لهذه الرسالة. يعادل ذلك "Show Original"من خلال واجهة مستخدم Gmail.

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

getReplyTo()

الحصول على عنوان الرد على هذه الرسالة (عادةً المُرسِل).

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

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getSubject()

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

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

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


getThread()

يحصل على سلسلة المحادثات التي تحتوي على هذه الرسالة.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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()

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

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

تذكرة ذهاب وعودة

String — المستلمون المفصولون بفواصل:

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


isDraft()

يحدد ما إذا كانت هذه الرسالة مسودة أم لا.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

isInChats()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

تذكرة ذهاب وعودة

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


isInInbox()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

isInPriorityInbox()

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

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var 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()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

تذكرة ذهاب وعودة

Boolean — ما إذا كانت هذه الرسالة في المهملات.


isStarred()

تحديد ما إذا كانت هذه الرسالة مميّزة بنجمة.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

تذكرة ذهاب وعودة

Boolean — تحديد ما إذا كانت هذه الرسالة مميّزة بنجمة.


isUnread()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

تذكرة ذهاب وعودة

Boolean — حالة الرسالة غير المقروءة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

markRead()

وضع علامة "مقروءة" على الرسالة.

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

تذكرة ذهاب وعودة

GmailMessage — رسالة Gmail هذه، مفيدة للسلاسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


markUnread()

وضع علامة "غير مقروءة" على الرسالة.

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

تذكرة ذهاب وعودة

GmailMessage — رسالة Gmail هذه، مفيدة للسلاسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


moveToTrash()

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

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

تذكرة ذهاب وعودة

GmailMessage — رسالة Gmail هذه، مفيدة للسلاسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


refresh()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var 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
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("Got your message");

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.

تذكرة ذهاب وعودة

GmailMessage - هذه الرسالة، مفيدة في السلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


reply(body, options)

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

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

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

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه.

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

الاسمالنوعالوصف
attachmentsBlobSource[]مصفوفة من الملفات لإرسالها عبر الرسالة الإلكترونية
bccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة مخفية الوجهة
ccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة
fromStringالعنوان الذي يجب إرسال الرسالة الإلكترونية منه، والذي يجب أن يكون إحدى القيم التي يعرضها GmailApp.getAliases()
htmlBodyStringعند الضبط، تستخدم الأجهزة القادرة على عرض HTML بدلاً من وسيطة النص الأساسي المطلوبة، ويمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة لبريدك الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على عملية ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك أنّه يتم استخدام المعلّمة htmlBody وتتضمن إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />.
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم's)
noReplyBooleantrue إذا كان يجب إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام بلا رد لمنع العملاء من الرد على الرسائل الإلكترونية، هذا الخيار متاح فقط لحسابات Google Workspace، وليس لمستخدمي Gmail
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الرد التلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم's)
subjectStringسطر موضوع جديد للرسالة الإلكترونية

تذكرة ذهاب وعودة

GmailMessage - هذه الرسالة، مفيدة في السلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


replyAll(body)

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

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

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.

تذكرة ذهاب وعودة

GmailMessage — هذه الرسالة مفيدة للسلاسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


replyAll(body, options)

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

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

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

المعلّمات

الاسمالنوعالوصف
bodyStringنص الرسالة الإلكترونية.
optionsObjectعنصر JavaScript يُحدّد المعلمات المتقدمة، كما هو موضّح أدناه.

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

الاسمالنوعالوصف
attachmentsBlobSource[]مصفوفة من الملفات لإرسالها عبر الرسالة الإلكترونية
bccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة مخفية الوجهة
ccStringقائمة بعناوين البريد الإلكتروني المفصولة بفاصلة إلى نسخة
fromStringالعنوان الذي يجب إرسال الرسالة الإلكترونية منه، والذي يجب أن يكون إحدى القيم التي يعرضها GmailApp.getAliases()
htmlBodyStringعند الضبط، تستخدم الأجهزة القادرة على عرض HTML بدلاً من وسيطة النص الأساسي المطلوبة، ويمكنك إضافة حقل inlineImages اختياري في نص HTML إذا كانت لديك صور مضمّنة لبريدك الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على عملية ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك أنّه يتم استخدام المعلّمة htmlBody وتتضمن إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />.
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم's)
noReplyBooleantrue إذا كان يجب إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام بلا رد لمنع العملاء من الرد على الرسائل الإلكترونية، هذا الخيار متاح فقط لحسابات Google Workspace، وليس لمستخدمي Gmail
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الرد التلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم's)
subjectStringسطر موضوع جديد للرسالة الإلكترونية (250 حرفًا كحد أقصى)

تذكرة ذهاب وعودة

GmailMessage - هذه الرسالة، مفيدة في السلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


star()

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

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

تذكرة ذهاب وعودة

GmailMessage — رسالة Gmail هذه، مفيدة للسلاسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا


unstar()

إلغاء تمييز الرسالة بنجمة.

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

تذكرة ذهاب وعودة

GmailMessage — رسالة Gmail هذه، مفيدة للسلاسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات REST ذات الصلة:

  • https://mail.google.com/

راجع أيضًا