Class GmailDraft

مسودة Gmail

رسالة مسودة أنشأها المستخدم في حساب Gmail للمستخدم.

الطُرق

الطريقةنوع الإرجاعوصف قصير
deleteDraft()voidسيتم حذف مسودة الرسالة هذه.
getId()Stringيحصل على رقم تعريف رسالة المسودة هذه.
getMessage()GmailMessageتعرض رسالة Gmail تمثل هذه المسودة.
getMessageId()Stringتعرض رقم تعريف GmailMessage الذي يمثّل هذه المسودة.
send()GmailMessageوتُرسل هذه الرسالة الإلكترونية الاختبارية.
update(recipient, subject, body)GmailDraftيستبدل محتوى هذه الرسالة الاختبارية.
update(recipient, subject, body, options)GmailDraftيستبدل محتوى مسودة الرسالة باستخدام وسيطات اختيارية.

المستندات التفصيلية

deleteDraft()

سيتم حذف مسودة الرسالة هذه.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
draft.deleteDraft();
draft.getMessage(); // Throws exception.

التفويض

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

  • https://mail.google.com/

getId()

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

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var draftId = draft.getId();
var draftById = GmailApp.getDraft(draftId);
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

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

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

التفويض

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

  • https://mail.google.com/

getMessage()

تعرض رسالة Gmail تمثل هذه المسودة.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var message = draft.getMessage();
Logger.log(message.getSubject());

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

GmailMessage — الرسالة التي تمثل محتوى هذه المسودة

التفويض

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

  • https://mail.google.com/

getMessageId()

تعرض رقم تعريف GmailMessage الذي يمثّل هذه المسودة.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var messageId = draft.getMessageId();
Logger.log(messageId == draft.getMessage().getId());

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

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

التفويض

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

  • https://mail.google.com/

send()

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

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var msg = draft.send(); // Send it
Logger.log(msg.getDate()); // Should be approximately the current timestamp

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

GmailMessage — الرسالة المرسلة مؤخرًا

التفويض

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

  • https://mail.google.com/

update(recipient, subject, body)

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

// The code below will update a draft email with the current date and time.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var now = new Date();
draft.update("mike@example.com", "current time", "The time is: " + now.toString());

المعلّمات

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

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

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

التفويض

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

  • https://mail.google.com/

راجع أيضًا


update(recipient, subject, body, options)

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

// Update a draft email with a file from Google Drive attached as a PDF.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
draft.update('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

المعلّمات

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

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

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

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

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

التفويض

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

  • https://mail.google.com/

راجع أيضًا