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}");