Go
Utilitaires et constantes
Ce que le package définit d'autre en plus des méthodes du client.
Fonctions
| Fonction | Ce que c'est |
|---|---|
| openemail.New() | Un client. Il lit dans l'environnement tout ce que vous omettez, et client.Err() signale une configuration qu'il a refusée. |
| openemail.NewTempMail() | Un client pour boîtes jetables qui ne porte aucune clé d'API. |
| openemail.VerifyWebhookSignature() | Vérifie la signature d'une livraison en temps constant, avec une fenêtre de cinq minutes que openemail.WithTolerance change, et renvoie l'événement. |
| openemail.IsAPIKey(), openemail.IsAccessToken() | Indique si une valeur a la forme d'une clé d'API ou d'un jeton d'accès. |
| openemail.IsSealed() | Indique si un message est chiffré de bout en bout, auquel cas l'API ne peut pas lire son corps. |
| openemail.ResolveLanguage(), openemail.LanguageByCode(), openemail.IsRTLLanguage() | Recherche une langue par code, nom anglais ou nom d'origine, dans la table que renvoie openemail.Languages(). |
| client.Request() | 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 |
|---|---|
| openemail.Body | Un corps de requête, une map[string]any avec les noms de champs de l'API. |
| openemail.Object | Une réponse décodée, avec les lecteurs ID, String, Int, Float, Bool, Time, Object, Objects, Strings et Has. |
| openemail.Page | Une page d'une liste : Items, HasMore et NextCursor. |
| openemail.Iterator | Un parcours de toutes les pages : Next, Item, Err et All. |
| openemail.Error | Chaque échec, avec Status, Type, Code, Param, DocURL, RequestID, RetryAfter, Fields et Body. |
Constantes
Le package 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 membre est une constante nommée d'après son ensemble, et chaque ensemble de valeurs textuelles a une fonction qui les énumère.
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()))