C#
सहायक और स्थिरांक
क्लाइंट के मेथड के अलावा पैकेज और क्या परिभाषित करता है।
हेल्पर
| हेल्पर | यह क्या है |
|---|---|
| new OpenEmailClient() | एक क्लाइंट। जो कुछ आप छोड़ देते हैं उसे यह एनवायरनमेंट से पढ़ता है, और जिस कॉन्फ़िगरेशन को यह अस्वीकार करता है उसके लिए ArgumentException थ्रो करता है। |
| OpenEmailClient.CreateTempMail() | अस्थायी इनबॉक्स के लिए एक क्लाइंट जिसमें कोई API कुंजी नहीं होती। |
| OpenEmailClient.VerifyWebhookSignature() | किसी डिलीवरी के हस्ताक्षर को स्थिर समय में जाँचता है, पाँच मिनट की उस खिड़की के साथ जिसे toleranceSeconds: बदलता है, और इवेंट लौटाता है। |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | कोई मान API कुंजी या एक्सेस टोकन के रूप का है या नहीं। |
| OpenEmailClient.IsSealed() | कोई संदेश एंड टू एंड एन्क्रिप्टेड है या नहीं, जिसमें API उसकी बॉडी नहीं पढ़ सकता। |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | उस तालिका में कोड, अंग्रेज़ी नाम या अपने नाम से भाषा खोजता है जो Languages.All में रहती है। |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | किसी byte[] या Stream को base64 में एनकोड करता है, उस फ़ील्ड के लिए जो base64 टेक्स्ट लेता है। |
| client.Raw.RequestAsync() | ऐसा पाथ कॉल करता है जिसे अभी कोई मेथड नहीं लपेटता, क्लाइंट के क्रेडेंशियल और रीट्राई नीति के साथ। |
टाइप
| टाइप | यह क्या है |
|---|---|
| Body | अनुरोध बॉडी: API के फ़ील्ड नामों वाली एक डिक्शनरी, जो उसी क्रम में भेजी जाती है जिसमें उसकी कुंजियाँ जोड़ी गई थीं। |
| JsonObject | System.Text.Json.Nodes से आया डिकोड किया हुआ जवाब। किसी फ़ील्ड को sent["id"] से पढ़ें, और (string?)sent["id"] से कास्ट करें। |
| Page | किसी सूची का एक पेज: Items, HasMore और NextCursor। |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | वे जवाब जिनमें एक सूची से ज़्यादा कुछ होता है, जैसे किसी बैच की Sent और Failed गिनतियाँ। |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | जो क्लाइंट थ्रो करता है। तीनों OpenEmailException से निकले हैं। |
स्थिरांक
OpenEmail.Constants नेमस्पेस में मानों का हर वह समूह है जिसे API इस्तेमाल करता है, और यह TypeScript SDK से बनाया जाता है: वेबहुक इवेंट, स्कोप, स्टेटस और बाकी सब। हर समूह एक स्टैटिक क्लास है जिसके सदस्य कॉन्स्टेंट हैं, और Values उन सबको सूचीबद्ध करता है।
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}");