C#
ヘルパーと定数
クライアントのメソッド以外にパッケージが定義しているもの。
ヘルパー
| ヘルパー | 内容 |
|---|---|
| new OpenEmailClient() | クライアント。省略したものはすべて環境から読み取り、拒否する設定に対しては ArgumentException をスローします。 |
| OpenEmailClient.CreateTempMail() | API キーを持たない、使い捨て受信箱用のクライアントです。 |
| OpenEmailClient.VerifyWebhookSignature() | 配信の署名を定数時間で確認し、イベントを返します。5 分の許容時間は toleranceSeconds: で変更できます。 |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | 値が API キーまたはアクセストークンの形式かどうかを返します。 |
| OpenEmailClient.IsSealed() | メッセージがエンドツーエンドで暗号化されていて、API が本文を読めないかどうかを返します。 |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Languages.All が持つ表から、コード、英語名、または現地語名で言語を検索します。 |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | base64 テキストを受け取るフィールドのために、byte[] または Stream を base64 にエンコードします。 |
| client.Raw.RequestAsync() | まだメソッドが用意されていないパスを、クライアントの資格情報と再試行ポリシーで呼び出します。 |
型
| 型 | 内容 |
|---|---|
| Body | リクエストボディ。API のフィールド名を持つディクショナリで、キーを追加した順に送信されます。 |
| JsonObject | System.Text.Json.Nodes のデコード済みレスポンス。フィールドは sent["id"] で読み取り、(string?)sent["id"] でキャストします。 |
| Page | リストの 1 ページ分。Items、HasMore、NextCursor を持ちます。 |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | リスト以上の情報を持つ応答。たとえばバッチの Sent と Failed の件数です。 |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | クライアントがスローするもの。3 つとも OpenEmailException から派生しています。 |
定数
OpenEmail.Constants 名前空間には、API が使うすべての値のセットが入っています。Webhook イベント、スコープ、ステータスなどで、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}");