Gmail API

رابط برنامه‌نویسی کاربردی جیمیل (Gmail API) به شما امکان می‌دهد داده‌های صندوق پستی جیمیل مانند رشته‌ها، پیام‌ها و برچسب‌ها را مشاهده و مدیریت کنید.

سرویس: gmail.googleapis.com

برای فراخوانی این سرویس، توصیه می‌کنیم از کتابخانه‌های کلاینت ارائه شده توسط گوگل استفاده کنید. اگر برنامه شما برای فراخوانی این سرویس نیاز به استفاده از کتابخانه‌های خودتان دارد، هنگام ارسال درخواست‌های API از اطلاعات زیر استفاده کنید.

سند کشف

یک سند کشف ، مشخصاتی قابل خواندن توسط ماشین برای توصیف و استفاده از APIهای REST است. از آن برای ساخت کتابخانه‌های کلاینت، افزونه‌های IDE و سایر ابزارهایی که با APIهای گوگل تعامل دارند، استفاده می‌شود. یک سرویس ممکن است چندین سند کشف ارائه دهد. این سرویس سند کشف زیر را ارائه می‌دهد:

نقطه پایانی سرویس

یک نقطه پایانی سرویس ، یک URL پایه است که آدرس شبکه یک سرویس API را مشخص می‌کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و تمام URI های زیر مربوط به این نقطه پایانی سرویس هستند:

  • https://gmail.googleapis.com

منبع REST: v1.users

روش‌ها
getProfile GET /gmail/v1/users/{userId}/profile
نمایه Gmail کاربر فعلی را دریافت می‌کند.
stop POST /gmail/v1/users/{userId}/stop
ارسال اعلان‌های فوری را برای صندوق پستی کاربر مشخص‌شده غیرفعال کنید.
watch POST /gmail/v1/users/{userId}/watch
یک ساعت هشدار اعلان‌های فوری روی صندوق پستی کاربر مورد نظر تنظیم یا به‌روزرسانی کنید.

منبع REST: v1.users.drafts

روش‌ها
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
یک پیش‌نویس با برچسب DRAFT ایجاد می‌کند.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
بلافاصله و برای همیشه پیش‌نویس مشخص‌شده را حذف می‌کند.
get GET /gmail/v1/users/{userId}/drafts/{id}
پیش‌نویس مشخص‌شده را دریافت می‌کند.
list GET /gmail/v1/users/{userId}/drafts
پیش‌نویس‌های موجود در صندوق پستی کاربر را فهرست می‌کند.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
پیش‌نویس مشخص‌شده و موجود را به گیرندگان موجود در سربرگ‌های To ، Cc و Bcc ارسال می‌کند.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
محتوای پیش‌نویس را جایگزین می‌کند.

منبع REST: v1.users.history

روش‌ها
list GET /gmail/v1/users/{userId}/history
تاریخچه تمام تغییرات در صندوق پستی داده شده را فهرست می‌کند.

منبع REST: v1.users.labels

روش‌ها
create POST /gmail/v1/users/{userId}/labels
یک برچسب ایجاد می‌کند.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
بلافاصله و برای همیشه برچسب مشخص شده را حذف می‌کند و آن را از هرگونه پیام و رشته‌ای که روی آن اعمال شده است، حذف می‌کند.
get GET /gmail/v1/users/{userId}/labels/{id}
برچسب مشخص شده را دریافت می‌کند.
list GET /gmail/v1/users/{userId}/labels
تمام برچسب‌های موجود در صندوق پستی کاربر را فهرست می‌کند.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
برچسب مشخص شده را وصله بزنید.
update PUT /gmail/v1/users/{userId}/labels/{id}
برچسب مشخص شده را به‌روزرسانی می‌کند.

منبع REST: v1.users.messages

