Class GmailApp

جیمیل اپ

دسترسی به موضوعات، پیام‌ها و برچسب‌ها در جیمیل را فراهم می‌کند.

روش‌ها

روش نوع بازگشتی شرح مختصر
create Draft(recipient, subject, body) Gmail Draft یک پیام ایمیل پیش‌نویس ایجاد می‌کند.
create Draft(recipient, subject, body, options) Gmail Draft یک پیام ایمیل پیش‌نویس با آرگومان‌های اختیاری ایجاد می‌کند.
create Label(name) Gmail Label یک برچسب کاربری جدید با نام داده شده ایجاد کنید.
delete Label(label) Gmail App برچسب مشخص شده را حذف می‌کند.
get Aliases() String[] فهرستی از ایمیل‌هایی که به عنوان نام مستعار برای این حساب در Gmail تنظیم شده‌اند را دریافت می‌کند.
get Draft(draftId) Gmail Draft دریافت پیش‌نویس ایمیل بر اساس شناسه.
get Draft Messages() Gmail Message[] تمام پیام‌های پیش‌نویس را بازیابی می‌کند.
get Drafts() Gmail Draft[] تمام پیام‌های پیش‌نویس جیمیل را دریافت می‌کند.
get Inbox Threads() Gmail Thread[] صرف نظر از برچسب‌ها، تمام موضوعات صندوق ورودی را بازیابی می‌کند.
get Inbox Threads(start, max) Gmail Thread[] صرف نظر از برچسب‌ها، طیفی از موضوعات صندوق ورودی را بازیابی می‌کند.
get Inbox Unread Count() Integer تعداد موضوعات خوانده نشده در صندوق ورودی را دریافت می‌کند.
get Message By Id(id) Gmail Message از طریق شناسه، پیام دریافت می‌کند.
get Messages For Thread(thread) Gmail Message[] بازیابی تمام پیام‌های موجود در رشته‌ی مشخص‌شده.
get Messages For Threads(threads) Gmail Message[][] تمام پیام‌های موجود در رشته‌های مشخص‌شده را بازیابی کنید.
get Priority Inbox Threads() Gmail Thread[] صرف نظر از برچسب‌ها، تمام رشته‌های اولویت‌دار صندوق ورودی را بازیابی می‌کند.
get Priority Inbox Threads(start, max) Gmail Thread[] صرف نظر از برچسب‌ها، طیفی از رشته‌های اولویت‌دار صندوق ورودی را بازیابی می‌کند.
get Priority Inbox Unread Count() Integer تعداد موضوعات خوانده نشده در صندوق ورودی اولویت‌دار را دریافت می‌کند.
get Spam Threads() Gmail Thread[] صرف نظر از برچسب‌ها، تمام تاپیک‌های اسپم را بازیابی می‌کند.
get Spam Threads(start, max) Gmail Thread[] صرف نظر از برچسب‌ها، طیف وسیعی از موضوعات هرزنامه را بازیابی می‌کند.
get Spam Unread Count() Integer تعداد تاپیک‌های خوانده نشده‌ای که هرزنامه هستند را دریافت می‌کند.
get Starred Threads() Gmail Thread[] صرف نظر از برچسب‌ها، تمام رشته‌های ستاره‌دار را بازیابی می‌کند.
get Starred Threads(start, max) Gmail Thread[] صرف نظر از برچسب‌ها، طیفی از رشته‌های ستاره‌دار را بازیابی می‌کند.
get Starred Unread Count() Integer تعداد تاپیک‌های خوانده نشده‌ای که ستاره‌دار شده‌اند را برمی‌گرداند.
get Thread By Id(id) Gmail Thread |null یک رشته را بر اساس شناسه (ID) دریافت می‌کند.
get Trash Threads() Gmail Thread[] صرف نظر از برچسب‌ها، تمام رشته‌های زباله را بازیابی می‌کند.
get Trash Threads(start, max) Gmail Thread[] صرف نظر از برچسب‌ها، طیف وسیعی از موضوعات زباله را بازیابی می‌کند.
get User Label By Name(name) Gmail Label با توجه به نام برچسب، یک برچسب را بازیابی می‌کند.
get User Labels() Gmail Label[] لیستی از برچسب‌های ایجاد شده توسط کاربر را بازیابی می‌کند.
mark Message Read(message) Gmail App این پیام را به عنوان خوانده شده علامت گذاری می‌کند و پیام را مجبور به رفرش کردن می‌کند.
mark Message Unread(message) Gmail App این پیام را خوانده نشده علامت‌گذاری می‌کند و پیام را مجبور به به‌روزرسانی می‌کند.
mark Messages Read(messages) Gmail App این پیام‌ها را به عنوان خوانده شده علامت‌گذاری می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند.
mark Messages Unread(messages) Gmail App این پیام‌ها را خوانده نشده علامت‌گذاری می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند.
mark Thread Important(thread) Gmail App این تاپیک را به عنوان مهم علامت‌گذاری می‌کند و آن را مجبور به به‌روزرسانی می‌کند.
mark Thread Read(thread) Gmail App این رشته را به عنوان خوانده شده علامت گذاری می‌کند و رشته را مجبور به رفرش می‌کند.
mark Thread Unimportant(thread) Gmail App این تاپیک را به عنوان بی‌اهمیت علامت‌گذاری می‌کند و آن را مجبور به به‌روزرسانی می‌کند.
mark Thread Unread(thread) Gmail App این تاپیک را خوانده نشده علامت گذاری می‌کند و تاپیک را مجبور به رفرش می‌کند.
mark Threads Important(threads) Gmail App این رشته‌ها را به عنوان مهم علامت‌گذاری می‌کند و آنها را مجبور به به‌روزرسانی می‌کند.
mark Threads Read(threads) Gmail App این نخ‌ها را به عنوان خوانده شده علامت‌گذاری می‌کند و آنها را مجبور به رفرش می‌کند.
mark Threads Unimportant(threads) Gmail App این رشته‌ها را به عنوان بی‌اهمیت علامت‌گذاری می‌کند و آنها را مجبور به به‌روزرسانی می‌کند.
mark Threads Unread(threads) Gmail App این تاپیک‌ها را به عنوان خوانده نشده علامت‌گذاری می‌کند و آنها را مجبور به رفرش می‌کند.
move Message To Trash(message) Gmail App پیام را به سطل زباله منتقل می‌کند و پیام را مجبور به به‌روزرسانی می‌کند.
move Messages To Trash(messages) Gmail App پیام‌های مشخص‌شده را به سطل زباله منتقل می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند.
move Thread To Archive(thread) Gmail App این تاپیک را به بایگانی منتقل می‌کند و تاپیک را مجبور به به‌روزرسانی می‌کند.
move Thread To Inbox(thread) Gmail App این تاپیک را به صندوق ورودی منتقل می‌کند و تاپیک را مجبور به رفرش می‌کند.
move Thread To Spam(thread) Gmail App این تاپیک را به بخش هرزنامه منتقل می‌کند و تاپیک را مجبور به رفرش می‌کند.
move Thread To Trash(thread) Gmail App این تاپیک را به سطل زباله منتقل می‌کند و آن را مجبور به به‌روزرسانی می‌کند.
move Threads To Archive(threads) Gmail App این نخ‌ها را به بایگانی منتقل می‌کند و نخ‌ها را مجبور به به‌روزرسانی می‌کند.
move Threads To Inbox(threads) Gmail App این رشته‌ها را به صندوق ورودی منتقل می‌کند و رشته‌ها را مجبور به به‌روزرسانی می‌کند.
move Threads To Spam(threads) Gmail App این تاپیک‌ها را به بخش هرزنامه منتقل می‌کند و آنها را مجبور به به‌روزرسانی می‌کند.
move Threads To Trash(threads) Gmail App این نخ‌ها را به سطل زباله منتقل می‌کند و آنها را مجبور به به‌روزرسانی می‌کند.
refresh Message(message) Gmail App پیام و وضعیت مرتبط را از Gmail دوباره بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).
refresh Messages(messages) Gmail App پیام‌ها و وضعیت مرتبط را از Gmail مجدداً بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).
refresh Thread(thread) Gmail App رشته و وضعیت مرتبط را از Gmail مجدداً بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).
refresh Threads(threads) Gmail App رشته‌ها و وضعیت مرتبط را از Gmail مجدداً بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).
search(query) Gmail Thread[] با عبارت داده شده در جیمیل جستجو کنید.
search(query, start, max) Gmail Thread[] با عبارت داده شده در جیمیل جستجو کنید.
send Email(recipient, subject, body) Gmail App یک پیام ایمیل ارسال می‌کند.
send Email(recipient, subject, body, options) Gmail App یک پیام ایمیل با آرگومان‌های اختیاری ارسال می‌کند.
set Current Message Access Token(accessToken) void توکن دسترسی پیام فعلی را تنظیم می‌کند که اسکریپت را قادر می‌سازد به ویژگی‌های Gmail Message دسترسی داشته باشد.
star Message(message) Gmail App یک ستاره به این پیام اضافه می‌کند و پیام را مجبور به به‌روزرسانی می‌کند.
star Messages(messages) Gmail App به این پیام‌ها ستاره اضافه می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند.
unstar Message(message) Gmail App یک ستاره از این پیام حذف می‌کند و پیام را مجبور به به‌روزرسانی می‌کند.
unstar Messages(messages) Gmail App ستاره‌ها را از این پیام‌ها حذف می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند.

