C#
Utilidades y constantes
Lo que el paquete define además de los métodos del cliente.
Utilidades
| Utilidad | Qué es |
|---|---|
| new OpenEmailClient() | Un cliente. Lee del entorno todo lo que omitas, y lanza ArgumentException ante una configuración que rechaza. |
| OpenEmailClient.CreateTempMail() | Un cliente para buzones desechables que no lleva ninguna clave de API. |
| OpenEmailClient.VerifyWebhookSignature() | Comprueba la firma de una entrega en tiempo constante, con una ventana de cinco minutos que cambia toleranceSeconds:, y devuelve el evento. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | Si un valor tiene la forma de una clave de API o de un token de acceso. |
| OpenEmailClient.IsSealed() | Si un mensaje está cifrado de extremo a extremo, de modo que la API no puede leer su cuerpo. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Busca un idioma por código, nombre en inglés o nombre propio, en la tabla que contiene Languages.All. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | Codifica un byte[] o un Stream en base64, para un campo que acepta texto en base64. |
| client.Raw.RequestAsync() | Llama a una ruta que todavía no envuelve ningún método, con la credencial y la política de reintentos del cliente. |
Tipos
| Tipo | Qué es |
|---|---|
| Body | El cuerpo de una petición: un diccionario con los nombres de campo de la API, enviado en el orden en que se añadieron sus claves. |
| JsonObject | Una respuesta decodificada, de System.Text.Json.Nodes. Lee un campo con sent["id"], y conviértelo con (string?)sent["id"]. |
| Page | Una página de una lista: Items, HasMore y NextCursor. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | Las respuestas que contienen algo más que una lista, como los recuentos Sent y Failed de un lote. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | Lo que lanza el cliente. Las tres derivan de OpenEmailException. |
Constantes
El espacio de nombres OpenEmail.Constants contiene cada conjunto de valores que usa la API, generado a partir del SDK de TypeScript: eventos de webhook, ámbitos, estados y lo demás. Cada conjunto es una clase estática cuyos miembros son constantes, y Values los enumera todos.
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}");