Class GmailMessage

پیام جیمیل

پیامی در حساب کاربری جیمیل یک کاربر.

روش ها

روش نوع برگشت شرح مختصر
create Draft Reply(body) Gmail Draft یک پیش نویس پیام ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد.
create Draft Reply(body, options) Gmail Draft یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
create Draft Reply All(body) Gmail Draft یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده و همه گیرندگان این پیام به فرستنده پاسخ می دهد.
create Draft Reply All(body, options) Gmail Draft یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام و همه گیرندگان، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
forward(recipient) Gmail Message این پیام را برای گیرندگان جدید بازارسال می کند.
forward(recipient, options) Gmail Message این پیام را با آرگومان های اختیاری به گیرندگان جدید فوروارد می کند.
get Attachments() Gmail Attachment[] تمام پیوست های این پیام را دریافت می کند.
get Attachments(options) Gmail Attachment[] تمام پیوست های این پیام را دریافت می کند.
get Bcc() String گیرندگانی که با کاما از هم جدا شده اند را روی این پیام bcc'd می کند.
get Body() String محتوای HTML متن این پیام را دریافت می کند.
get Cc() String گیرندگان جدا شده با کاما را در این پیام cc'd می کند.
get Date() Date تاریخ و زمان این پیام را دریافت می کند.
get From() String فرستنده این پیام را دریافت می کند.
get Header(name) String با توجه به نام هدر، مقدار یک هدر RFC 2822 را دریافت می کند.
get Id() String شناسه این پیام را دریافت می کند.
get Plain Body() String محتوای متن این پیام را بدون قالب بندی HTML دریافت می کند.
get Raw Content() String محتوای خام این پیام را دریافت می کند.
get Reply To() String آدرس پاسخ به این پیام (معمولاً فرستنده) را دریافت می کند.
get Subject() String موضوع این پیام را دریافت می کند.
get Thread() Gmail Thread رشته ای را دریافت می کند که حاوی این پیام است.
get To() String گیرندگان این پیام را که با کاما از هم جدا شده اند دریافت می کند.
is Draft() Boolean متوجه می شود که آیا این پیام پیش نویس است یا خیر.
is In Chats() Boolean متوجه می شود که آیا این پیام یک چت است یا خیر.
is In Inbox() Boolean متوجه می شود که آیا این پیام در صندوق ورودی است یا خیر.
is In Priority Inbox() Boolean اگر این پیام در صندوق ورودی اولویت قرار داشته باشد، true برمی گردد. در غیر این صورت false برمی گرداند.
is In Trash() Boolean متوجه می شود که آیا این پیام در سطل زباله است.
is Starred() Boolean متوجه می شود که آیا این پیام ستاره دار است یا خیر.
is Unread() Boolean متوجه می شود که آیا این پیام خوانده نشده است یا خیر.
mark Read() Gmail Message پیام را به عنوان خوانده شده علامت گذاری می کند.
mark Unread() Gmail Message پیام را به عنوان خوانده نشده علامت گذاری می کند.
move To Trash() Gmail Message پیام را به سطل زباله منتقل می کند.
refresh() Gmail Message این پیام و وضعیت مرتبط را از Gmail مجدداً بارگیری می‌کند (در مواردی که برچسب‌ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
reply(body) Gmail Message با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد.
reply(body, options) Gmail Message با استفاده از آدرس پاسخ به، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
reply All(body) Gmail Message به فرستنده با استفاده از آدرس پاسخ به و همه گیرندگان این پیام پاسخ می دهد.
reply All(body, options) Gmail Message به فرستنده این پیام با استفاده از آدرس پاسخ به و همه گیرندگان، با آرگومان های اختیاری پاسخ می دهد.
star() Gmail Message پیام را ستاره می دهد.
unstar() Gmail Message پیام را از ستاره خارج می کند.

مستندات دقیق

create Draft Reply(body)

یک پیش نویس پیام ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Create a draft reply to the original message with an acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('Got your message');

پارامترها

نام تایپ کنید توضیحات
body String بدنه ایمیل.

بازگشت

Gmail Draft - پیام پیش نویس تازه ایجاد شده.

مجوز

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

  • https://mail.google.com/

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


create Draft Reply(body, options)

یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.

ایمیل می تواند شامل متن ساده و متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Create a draft response with an HTML text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

پارامترها

نام تایپ کنید توضیحات
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 یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

بازگشت

Gmail Draft - پیام پیش نویس تازه ایجاد شده.

مجوز

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

  • https://mail.google.com/

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


create Draft Reply All(body)

یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده و همه گیرندگان این پیام به فرستنده پاسخ می دهد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Create a draft response to all recipients (except those bcc'd) with an
// acknowledgment.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('Got your message');

پارامترها

نام تایپ کنید توضیحات
body String بدنه ایمیل.

بازگشت

Gmail Draft - پیام پیش نویس تازه ایجاد شده.

مجوز

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

  • https://mail.google.com/

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


create Draft Reply All(body, options)

یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام و همه گیرندگان، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.

ایمیل می تواند شامل متن ساده و متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Create a draft response to all recipients (except those bcc'd) using an HTML
// text body.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.createDraftReplyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  cc: 'another@example.com',
});

پارامترها

نام تایپ کنید توضیحات
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 یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

بازگشت

Gmail Draft - پیام پیش نویس تازه ایجاد شده.

مجوز

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

  • https://mail.google.com/

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


forward(recipient)

این پیام را برای گیرندگان جدید بازارسال می کند. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Forward first message of first inbox thread to recipient1 & recipient2,
// both @example.com
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com');

پارامترها

نام تایپ کنید توضیحات
recipient String فهرستی از آدرس‌های ایمیل جدا شده با کاما.

بازگشت

Gmail Message - این پیام برای زنجیره کردن مفید است.

مجوز

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

  • https://mail.google.com/

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


forward(recipient, options)

این پیام را با آرگومان های اختیاری به گیرندگان جدید فوروارد می کند.

ایمیل می تواند شامل متن ساده و همچنین یک متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.forward('recipient1@example.com,recipient2@example.com', {
  cc: 'myboss@example.com',
  bcc: 'mybosses-boss@example.com,vp@example.com',
});

پارامترها

نام تایپ کنید توضیحات
recipient 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 نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
no Reply Boolean true اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان را از پاسخ دادن به ایمیل ها منصرف کند. این گزینه فقط برای حساب های Google Workspace امکان پذیر است، نه کاربران Gmail
reply To String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

بازگشت

Gmail Message - این پیام برای زنجیره کردن مفید است.

مجوز

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

  • https://mail.google.com/

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


get Attachments()

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

بازگشت

Gmail Attachment[] - آرایه ای از پیوست های Blob برای این پیام.

مجوز

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

  • https://mail.google.com/

get Attachments(options)

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

پارامترها

نام تایپ کنید توضیحات
options Object یک شی جاوا اسکریپت که پارامترهای پیشرفته را به شرح زیر مشخص می کند.

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

نام تایپ کنید توضیحات
include Inline Images Boolean true اگر آرایه بازگشتی از پیوست های Blob باید شامل تصاویر درون خطی باشد (پیش فرض true است).
include Attachments Boolean true اگر آرایه برگشتی از پیوست های Blob باید شامل پیوست های معمولی (غیر خطی) باشد (پیش فرض true است).

بازگشت

Gmail Attachment[] - آرایه ای از پیوست های Blob برای این پیام.

مجوز

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

  • https://mail.google.com/

get Bcc()

گیرندگانی که با کاما از هم جدا شده اند را روی این پیام bcc'd می کند.

این برای همه پیام های دریافتی، طبق تعریف خالی است.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBcc());                      // Log bcc'd addresses

