Class GmailApp

GmailApp

يوفّر إمكانية الوصول إلى سلاسل المحادثات والرسائل والتصنيفات في Gmail.

الطُرق

الطريقةنوع الإرجاعوصف قصير
createDraft(recipient, subject, body)GmailDraftإنشاء مسودة رسالة إلكترونية
createDraft(recipient, subject, body, options)GmailDraftتنشئ مسودة رسالة إلكترونية تتضمّن وسيطات اختيارية.
createLabel(name)GmailLabelأنشئ تصنيف مستخدم جديدًا للاسم المحدّد.
deleteLabel(label)GmailAppحذف التصنيف المحدد.
getAliases()String[]الحصول على قائمة بالرسائل الإلكترونية التي تم إعدادها كعناوين بديلة لهذا الحساب في Gmail.
getDraft(draftId)GmailDraftيمكنك استرداد مسودة رسالة إلكترونية باستخدام رقم التعريف.
getDraftMessages()GmailMessage[]استرداد كل مسودات الرسائل.
getDrafts()GmailDraft[]الحصول على جميع مسودات الرسائل في Gmail
getInboxThreads()GmailThread[]لاسترداد جميع سلاسل البريد الوارد بغض النظر عن التصنيفات.
getInboxThreads(start, max)GmailThread[]لاسترداد مجموعة من سلاسل محادثات البريد الوارد بغض النظر عن التصنيفات.
getInboxUnreadCount()Integerالحصول على عدد سلاسل المحادثات غير المقروءة في البريد الوارد
getMessageById(id)GmailMessageيتلقّى رسالة من خلال رقم التعريف.
getMessagesForThread(thread)GmailMessage[]يمكنك استرداد جميع الرسائل في سلسلة المحادثات المحدّدة.
getMessagesForThreads(threads)GmailMessage[][]يمكنك استرداد جميع الرسائل في سلاسل المحادثات المحدّدة.
getPriorityInboxThreads()GmailThread[]لاسترداد جميع سلاسل البريد الهام، بغض النظر عن التصنيفات.
getPriorityInboxThreads(start, max)GmailThread[]لاسترداد مجموعة من سلاسل محادثات البريد الهام، بغض النظر عن التصنيفات.
getPriorityInboxUnreadCount()Integerالحصول على عدد سلاسل المحادثات غير المقروءة في البريد الهام.
getSpamThreads()GmailThread[]لاسترداد جميع سلاسل المحادثات غير المرغوب فيها بغض النظر عن التصنيفات.
getSpamThreads(start, max)GmailThread[]لاسترداد مجموعة من سلاسل الرسائل غير المرغوب فيها بغض النظر عن التصنيفات.
getSpamUnreadCount()Integerالحصول على عدد سلاسل المحادثات غير المقروءة والتي تكون غير مرغوب فيها
getStarredThreads()GmailThread[]لاسترداد كل سلاسل المحادثات المميّزة بنجمة بغض النظر عن التصنيفات.
getStarredThreads(start, max)GmailThread[]لاسترداد مجموعة من سلاسل المحادثات المميّزة بنجمة بغض النظر عن التصنيفات.
getStarredUnreadCount()Integerالحصول على عدد سلاسل المحادثات غير المقروءة التي تم تمييزها بنجمة
getThreadById(id)GmailThreadالحصول على سلسلة محادثات من خلال رقم التعريف
getTrashThreads()GmailThread[]لاسترداد كل سلاسل المحادثات في المهملات بغض النظر عن التصنيفات.
getTrashThreads(start, max)GmailThread[]لاسترداد نطاق من سلاسل المهملات بغض النظر عن التصنيفات.
getUserLabelByName(name)GmailLabelلاسترداد تصنيف وفقًا لاسم التصنيف.
getUserLabels()GmailLabel[]لاسترداد قائمة بالتصنيفات التي أنشأها المستخدم.
markMessageRead(message)GmailAppوضع علامة على هذه الرسالة كمقروءة وفرض إعادة تحميل الرسالة
markMessageUnread(message)GmailAppوضع علامة "غير مقروءة" على هذه الرسالة وفرض إعادة تحميل الرسالة
markMessagesRead(messages)GmailAppوضع علامة على هذه الرسائل كمقروءة وفرض إعادة تحميل الرسائل
markMessagesUnread(messages)GmailAppوضع علامة "غير مقروءة" على هذه الرسائل وفرض إعادة تحميل الرسائل
markThreadImportant(thread)GmailAppوضع علامة على سلسلة المحادثات هذه كمهمة وفرض إعادة تحميل سلسلة المحادثات
markThreadRead(thread)GmailAppيضع علامة "مقروءة" على سلسلة المحادثات هذه وفرض إعادة تحميل سلسلة المحادثات.
markThreadUnimportant(thread)GmailAppوضع علامة "غير مهمة" على سلسلة المحادثات هذه وفرض إعادة تحميل سلسلة المحادثات
markThreadUnread(thread)GmailAppيؤدي وضع علامة "غير مقروءة" إلى سلسلة المحادثات هذه وفرض إعادة تحميل سلسلة المحادثات.
markThreadsImportant(threads)GmailAppيؤدي وضع علامة "مهمة" إلى سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات.
markThreadsRead(threads)GmailAppيؤدي وضع علامة "مقروءة" إلى سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات.
markThreadsUnimportant(threads)GmailAppوضع علامة "غير مهمة" على سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات
markThreadsUnread(threads)GmailAppوضع علامة "غير مقروءة" على سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات
moveMessageToTrash(message)GmailAppنقل الرسالة إلى المهملات وفرض إعادة تحميل الرسالة
moveMessagesToTrash(messages)GmailAppنقل الرسائل المحددة إلى المهملات وفرض إعادة تحميل الرسائل
moveThreadToArchive(thread)GmailAppنقل سلسلة المحادثات هذه إلى الأرشيف وفرض إعادة تحميل سلسلة المحادثات
moveThreadToInbox(thread)GmailAppنقل سلسلة المحادثات هذه إلى البريد الوارد وفرض إعادة تحميل سلسلة المحادثات
moveThreadToSpam(thread)GmailAppنقل سلسلة المحادثات هذه إلى مجلد "المحتوى غير المرغوب فيه" وفرض إعادة تحميل سلسلة المحادثات
moveThreadToTrash(thread)GmailAppيؤدي هذا الإجراء إلى نقل سلسلة المحادثات هذه إلى المهملات وفرض إعادة تحميل سلسلة المحادثات.
moveThreadsToArchive(threads)GmailAppيؤدي هذا الإجراء إلى نقل سلاسل المحادثات هذه إلى الأرشيف وفرض إعادة تحميل سلاسل المحادثات.
moveThreadsToInbox(threads)GmailAppنقل سلاسل المحادثات هذه إلى البريد الوارد وفرض إعادة تحميل سلاسل المحادثات
moveThreadsToSpam(threads)GmailAppنقل سلاسل المحادثات هذه إلى مجلد "الرسائل غير المرغوب فيها" وفرض إعادة تحميل سلاسل المحادثات
moveThreadsToTrash(threads)GmailAppيؤدي هذا الإجراء إلى نقل سلاسل المحادثات هذه إلى المهملات وفرض إعادة تحميل سلاسل المحادثات.
refreshMessage(message)GmailAppيعيد تحميل الرسالة والحالة المرتبطة بها من Gmail (مفيد في حالة التصنيفات وحالة القراءة وما إلى ذلك).
refreshMessages(messages)GmailAppيعيد تحميل الرسائل والحالة المرتبطة بها من Gmail (مفيد في حالة التصنيفات وحالة القراءة وما إلى ذلك).
refreshThread(thread)GmailAppإعادة تحميل سلسلة المحادثات والحالة المرتبطة بها من Gmail (مفيدة في حالة التسميات وحالة القراءة وما إلى ذلك).
refreshThreads(threads)GmailAppإعادة تحميل سلاسل المحادثات والحالة المرتبطة بها من Gmail (مفيد في حالة التصنيفات وحالة القراءة وما إلى ذلك).
search(query)GmailThread[]يمكنك البحث في Gmail باستخدام طلب البحث المحدد.
search(query, start, max)GmailThread[]يمكنك البحث في Gmail باستخدام طلب البحث المحدد.
sendEmail(recipient, subject, body)GmailAppإرسال رسالة إلكترونية
sendEmail(recipient, subject, body, options)GmailAppلإرسال رسالة إلكترونية مع وسيطات اختيارية.
setCurrentMessageAccessToken(accessToken)voidلضبط الرسالة الحالية رمز الدخول الذي يسمح للنص البرمجي بالوصول إلى خصائص GmailMessage الحالية.
starMessage(message)GmailAppتمييز الرسالة بنجمة وفرض إعادة تحميل الرسالة
starMessages(messages)GmailAppإضافة نجوم إلى هذه الرسائل وفرض إعادة تحميل الرسائل
unstarMessage(message)GmailAppإزالة نجمة من هذه الرسالة وفرض إعادة تحميل الرسالة
unstarMessages(messages)GmailAppإزالة النجوم من هذه الرسائل وفرض إعادة تحميل الرسائل

