Class GmailDraft

جیمیل درفت

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

روش‌ها

روش نوع بازگشتی شرح مختصر
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 محتویات این پیام پیش‌نویس را با استفاده از آرگومان‌های اختیاری جایگزین می‌کند.

مستندات دقیق

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()}`,
);

پارامترها

نام نوع توضیحات
recipient String فهرست آدرس‌های ایمیل جدا شده با کاما
subject String موضوع ایمیل (حداکثر ۲۵۰ کاراکتر)
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.
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 موضوع ایمیل (حداکثر ۲۵۰ کاراکتر)
body String بدنه ایمیل
options Object یک شیء جاوا اسکریپت که پارامترهای پیشرفته را مشخص می‌کند، همانطور که در زیر فهرست شده است

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

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

بازگشت

GmailDraft - پیش‌نویس تازه به‌روزرسانی‌شده

مجوز

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

  • https://mail.google.com/

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