Gmail Service

جیمیل

این سرویس به شما امکان ارسال ایمیل، نوشتن پیش‌نویس، مدیریت برچسب‌ها، علامت‌گذاری پیام‌ها و موضوعات و انجام انواع دیگر کارهای مدیریت حساب Gmail را می‌دهد. همچنین به سرویس ایمیل ، سرویس ساده‌تری که فقط امکان ارسال ایمیل را فراهم می‌کند، مراجعه کنید.

کلاس‌ها

نام شرح مختصر
Gmail App دسترسی به موضوعات، پیام‌ها و برچسب‌ها در جیمیل را فراهم می‌کند.
Gmail Attachment یک پیوست از جیمیل.
Gmail Draft یک پیام پیش‌نویس ایجاد شده توسط کاربر در حساب جیمیل کاربر.
Gmail Label برچسبی که توسط کاربر در حساب جیمیل او ایجاد شده است.
Gmail Message پیامی در حساب جیمیل کاربر.
Gmail Thread یک تاپیک در حساب جیمیل یک کاربر.

Gmail App

روش‌ها

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

Gmail Attachment

روش‌ها

روش نوع بازگشتی شرح مختصر
copy Blob() Blob یک کپی از این blob را برمی‌گرداند.
get As(contentType) Blob داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده، برمی‌گرداند.
get Bytes() Byte[] داده‌های ذخیره شده در این blob را دریافت می‌کند.
get Content Type() String|null نوع محتوای بایت‌های موجود در این blob را دریافت می‌کند.
get Data As String() String داده‌های این blob را به صورت یک رشته با کدگذاری UTF-8 دریافت می‌کند.
get Data As String(charset) String داده‌های این blob را به صورت یک رشته با کدگذاری مشخص شده دریافت می‌کند.
get Hash() String هش محتوای SHA1 را برای این پیوست دریافت می‌کند.
get Name() String|null نام این لکه را دریافت می‌کند.
get Size() Integer اندازه این فایل پیوست را دریافت می‌کند.
is Google Type() Boolean برمی‌گرداند که آیا این blob یک فایل Google Workspace (Sheets، Docs و غیره) است یا خیر.
set Bytes(data) Blob داده‌های ذخیره شده در این blob را تنظیم می‌کند.
set Content Type(contentType) Blob نوع محتوای بایت‌های موجود در این blob را تنظیم می‌کند.
set Content Type From Extension() Blob نوع محتوای بایت‌های موجود در این blob را بر اساس پسوند فایل تنظیم می‌کند.
set Data From String(string) Blob داده‌های این blob را از یک رشته با کدگذاری UTF-8 تنظیم می‌کند.
set Data From String(string, charset) Blob داده‌های این blob را از یک رشته با کدگذاری مشخص شده تنظیم می‌کند.
set Name(name) Blob نام این blob را تنظیم می‌کند.

Gmail Draft

روش‌ها

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

Gmail Label

روش‌ها

روش نوع بازگشتی شرح مختصر
add To Thread(thread) Gmail Label این برچسب را به رشته داده شده اضافه می‌کند و رشته را مجبور به رفرش (Refresh Gmail Thread.refresh() ) می‌کند.
add To Threads(threads) Gmail Label این برچسب را به رشته‌های داده شده اضافه می‌کند و رشته‌ها را مجبور به رفرش (refresh) می‌کند.
delete Label() void این برچسب را حذف می‌کند.
get Id() String شناسه (id) این برچسب را دریافت می‌کند.
get Name() String نام این برچسب را دریافت می‌کند.
get Threads() Gmail Thread[] رشته‌هایی را که با این برچسب علامت‌گذاری شده‌اند، برمی‌گرداند.
get Threads(start, max) Gmail Thread[] طیفی از رشته‌های مشخص‌شده با این برچسب را دریافت می‌کند.
get Unread Count() Integer تعداد تاپیک‌های خوانده نشده‌ای که با این برچسب برچسب‌گذاری شده‌اند را برمی‌گرداند.
remove From Thread(thread) Gmail Label این برچسب را از رشته داده شده حذف می‌کند و رشته را مجبور به رفرش (refresh) می‌کند.
remove From Threads(threads) Gmail Label این برچسب را از رشته‌های داده شده حذف می‌کند و رشته‌ها را مجبور به رفرش می‌کند.

Gmail Message

روش‌ها