الوثائق التفصيلية

createDraft(recipient, subject, body)

إنشاء مسودة رسالة إلكترونية يكون حجم الرسالة الإلكترونية (بما في ذلك الرؤوس) محدودًا.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

المعلمات

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

الإرجاع

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

التفويض

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

  • https://mail.google.com/

انظر أيضًا


createDraft(recipient, subject, body, options)

تنشئ مسودة رسالة إلكترونية تتضمّن وسيطات اختيارية. يمكن أن تحتوي رسالة البريد الإلكتروني على نص عادي أو نص HTML الأساسي. يكون حجم الرسالة الإلكترونية (بما في ذلك الرؤوس ولكن باستثناء المرفقات) محدودًا.

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

المعلمات

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

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

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

الإرجاع

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

التفويض

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

  • https://mail.google.com/

انظر أيضًا


createLabel(name)

أنشئ تصنيف مستخدم جديدًا للاسم المحدّد.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

المعلمات

الاسمالنوعالوصف
nameStringباسم التسمية الجديدة

الإرجاع

GmailLabel — التصنيف الذي تم إنشاؤه حديثًا

التفويض

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

  • https://mail.google.com/

انظر أيضًا


deleteLabel(label)

حذف التصنيف المحدد.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

المعلمات

الاسمالنوعالوصف
labelGmailLabelالتصنيف المراد حذفه

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getAliases()

