Class GmailDraft

GmailDraft

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

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
deleteDraft()voidلحذف رسالة المسودة هذه
getId()Stringتعرض هذه الطريقة معرّف الرسالة في المسودّة.
getMessage()GmailMessageتعرض هذه الدالة GmailMessage يمثّل هذه المسودة.
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 API ذات الصلة:

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

  • https://mail.google.com/

getMessage()

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

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

الإرجاع

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

التفويض

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

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

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

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

  • 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 هذا الحقل بدلاً من وسيطة النص الأساسي المطلوبة. يمكنك إضافة حقل inlineImages اختياري في النص الأساسي لـ HTML إذا كانت لديك صور مضمّنة في رسالتك الإلكترونية.
inlineImagesObjectكائن JavaScript يحتوي على ربط من مفتاح الصورة (String) إلى بيانات الصورة (BlobSource)، وهذا يفترض أنّه يتم استخدام المَعلمة htmlBody وأنّها تحتوي على مراجع إلى هذه الصور بالتنسيق <img src="cid:imageKey" />
nameStringاسم مرسل الرسالة الإلكترونية (القيمة التلقائية: اسم المستخدم)
replyToStringعنوان بريد إلكتروني لاستخدامه كعنوان الردّ التلقائي (القيمة التلقائية: عنوان البريد الإلكتروني للمستخدم)

الإرجاع

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

التفويض

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

  • https://mail.google.com/

انظر أيضًا