Gmail Service

جیمیل

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

کلاس ها

نام توضیح مختصر
GmailApp دسترسی به رشته‌ها، پیام‌ها و برچسب‌های Gmail را فراهم می‌کند.
GmailAttachment پیوستی از جیمیل.
GmailDraft یک پیام پیش نویس ایجاد شده توسط کاربر در حساب Gmail کاربر.
GmailLabel برچسب ایجاد شده توسط کاربر در حساب کاربری جیمیل یک کاربر.
GmailMessage پیامی در حساب کاربری جیمیل یک کاربر.
GmailThread رشته ای در حساب کاربری جیمیل یک کاربر.

GmailApp

مواد و روش ها

روش نوع برگشت توضیح مختصر
createDraft(recipient, subject, body) GmailDraft یک پیام ایمیل پیش نویس ایجاد می کند.
createDraft(recipient, subject, body, options) GmailDraft یک پیام ایمیل پیش نویس با آرگومان های اختیاری ایجاد می کند.
createLabel(name) GmailLabel یک برچسب کاربری جدید با نام داده شده ایجاد کنید.
deleteLabel(label) GmailApp برچسب مشخص شده را حذف می کند.
getAliases() String[] فهرستی از ایمیل هایی را دریافت می کند که به عنوان نام مستعار برای این حساب در Gmail تنظیم شده اند.
getDraft(draftId) GmailDraft پیش نویس پیام ایمیل را با شناسه بازیابی کنید.
getDraftMessages() GmailMessage[] همه پیام های پیش نویس را بازیابی می کند.
getDrafts() GmailDraft[] همه پیام‌های پیش‌نویس Gmail را دریافت می‌کند.
getInboxThreads() GmailThread[] همه رشته‌های صندوق ورودی را بدون در نظر گرفتن برچسب‌ها بازیابی می‌کند.
getInboxThreads(start, max) GmailThread[] طیفی از رشته‌های صندوق ورودی را بدون توجه به برچسب‌ها بازیابی می‌کند.
getInboxUnreadCount() Integer تعداد رشته های خوانده نشده را در صندوق ورودی دریافت می کند.
getMessageById(id) GmailMessage با شناسه پیام می گیرد.
getMessagesForThread(thread) GmailMessage[] همه پیام های موجود در رشته مشخص شده را بازیابی کنید.
getMessagesForThreads(threads) GmailMessage[][] همه پیام ها را در رشته های مشخص شده بازیابی کنید.
getPriorityInboxThreads() GmailThread[] همه رشته‌های صندوق ورودی اولویتی را بدون توجه به برچسب‌ها بازیابی می‌کند.
getPriorityInboxThreads(start, max) GmailThread[] طیفی از رشته‌های صندوق ورودی اولویتی را بدون توجه به برچسب‌ها بازیابی می‌کند.
getPriorityInboxUnreadCount() Integer تعداد رشته های خوانده نشده را در صندوق ورودی اولویتی دریافت می کند.
getSpamThreads() GmailThread[] همه رشته های هرزنامه را بدون در نظر گرفتن برچسب ها بازیابی می کند.
getSpamThreads(start, max) GmailThread[] طیفی از رشته های هرزنامه را بدون توجه به برچسب ها بازیابی می کند.
getSpamUnreadCount() Integer تعداد رشته های خوانده نشده که هرزنامه هستند را دریافت می کند.
getStarredThreads() GmailThread[] همه رشته های ستاره دار را بدون در نظر گرفتن برچسب ها بازیابی می کند.
getStarredThreads(start, max) GmailThread[] طیفی از رشته های ستاره دار را بدون توجه به برچسب ها بازیابی می کند.
getStarredUnreadCount() Integer تعداد رشته های خوانده نشده ستاره دار را دریافت می کند.
getThreadById(id) GmailThread یک موضوع با شناسه دریافت می کند.
getTrashThreads() GmailThread[] همه رشته های زباله را بدون در نظر گرفتن برچسب ها بازیابی می کند.
getTrashThreads(start, max) GmailThread[] طیفی از رشته های زباله را بدون توجه به برچسب ها بازیابی می کند.
getUserLabelByName(name) GmailLabel برچسبی را با نام برچسب بازیابی می کند.
getUserLabels() GmailLabel[] لیستی از برچسب های ایجاد شده توسط کاربر را بازیابی می کند.
markMessageRead(message) GmailApp این پیام را به عنوان خوانده شده علامت گذاری می کند و پیام را مجبور به بازخوانی می کند.
markMessageUnread(message) GmailApp این پیام را به عنوان خوانده‌نشده علامت‌گذاری می‌کند و پیام را مجبور به بازخوانی می‌کند.
markMessagesRead(messages) GmailApp این پیام‌ها را به‌عنوان خوانده‌شده علامت‌گذاری می‌کند و پیام‌ها را مجبور به بازخوانی می‌کند.
markMessagesUnread(messages) GmailApp این پیام‌ها را به عنوان خوانده نشده علامت‌گذاری می‌کند و پیام‌ها را مجبور به بازخوانی می‌کند.
markThreadImportant(thread) GmailApp این موضوع را به‌عنوان مهم علامت‌گذاری می‌کند و موضوع را مجبور به تازه کردن می‌کند.
markThreadRead(thread) GmailApp این موضوع را به عنوان خوانده شده علامت گذاری می کند و موضوع را مجبور به تازه کردن می کند.
markThreadUnimportant(thread) GmailApp این رشته را به‌عنوان بی‌اهمیت علامت‌گذاری می‌کند و موضوع را مجبور به تازه کردن می‌کند.
markThreadUnread(thread) GmailApp این موضوع را به عنوان خوانده نشده علامت گذاری می کند و موضوع را مجبور به تازه کردن می کند.
markThreadsImportant(threads) GmailApp این رشته‌ها را به‌عنوان مهم علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
markThreadsRead(threads) GmailApp این رشته‌ها را به‌عنوان خوانده شده علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
markThreadsUnimportant(threads) GmailApp این رشته‌ها را به‌عنوان بی‌اهمیت علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه‌سازی می‌کند.
markThreadsUnread(threads) GmailApp این رشته‌ها را به‌عنوان خوانده‌نشده علامت‌گذاری می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
moveMessageToTrash(message) GmailApp پیام را به سطل زباله منتقل می کند و پیام را مجبور به بازخوانی می کند.
moveMessagesToTrash(messages) GmailApp پیام های مشخص شده را به سطل زباله منتقل می کند و پیام ها را مجبور به بازخوانی می کند.
moveThreadToArchive(thread) GmailApp این رشته را به بایگانی منتقل می کند و موضوع را مجبور به تازه کردن می کند.
moveThreadToInbox(thread) GmailApp این رشته را به صندوق ورودی منتقل می کند و موضوع را مجبور می کند تا به روز شود.
moveThreadToSpam(thread) GmailApp این رشته را به هرزنامه منتقل می کند و موضوع را مجبور به تازه کردن می کند.
moveThreadToTrash(thread) GmailApp این رشته را به سطل زباله منتقل می کند و موضوع را مجبور به تازه کردن می کند.
moveThreadsToArchive(threads) GmailApp این رشته ها را به بایگانی منتقل می کند و رشته ها را مجبور به تازه کردن می کند.
moveThreadsToInbox(threads) GmailApp این رشته‌ها را به صندوق ورودی منتقل می‌کند و رشته‌ها را مجبور به تازه‌سازی می‌کند.
moveThreadsToSpam(threads) GmailApp این رشته ها را به هرزنامه منتقل می کند و رشته ها را مجبور به بازخوانی می کند.
moveThreadsToTrash(threads) GmailApp این رشته‌ها را به سطل زباله منتقل می‌کند و رشته‌ها را مجبور به تازه کردن می‌کند.
refreshMessage(message) GmailApp پیام و وضعیت مربوطه را از Gmail بارگیری مجدد می کند (در مواردی که برچسب ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
refreshMessages(messages) GmailApp پیام‌ها و وضعیت مرتبط را از Gmail بارگیری مجدد می‌کند (برای مواردی که برچسب‌ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
refreshThread(thread) GmailApp رشته و وضعیت مرتبط را از Gmail بارگیری مجدد می کند (در مواردی که برچسب ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
refreshThreads(threads) GmailApp رشته‌ها و وضعیت مرتبط را از Gmail بارگیری مجدد می‌کند (برای مواردی که برچسب‌ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
search(query) GmailThread[] جیمیل را با عبارت مورد نظر جستجو کنید.
search(query, start, max) GmailThread[] جیمیل را با عبارت مورد نظر جستجو کنید.
sendEmail(recipient, subject, body) GmailApp یک پیام ایمیل می فرستد.
sendEmail(recipient, subject, body, options) GmailApp یک پیام ایمیل با آرگومان های اختیاری ارسال می کند.
setCurrentMessageAccessToken(accessToken) void رمز دسترسی پیام فعلی را تنظیم می کند که اسکریپت را قادر می سازد به ویژگی های GmailMessage فعلی دسترسی پیدا کند.
starMessage(message) GmailApp یک ستاره به این پیام اضافه می کند و پیام را مجبور می کند تا به روز شود.
starMessages(messages) GmailApp به این پیام‌ها ستاره اضافه می‌کند و پیام‌ها را مجبور به تازه‌سازی می‌کند.
unstarMessage(message) GmailApp ستاره ای را از این پیام حذف می کند و پیام را مجبور به بازخوانی می کند.
unstarMessages(messages) GmailApp ستاره‌ها را از این پیام‌ها حذف می‌کند و پیام‌ها را مجبور به بازخوانی می‌کند.

GmailAttachment

مواد و روش ها

روش نوع برگشت توضیح مختصر
copyBlob() Blob یک کپی از این لکه را برمی گرداند.
getAs(contentType) Blob داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید.
getBytes() Byte[] داده های ذخیره شده در این لکه را دریافت می کند.
getContentType() String نوع محتوای بایت های این لکه را دریافت می کند.
getDataAsString() String داده های این حباب را به صورت رشته ای با رمزگذاری UTF-8 دریافت می کند.
getDataAsString(charset) String داده های این لکه را به صورت رشته ای با رمزگذاری مشخص شده دریافت می کند.
getHash() String هش محتوای SHA1 را برای این پیوست دریافت می کند.
getName() String نام این لکه را می گیرد.
getSize() Integer اندازه این پیوست را دریافت می کند.
isGoogleType() Boolean نشان می دهد که آیا این لکه یک فایل Google Workspace (کاربرگ، اسناد و غیره) است یا خیر.
setBytes(data) Blob داده های ذخیره شده در این لکه را تنظیم می کند.
setContentType(contentType) Blob نوع محتوای بایت های این لکه را تنظیم می کند.
setContentTypeFromExtension() Blob نوع محتوای بایت های این لکه را بر اساس پسوند فایل تنظیم می کند.
setDataFromString(string) Blob داده های این حباب را از یک رشته با رمزگذاری UTF-8 تنظیم می کند.
setDataFromString(string, charset) Blob داده های این حباب را از یک رشته با رمزگذاری مشخص شده تنظیم می کند.
setName(name) Blob نام این لکه را تنظیم می کند.

GmailDraft

مواد و روش ها

روش نوع برگشت توضیح مختصر
deleteDraft() void این پیام پیش نویس را حذف می کند.
getId() String شناسه این پیام پیش نویس را دریافت می کند.
getMessage() GmailMessage GmailMessage نشان دهنده این پیش نویس را برمی گرداند.
getMessageId() String شناسه GmailMessage را که این پیش‌نویس را نشان می‌دهد، برمی‌گرداند.
send() GmailMessage این پیش‌نویس ایمیل را ارسال می‌کند.
update(recipient, subject, body) GmailDraft جایگزین محتویات این پیام پیش نویس می شود.
update(recipient, subject, body, options) GmailDraft با استفاده از آرگومان های اختیاری، محتوای این پیام پیش نویس را جایگزین می کند.

GmailLabel

مواد و روش ها

روش نوع برگشت توضیح مختصر
addToThread(thread) GmailLabel این برچسب را به رشته داده شده اضافه می کند و رشته را مجبور می کند تا رفرش شود ( GmailThread.refresh() ).
addToThreads(threads) GmailLabel این برچسب را به رشته های داده شده اضافه می کند و رشته ها را مجبور به تازه کردن می کند.
deleteLabel() void این برچسب را حذف می کند.
getName() String نام این برچسب را دریافت می کند.
getThreads() GmailThread[] رشته هایی که با این برچسب مشخص شده اند را دریافت می کند.
getThreads(start, max) GmailThread[] طیف وسیعی از موضوعات را که با این برچسب مشخص شده اند دریافت می کند.
getUnreadCount() Integer تعداد رشته های خوانده نشده برچسب گذاری شده با این برچسب را دریافت می کند.
removeFromThread(thread) GmailLabel این برچسب را از رشته داده شده حذف می کند و موضوع را مجبور به تازه کردن می کند.
removeFromThreads(threads) GmailLabel این برچسب را از رشته های داده شده حذف می کند و رشته ها را مجبور به تازه کردن می کند.

GmailMessage

مواد و روش ها

روش نوع برگشت توضیح مختصر
createDraftReply(body) GmailDraft یک پیش نویس پیام ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد.
createDraftReply(body, options) GmailDraft یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
createDraftReplyAll(body) GmailDraft یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به فرستنده و همه گیرندگان این پیام به فرستنده پاسخ می دهد.
createDraftReplyAll(body, options) GmailDraft یک پیام پیش نویس ایجاد می کند که با استفاده از آدرس پاسخ به این پیام و همه گیرندگان، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
forward(recipient) GmailMessage این پیام را برای گیرندگان جدید بازارسال می کند.
forward(recipient, options) GmailMessage این پیام را با آرگومان های اختیاری به گیرندگان جدید فوروارد می کند.
getAttachments() GmailAttachment[] تمام پیوست های این پیام را دریافت می کند.
getAttachments(options) GmailAttachment[] تمام پیوست های این پیام را دریافت می کند.
getBcc() String گیرندگانی که با کاما از هم جدا شده اند را روی این پیام bcc'd می کند.
getBody() String محتوای HTML متن این پیام را دریافت می کند.
getCc() String گیرندگان جدا شده با کاما را در این پیام cc'd می کند.
getDate() Date تاریخ و زمان این پیام را دریافت می کند.
getFrom() String فرستنده این پیام را دریافت می کند.
getHeader(name) String با توجه به نام هدر، مقدار یک هدر RFC 2822 را دریافت می کند.
getId() String شناسه این پیام را دریافت می کند.
getPlainBody() String محتوای متن این پیام را بدون قالب بندی HTML دریافت می کند.
getRawContent() String محتوای خام این پیام را دریافت می کند.
getReplyTo() String آدرس پاسخ به این پیام (معمولاً فرستنده) را دریافت می کند.
getSubject() String موضوع این پیام را دریافت می کند.
getThread() GmailThread رشته ای را دریافت می کند که حاوی این پیام است.
getTo() String گیرندگان این پیام را که با کاما از هم جدا شده اند دریافت می کند.
isDraft() Boolean متوجه می شود که آیا این پیام پیش نویس است یا خیر.
isInChats() Boolean متوجه می شود که آیا این پیام یک چت است یا خیر.
isInInbox() Boolean متوجه می شود که آیا این پیام در صندوق ورودی است یا خیر.
isInPriorityInbox() Boolean اگر این پیام در صندوق ورودی اولویت قرار داشته باشد، true برمی گردد. در غیر این صورت false برمی گرداند.
isInTrash() Boolean متوجه می شود که آیا این پیام در سطل زباله است.
isStarred() Boolean متوجه می شود که آیا این پیام ستاره دار است یا خیر.
isUnread() Boolean متوجه می شود که آیا این پیام خوانده نشده است یا خیر.
markRead() GmailMessage پیام را به عنوان خوانده شده علامت گذاری می کند.
markUnread() GmailMessage پیام را به عنوان خوانده نشده علامت گذاری می کند.
moveToTrash() GmailMessage پیام را به سطل زباله منتقل می کند.
refresh() GmailMessage این پیام و وضعیت مرتبط را از Gmail مجدداً بارگیری می‌کند (در مواردی که برچسب‌ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
reply(body) GmailMessage با استفاده از آدرس پاسخ به فرستنده این پیام را پاسخ می دهد.
reply(body, options) GmailMessage با استفاده از آدرس پاسخ به، با آرگومان های اختیاری به فرستنده این پیام پاسخ می دهد.
replyAll(body) GmailMessage به فرستنده با استفاده از آدرس پاسخ به و همه گیرندگان این پیام پاسخ می دهد.
replyAll(body, options) GmailMessage به فرستنده این پیام با استفاده از آدرس پاسخ به و همه گیرندگان، با آرگومان های اختیاری پاسخ می دهد.
star() GmailMessage پیام را ستاره می دهد.
unstar() GmailMessage پیام را از ستاره خارج می کند.

GmailThread

مواد و روش ها

روش نوع برگشت توضیح مختصر
addLabel(label) GmailThread این برچسب را به موضوع اضافه می کند.
createDraftReply(body) GmailDraft یک پیام پیش‌نویس ایجاد می‌کند که به فرستنده آخرین پیام در این رشته با استفاده از آدرس پاسخ به پاسخ می‌دهد.
createDraftReply(body, options) GmailDraft یک پیام پیش‌نویس ایجاد می‌کند که به فرستنده آخرین پیام در این رشته با استفاده از آدرس پاسخ به، با آرگومان‌های اختیاری پاسخ می‌دهد.
createDraftReplyAll(body) GmailDraft با استفاده از آدرس پاسخ به و همه گیرندگان این پیام، یک پیام پیش‌نویس ایجاد می‌کند که به فرستنده آخرین پیام در این رشته پاسخ می‌دهد.
createDraftReplyAll(body, options) GmailDraft یک پیام پیش نویس برای پاسخ به فرستنده آخرین پیام در این رشته، با استفاده از آدرس پاسخ به و همه گیرندگان، با آرگومان های اختیاری ایجاد می کند.
getFirstMessageSubject() String موضوع اولین پیام در تاپیک را دریافت می کند.
getId() String شناسه این تاپیک را می گیرد.
getLabels() GmailLabel[] برچسب های ایجاد شده توسط کاربر در این رشته را برمی گرداند.
getLastMessageDate() Date تاریخ آخرین پیام این موضوع را دریافت می کند.
getMessageCount() Integer تعداد پیام های موجود در رشته را برمی گرداند.
getMessages() GmailMessage[] پیام های این تاپیک را دریافت می کند.
getPermalink() String یک پیوند ثابت برای این موضوع دریافت می کند.
hasStarredMessages() Boolean نشان می دهد که آیا رشته پیام های ستاره دار دارد یا خیر.
isImportant() Boolean نشان می دهد که آیا موضوع به عنوان مهم علامت گذاری شده است یا خیر.
isInChats() Boolean نشان می دهد که آیا موضوع برچسب چت است یا خیر.
isInInbox() Boolean نشان می دهد که آیا موضوع در صندوق ورودی است یا خیر.
isInPriorityInbox() Boolean اگر این موضوع در صندوق ورودی اولویت باشد، مقدار true را برمی‌گرداند. در غیر این صورت false برمی گرداند.
isInSpam() Boolean نشان می دهد که آیا موضوع به عنوان هرزنامه علامت گذاری شده است.
isInTrash() Boolean نشان می دهد که آیا موضوع در سطل زباله است.
isUnread() Boolean نشان می دهد که آیا رشته پیام های خوانده نشده ای دارد یا خیر.
markImportant() GmailThread این موضوع را به عنوان مهم علامت گذاری می کند.
markRead() GmailThread این موضوع را به عنوان خوانده شده علامت گذاری می کند.
markUnimportant() GmailThread این موضوع را به عنوان بی اهمیت علامت گذاری می کند.
markUnread() GmailThread این موضوع را به عنوان خوانده نشده علامت گذاری می کند.
moveToArchive() GmailThread این موضوع را به بایگانی منتقل می کند.
moveToInbox() GmailThread این موضوع را به صندوق ورودی منتقل می کند.
moveToSpam() GmailThread این موضوع را به هرزنامه منتقل می کند.
moveToTrash() GmailThread این موضوع را به سطل زباله منتقل می کند.
refresh() GmailThread این رشته و وضعیت مرتبط را از Gmail بارگیری مجدد می کند (در مواردی که برچسب ها، وضعیت خواندن و غیره تغییر کرده باشند مفید است).
removeLabel(label) GmailThread این برچسب را از موضوع حذف می کند.
reply(body) GmailThread با استفاده از آدرس replyTo به فرستنده آخرین پیام در این موضوع پاسخ دهید.
reply(body, options) GmailThread با استفاده از آدرس replyTo، با آرگومان های اختیاری به فرستنده آخرین پیام در این رشته پاسخ دهید.
replyAll(body) GmailThread به فرستنده (با استفاده از آدرس replyTo)، و همه گیرندگان آخرین پیام در این موضوع پاسخ دهید.
replyAll(body, options) GmailThread به فرستنده (با استفاده از آدرس replyTo )، و همه گیرندگان آخرین پیام در این رشته، با آرگومان های اختیاری پاسخ دهید.