C#
Auxiliares e constantes
O que mais o pacote define além dos métodos do cliente.
Utilitários
| Utilitário | O que é |
|---|---|
| new OpenEmailClient() | Um cliente. Lê do ambiente tudo o que omitir, e lança ArgumentException para uma configuração que recusa. |
| OpenEmailClient.CreateTempMail() | Um cliente para caixas descartáveis que não leva nenhuma chave de API. |
| OpenEmailClient.VerifyWebhookSignature() | Verifica a assinatura de uma entrega em tempo constante, com uma janela de cinco minutos que toleranceSeconds: altera, e devolve o evento. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | Se um valor tem a forma de uma chave de API ou de um token de acesso. |
| OpenEmailClient.IsSealed() | Se uma mensagem está cifrada de ponta a ponta, de modo que a API não consegue ler o seu corpo. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Procura uma língua por código, nome em inglês ou nome próprio, na tabela que Languages.All contém. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | Codifica um byte[] ou um Stream em base64, para um campo que aceita texto em base64. |
| client.Raw.RequestAsync() | 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 é |
|---|---|
| Body | O corpo de um pedido: um dicionário com os nomes de campo da API, enviado pela ordem em que as suas chaves foram acrescentadas. |
| JsonObject | Uma resposta descodificada, de System.Text.Json.Nodes. Leia um campo com sent["id"], e converta-o com (string?)sent["id"]. |
| Page | Uma página de uma lista: Items, HasMore e NextCursor. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | As respostas que contêm mais do que uma lista, como as contagens Sent e Failed de um lote. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | O que o cliente lança. As três derivam de OpenEmailException. |
Constantes
O namespace OpenEmail.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 conjunto é uma classe estática cujos membros são constantes, e Values enumera-os todos.
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}");