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");

المَعلمات

الاسمTypeالوصف
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"
});

المَعلمات

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

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

الاسمTypeالوصف
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 ذات الصلة:

  • 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");

المَعلمات

الاسمTypeالوصف
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"
});

المَعلمات

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

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

الاسمTypeالوصف
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 ذات الصلة:

  • 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");

المَعلمات

الاسمTypeالوصف
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"
});

المَعلمات

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

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

الاسمTypeالوصف
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 ذات الصلة:

  • https://mail.google.com/

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


getAttachments()

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

استرجاع الكرة

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

التفويض

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

  • https://mail.google.com/

getAttachments(options)

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

المَعلمات

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

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

الاسمTypeالوصف
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.

المَعلمات

الاسمTypeالوصف
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 — سلسلة 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");

المَعلمات

الاسمTypeالوصف
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
});

المَعلمات

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

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

الاسمTypeالوصف
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 ذات الصلة:

  • 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");

المَعلمات

الاسمTypeالوصف
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
});

المَعلمات

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

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

الاسمTypeالوصف
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 ذات الصلة:

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

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