روش نوع بازگشتی شرح مختصر
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 پیام قرار دارند، دریافت می‌کند.
get Body() String محتوای HTML بدنه‌ی این پیام را دریافت می‌کند.
get Cc() String گیرندگان جدا شده با کاما را در cc'd این پیام دریافت می‌کند.
get Date() Date تاریخ و زمان این پیام را دریافت می‌کند.
get From() String فرستنده این پیام را دریافت می‌کند.
get Header(name) String مقدار یک هدر RFC 2822 را با توجه به نام هدر دریافت می‌کند.
get Id() String شناسه (ID) این پیام را دریافت می‌کند.
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 پیام را از حالت ستاره‌دار خارج می‌کند.

Gmail Thread

روش‌ها

روش نوع بازگشتی شرح مختصر
add Label(label) Gmail Thread این برچسب را به موضوع اضافه می‌کند.
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 یک پیام پیش‌نویس در پاسخ به فرستنده آخرین پیام در این رشته، با استفاده از آدرس پاسخ و همه گیرندگان، با آرگومان‌های اختیاری ایجاد می‌کند.
get First Message Subject() String موضوع اولین پیام در رشته پیام‌ها را دریافت می‌کند.
get Id() String شناسه (ID) این رشته را دریافت می‌کند.
get Labels() Gmail Label[] برچسب‌های ایجاد شده توسط کاربر در این موضوع را برمی‌گرداند.
get Last Message Date() Date تاریخ آخرین پیام این تاپیک را دریافت می‌کند.
get Message Count() Integer تعداد پیام‌های موجود در رشته را برمی‌گرداند.
get Messages() Gmail Message[] پیام‌های این تاپیک را دریافت می‌کند.
get Permalink() String برای این تاپیک یک پیوند دائمی دریافت می‌کند.
has Starred Messages() Boolean برمی‌گرداند که آیا رشته پیام‌های ستاره‌دار دارد یا خیر.
is Important() Boolean برمی‌گرداند که آیا موضوع به عنوان مهم علامت‌گذاری شده است یا خیر.
is In Chats() Boolean برمی‌گرداند که آیا موضوع مورد بحث، چت (chat) نامگذاری شده است یا خیر.
is In Inbox() Boolean برمی‌گرداند که آیا موضوع در صندوق ورودی قرار دارد یا خیر.
is In Priority Inbox() Boolean اگر این رشته در صندوق ورودی اولویت‌دار باشد، مقدار true و در غیر این صورت مقدار false را برمی‌گرداند.
is In Spam() Boolean برمی‌گرداند که آیا تاپیک به عنوان هرزنامه علامت‌گذاری شده است یا خیر.
is In Trash() Boolean برمی‌گرداند که آیا رشته در سطل زباله قرار دارد یا خیر.
is Unread() Boolean برمی‌گرداند که آیا رشته پیام‌های خوانده نشده‌ای دارد یا خیر.
mark Important() Gmail Thread این تاپیک را به عنوان تاپیک مهم علامت گذاری می‌کند.
mark Read() Gmail Thread این تاپیک را به عنوان خوانده شده علامت گذاری می کند.
mark Unimportant() Gmail Thread این تاپیک را به عنوان بی‌اهمیت علامت‌گذاری می‌کند.
mark Unread() Gmail Thread این تاپیک را به عنوان خوانده نشده علامت گذاری می کند.
move To Archive() Gmail Thread این تاپیک را به بایگانی منتقل می‌کند.
move To Inbox() Gmail Thread این تاپیک را به صندوق ورودی منتقل می‌کند.
move To Spam() Gmail Thread این تاپیک رو به اسپم منتقل میکنه.
move To Trash() Gmail Thread این تاپیک را به سطل زباله منتقل می‌کند.
refresh() Gmail Thread این رشته و وضعیت مرتبط با آن را از Gmail مجدداً بارگذاری می‌کند (در صورتی که برچسب‌ها، وضعیت خوانده شدن و غیره تغییر کرده باشند، مفید است).
remove Label(label) Gmail Thread این برچسب را از تاپیک حذف می‌کند.
reply(body) Gmail Thread با استفاده از آدرس replyTo به فرستنده آخرین پیام در این تاپیک پاسخ دهید.
reply(body, options) Gmail Thread با استفاده از آدرس replyTo، با آرگومان‌های اختیاری، به فرستنده آخرین پیام در این تاپیک پاسخ دهید.
reply All(body) Gmail Thread به فرستنده (با استفاده از آدرس replyTo) و تمام گیرندگان آخرین پیام در این رشته پاسخ دهید.
reply All(body, options) Gmail Thread به فرستنده (با استفاده از آدرس reply To ) و تمام گیرندگان آخرین پیام در این رشته، با آرگومان‌های اختیاری پاسخ دهید.