مستندات دقیق

createDraft(recipient, subject, body)

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

// The code below creates a draft email with the current date and time.
const now = new Date();
GmailApp.createDraft(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

پارامترها

نام نوع توضیحات
recipient String فهرست آدرس‌های ایمیل جدا شده با کاما
subject String موضوع ایمیل
body String بدنه ایمیل

بازگشت

GmailDraft — GmailDraft تازه ایجاد شده

مجوز

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

  • https://mail.google.com/

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

createDraft(recipient, subject, body, options)

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

// Create a draft email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft(
    '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 آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر برگردانده شده توسط get Aliases() باشد.
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 — GmailDraft تازه ایجاد شده

مجوز

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

  • https://mail.google.com/

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

createLabel(name)

یک برچسب کاربری جدید با نام داده شده ایجاد کنید.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

پارامترها

نام نوع توضیحات
name String نام برچسب جدید

بازگشت

GmailLabel - برچسب تازه ایجاد شده

مجوز

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

  • https://mail.google.com/

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

deleteLabel(label)

برچسب مشخص شده را حذف می‌کند.

// Have to get the label by name first
const label = GmailApp.getUserLabelByName('FOO');
GmailApp.deleteLabel(label);

پارامترها

نام نوع توضیحات
label Gmail Label برچسبی که باید حذف شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

getAliases()

فهرستی از ایمیل‌هایی که به عنوان نام مستعار برای این حساب در Gmail تنظیم شده‌اند را دریافت می‌کند.

شما می‌توانید با استفاده از آرگومان اختیاری "from" از هر یک از این نام‌های مستعار پیام ارسال کنید.

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

بازگشت

String[] — آرایه‌ای از نام‌های مستعار برای این حساب کاربری

مجوز

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

  • https://mail.google.com/

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

getDraft(draftId)

دریافت پیش‌نویس ایمیل بر اساس شناسه.

از این تابع به همراه تابع getId() در پیش‌نویس‌های جیمیل استفاده کنید.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

پارامترها

نام نوع توضیحات
draft Id String شناسه پیش‌نویس برای بازیابی

بازگشت

GmailDraft — پیش‌نویس با شناسه داده شده

پرتاب‌ها

Error - اگر هیچ پیش‌نویسی با شناسه داده شده یافت نشود

مجوز

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

  • https://mail.google.com/

getDraftMessages()

تمام پیام‌های پیش‌نویس را بازیابی می‌کند.

// Logs the number of draft messages
const drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

بازگشت

GmailMessage[] — آرایه‌ای از پیام‌های پیش‌نویس Gmail

مجوز

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

  • https://mail.google.com/

getDrafts()

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

const drafts = GmailApp.getDrafts();
for (let i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

بازگشت

GmailDraft[] — آرایه‌ای از پیام‌های پیش‌نویس Gmail

مجوز

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

  • https://mail.google.com/

getInboxThreads()

صرف نظر از برچسب‌ها، تمام موضوعات صندوق ورودی را بازیابی می‌کند.

این فراخوانی زمانی که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد، با شکست مواجه می‌شود. در جایی که اندازه رشته ناشناخته است و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی 'paged' استفاده کنید و محدوده رشته‌هایی را که باید در هر فراخوانی بازیابی شوند، مشخص کنید.

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail در صندوق ورودی

مجوز

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

  • https://mail.google.com/

getInboxThreads(start, max)

صرف نظر از برچسب‌ها، طیفی از موضوعات صندوق ورودی را بازیابی می‌کند. 

// Log the subject lines of up to the first 50 emails in your Inbox
const threads = GmailApp.getInboxThreads(0, 50);
for (let i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

پارامترها

نام نوع توضیحات
start Integer شاخص اولین نخی که باید بازیابی شود
max Integer حداکثر تعداد نخ‌ها برای بازیابی

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail در صندوق ورودی

مجوز

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

  • https://mail.google.com/

getInboxUnreadCount()

تعداد موضوعات خوانده نشده در صندوق ورودی را دریافت می‌کند. 

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

بازگشت

Integer - تعداد رشته‌های موجود در صندوق ورودی که پیام‌های خوانده نشده دارند

مجوز

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

  • https://mail.google.com/

getMessageById(id)

از طریق شناسه، پیام دریافت می‌کند.

از این تابع به همراه تابع getId() در پیام‌های جیمیل استفاده کنید. 

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

پارامترها

نام نوع توضیحات
id String شناسه پیام برای بازیابی

بازگشت

GmailMessage — پیامی با شناسه داده شده

پرتاب‌ها

Error - اگر هیچ پیامی با شناسه داده شده پیدا نشود

مجوز

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

  • https://mail.google.com/

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

getMessagesForThread(thread)

بازیابی تمام پیام‌های موجود در رشته‌ی مشخص‌شده. 

// Log all the subject lines in the first thread of your inbox
const thread = GmailApp.getInboxThreads(0, 1)[0];
const messages = GmailApp.getMessagesForThread(thread);
for (let i = 0; i < messages.length; i++) {
  Logger.log(`subject: ${messages[i].getSubject()}`);
}

پارامترها

نام نوع توضیحات
thread Gmail Thread رشته پیام‌هایی که باید بازیابی شوند

بازگشت

GmailMessage[] — آرایه‌ای از پیام‌های مربوط به این رشته

مجوز

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

  • https://mail.google.com/

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

getMessagesForThreads(threads)

تمام پیام‌های موجود در رشته‌های مشخص‌شده را بازیابی کنید. 

// Log the subject lines of all messages in the first two threads of your inbox
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

پارامترها

نام نوع توضیحات
threads Gmail Thread[] رشته پیام‌ها برای بازیابی

بازگشت

GmailMessage[][] — آرایه‌ای از آرایه‌های پیام‌ها، که در آن هر آیتم در آرایه بیرونی مربوط به یک رشته (thread) است و آرایه درونی شامل پیام‌های موجود در آن رشته است.

مجوز

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

  • https://mail.google.com/

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

getPriorityInboxThreads()

صرف نظر از برچسب‌ها، تمام رشته‌های اولویت‌دار صندوق ورودی را بازیابی می‌کند.

این فراخوانی زمانی که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد، با شکست مواجه می‌شود. در جایی که اندازه رشته ناشناخته است و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی 'paged' استفاده کنید و محدوده رشته‌هایی را که باید در هر فراخوانی بازیابی شوند، مشخص کنید. 

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های جیمیل در صندوق ورودی اولویت‌دار

مجوز

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

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

صرف نظر از برچسب‌ها، طیفی از رشته‌های اولویت‌دار صندوق ورودی را بازیابی می‌کند. 

// Will log some number 2 or less
Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads(0, 2).length}`,
);

پارامترها

نام نوع توضیحات
start Integer شاخص اولین نخی که باید بازیابی شود
max Integer حداکثر تعداد نخ‌ها برای بازیابی

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های جیمیل در صندوق ورودی اولویت‌دار

مجوز

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

  • https://mail.google.com/

getPriorityInboxUnreadCount()

تعداد موضوعات خوانده نشده در صندوق ورودی اولویت‌دار را دریافت می‌کند. 

Logger.log(
    `Number of unread emails in your Priority Inbox : ${
        GmailApp.getPriorityInboxUnreadCount()}`,
);

بازگشت

Integer — تعداد رشته‌های موجود در صندوق ورودی اولویت‌دار که پیام‌های خوانده نشده دارند

مجوز

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

  • https://mail.google.com/

getSpamThreads()

صرف نظر از برچسب‌ها، تمام تاپیک‌های اسپم را بازیابی می‌کند.

این فراخوانی زمانی که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد، با شکست مواجه می‌شود. در جایی که اندازه رشته ناشناخته است و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی 'paged' استفاده کنید و محدوده رشته‌هایی را که باید در هر فراخوانی بازیابی شوند، مشخص کنید. 

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail در پوشه هرزنامه

مجوز

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

  • https://mail.google.com/

getSpamThreads(start, max)

صرف نظر از برچسب‌ها، طیف وسیعی از موضوعات هرزنامه را بازیابی می‌کند. 

// Will log a number at most 5
Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads(0, 5).length}`);

پارامترها

نام نوع توضیحات
start Integer شاخص اولین نخی که باید بازیابی شود
max Integer حداکثر تعداد نخ‌ها برای بازیابی

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail در پوشه هرزنامه

مجوز

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

  • https://mail.google.com/

getSpamUnreadCount()

تعداد تاپیک‌های خوانده نشده‌ای که هرزنامه هستند را دریافت می‌کند. 

// Unless you actually read stuff in your spam folder, this should be the same
// as the number of messages in your spam folder.
Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);