روش‌ها
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
پیام‌های زیادی را بر اساس شناسه پیام حذف می‌کند.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
برچسب‌های روی پیام‌های مشخص‌شده را تغییر می‌دهد.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
پیام مشخص شده را فوراً و برای همیشه حذف می‌کند.
get GET /gmail/v1/users/{userId}/messages/{id}
پیام مشخص شده را دریافت می‌کند.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
پیامی را فقط به صندوق پستی این کاربر وارد می‌کند، با اسکن و طبقه‌بندی استاندارد ارسال ایمیل مشابه دریافت از طریق SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
مستقیماً پیامی را فقط در صندوق پستی این کاربر مشابه IMAP APPEND وارد می‌کند و اکثر اسکن‌ها و طبقه‌بندی‌ها را دور می‌زند.
list GET /gmail/v1/users/{userId}/messages
لیست پیام‌های موجود در صندوق پستی کاربر.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
برچسب‌های روی پیام مشخص‌شده را تغییر می‌دهد.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
پیام مشخص شده را به گیرندگان موجود در هدرهای To ، Cc و Bcc ارسال می‌کند.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
پیام مشخص شده را به سطل زباله منتقل می‌کند.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
پیام مشخص شده را از سطل زباله حذف می‌کند.

منبع REST: v1.users.messages.attachments

روش‌ها
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
پیوست پیام مشخص شده را دریافت می‌کند.

منبع REST: v1.users.settings

روش‌ها
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
تنظیمات هدایت خودکار را برای حساب مشخص شده دریافت می‌کند.
getImap GET /gmail/v1/users/{userId}/settings/imap
تنظیمات IMAP را دریافت می‌کند.
getLanguage GET /gmail/v1/users/{userId}/settings/language
تنظیمات زبان را دریافت می‌کند.
getPop GET /gmail/v1/users/{userId}/settings/pop
تنظیمات POP را دریافت می‌کند.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
تنظیمات پاسخگوی تعطیلات را دریافت می‌کند.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
تنظیمات هدایت خودکار را برای حساب مشخص‌شده به‌روزرسانی می‌کند.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
تنظیمات IMAP را به‌روزرسانی می‌کند.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
تنظیمات زبان را به‌روزرسانی می‌کند.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
تنظیمات POP را به‌روزرسانی می‌کند.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
تنظیمات پاسخگوی تعطیلات را به‌روزرسانی می‌کند.

منبع REST: v1.users.settings.cse.identities

روش‌ها
create POST /gmail/v1/users/{userId}/settings/cse/identities
یک هویت رمزگذاری شده سمت کلاینت ایجاد و پیکربندی می‌کند که مجاز به ارسال ایمیل از حساب کاربری است.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
هویت رمزگذاری سمت کلاینت را حذف می‌کند.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
پیکربندی هویت رمزگذاری سمت کلاینت را بازیابی می‌کند.
list GET /gmail/v1/users/{userId}/settings/cse/identities
هویت‌های رمزگذاری‌شده‌ی سمت کلاینت را برای یک کاربر احراز هویت‌شده فهرست می‌کند.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
یک جفت کلید متفاوت را با یک هویت رمزگذاری سمت کلاینت موجود مرتبط می‌کند.

منبع REST: v1.users.settings.cse.keypairs

روش‌ها
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
یک زنجیره گواهی کلید عمومی S/MIME رمزگذاری شده سمت کلاینت و فراداده کلید خصوصی را برای کاربر احراز هویت شده ایجاد و آپلود می‌کند.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
یک جفت کلید رمزگذاری سمت کلاینت را خاموش می‌کند.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
یک جفت کلید رمزگذاری سمت کلاینت را که خاموش بود، فعال می‌کند.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
یک جفت کلید رمزگذاری موجود در سمت کلاینت را بازیابی می‌کند.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
جفت کلیدهای رمزگذاری سمت کلاینت را برای یک کاربر احراز هویت شده فهرست می‌کند.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
یک جفت کلید رمزگذاری سمت کلاینت را به طور دائم و فوری حذف می‌کند.

