Go
Utilidades y constantes
Lo que el paquete define además de los métodos del cliente.
Funciones
| Función | Qué es |
|---|---|
| openemail.New() | Un cliente. Lee del entorno todo lo que omitas, y client.Err() informa de una configuración que rechazó. |
| openemail.NewTempMail() | Un cliente para buzones desechables que no lleva ninguna clave de API. |
| openemail.VerifyWebhookSignature() | Comprueba la firma de una entrega en tiempo constante, con una ventana de cinco minutos que cambia openemail.WithTolerance, y devuelve el evento. |
| openemail.IsAPIKey(), openemail.IsAccessToken() | Si un valor tiene la forma de una clave de API o de un token de acceso. |
| openemail.IsSealed() | Si un mensaje está cifrado de extremo a extremo, de modo que la API no puede leer su cuerpo. |
| openemail.ResolveLanguage(), openemail.LanguageByCode(), openemail.IsRTLLanguage() | Busca un idioma por código, nombre en inglés o nombre propio, en la tabla que devuelve openemail.Languages(). |
| client.Request() | 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 |
|---|---|
| openemail.Body | El cuerpo de una petición, un map[string]any con los nombres de campo de la API. |
| openemail.Object | Una respuesta decodificada, con los lectores ID, String, Int, Float, Bool, Time, Object, Objects, Strings y Has. |
| openemail.Page | Una página de una lista: Items, HasMore y NextCursor. |
| openemail.Iterator | Un recorrido por todas las páginas: Next, Item, Err y All. |
| openemail.Error | Cada fallo, con Status, Type, Code, Param, DocURL, RequestID, RetryAfter, Fields y Body. |
Constantes
El paquete 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 miembro es una constante con el nombre de su conjunto, y cada conjunto de valores de texto tiene una función que los enumera.
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()))