این سند نحوه ایجاد، بهروزرسانی و ارسال ایمیلهای پیشنویس با استفاده از Gmail API را توضیح میدهد.
پیشنویسهای ایمیل، پیامهای ارسال نشدهای را نشان میدهند که برچسب سیستمی DRAFT روی آنها اعمال شده است. پیام موجود در پیشنویس پس از ایجاد قابل ویرایش نیست، اما میتوان آن را جایگزین کرد. از این نظر، منبع drafts ، ظرفی است که یک شناسه پایدار ارائه میدهد زیرا شناسههای پیام اصلی هر بار که پیام جایگزین میشود، تغییر میکنند.
منبع messages در داخل یک پیشنویس، رفتاری مشابه سایر پیامها دارد، به جز تفاوتهای زیر:
- پیامهای پیشنویس نمیتوانند برچسبی غیر از برچسب سیستمی
DRAFTداشته باشند. - وقتی پیشنویس ارسال میشود، پیشنویس بهطور خودکار حذف میشود و یک پیام جدید با شناسه بهروزرسانیشده با برچسب سیستمی
SENTایجاد میشود. این پیام در پاسخ متدdrafts.sendبرگردانده میشود.
ایجاد پیشنویسها
برنامه شما میتواند با استفاده از متد drafts.create پیشنویس ایجاد کند. برای ایجاد یک پیشنویس:
- یک پیام MIME ایجاد کنید که با RFC 2822 مطابقت داشته باشد.
- پیام را به یک رشته کدگذاری شده با base64URL تبدیل کنید.
- متد
drafts.createرا فراخوانی کنید و مقدار فیلدmessages.rawرا برابر با رشته کدگذاری شده قرار دهید.
نمونههای کد زیر روند کار را نشان میدهند:
جاوا
پایتون
حلقه
curl --request POST \
'https://gmail.googleapis.com/gmail/v1/users/me/drafts' \
--header 'Authorization: Bearer ACCESS_TOKEN" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"message":{"raw":"MESSAGE"}}'
موارد زیر را جایگزین کنید:
- ACCESS_TOKEN : توکن دسترسی که دسترسی به API را اعطا میکند.
- MESSAGE : پیام MIME با فرمت RFC 2822 که به صورت base64URL کدگذاری شده است.
پیشنویسها را بهروزرسانی کنید
مشابه ایجاد یک پیشنویس، برای بهروزرسانی یک پیشنویس، باید منبعی drafts را در بدنه درخواست خود ارائه دهید که فیلد messages.raw روی یک رشته کدگذاری شده base64URL حاوی پیام MIME تنظیم شده باشد. از آنجا که پیامها قابل بهروزرسانی نیستند، پیام موجود در پیشنویس از بین میرود و با پیام MIME جدید ارائه شده در درخواست بهروزرسانی جایگزین میشود.
شما میتوانید پیام MIME فعلی موجود در پیشنویس را با فراخوانی متد drafts.get به همراه پارامتر query format=raw بازیابی کنید.
برای اطلاعات بیشتر، به متد drafts.update مراجعه کنید.
ارسال پیشنویسها
هنگام ارسال پیشنویس، میتوانید آن را به همان صورت ارسال کنید، یا میتوانید در درخواست ارسال، بهروزرسانیهایی را ارائه دهید.
برای بهروزرسانی پیشنویس هنگام ارسال، یک منبع drafts در بدنه درخواست متد drafts.send ارائه دهید. در منبع drafts ، باید id پیشنویس ارسالی را مشخص کنید و فیلد messages.raw را روی پیام MIME جدید که به صورت رشته base64URL کدگذاری شده است، تنظیم کنید.
برای اطلاعات بیشتر در مورد ارسال پیام از طریق Gmail، به بخش ارسال پیام مراجعه کنید.