Go
Auxiliares e constantes
O que mais o pacote define além dos métodos do cliente.
Funções
| Função | O que é |
|---|---|
| openemail.New() | Um cliente. Lê do ambiente tudo o que omitir, e client.Err() comunica uma configuração que ele recusou. |
| openemail.NewTempMail() | Um cliente para caixas descartáveis que não leva nenhuma chave de API. |
| openemail.VerifyWebhookSignature() | Verifica a assinatura de uma entrega em tempo constante, com uma janela de cinco minutos que openemail.WithTolerance altera, e devolve o evento. |
| openemail.IsAPIKey(), openemail.IsAccessToken() | Se um valor tem a forma de uma chave de API ou de um token de acesso. |
| openemail.IsSealed() | Se uma mensagem está cifrada de ponta a ponta, de modo que a API não consegue ler o seu corpo. |
| openemail.ResolveLanguage(), openemail.LanguageByCode(), openemail.IsRTLLanguage() | Procura uma língua por código, nome em inglês ou nome próprio, na tabela que openemail.Languages() devolve. |
| client.Request() | Chama um caminho que nenhum método envolve ainda, com a credencial e a política de novas tentativas do cliente. |
Tipos
| Tipo | O que é |
|---|---|
| openemail.Body | O corpo de um pedido, um map[string]any com os nomes de campo da API. |
| openemail.Object | Uma resposta descodificada, com os leitores ID, String, Int, Float, Bool, Time, Object, Objects, Strings e Has. |
| openemail.Page | Uma página de uma lista: Items, HasMore e NextCursor. |
| openemail.Iterator | Um percurso por todas as páginas: Next, Item, Err e All. |
| openemail.Error | Cada falha, com Status, Type, Code, Param, DocURL, RequestID, RetryAfter, Fields e Body. |
Constantes
O pacote constants contém cada conjunto de valores que a API usa, gerado a partir do SDK de TypeScript: eventos de webhook, âmbitos, estados e o resto. Cada membro é uma constante com o nome do seu conjunto, e cada conjunto de valores de texto tem uma função que os 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()))