بازگشت

String - گیرندگانی که با کاما از هم جدا شده اند روی این پیام bcc'd شده اند.

مجوز

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

  • https://mail.google.com/

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


get Body()

محتوای HTML متن این پیام را دریافت می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getBody());                     // Log contents of the body

بازگشت

String - محتوای بدنه این پیام.

مجوز

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

  • https://mail.google.com/

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


get Cc()

گیرندگان جدا شده با کاما را در این پیام cc'd می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getCc());                       // Log cc'd addresses

بازگشت

String - گیرندگانی که با کاما از هم جدا شده اند روی این پیام قید شده اند.

مجوز

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

  • https://mail.google.com/

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


get Date()

تاریخ و زمان این پیام را دریافت می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getDate());  // Log date and time of the message

بازگشت

Date - تاریخ و زمان این پیام.

مجوز

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

  • https://mail.google.com/

get From()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getFrom());  // Log from address of the message

بازگشت

String - آدرس ایمیل فرستنده پیام.

مجوز

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

  • https://mail.google.com/

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


get Header(name)

با توجه به نام هدر، مقدار یک هدر RFC 2822 را دریافت می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox.
const message = thread.getMessages()[0];           // Get the first message.
Logger.log(
    message.getHeader('Message-ID'));  // Logs the Message-ID RFC 2822 header.

