Zur Dokumentation springen
Go

Helfer und Konstanten

Was das Paket neben den Methoden des Clients noch definiert.

Funktionen

FunktionWas es ist
openemail.New()Ein Client. Er liest aus der Umgebung, was Sie weglassen, und client.Err() meldet eine Konfiguration, die er abgelehnt hat.
openemail.NewTempMail()Ein Client für Wegwerf-Postfächer, der keinen API-Schlüssel trägt.
openemail.VerifyWebhookSignature()Prüft die Signatur einer Zustellung in konstanter Zeit, mit einem Fenster von fünf Minuten, das openemail.WithTolerance ändert, und gibt das Ereignis zurück.
openemail.IsAPIKey(), openemail.IsAccessToken()Ob ein Wert die Form eines API-Schlüssels oder eines Zugriffstokens hat.
openemail.IsSealed()Ob eine Nachricht Ende-zu-Ende-verschlüsselt ist, sodass die API ihren Inhalt nicht lesen kann.
openemail.ResolveLanguage(), openemail.LanguageByCode(), openemail.IsRTLLanguage()Schlägt eine Sprache nach Code, englischem Namen oder Eigennamen in der Tabelle nach, die openemail.Languages() zurückgibt.
client.Request()Ruft einen Pfad auf, den noch keine Methode abdeckt, mit den Zugangsdaten und den Wiederholungsregeln des Clients.

Typen

TypWas es ist
openemail.BodyEin Anfragekörper, eine map[string]any mit den Feldnamen der API.
openemail.ObjectEine dekodierte Antwort mit den Lesemethoden ID, String, Int, Float, Bool, Time, Object, Objects, Strings und Has.
openemail.PageEine Seite einer Liste: Items, HasMore und NextCursor.
openemail.IteratorEin Durchlauf über alle Seiten: Next, Item, Err und All.
openemail.ErrorJeder Fehlschlag, mit Status, Type, Code, Param, DocURL, RequestID, RetryAfter, Fields und Body.

Konstanten

Das Paket constants enthält jede Wertemenge, die die API verwendet, erzeugt aus dem TypeScript-SDK: Webhook-Ereignisse, Scopes, Status und den Rest. Jedes Mitglied ist eine Konstante, die nach ihrer Menge benannt ist, und jede Menge von Textwerten hat eine Funktion, die sie auflistet.

constants.go
webhook, err := client.Webhooks.Create(ctx, openemail.Body{	"url":    "https://example.com/webhooks/openemail",	"events": []string{constants.WebhookEventsEmailReceived, constants.WebhookEventsEmailBounced},})if err != nil {	return err} fmt.Println(webhook.ID(), len(constants.WebhookEventsValues()))