الحصول على قائمة بالرسائل الإلكترونية التي تم إعدادها كعناوين بديلة لهذا الحساب في Gmail.

يمكنك إرسال رسالة من أي من هذه الأسماء المستعارة باستخدام عامل التشغيل "من" الوسيطة الاختيارية.

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

الإرجاع

String[] — مصفوفة من الأسماء المستعارة لهذا الحساب

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getDraft(draftId)

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

يمكنك استخدام هذا الخيار مع الطريقة getId() في مسودات Gmail.

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

المعلمات

الاسمالنوعالوصف
draftIdStringمعرّف المسودة لاسترداد

الإرجاع

GmailDraft: المسودة التي تتضمّن المعرّف المحدّد

الرميات

Error: في حال عدم العثور على مسودّة بالمعرّف المحدّد

التفويض

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

  • https://mail.google.com/

getDraftMessages()

استرداد كل مسودات الرسائل.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

الإرجاع

GmailMessage[] - مجموعة من مسودات رسائل Gmail

التفويض

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

  • https://mail.google.com/

getDrafts()

الحصول على جميع مسودات الرسائل في Gmail

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

الإرجاع

GmailDraft[] - مجموعة من مسودات الرسائل في Gmail

التفويض

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

  • https://mail.google.com/

getInboxThreads()

لاسترداد جميع سلاسل البريد الوارد بغض النظر عن التصنيفات.

سيفشل هذا الاستدعاء عندما يكون حجم كل سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. عندما يكون حجم سلسلة المحادثات غير معروف، وربما كبيرًا جدًا، يُرجى استخدام الجدول والاتصال تحديد نطاقات سلاسل المحادثات المطلوب استردادها في كل استدعاء.

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

الإرجاع

GmailThread[] — مصفوفة من سلاسل محادثات Gmail في البريد الوارد

التفويض

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

  • https://mail.google.com/

getInboxThreads(start, max)

لاسترداد مجموعة من سلاسل محادثات البريد الوارد بغض النظر عن التصنيفات.

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

المعلمات

الاسمالنوعالوصف
startIntegerفهرس السلسلة الأولى لاسترداد
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

الإرجاع

GmailThread[] — مصفوفة من سلاسل محادثات Gmail في البريد الوارد

التفويض

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

  • https://mail.google.com/

getInboxUnreadCount()

الحصول على عدد سلاسل المحادثات غير المقروءة في البريد الوارد

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

الإرجاع