پارامترها

نام تایپ کنید توضیحات
name String نام هدر RFC، بدون دو نقطه آن را از مقدار جدا کند.

بازگشت

String - مقدار هدر یا یک رشته خالی در صورتی که سرصفحه در پیام وجود نداشته باشد.

مجوز

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

  • https://mail.google.com/

get Id()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const messageById = GmailApp.getMessageById(id);
Logger.log(
    message.getSubject() === messageById.getMessage());  // Always logs true

بازگشت

String - شناسه پیام.


get Plain Body()

محتوای متن این پیام را بدون قالب بندی HTML دریافت می کند. این پیچیده تر از get Body() است و زمان بیشتری می برد.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getPlainBody());                // Log contents of the body

بازگشت

String - محتوای بدنه ساده این پیام.

مجوز

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

  • https://mail.google.com/

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


get Raw Content()

محتوای خام این پیام را دریافت می کند. این معادل «نمایش اصلی» در رابط کاربری Gmail است.

بازگشت

String - محتوای خام این پیام.

مجوز

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

  • https://mail.google.com/

get Reply To()

آدرس پاسخ به این پیام (معمولاً فرستنده) را دریافت می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getReplyTo());                  // Logs reply-to address

بازگشت

String - آدرس ایمیل برای پاسخ.

مجوز

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

  • https://mail.google.com/

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


get Subject()

موضوع این پیام را دریافت می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getSubject());                  // Log subject line

بازگشت

String - موضوع این پیام.

مجوز

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

  • https://mail.google.com/

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


get Thread()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(
    message.getThread().getFirstMessageSubject() ===
        thread.getFirstMessageSubject(),
);  // Always logs true

بازگشت

Gmail Thread - GmailThread که حاوی این پیام است.

مجوز

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

  • https://mail.google.com/

get To()

گیرندگان این پیام را که با کاما از هم جدا شده اند دریافت می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(message.getTo());  // Log the recipient of message

بازگشت

String - گیرندگان این پیام که با کاما از هم جدا شده اند.

مجوز

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

  • https://mail.google.com/

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


is Draft()

متوجه می شود که آیا این پیام پیش نویس است یا خیر.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

بازگشت

Boolean - آیا این پیام پیش‌نویس است.

مجوز

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

  • https://mail.google.com/

is In Chats()

متوجه می شود که آیا این پیام یک چت است یا خیر.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

بازگشت

Boolean - آیا این پیام یک چت است.


is In Inbox()

متوجه می شود که آیا این پیام در صندوق ورودی است یا خیر.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in inbox? ${message.isInInbox()}`);

بازگشت

Boolean - آیا این پیام در صندوق ورودی است.

مجوز

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

  • https://mail.google.com/

is In Priority Inbox()

اگر این پیام در صندوق ورودی اولویت قرار داشته باشد، true برمی گردد. در غیر این صورت false برمی گرداند.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log(`is in priority inbox? ${messages[i].isInPriorityInbox()}`);
}

بازگشت

Boolean - آیا این پیام در صندوق ورودی اولویت قرار دارد یا خیر.

مجوز

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

  • https://mail.google.com/

is In Trash()

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is in the trash? ${message.isInTrash()}`);

بازگشت

Boolean - آیا این پیام در سطل زباله است.


is Starred()

متوجه می شود که آیا این پیام ستاره دار است یا خیر.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

بازگشت

Boolean - آیا این پیام ستاره‌دار است یا خیر.


is Unread()

