Class GmailDraft

پیش نویس جیمیل

یک پیام پیش نویس ایجاد شده توسط کاربر در حساب Gmail کاربر.

روش ها

روش نوع برگشت شرح مختصر
delete Draft() void این پیام پیش نویس را حذف می کند.
get Id() String شناسه این پیام پیش نویس را دریافت می کند.
get Message() Gmail Message GmailMessage نشان دهنده این پیش نویس را برمی گرداند.
get Message Id() String شناسه Gmail Message را که این پیش‌نویس را نشان می‌دهد، برمی‌گرداند.
send() Gmail Message این پیش‌نویس ایمیل را ارسال می‌کند.
update(recipient, subject, body) Gmail Draft جایگزین محتویات این پیام پیش نویس می شود.
update(recipient, subject, body, options) Gmail Draft با استفاده از آرگومان های اختیاری، محتوای این پیام پیش نویس را جایگزین می کند.

مستندات دقیق

delete Draft()

این پیام پیش نویس را حذف می کند. 

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/

get Id()

شناسه این پیام پیش نویس را دریافت می کند. 

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/

get Message()

GmailMessage نشان دهنده این پیش نویس را برمی گرداند. 

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

بازگشت

Gmail Message - پیامی که محتوای این پیش‌نویس را نشان می‌دهد

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

  • https://mail.google.com/

get Message Id()

شناسه Gmail Message را که این پیش‌نویس را نشان می‌دهد، برمی‌گرداند. 

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

بازگشت

Gmail Message - پیامی که به تازگی ارسال شده است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از 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()}`,
);

پارامترها

نام تایپ کنید توضیحات
recipient String لیست آدرس های ایمیل جدا شده با کاما
subject String موضوع ایمیل (حداکثر 250 کاراکتر)
body String بدنه ایمیل

بازگشت

Gmail Draft - پیش نویس تازه به روز شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از 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',
    },
);

پارامترها

نام تایپ کنید توضیحات
recipient String لیست آدرس های ایمیل جدا شده با کاما
subject String موضوع ایمیل (حداکثر 250 کاراکتر)
body String بدنه ایمیل
options Object یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند

پارامترهای پیشرفته

نام تایپ کنید توضیحات
attachments Blob Source[] مجموعه ای از فایل ها برای ارسال با ایمیل
bcc String فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
cc String فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
from String آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط Gmail App.getAliases() باشد.
html Body String در صورت تنظیم، دستگاه هایی که قادر به ارائه HTML هستند، از آن به جای آرگومان بدن مورد نیاز استفاده می کنند. اگر تصاویر درون خطی برای ایمیل خود دارید، می توانید یک فیلد inline Images اختیاری در متن HTML اضافه کنید
inline Images Object یک شی جاوا اسکریپت حاوی نگاشت از کلید تصویر ( String ) به داده های تصویر ( Blob Source ) . فرض بر این است که پارامتر html Body استفاده شده است و حاوی ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" /> است.
name String نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
reply To String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)

بازگشت

Gmail Draft - پیش نویس تازه به روز شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

  • https://mail.google.com/

همچنین ببینید