بازگشت

Integer - تعداد رشته‌های هرزنامه‌ای که پیام‌های خوانده نشده دارند

مجوز

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

  • https://mail.google.com/

getStarredThreads()

صرف نظر از برچسب‌ها، تمام رشته‌های ستاره‌دار را بازیابی می‌کند.

این فراخوانی زمانی که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد، با شکست مواجه می‌شود. در جایی که اندازه رشته ناشناخته است و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی 'paged' استفاده کنید و محدوده رشته‌هایی را که باید در هر فراخوانی بازیابی شوند، مشخص کنید. 

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های ستاره‌دار Gmail

مجوز

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

  • https://mail.google.com/

getStarredThreads(start, max)

صرف نظر از برچسب‌ها، طیفی از رشته‌های ستاره‌دار را بازیابی می‌کند. 

// Logs the number of starred threads to a maximum of 5
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads(0, 5).length}`);

پارامترها

نام نوع توضیحات
start Integer شاخص اولین نخی که باید بازیابی شود
max Integer حداکثر تعداد نخ‌ها برای بازیابی

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های ستاره‌دار Gmail

مجوز

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

  • https://mail.google.com/

getStarredUnreadCount()

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

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

بازگشت

Integer — تعداد تاپیک‌های ستاره‌دار که پیام‌های خوانده نشده دارند

مجوز

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

  • https://mail.google.com/

getThreadById(id)

یک رشته را بر اساس شناسه (ID) دریافت می‌کند.

از این تابع به همراه تابع getId() در رشته‌های جیمیل استفاده کنید. 

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(
    firstThread.getFirstMessageSubject() ===
        threadById.getFirstMessageSubject(),
);

پارامترها

نام نوع توضیحات
id String شناسه‌ی رشته‌ای که قرار است بازیابی شود.

بازگشت

GmailThread |null — رشته‌ای با شناسه‌ی داده شده یا در صورت عدم یافتن، null .

مجوز

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

  • https://mail.google.com/

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

getTrashThreads()

صرف نظر از برچسب‌ها، تمام رشته‌های زباله را بازیابی می‌کند.

این فراخوانی زمانی که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد، با شکست مواجه می‌شود. در جایی که اندازه رشته ناشناخته است و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی 'paged' استفاده کنید و محدوده رشته‌هایی را که باید در هر فراخوانی بازیابی شوند، مشخص کنید. 

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail در سطل زباله

مجوز

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

  • https://mail.google.com/

getTrashThreads(start, max)

صرف نظر از برچسب‌ها، طیف وسیعی از موضوعات زباله را بازیابی می‌کند. 

// Will log a number at most 5
Logger.log(
    `# of total trash threads: ${GmailApp.getTrashThreads(0, 5).length}`,
);