Integer - عدد سلاسل المحادثات في البريد الوارد التي تحتوي على رسائل غير مقروءة

التفويض

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

  • https://mail.google.com/

getMessageById(id)

يتلقّى رسالة من خلال رقم التعريف.

يمكنك استخدام هذا الخيار مع الطريقة getId() على رسائل Gmail.

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

المعلمات

الاسمالنوعالوصف
idStringمعرف الرسالة لاسترداد

الإرجاع

GmailMessage - الرسالة التي تحتوي على المعرّف المحدّد

الرميات

Error: في حال عدم العثور على رسالة بالمعرّف المحدّد

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getMessagesForThread(thread)

يمكنك استرداد جميع الرسائل في سلسلة المحادثات المحدّدة.

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

المعلمات

الاسمالنوعالوصف
threadGmailThreadسلسلة الرسائل لاسترداد

الإرجاع

GmailMessage[] — مصفوفة الرسائل المقابلة لسلسلة المحادثات هذه

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getMessagesForThreads(threads)

يمكنك استرداد جميع الرسائل في سلاسل المحادثات المحدّدة.

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]سلاسل الرسائل لاسترداد

الإرجاع

GmailMessage[][] — مصفوفة من صفائف الرسائل، حيث يتجاوب كل عنصر في الصفيف الخارجي مع تشتمل سلسلة المحادثات والصفيف الداخلي على الرسائل المضمَّنة في سلسلة المحادثات هذه.

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getPriorityInboxThreads()

لاسترداد جميع سلاسل البريد الهام، بغض النظر عن التصنيفات.

سيفشل هذا الاستدعاء عندما يكون حجم كل سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. عندما يكون حجم سلسلة المحادثات غير معروف، وربما كبيرًا جدًا، يُرجى استخدام الجدول والاتصال تحديد نطاقات سلاسل المحادثات المطلوب استردادها في كل استدعاء.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

الإرجاع

GmailThread[] — مصفوفة من سلاسل محادثات Gmail في البريد الهام

التفويض

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

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

لاسترداد مجموعة من سلاسل محادثات البريد الهام، بغض النظر عن التصنيفات.

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

المعلمات

الاسمالنوعالوصف
startIntegerفهرس السلسلة الأولى لاسترداد
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

الإرجاع

GmailThread[] — مصفوفة من سلاسل محادثات Gmail في البريد الهام

التفويض

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

  • https://mail.google.com/

getPriorityInboxUnreadCount()

الحصول على عدد سلاسل المحادثات غير المقروءة في البريد الهام.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

الإرجاع

Integer - عدد سلاسل المحادثات في البريد الهام التي تحتوي على رسائل غير مقروءة

التفويض

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

  • https://mail.google.com/

getSpamThreads()

لاسترداد جميع سلاسل المحادثات غير المرغوب فيها بغض النظر عن التصنيفات.

سيفشل هذا الاستدعاء عندما يكون حجم كل سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. عندما يكون حجم سلسلة المحادثات غير معروف، وربما كبيرًا جدًا، يُرجى استخدام الجدول والاتصال تحديد نطاقات سلاسل المحادثات المطلوب استردادها في كل استدعاء.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

الإرجاع

GmailThread[] - مصفوفة من سلاسل محادثات Gmail في مجلد الرسائل غير المرغوب فيها

التفويض

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

  • https://mail.google.com/

getSpamThreads(start, max)

لاسترداد مجموعة من سلاسل الرسائل غير المرغوب فيها بغض النظر عن التصنيفات.

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

المعلمات

الاسمالنوعالوصف
startIntegerفهرس السلسلة الأولى لاسترداد
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

الإرجاع

GmailThread[] - مصفوفة من سلاسل محادثات Gmail في مجلد الرسائل غير المرغوب فيها

التفويض

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

  • https://mail.google.com/

getSpamUnreadCount()

الحصول على عدد سلاسل المحادثات غير المقروءة والتي تكون غير مرغوب فيها

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

الإرجاع

Integer - عدد سلاسل المحادثات غير المرغوب فيها التي تحتوي على رسائل غير مقروءة

التفويض

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

  • https://mail.google.com/

getStarredThreads()

لاسترداد كل سلاسل المحادثات المميّزة بنجمة بغض النظر عن التصنيفات.

