تخطَّ إلى المستندات
Python

سجل التغييرات

كل إصدار من الحزمة، الأحدث أولاً.

0.0.1

الإصدار الأول. يغطي TypeScript SDK كاملًا كما كان عند 0.0.8، إضافة إلى التغييرات المنتظرة بعده: 430 دالة في 41 مساحة أسماء، كل منها باسمها في TypeScript بصيغة snake_case. ويثبت فحص التكافؤ أن كل واحدة منها ترسل بالضبط الطلب الذي يرسله نظيرها في TypeScript، مرة دون خيارات ومرة مع ضبط كل خيار.

  • لكل من OpenEmail وAsyncOpenEmail سمة لكل مساحة أسماء، من emails وthreads وtemplates إلى provider_imports وdns_connections وaccount. فـlistAll هي list_all، وgetActive هي get_active، وtempMail هي temp_mail.
  • جسم الطلب قاموس تحتفظ مفاتيحه بأسماء API بصيغة camelCase، وخيارات الاستدعاء وسائط مسمّاة بصيغة snake_case مثل idempotency_key= وlimit=، والاستجابة تعود في صورة قاموس. ولكل جسم ونتيجة TypedDict في openemail.types، مسمّى كما في TypeScript.
  • يملك AsyncOpenEmail الدوال نفسها بالوسائط نفسها، تُستدعى مع await، ويعمل على asyncio وعلى trio.
  • لكل مورد مقسَّم إلى صفحات list لصفحة واحدة، وlist_all لكل العناصر في قائمة، وiterate الذي يُنتج العناصر ولا يجلب الصفحة التالية إلا حين يصل إليها.
  • يرفع رفضُ API الخطأ OpenEmailApiError، مع status وtype وcode وparam وrequest_id، وis_validation وis_not_found وis_rate_limited وis_step_up_required وis_retryable وبقية الفحوص. وغياب أي استجابة يرفع OpenEmailNetworkError، مع is_timeout حين تنقضي المهلة.
  • from openemail import openemail عميل جاهز يُبنى من OPENEMAIL_API_KEY في أول مرة يُستخدم فيها، ويضبطه init مرة واحدة عند بدء التشغيل. ويفتح create_temp_mail وcreate_async_temp_mail صناديق بريد مؤقتة دون أي بيانات اعتماد.
  • يقبل access_token= رمز وصول OAuth أو دالة تعيده، تُستدعى قبل كل طلب. ويفحص verify_webhook_signature التسليم بزمن ثابت ويعيد الحدث المحلَّل. ويصل client.raw.request إلى نقطة نهاية لا تغلّفها أي دالة بعد.
  • تُعاد القراءات عند 408 و5xx، ولا يُعاد 429 إلا حين يحمل Retry-After. ويحدّ timeout المحاولة كاملة، بما في ذلك جسم الاستجابة، ولا تُرسَل بيانات الاعتماد أبدًا عبر HTTP غير مشفّر إلا إلى خادم على هذا الجهاز.
  • تحتاج إلى Python 3.10 أو أحدث، ولا تعتمد إلا على httpx وanyio وtyping-extensions.