منبع REST: v1.users.settings.delegates

روش‌ها
create POST /gmail/v1/users/{userId}/settings/delegates
یک نماینده اضافه می‌کند که وضعیت تأیید آن مستقیماً روی accepted تنظیم شده است، بدون اینکه هیچ ایمیل تأییدی ارسال کند.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
نماینده مشخص شده (که می‌تواند هر وضعیت تأییدی داشته باشد) را حذف می‌کند و هرگونه تأییدی را که ممکن است برای استفاده از آن لازم بوده باشد، لغو می‌کند.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
نماینده مشخص شده را دریافت می‌کند.
list GET /gmail/v1/users/{userId}/settings/delegates
نمایندگان را برای حساب مشخص شده لیست می‌کند.

منبع REST: v1.users.settings.filters

روش‌ها
create POST /gmail/v1/users/{userId}/settings/filters
فیلتر ایجاد می‌کند.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
بلافاصله و برای همیشه فیلتر مشخص شده را حذف می‌کند.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
فیلتر می‌گیرد.
list GET /gmail/v1/users/{userId}/settings/filters
فیلترهای پیام یک کاربر Gmail را فهرست می‌کند.

منبع REST: v1.users.settings.forwardingAddresses

روش‌ها
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
یک آدرس ارسال ایجاد می‌کند.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
آدرس ارسال مشخص شده را حذف می‌کند و هرگونه تأییدی را که ممکن است لازم بوده باشد، لغو می‌کند.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
آدرس ارسال مشخص شده را دریافت می‌کند.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
آدرس‌های ارسال برای حساب مشخص‌شده را فهرست می‌کند.

منبع REST: v1.users.settings.sendAs

روش‌ها
create POST /gmail/v1/users/{userId}/settings/sendAs
یک نام مستعار سفارشی برای ارسال از نوع "from" ایجاد می‌کند.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
نام مستعار ارسالی مشخص شده را حذف می‌کند.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
نام مستعار ارسال به عنوان مشخص شده را دریافت می‌کند.
list GET /gmail/v1/users/{userId}/settings/sendAs
نام‌های مستعار ارسالی برای حساب مشخص‌شده را فهرست می‌کند.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
نام مستعار ارسالی مشخص شده را اصلاح کنید.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
یک نام مستعار ارسالی را به‌روزرسانی می‌کند.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
یک ایمیل تأیید به آدرس ایمیل مستعار ارسالی مشخص شده ارسال می‌کند.

منبع REST: v1.users.settings.sendAs.smimeInfo

روش‌ها
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
پیکربندی S/MIME مشخص شده را برای نام مستعار ارسالی مشخص شده حذف می‌کند.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
پیکربندی S/MIME مشخص شده را برای نام مستعار ارسالی مشخص شده دریافت می‌کند.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
پیکربندی S/MIME داده شده را برای نام مستعار ارسالی مشخص شده وارد (آپلود) کنید.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
پیکربندی‌های S/MIME را برای نام مستعار ارسالی مشخص‌شده فهرست می‌کند.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
پیکربندی پیش‌فرض S/MIME را برای نام مستعار ارسالی مشخص‌شده تنظیم می‌کند.

منبع REST: v1.users.threads

روش‌ها
delete DELETE /gmail/v1/users/{userId}/threads/{id}
بلافاصله و برای همیشه رشته‌ی مشخص‌شده را حذف می‌کند.
get GET /gmail/v1/users/{userId}/threads/{id}
رشته‌ی مشخص‌شده را دریافت می‌کند.
list GET /gmail/v1/users/{userId}/threads
فهرستی از موضوعات موجود در صندوق پستی کاربر را نمایش می‌دهد.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
برچسب‌های اعمال شده روی نخ را اصلاح می‌کند.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
رشته‌ی مشخص‌شده را به سطل زباله منتقل می‌کند.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
رشته‌ی مشخص‌شده را از سطل زباله حذف می‌کند.