C#
Helfer und Konstanten
Was das Paket neben den Methoden des Clients noch definiert.
Hilfsfunktionen
| Hilfsfunktion | Was es ist |
|---|---|
| new OpenEmailClient() | Ein Client. Er liest aus der Umgebung, was Sie weglassen, und löst ArgumentException für eine Konfiguration aus, die er ablehnt. |
| OpenEmailClient.CreateTempMail() | Ein Client für Wegwerf-Postfächer, der keinen API-Schlüssel trägt. |
| OpenEmailClient.VerifyWebhookSignature() | Prüft die Signatur einer Zustellung in konstanter Zeit, mit einem Fenster von fünf Minuten, das toleranceSeconds: ändert, und gibt das Ereignis zurück. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | Ob ein Wert die Form eines API-Schlüssels oder eines Zugriffstokens hat. |
| OpenEmailClient.IsSealed() | Ob eine Nachricht Ende-zu-Ende-verschlüsselt ist, sodass die API ihren Inhalt nicht lesen kann. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Schlägt eine Sprache nach Code, englischem Namen oder Eigennamen in der Tabelle nach, die Languages.All enthält. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | Kodiert ein byte[] oder einen Stream als Base64, für ein Feld, das Base64-Text nimmt. |
| client.Raw.RequestAsync() | Ruft einen Pfad auf, den noch keine Methode abdeckt, mit den Zugangsdaten und den Wiederholungsregeln des Clients. |
Typen
| Typ | Was es ist |
|---|---|
| Body | Ein Anfragekörper: ein Dictionary mit den Feldnamen der API, gesendet in der Reihenfolge, in der seine Schlüssel hinzugefügt wurden. |
| JsonObject | Eine dekodierte Antwort aus System.Text.Json.Nodes. Lesen Sie ein Feld mit sent["id"] und wandeln Sie es mit (string?)sent["id"] um. |
| Page | Eine Seite einer Liste: Items, HasMore und NextCursor. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | Die Antworten, die mehr als eine Liste enthalten, etwa die Zähler Sent und Failed eines Stapels. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | Was der Client auslöst. Alle drei leiten von OpenEmailException ab. |
Konstanten
Der Namespace OpenEmail.Constants enthält jede Wertemenge, die die API verwendet, erzeugt aus dem TypeScript-SDK: Webhook-Ereignisse, Scopes, Status und den Rest. Jede Menge ist eine statische Klasse, deren Mitglieder Konstanten sind, und Values listet sie alle auf.
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}");