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.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

المَعلمات

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

رحلة العودة

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

التفويض

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

  • 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اسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان رد تلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم)
subjectStringسطر موضوع جديد للرسالة الإلكترونية، بحد أقصى 250 حرفًا.

رحلة العودة

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

التفويض

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

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

  • 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اسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان رد تلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم)
subjectStringسطر موضوع جديد للرسالة الإلكترونية، بحد أقصى 250 حرفًا.

رحلة العودة

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

التفويض

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

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

  • 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اسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
noReplyBooleantrue إذا كان يجب إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام لا يتم الرد عليه لمنع العملاء من الرد على الرسائل الإلكترونية، وهذا الخيار متاح فقط لحسابات Google Workspace، وليس لمستخدمي Gmail.
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان رد تلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم)
subjectStringسطر موضوع جديد للرسالة الإلكترونية، بحد أقصى 250 حرفًا.

رحلة العودة

GmailMessage: هذه الرسالة مفيدة في وضع السلاسل.

التفويض

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

  • https://mail.google.com/

يمكن أيضًا مراجعة


getAttachments()

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

رحلة العودة

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

التفويض

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

  • https://mail.google.com/

getAttachments(options)

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

المَعلمات

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

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

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

رحلة العودة

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

التفويض

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

  • https://mail.google.com/

getBcc()

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

هذا فارغ لجميع الرسائل المستلمة، حسب التعريف.

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: تم إنشاء نسخة مخفية الوجهة من المُستلِمين المفصولين بفواصل.

التفويض

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

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

  • https://mail.google.com/

يمكن أيضًا مراجعة


getCc()

يتم إرسال نسخة من هذه الرسالة إلى المُستلِمين المفصولين بفواصل.

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 — يتم إرسال نسخة من هذه الرسالة إلى المُستلِمين المفصولين بفواصل.

التفويض

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

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

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

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

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

  • https://mail.google.com/

يمكن أيضًا مراجعة


getRawContent()

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

رحلة العودة

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

التفويض

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 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اسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
noReplyBooleantrue إذا كان يجب إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام لا يتم الرد عليه لمنع العملاء من الرد على الرسائل الإلكترونية، وهذا الخيار متاح فقط لحسابات Google Workspace، وليس لمستخدمي Gmail.
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان رد تلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم)
subjectStringسطر موضوع جديد للرسالة الإلكترونية، بحد أقصى 250 حرفًا.

رحلة العودة

GmailMessage: هذه الرسالة مفيدة في وضع السلاسل.

التفويض

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

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

  • 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اسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
noReplyBooleantrue إذا كان يجب إرسال الرسالة الإلكترونية من عنوان بريد إلكتروني عام لا يتم الرد عليه لمنع العملاء من الرد على الرسائل الإلكترونية، وهذا الخيار متاح فقط لحسابات Google Workspace، وليس لمستخدمي Gmail.
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان رد تلقائي (تلقائي: عنوان البريد الإلكتروني للمستخدم)
subjectStringسطر موضوع جديد للرسالة الإلكترونية، بحد أقصى 250 حرفًا.

رحلة العودة

GmailMessage: هذه الرسالة مفيدة في وضع السلاسل.

التفويض

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

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

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

  • https://mail.google.com/

يمكن أيضًا مراجعة