سيفشل هذا الاستدعاء عندما يكون حجم كل سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. عندما يكون حجم سلسلة المحادثات غير معروف، وربما كبيرًا جدًا، يُرجى استخدام الجدول والاتصال تحديد نطاقات سلاسل المحادثات المطلوب استردادها في كل استدعاء.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

الإرجاع

GmailThread[] - مصفوفة من سلاسل محادثات Gmail المميّزة بنجمة

التفويض

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

  • https://mail.google.com/

getStarredThreads(start, max)

لاسترداد مجموعة من سلاسل المحادثات المميّزة بنجمة بغض النظر عن التصنيفات.

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

المعلمات

الاسمالنوعالوصف
startIntegerفهرس السلسلة الأولى لاسترداد
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

الإرجاع

GmailThread[] - مصفوفة من سلاسل محادثات Gmail المميّزة بنجمة

التفويض

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

  • https://mail.google.com/

getStarredUnreadCount()

الحصول على عدد سلاسل المحادثات غير المقروءة التي تم تمييزها بنجمة

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

الإرجاع

Integer: عدد سلاسل المحادثات المميّزة بنجمة التي تحتوي على رسائل غير مقروءة

التفويض

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

  • https://mail.google.com/

getThreadById(id)

الحصول على سلسلة محادثات من خلال رقم التعريف

يمكنك استخدام هذا مع الطريقة getId() في سلاسل محادثات Gmail.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

المعلمات

الاسمالنوعالوصف
idStringرقم تعريف سلسلة المحادثات المطلوب استردادها

الإرجاع

GmailThread — سلسلة المحادثات التي تتضمّن رقم التعريف المحدّد أو null إذا لم يتم العثور عليها

التفويض

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

  • https://mail.google.com/

انظر أيضًا


getTrashThreads()

لاسترداد كل سلاسل المحادثات في المهملات بغض النظر عن التصنيفات.

سيفشل هذا الاستدعاء عندما يكون حجم كل سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. عندما يكون حجم سلسلة المحادثات غير معروف، وربما كبيرًا جدًا، يُرجى استخدام الجدول والاتصال تحديد نطاقات سلاسل المحادثات المطلوب استردادها في كل استدعاء.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

الإرجاع

GmailThread[]: مصفوفة من سلاسل محادثات Gmail في المهملات

التفويض

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

  • https://mail.google.com/

getTrashThreads(start, max)

لاسترداد نطاق من سلاسل المهملات بغض النظر عن التصنيفات.

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

المعلمات

الاسمالنوعالوصف
startIntegerفهرس السلسلة الأولى لاسترداد
maxIntegerالحد الأقصى لعدد سلاسل المحادثات التي يمكن استردادها

الإرجاع

GmailThread[]: مصفوفة من سلاسل محادثات Gmail في المهملات

التفويض

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

  • https://mail.google.com/

getUserLabelByName(name)

لاسترداد تصنيف وفقًا لاسم التصنيف.

var labelObject = GmailApp.getUserLabelByName("myLabel");

المعلمات

الاسمالنوعالوصف
nameStringاسم التسمية لاسترداد

الإرجاع

GmailLabel - تصنيف Gmail بالاسم الأول

التفويض

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

  • https://mail.google.com/

getUserLabels()

لاسترداد قائمة بالتصنيفات التي أنشأها المستخدم.

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

الإرجاع

GmailLabel[] - مصفوفة التصنيفات التي أنشأها المستخدمون

التفويض

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

  • https://mail.google.com/

markMessageRead(message)

وضع علامة على هذه الرسالة كمقروءة وفرض إعادة تحميل الرسالة

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

المعلمات

الاسمالنوعالوصف
messageGmailMessageالرسالة لوضع علامة "مقروءة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markMessageUnread(message)

وضع علامة "غير مقروءة" على هذه الرسالة وفرض إعادة تحميل الرسالة

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

المعلمات

الاسمالنوعالوصف
messageGmailMessageلوضع علامة "غير مقروءة" على الرسالة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markMessagesRead(messages)

وضع علامة على هذه الرسائل كمقروءة وفرض إعادة تحميل الرسائل

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

المعلمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل لوضع علامة "مقروءة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markMessagesUnread(messages)

وضع علامة "غير مقروءة" على هذه الرسائل وفرض إعادة تحميل الرسائل

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

المعلمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل لوضع علامة "غير مقروءة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadImportant(thread)

