C#
Yardımcılar ve sabitler
Paketin istemcinin metotları dışında tanımladığı diğer şeyler.
Yardımcılar
| Yardımcı | Nedir |
|---|---|
| new OpenEmailClient() | Bir istemci. Belirtmediğiniz her şeyi ortamdan okur ve reddettiği bir yapılandırma için ArgumentException fırlatır. |
| OpenEmailClient.CreateTempMail() | Tek kullanımlık gelen kutuları için, API anahtarı taşımayan bir istemci. |
| OpenEmailClient.VerifyWebhookSignature() | Bir teslimatın imzasını, toleranceSeconds: ile değişen beş dakikalık bir pencereyle sabit zamanda denetler ve olayı döndürür. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | Bir değerin API anahtarı ya da erişim belirteci biçiminde olup olmadığı. |
| OpenEmailClient.IsSealed() | Bir iletinin uçtan uca şifreli olup olmadığı; öyleyse API gövdesini okuyamaz. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Bir dili koda, İngilizce ada ya da kendi adına göre Languages.All içindeki tabloda arar. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | Base64 metin alan bir alan için bir byte[] ya da bir Stream değerini base64 olarak kodlar. |
| client.Raw.RequestAsync() | Henüz hiçbir yöntemin sarmadığı bir yolu, istemcinin kimlik bilgisi ve yeniden deneme kurallarıyla çağırır. |
Türler
| Tür | Nedir |
|---|---|
| Body | İstek gövdesi: API'nin alan adlarını taşıyan ve anahtarlarının eklendiği sırayla gönderilen bir sözlük. |
| JsonObject | System.Text.Json.Nodes içinden gelen çözülmüş bir yanıt. Bir alanı sent["id"] ile okuyun ve (string?)sent["id"] ile dönüştürün. |
| Page | Bir listenin tek sayfası: Items, HasMore ve NextCursor. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | Bir listeden fazlasını taşıyan yanıtlar; örneğin bir toplu gönderimin Sent ve Failed sayıları. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | İstemcinin fırlattıkları. Üçü de OpenEmailException türünden türer. |
Sabitler
OpenEmail.Constants ad alanı, API'nin kullandığı her değer kümesini içerir ve TypeScript SDK'sından üretilir: webhook olayları, kapsamlar, durumlar ve diğerleri. Her küme, üyeleri sabit olan statik bir sınıftır ve Values hepsini listeler.
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}");