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

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

الإرجاع

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

الإرجاع

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[]CANNOT TRANSLATE مصفوفة الملفات لإرسالها باستخدام البريد الإلكتروني
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 ذات الصلة:

  • 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()

جلب المستلمين المفصولين بفواصل في الحقل "نسخة مخفية الوجهة" في هذه الرسالة

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

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

  • 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()

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

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

  • 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()

الحصول على المحتوى الأولي لهذه الرسالة يعادل ذلك "إظهار الأصل" في واجهة مستخدم 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 — GmailThread الذي يحتوي على هذه الرسالة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية أو النطاقات المناسبة من واجهة برمجة تطبيقات 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[]CANNOT TRANSLATE مصفوفة الملفات لإرسالها باستخدام البريد الإلكتروني
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 ذات الصلة:

  • 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[]CANNOT TRANSLATE مصفوفة الملفات لإرسالها باستخدام البريد الإلكتروني
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 ذات الصلة:

  • 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/

انظر أيضًا