C#
الأدوات المساعدة والثوابت
ما تعرّفه الحزمة غير توابع العميل.
الأدوات المساعدة
| الأداة المساعدة | ما هي |
|---|---|
| new OpenEmailClient() | عميل. يقرأ من البيئة كل ما تتركه، ويرمي ArgumentException عند إعداد يرفضه. |
| OpenEmailClient.CreateTempMail() | عميل لصناديق البريد المؤقتة لا يحمل مفتاح واجهة برمجية. |
| OpenEmailClient.VerifyWebhookSignature() | تتحقق من توقيع التسليم في زمن ثابت، بنافذة من خمس دقائق يغيّرها toleranceSeconds:، وتعيد الحدث. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | هل للقيمة شكل مفتاح واجهة برمجية أو شكل رمز وصول. |
| OpenEmailClient.IsSealed() | هل الرسالة مشفرة من طرف إلى طرف، فلا تستطيع الواجهة البرمجية قراءة محتواها. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | تبحث عن لغة بالرمز أو بالاسم الإنجليزي أو باسمها الأصلي، في الجدول الذي يحتويه Languages.All. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | ترمّز byte[] أو Stream بصيغة base64، لحقل يأخذ نصًا بصيغة base64. |
| client.Raw.RequestAsync() | تستدعي مسارًا لا تغلفه أي دالة بعد، ببيانات اعتماد العميل وسياسة إعادة المحاولة لديه. |
الأنواع
| النوع | ما هي |
|---|---|
| Body | جسم الطلب: قاموس بأسماء حقول الواجهة البرمجية، يُرسل بالترتيب الذي أُضيفت به مفاتيحه. |
| JsonObject | استجابة مفكوكة الترميز من System.Text.Json.Nodes. اقرأ حقلًا عبر sent["id"]، وحوّله عبر (string?)sent["id"]. |
| Page | صفحة واحدة من قائمة: Items وHasMore وNextCursor. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | الإجابات التي تحمل أكثر من قائمة، مثل العدّين Sent وFailed في دفعة. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | ما يرميه العميل. الثلاثة كلها مشتقة من OpenEmailException. |
الثوابت
مساحة الأسماء OpenEmail.Constants تضم كل مجموعة قيم تستخدمها الواجهة البرمجية، مولَّدة من TypeScript SDK: أحداث الويب هوك والنطاقات والحالات وغيرها. كل مجموعة صنف ساكن أعضاؤه ثوابت، وValues يسردها كلها.
using OpenEmail.Constants; var webhook = await client.Webhooks.CreateAsync(new Body{ ["url"] = "https://example.com/webhooks/openemail", ["events"] = new[] { WebhookEvents.EmailReceived, WebhookEvents.EmailBounced },}); Console.WriteLine($"{webhook["id"]} {WebhookEvents.Values.Count}");