متوجه می شود که آیا این پیام خوانده نشده است یا خیر.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is unread? ${message.isUnread()}`);

بازگشت

Boolean - وضعیت خوانده نشده این پیام.

مجوز

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

  • https://mail.google.com/

mark Read()

پیام را به عنوان خوانده شده علامت گذاری می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markRead();                                // Mark as read

بازگشت

Gmail Message - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

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

  • https://mail.google.com/

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


mark Unread()

پیام را به عنوان خوانده نشده علامت گذاری می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.markUnread();                              // Mark as unread

بازگشت

Gmail Message - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

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

  • https://mail.google.com/

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


move To Trash()

پیام را به سطل زباله منتقل می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.moveToTrash();                             // Move message to trash

بازگشت

Gmail Message - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

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

  • https://mail.google.com/

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


refresh()

این پیام و وضعیت مرتبط را از Gmail مجدداً بارگیری می‌کند (در مواردی که برچسب‌ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
// .. Do bunch of stuff here
message.refresh();  // Make sure it's up to date
// Do more stuff to message

بازگشت

Gmail Message - این پیام برای زنجیر کردن.

مجوز

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

  • https://mail.google.com/

reply(body)

با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Respond to author of message with acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('Got your message');

پارامترها

نام تایپ کنید توضیحات
body String بدنه ایمیل.

بازگشت

Gmail Message - این پیام برای زنجیره کردن مفید است.

مجوز

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

  • https://mail.google.com/

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


reply(body, options)

با استفاده از آدرس پاسخ به، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.

ایمیل می تواند شامل متن ساده و همچنین یک متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.reply('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

پارامترها

نام تایپ کنید توضیحات
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 نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
no Reply Boolean true اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان را از پاسخ دادن به ایمیل ها منصرف کند. این گزینه فقط برای حساب های Google Workspace امکان پذیر است، نه کاربران Gmail
reply To String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

بازگشت

Gmail Message - این پیام برای زنجیره کردن مفید است.

مجوز

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

  • https://mail.google.com/

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


reply All(body)

به فرستنده با استفاده از آدرس پاسخ به و همه گیرندگان این پیام پاسخ می دهد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Respond to all recipients (except bcc'd) of last email in thread with
// acknowledgment
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('Got your message');

پارامترها

نام تایپ کنید توضیحات
body String بدنه ایمیل.

بازگشت

Gmail Message - این پیام برای زنجیره زدن مفید است.

مجوز

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

  • https://mail.google.com/

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


reply All(body, options)

به فرستنده این پیام با استفاده از آدرس پاسخ به و همه گیرندگان، با آرگومان های اختیاری پاسخ می دهد.

ایمیل می تواند شامل متن ساده و همچنین یک متن HTML باشد. اندازه ایمیل (شامل سرصفحه ها) محدود است.

// Respond with HTML body text
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
message.replyAll('incapable of HTML', {
  htmlBody: '<b>some HTML body text</b>',
  noReply: true,
});

پارامترها

نام تایپ کنید توضیحات
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 نام فرستنده ایمیل (پیش‌فرض: نام کاربر)
no Reply Boolean true اگر ایمیل باید از یک آدرس ایمیل عمومی بدون پاسخ ارسال شود تا گیرندگان را از پاسخ دادن به ایمیل ها منصرف کند. این گزینه فقط برای حساب های Google Workspace امکان پذیر است، نه کاربران Gmail
reply To String یک آدرس ایمیل برای استفاده به عنوان آدرس پیش فرض پاسخ به (پیش فرض: آدرس ایمیل کاربر)
subject String یک خط موضوع جدید برای ایمیل، حداکثر تا 250 کاراکتر.

بازگشت

Gmail Message - این پیام برای زنجیره کردن مفید است.

مجوز

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

  • https://mail.google.com/

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


star()

پیام را ستاره می دهد.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.star();                                    // Star the message

بازگشت

Gmail Message - این GmailMessage، برای زنجیره زدن مفید است.

مجوز

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

  • https://mail.google.com/

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


unstar()

پیام را از ستاره خارج می کند.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
message.unstar();                                  // Unstar the message

بازگشت

Gmail Message - این پیام جیمیل، برای زنجیره زدن مفید است.

مجوز

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

  • https://mail.google.com/

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