Gmail API

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

خدمات: gmail.googleapis.com

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

سند کشف

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

نقطه پایان خدمات

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

  • https://gmail.googleapis.com

منبع REST: v1.users

مواد و روش ها
getProfile GET /gmail/v1/users/{userId}/profile
نمایه جیمیل کاربر فعلی را دریافت می کند.
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
فیلترهای پیام یک کاربر جیمیل را فهرست می کند.

منبع 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
یک نام مستعار send-as سفارشی "از" ایجاد می کند.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
نام مستعار send-as مشخص شده را حذف می کند.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
نام مستعار send-as مشخص شده را دریافت می کند.
list GET /gmail/v1/users/{userId}/settings/sendAs
نام مستعار send-as را برای حساب مشخص شده فهرست می کند.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
نام مستعار send-as مشخص شده را وصله کنید.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
یک نام مستعار send-as را به روز می کند.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
یک ایمیل تأیید به آدرس مشخص شده send-as نام مستعار ارسال می کند.

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

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

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