C#
Ndihmësit dhe konstantet
Çfarë tjetër përcakton paketa përveç metodave të klientit.
Ndihmësit
| Ndihmësi | Çfarë është |
|---|---|
| new OpenEmailClient() | Një klient. Lexon nga mjedisi gjithçka që e lini jashtë, dhe hedh ArgumentException për një konfigurim që e refuzon. |
| OpenEmailClient.CreateTempMail() | Një klient për kutitë e përkohshme që nuk mban asnjë çelës API. |
| OpenEmailClient.VerifyWebhookSignature() | Kontrollon nënshkrimin e një dorëzimi në kohë konstante, me një dritare pesëminutëshe që e ndryshon toleranceSeconds:, dhe kthen ngjarjen. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | Nëse një vlerë ka formën e një çelësi API ose të një tokeni aksesi. |
| OpenEmailClient.IsSealed() | Nëse një mesazh është i enkriptuar nga skaji në skaj, kështu që API-ja nuk mund ta lexojë trupin e tij. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Kërkon një gjuhë sipas kodit, emrit në anglisht ose emrit të vet, në tabelën që mban Languages.All. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | Kodon një byte[] ose një Stream si base64, për një fushë që merr tekst base64. |
| client.Raw.RequestAsync() | Thërret një shteg që ende nuk e mbështjell asnjë metodë, me kredencialin dhe rregullat e riprovimit të klientit. |
Tipet
| Tipi | Çfarë është |
|---|---|
| Body | Trupi i një kërkese: një fjalor me emrat e fushave të API-së, i dërguar sipas radhës në të cilën u shtuan çelësat e tij. |
| JsonObject | Një përgjigje e dekoduar, nga System.Text.Json.Nodes. Lexoni një fushë me sent["id"], dhe shndërrojeni me (string?)sent["id"]. |
| Page | Një faqe e një liste: Items, HasMore dhe NextCursor. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | Përgjigjet që mbajnë më shumë se një listë, si numërimet Sent dhe Failed të një grupi. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | Çfarë hedh klienti. Të treja rrjedhin nga OpenEmailException. |
Konstantet
Hapësira e emrave OpenEmail.Constants mban çdo bashkësi vlerash që përdor API-ja, të gjeneruar nga SDK-ja TypeScript: ngjarjet e webhook-ëve, scope-t, statuset dhe të tjerat. Çdo bashkësi është një klasë statike anëtarët e së cilës janë konstante, dhe Values i rendit të gjitha.
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}");