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

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

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

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

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 API مربوطه دارند:

  • https://mail.google.com/

getMessage()

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

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

برگشت

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

مجوز

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

  • 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 API مربوطه دارند:

  • 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 API مربوطه دارند:

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

مولفه های

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

برگشت

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.
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'
});

مولفه های

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

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

نام تایپ کنید شرح
attachments BlobSource[] مجموعه ای از فایل ها برای ارسال با ایمیل
bcc String فهرستی از آدرس‌های ایمیل به BCC که با کاما از هم جدا شده‌اند
cc String فهرستی از آدرس‌های ایمیل به CC جدا شده با کاما
from String آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر بازگردانده شده توسط GmailApp.getAliases() باشد.
htmlBody String در صورت تنظیم، دستگاه هایی که قادر به ارائه HTML هستند، از آن به جای آرگومان بدن مورد نیاز استفاده می کنند. اگر برای ایمیل خود تصاویر درون خطی دارید، می توانید یک فیلد inlineImages اختیاری در متن HTML اضافه کنید
inlineImages Object یک شی جاوا اسکریپت حاوی نگاشت از کلید تصویر ( String ) به داده های تصویر ( BlobSource ). فرض بر این است که پارامتر htmlBody استفاده شده است و حاوی ارجاعاتی به این تصاویر در قالب <img src="cid:imageKey" /> است.
name String نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
replyTo String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)

برگشت

GmailDraft - پیش نویس جدید به روز شده

مجوز

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

  • https://mail.google.com/

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