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

يؤدي إلى حذف مسودة الرسالة هذه.

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

التفويض

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

  • https://mail.google.com/

getId()

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

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

الإرجاع

String - معرّف المسودة

التفويض

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

  • https://mail.google.com/

getMessage()

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

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

الإرجاع

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

التفويض

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

  • https://mail.google.com/

getMessageId()

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

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

الإرجاع

String - معرّف الرسالة

التفويض

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

  • https://mail.google.com/

send()

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

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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 هذا الحقل بدلاً من الوسيطة المطلوبة body. يمكنك إضافة حقل inlineImages اختياري في HTML body إذا كانت لديك صور مضمّنة لبريدك الإلكتروني.
inlineImagesObjectعنصر JavaScript يحتوي على تعيين من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، ويفترض ذلك استخدام المَعلمة htmlBody وأن يحتوي على إشارات إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
nameStringاسم مُرسِل الرسالة الإلكترونية (الإعداد التلقائي: اسم المستخدم)
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (الإعداد التلقائي: عنوان البريد الإلكتروني للمستخدم)

الإرجاع

GmailDraft: المسودة المعدَّلة حديثًا

التفويض

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

  • https://mail.google.com/

انظر أيضًا