C#
Utilitaires et constantes
Ce que le package définit d'autre en plus des méthodes du client.
Utilitaires
| Utilitaire | Ce que c'est |
|---|---|
| new OpenEmailClient() | Un client. Il lit dans l'environnement tout ce que vous omettez, et lève ArgumentException pour une configuration qu'il refuse. |
| OpenEmailClient.CreateTempMail() | Un client pour boîtes jetables qui ne porte aucune clé d'API. |
| OpenEmailClient.VerifyWebhookSignature() | Vérifie la signature d'une livraison en temps constant, avec une fenêtre de cinq minutes que toleranceSeconds: change, et renvoie l'événement. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | Indique si une valeur a la forme d'une clé d'API ou d'un jeton d'accès. |
| OpenEmailClient.IsSealed() | Indique si un message est chiffré de bout en bout, auquel cas l'API ne peut pas lire son corps. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Recherche une langue par code, nom anglais ou nom d'origine, dans la table que contient Languages.All. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | Encode un byte[] ou un Stream en base64, pour un champ qui prend du texte en base64. |
| client.Raw.RequestAsync() | Appelle un chemin qu'aucune méthode ne couvre encore, avec l'identifiant et la politique de nouvelles tentatives du client. |
Types
| Type | Ce que c'est |
|---|---|
| Body | Un corps de requête : un dictionnaire avec les noms de champs de l'API, envoyé dans l'ordre où ses clés ont été ajoutées. |
| JsonObject | Une réponse décodée, issue de System.Text.Json.Nodes. Lisez un champ avec sent["id"], et convertissez-le avec (string?)sent["id"]. |
| Page | Une page d'une liste : Items, HasMore et NextCursor. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | Les réponses qui contiennent plus qu'une liste, comme les compteurs Sent et Failed d'un lot. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | Ce que le client lève. Les trois dérivent d'OpenEmailException. |
Constantes
L'espace de noms OpenEmail.Constants contient chaque ensemble de valeurs que l'API utilise, généré à partir du SDK TypeScript : événements de webhook, portées, statuts et le reste. Chaque ensemble est une classe statique dont les membres sont des constantes, et Values les énumère tous.
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}");