پارامترها

نام نوع توضیحات
start Integer شاخص اولین نخی که باید بازیابی شود
max Integer حداکثر تعداد نخ‌ها برای بازیابی

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail در سطل زباله

مجوز

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

  • https://mail.google.com/

getUserLabelByName(name)

با توجه به نام برچسب، یک برچسب را بازیابی می‌کند. 

const labelObject = GmailApp.getUserLabelByName('myLabel');

پارامترها

نام نوع توضیحات
name String نام برچسب برای بازیابی

بازگشت

GmailLabel - برچسب Gmail با نام داده شده

مجوز

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

  • https://mail.google.com/

getUserLabels()

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

// Logs all of the names of your labels
const labels = GmailApp.getUserLabels();
for (let i = 0; i < labels.length; i++) {
  Logger.log(`label: ${labels[i].getName()}`);
}

بازگشت

GmailLabel[] — آرایه‌ای از برچسب‌های ایجاد شده توسط کاربر

مجوز

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

  • https://mail.google.com/

markMessageRead(message)

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

// Mark the first message in the first thread of your inbox as read
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

پارامترها

نام نوع توضیحات
message Gmail Message پیامی که قرار است به عنوان خوانده شده علامت گذاری شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markMessageUnread(message)

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

// Mark the first message in the first thread of your inbox as unread
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