وضع علامة على سلسلة المحادثات هذه كمهمة وفرض إعادة تحميل سلسلة المحادثات

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات لوضع علامة عليها كمهمة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadRead(thread)

يضع علامة "مقروءة" على سلسلة المحادثات هذه وفرض إعادة تحميل سلسلة المحادثات.

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات لوضع علامة "مقروءة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadUnimportant(thread)

وضع علامة "غير مهمة" على سلسلة المحادثات هذه وفرض إعادة تحميل سلسلة المحادثات

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات لوضع علامة عليها كغير مهمة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadUnread(thread)

يؤدي وضع علامة "غير مقروءة" إلى سلسلة المحادثات هذه وفرض إعادة تحميل سلسلة المحادثات.

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسلسلة المحادثات لوضع علامة "غير مقروءة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadsImportant(threads)

يؤدي وضع علامة "مهمة" إلى سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات.

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة عليها كمهمة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadsRead(threads)

يؤدي وضع علامة "مقروءة" إلى سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات.

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة "مقروءة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadsUnimportant(threads)

وضع علامة "غير مهمة" على سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة "غير مهمة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


markThreadsUnread(threads)

وضع علامة "غير مقروءة" على سلاسل المحادثات هذه وفرض إعادة تحميل سلاسل المحادثات

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات لوضع علامة "غير مقروءة" عليها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveMessageToTrash(message)

نقل الرسالة إلى المهملات وفرض إعادة تحميل الرسالة

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

المعلمات

الاسمالنوعالوصف
messageGmailMessageستتم إضافة الرسالة إلى المهملات

الإرجاع

GmailApp — خدمة Gmail (مفيدة للتسلسل)

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveMessagesToTrash(messages)

نقل الرسائل المحددة إلى المهملات وفرض إعادة تحميل الرسائل

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

المعلمات

الاسمالنوعالوصف
messagesGmailMessage[]الرسائل المراد وضعها في المهملات

الإرجاع

GmailApp — خدمة Gmail (مفيدة للتسلسل)

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadToArchive(thread)

نقل سلسلة المحادثات هذه إلى الأرشيف وفرض إعادة تحميل سلسلة المحادثات

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسيتم أرشفة سلسلة المحادثات

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadToInbox(thread)

نقل سلسلة المحادثات هذه إلى البريد الوارد وفرض إعادة تحميل سلسلة المحادثات

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسيتم نقل سلسلة المحادثات إلى البريد الوارد

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadToSpam(thread)

نقل سلسلة المحادثات هذه إلى مجلد "المحتوى غير المرغوب فيه" وفرض إعادة تحميل سلسلة المحادثات

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadسيتم نقل سلسلة المحادثات إلى مجلد "المحتوى غير المرغوب فيه"

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadToTrash(thread)

يؤدي هذا الإجراء إلى نقل سلسلة المحادثات هذه إلى المهملات وفرض إعادة تحميل سلسلة المحادثات.

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

المعلمات

الاسمالنوعالوصف
threadGmailThreadستتم إزالة سلسلة المحادثات من المهملات

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadsToArchive(threads)

يؤدي هذا الإجراء إلى نقل سلاسل المحادثات هذه إلى الأرشيف وفرض إعادة تحميل سلاسل المحادثات.

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي ستتم أرشفتها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadsToInbox(threads)

نقل سلاسل المحادثات هذه إلى البريد الوارد وفرض إعادة تحميل سلاسل المحادثات

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي سيتم نقلها إلى البريد الوارد

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadsToSpam(threads)

نقل سلاسل المحادثات هذه إلى مجلد "الرسائل غير المرغوب فيها" وفرض إعادة تحميل سلاسل المحادثات

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي سيتم نقلها إلى مجلد الرسائل غير المرغوب فيها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


moveThreadsToTrash(threads)

يؤدي هذا الإجراء إلى نقل سلاسل المحادثات هذه إلى المهملات وفرض إعادة تحميل سلاسل المحادثات.

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]مصفوفة من سلاسل المحادثات التي سيتم نقلها إلى المهملات

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshMessage(message)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

المعلمات

الاسمالنوعالوصف
messageGmailMessageستتم إعادة تحميل الرسالة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshMessages(messages)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

المعلمات

الاسمالنوعالوصف
messagesGmailMessage[]الرسائل التي ستتم إعادة تحميلها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshThread(thread)

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

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

المعلمات

