Go
ヘルパーと定数
クライアントのメソッド以外にパッケージが定義しているもの。
関数
| 関数 | 内容 |
|---|---|
| openemail.New() | クライアントです。省略したものは環境から読み込み、拒否した設定は client.Err() が報告します。 |
| openemail.NewTempMail() | API キーを持たない、使い捨て受信箱用のクライアントです。 |
| openemail.VerifyWebhookSignature() | 配信の署名を定数時間で確認し、イベントを返します。5 分の許容時間は openemail.WithTolerance で変更できます。 |
| openemail.IsAPIKey(), openemail.IsAccessToken() | 値が API キーまたはアクセストークンの形式かどうかを返します。 |
| openemail.IsSealed() | メッセージがエンドツーエンドで暗号化されていて、API が本文を読めないかどうかを返します。 |
| openemail.ResolveLanguage(), openemail.LanguageByCode(), openemail.IsRTLLanguage() | openemail.Languages() が返す表から、コード、英語名、または現地語名で言語を検索します。 |
| client.Request() | まだメソッドが用意されていないパスを、クライアントの資格情報と再試行ポリシーで呼び出します。 |
型
| 型 | 内容 |
|---|---|
| openemail.Body | リクエストボディ。API のフィールド名を持つ map[string]any です。 |
| openemail.Object | デコードされたレスポンス。読み取りメソッドは ID、String、Int、Float、Bool、Time、Object、Objects、Strings、Has です。 |
| openemail.Page | リストの 1 ページ分。Items、HasMore、NextCursor を持ちます。 |
| openemail.Iterator | すべてのページの走査。Next、Item、Err、All を持ちます。 |
| openemail.Error | すべての失敗。Status、Type、Code、Param、DocURL、RequestID、RetryAfter、Fields、Body を持ちます。 |
定数
constants パッケージには、API が使うすべての値のセットが入っています。Webhook イベント、スコープ、ステータスなどで、TypeScript SDK から生成されます。各メンバーはセットにちなんだ名前の定数で、テキスト値のセットにはそれぞれ値を一覧する関数があります。
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()))