پارامترها

نام نوع توضیحات
message Gmail Message پیامی که قرار است به عنوان خوانده نشده علامت گذاری شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markMessagesRead(messages)

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

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

پارامترها

نام نوع توضیحات
messages Gmail Message[] آرایه‌ای از پیام‌ها برای علامت‌گذاری به عنوان خوانده شده

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markMessagesUnread(messages)

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

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(messages);

پارامترها

نام نوع توضیحات
messages Gmail Message[] آرایه‌ای از پیام‌ها برای علامت‌گذاری به عنوان خوانده نشده

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadImportant(thread)

این تاپیک را به عنوان مهم علامت‌گذاری می‌کند و آن را مجبور به به‌روزرسانی می‌کند. 

// Marks first inbox thread as important
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیک برای علامت گذاری به عنوان مهم

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadRead(thread)

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

// Marks first inbox thread as read
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیک برای علامت گذاری به عنوان خوانده شده

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadUnimportant(thread)

این تاپیک را به عنوان بی‌اهمیت علامت‌گذاری می‌کند و آن را مجبور به به‌روزرسانی می‌کند. 

// Marks first inbox thread as unimportant
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیکی که قرار است بی‌اهمیت علامت‌گذاری شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadUnread(thread)

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

// Marks first inbox thread as unread
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیک برای علامت گذاری به عنوان خوانده نشده

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadsImportant(threads)