الاسمالنوعالوصف
threadGmailThreadستتم إعادة تحميل سلسلة المحادثات

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


refreshThreads(threads)

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

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

المعلمات

الاسمالنوعالوصف
threadsGmailThread[]سلاسل المحادثات التي ستتم إعادة تحميلها

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


search(query)

يمكنك البحث في Gmail باستخدام طلب البحث المحدد.

سيفشل هذا الاستدعاء عندما يكون حجم كل سلاسل المحادثات كبيرًا جدًا بحيث لا يمكن للنظام التعامل معه. عندما يكون حجم سلسلة المحادثات غير معروف، وربما كبيرًا جدًا، يُرجى استخدام الجدول والاتصال تحديد نطاقات سلاسل المحادثات المطلوب استردادها في كل استدعاء.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

المعلمات

الاسمالنوعالوصف
queryStringطلب البحث، كما تفعل في Gmail

الإرجاع

GmailThread[]: مصفوفة من سلاسل محادثات Gmail التي تتطابق مع طلب البحث هذا

التفويض

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

  • https://mail.google.com/

search(query, start, max)

يمكنك البحث في Gmail باستخدام طلب البحث المحدد.

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

المعلمات

الاسمالنوعالوصف
queryStringطلب البحث، كما تفعل في Gmail
startIntegerفهرس سلسلة التعليمات الأولى
maxIntegerالحدّ الأقصى لعدد سلاسل المحادثات المطلوب عرضها

الإرجاع

GmailThread[]: مصفوفة من سلاسل محادثات Gmail التي تتطابق مع طلب البحث هذا

التفويض

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

  • https://mail.google.com/

sendEmail(recipient, subject, body)

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

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

المعلمات

الاسمالنوعالوصف
recipientStringقائمة بعناوين البريد الإلكتروني مفصولة بفواصل
subjectStringموضوع رسالة البريد الإلكتروني (250 حرفًا بحد أقصى)
bodyStringنص الرسالة الإلكترونية

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


sendEmail(recipient, subject, body, options)

لإرسال رسالة إلكترونية مع وسيطات اختيارية. يمكن أن تحتوي الرسالة الإلكترونية على نص عادي أو HTML جسم. يكون حجم الرسالة الإلكترونية (بما في ذلك الرؤوس ولكن باستثناء المرفقات) محدودًا.

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

المعلمات

الاسمالنوعالوصف
recipientStringعناوين المستلِم
subjectStringسطر الموضوع (250 حرفًا بحدّ أقصى)
bodyStringنص الرسالة الإلكترونية
optionsObjectكائن JavaScript يحدّد المَعلمات المتقدّمة، كما هو موضّح أدناه

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

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

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


setCurrentMessageAccessToken(accessToken)

لضبط الرسالة الحالية رمز الدخول الذي يسمح للنص البرمجي بالوصول إلى خصائص GmailMessage الحالية.

مشاريع إضافة Google Workspace التي تستخدم نطاقات الرسائل الحالية في Gmail فقط تتطلب هذه الطريقة.

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

المعلمات

الاسمالنوعالوصف
accessTokenStringرمز الدخول المؤقت الذي تم الحصول عليه من كائن حدث الإجراء في إضافة Gmail.

التفويض

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

  • https://mail.google.com/

starMessage(message)

تمييز الرسالة بنجمة وفرض إعادة تحميل الرسالة

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

المعلمات

الاسمالنوعالوصف
messageGmailMessageتمييز الرسالة بنجمة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


starMessages(messages)

إضافة نجوم إلى هذه الرسائل وفرض إعادة تحميل الرسائل

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

المعلمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل لتمييزها بنجمة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


unstarMessage(message)

إزالة نجمة من هذه الرسالة وفرض إعادة تحميل الرسالة

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

المعلمات

الاسمالنوعالوصف
messageGmailMessageإلغاء تمييز الرسالة بنجمة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا


unstarMessages(messages)

إزالة النجوم من هذه الرسائل وفرض إعادة تحميل الرسائل

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

المعلمات

الاسمالنوعالوصف
messagesGmailMessage[]مصفوفة من الرسائل لإلغاء تمييزها بنجمة

الإرجاع

GmailApp — خدمة Gmail، مفيدة للسلاسل

التفويض

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

  • https://mail.google.com/

انظر أيضًا

طرق متوقّفة نهائيًا