C#
کمکی‌ها و ثابت‌ها
آنچه بسته جز متدهای کلاینت تعریف می‌کند.
ابزارهای کمکی
| ابزار کمکی | چیست |
|---|---|
| new OpenEmailClient() | یک کلاینت. هر چه را ننویسید از محیط می‌خواند، و برای پیکربندی‌ای که نمی‌پذیرد ArgumentException پرتاب می‌کند. |
| OpenEmailClient.CreateTempMail() | کلاینتی برای صندوق‌های موقت که هیچ کلید API ندارد. |
| OpenEmailClient.VerifyWebhookSignature() | امضای یک تحویل را در زمان ثابت بررسی می‌کند، با پنجره‌ای پنج‌دقیقه‌ای که toleranceSeconds: تغییرش می‌دهد، و رویداد را برمی‌گرداند. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | اینکه یک مقدار شکل کلید API یا توکن دسترسی را دارد یا نه. |
| OpenEmailClient.IsSealed() | اینکه یک پیام سرتاسری رمزگذاری شده است یا نه، که در آن صورت API نمی‌تواند بدنه‌اش را بخواند. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | یک زبان را با کد، نام انگلیسی یا نام بومی‌اش در جدولی که Languages.All در خود دارد جست‌وجو می‌کند. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | یک byte[] یا یک Stream را به base64 رمزگذاری می‌کند، برای فیلدی که متن base64 می‌گیرد. |
| client.Raw.RequestAsync() | مسیری را که هنوز هیچ متدی آن را نمی‌پوشاند، با اعتبارنامه و سیاست تلاش دوبارهٔ کلاینت فراخوانی می‌کند. |
تایپ‌ها
| نوع | چیست |
|---|---|
| Body | بدنهٔ درخواست: یک دیکشنری با نام فیلدهای API که به همان ترتیبی که کلیدهایش افزوده شده‌اند فرستاده می‌شود. |
| 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 هر مجموعه از مقدارهایی را که API به کار می‌برد در خود دارد و از 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}");