این رشته‌ها را به عنوان مهم علامت‌گذاری می‌کند و آنها را مجبور به به‌روزرسانی می‌کند. 

// Marks first two threads in inbox as important
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها برای علامت‌گذاری به عنوان رشته‌های مهم

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadsRead(threads)

این نخ‌ها را به عنوان خوانده شده علامت‌گذاری می‌کند و آنها را مجبور به رفرش می‌کند. 

// Marks first two threads in inbox as read
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها برای علامت‌گذاری به عنوان خوانده شده

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadsUnimportant(threads)

این رشته‌ها را به عنوان بی‌اهمیت علامت‌گذاری می‌کند و آنها را مجبور به به‌روزرسانی می‌کند. 

// Marks first two threads in inbox as unimportant
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها برای علامت‌گذاری به عنوان بی‌اهمیت

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

markThreadsUnread(threads)

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

// Marks first two threads in inbox as unread
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها برای علامت‌گذاری به عنوان خوانده نشده

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveMessageToTrash(message)

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

// Move the first message in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

پارامترها

نام نوع توضیحات
message Gmail Message پیامی که قرار است حذف شود

بازگشت

GmailApp — سرویس Gmail (برای زنجیره‌سازی مفید است)

مجوز

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

  • https://mail.google.com/

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

moveMessagesToTrash(messages)

پیام‌های مشخص‌شده را به سطل زباله منتقل می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند. 

// Move first two messages in your inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const messages = firstThread.getMessages();
const toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

پارامترها

نام نوع توضیحات
messages Gmail Message[] پیام‌هایی که باید حذف شوند

بازگشت

GmailApp — سرویس Gmail (برای زنجیره‌سازی مفید است)

مجوز

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

  • https://mail.google.com/

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

moveThreadToArchive(thread)

این تاپیک را به بایگانی منتقل می‌کند و تاپیک را مجبور به به‌روزرسانی می‌کند. 

// Archive the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToArchive(firstThread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیکی که قرار است بایگانی شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveThreadToInbox(thread)

این تاپیک را به صندوق ورودی منتقل می‌کند و تاپیک را مجبور به رفرش می‌کند. 

// Find a thread not already in your inbox
const thread = GmailApp.search('-in:inbox')[0];  // Get the first one
GmailApp.moveThreadToInbox(thread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیکی که قرار است به صندوق ورودی منتقل شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveThreadToSpam(thread)

این تاپیک را به بخش هرزنامه منتقل می‌کند و تاپیک را مجبور به رفرش می‌کند. 

// Tag first thread in inbox as spam
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToSpam(firstThread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیکی که قرار است به اسپم منتقل شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveThreadToTrash(thread)

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

// Move first thread in inbox to trash
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.moveThreadToTrash(firstThread);

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیکی که قرار است حذف شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveThreadsToArchive(threads)

این نخ‌ها را به بایگانی منتقل می‌کند و نخ‌ها را مجبور به به‌روزرسانی می‌کند. 

// Move first two threads in your inbox to the archive
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها که باید بایگانی شوند

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveThreadsToInbox(threads)

این رشته‌ها را به صندوق ورودی منتقل می‌کند و رشته‌ها را مجبور به به‌روزرسانی می‌کند. 

// Find two threads not already in your inbox
const firstTwoThreads = GmailApp.search('-in:inbox', 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها که قرار است به صندوق ورودی منتقل شوند

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveThreadsToSpam(threads)

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

// Move first two threads in your inbox to spam
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از رشته‌ها که قرار است به هرزنامه منتقل شوند

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

moveThreadsToTrash(threads)

این نخ‌ها را به سطل زباله منتقل می‌کند و آنها را مجبور به به‌روزرسانی می‌کند. 

// Move first two threads in your inbox to trash
const firstTwoThreads = GmailApp.getInboxThreads(0, 2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

پارامترها

نام نوع توضیحات
threads Gmail Thread[] آرایه‌ای از نخ‌ها که باید حذف شوند

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

refreshMessage(message)

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

پارامترها

نام نوع توضیحات
message Gmail Message پیامی که باید به‌روزرسانی شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

refreshMessages(messages)

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

پارامترها

نام نوع توضیحات
messages Gmail Message[] پیام‌هایی که باید به‌روزرسانی شوند

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

refreshThread(thread)

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

پارامترها

نام نوع توضیحات
thread Gmail Thread تاپیکی که قرار است به‌روزرسانی شود

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

refreshThreads(threads)

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

const threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

پارامترها

نام نوع توضیحات
threads Gmail Thread[] تاپیک‌هایی که قرار است به‌روزرسانی شوند

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

search(query)

با عبارت داده شده در جیمیل جستجو کنید.

این فراخوانی زمانی که اندازه همه رشته‌ها برای سیستم بسیار بزرگ باشد، با شکست مواجه می‌شود. در جایی که اندازه رشته ناشناخته است و احتمالاً بسیار بزرگ است، لطفاً از فراخوانی 'paged' استفاده کنید و محدوده رشته‌هایی را که باید در هر فراخوانی بازیابی شوند، مشخص کنید. 

// Find starred messages with subject IMPORTANT
const threads = GmailApp.search('is:starred subject:"IMPORTANT"');

پارامترها

نام نوع توضیحات
query String عبارت جستجو، همانطور که آن را در Gmail تایپ می‌کنید

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail که با این پرس‌وجو مطابقت دارند

مجوز

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

  • https://mail.google.com/

search(query, start, max)

با عبارت داده شده در جیمیل جستجو کنید. 

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty
// array.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

پارامترها

نام نوع توضیحات
query String عبارت جستجو، همانطور که آن را در Gmail تایپ می‌کنید
start Integer فهرست رشته‌ی آغازین
max Integer حداکثر تعداد نخ‌ها برای بازگشت

بازگشت

GmailThread[] — آرایه‌ای از رشته‌های Gmail که با این پرس‌وجو مطابقت دارند

مجوز

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

  • https://mail.google.com/

sendEmail(recipient, subject, body)

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

// The code below will send an email with the current date and time.
const now = new Date();
GmailApp.sendEmail(
    'mike@example.com',
    'current time',
    `The time is: ${now.toString()}`,
);

پارامترها

نام نوع توضیحات
recipient String فهرست آدرس‌های ایمیل جدا شده با کاما
subject String موضوع ایمیل (حداکثر ۲۵۰ کاراکتر)
body String بدنه ایمیل

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

sendEmail(recipient, subject, body, options)

یک پیام ایمیل با آرگومان‌های اختیاری ارسال می‌کند. ایمیل می‌تواند حاوی متن ساده یا بدنه HTML باشد. اندازه ایمیل (شامل هدرها، اما بدون پیوست‌ها) دارای محدودیت سهمیه است. 

// Send an email with a file from Google Drive attached as a PDF.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail(
    'mike@example.com',
    'Attachment example',
    'Please see the 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 آدرسی که ایمیل باید از آن ارسال شود، که باید یکی از مقادیر برگردانده شده توسط get Aliases() باشد.
html Body String اگر تنظیم شود، دستگاه‌هایی که قادر به رندر HTML هستند، به جای آرگومان مورد نیاز body از آن استفاده می‌کنند؛ اگر برای ایمیل خود تصاویر درون‌خطی دارید، می‌توانید یک فیلد 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 یک آدرس ایمیل برای استفاده به عنوان آدرس پیش‌فرض پاسخ (پیش‌فرض: آدرس ایمیل کاربر)

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

setCurrentMessageAccessToken(accessToken)

توکن دسترسی پیام فعلی را تنظیم می‌کند که اسکریپت را قادر می‌سازد به ویژگی‌های فعلی GmailMessage دسترسی داشته باشد.

فقط پروژه‌های افزونه‌ی Google Workspace که از محدوده‌های پیام فعلی Gmail استفاده می‌کنند، به این روش نیاز دارند. 

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.messageId);
  // Do something with mailMessage
}

پارامترها

نام نوع توضیحات
access Token String توکن دسترسی موقت که از یک شیء رویداد اکشن افزونه جیمیل به دست آمده است.

مجوز

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

  • https://mail.google.com/

starMessage(message)

یک ستاره به این پیام اضافه می‌کند و پیام را مجبور به به‌روزرسانی می‌کند. 

// Stars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

پارامترها

نام نوع توضیحات
message Gmail Message پیام برای ستاره دار کردن

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

starMessages(messages)

به این پیام‌ها ستاره اضافه می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند. 

// Stars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

پارامترها

نام نوع توضیحات
messages Gmail Message[] آرایه‌ای از پیام‌ها برای ستاره‌گذاری

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

unstarMessage(message)

یک ستاره از این پیام حذف می‌کند و پیام را مجبور به به‌روزرسانی می‌کند. 

// Unstars the first message in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

پارامترها

نام نوع توضیحات
message Gmail Message پیام برای برداشتن ستاره

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

unstarMessages(messages)

ستاره‌ها را از این پیام‌ها حذف می‌کند و پیام‌ها را مجبور به به‌روزرسانی می‌کند. 

// Unstars the first three messages in the first thread in your inbox
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

پارامترها

نام نوع توضیحات
messages Gmail Message[] مجموعه‌ای از پیام‌ها برای برداشتن ستاره

بازگشت

GmailApp — سرویس Gmail، مفید برای زنجیره‌سازی

مجوز

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

  • https://mail.google.com/

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

متدهای منسوخ شده