Go
کمکی‌ها و ثابت‌ها
آنچه بسته جز متدهای کلاینت تعریف می‌کند.
تابع‌ها
| تابع | چیست |
|---|---|
| openemail.New() | یک کلاینت. هر چه را ننویسید از محیط می‌خواند، و client.Err() پیکربندی‌ای را که رد کرده گزارش می‌کند. |
| openemail.NewTempMail() | کلاینتی برای صندوق‌های موقت که هیچ کلید API ندارد. |
| openemail.VerifyWebhookSignature() | امضای یک تحویل را در زمان ثابت بررسی می‌کند، با پنجره‌ای پنج‌دقیقه‌ای که openemail.WithTolerance تغییرش می‌دهد، و رویداد را برمی‌گرداند. |
| openemail.IsAPIKey(), openemail.IsAccessToken() | اینکه یک مقدار شکل کلید API یا توکن دسترسی را دارد یا نه. |
| openemail.IsSealed() | اینکه یک پیام سرتاسری رمزگذاری شده است یا نه، که در آن صورت API نمی‌تواند بدنه‌اش را بخواند. |
| openemail.ResolveLanguage(), openemail.LanguageByCode(), openemail.IsRTLLanguage() | یک زبان را با کد، نام انگلیسی یا نام بومی‌اش در جدولی که openemail.Languages() برمی‌گرداند جست‌وجو می‌کند. |
| client.Request() | مسیری را که هنوز هیچ متدی آن را نمی‌پوشاند، با اعتبارنامه و سیاست تلاش دوبارهٔ کلاینت فراخوانی می‌کند. |
تایپ‌ها
| نوع | چیست |
|---|---|
| openemail.Body | بدنهٔ درخواست، یک map[string]any با نام فیلدهای API. |
| openemail.Object | پاسخ رمزگشایی‌شده، با خواننده‌های ID، String، Int، Float، Bool، Time، Object، Objects، Strings و Has. |
| openemail.Page | یک صفحه از یک فهرست: Items، HasMore و NextCursor. |
| openemail.Iterator | پیمایشی روی همهٔ صفحه‌ها: Next، Item، Err و All. |
| openemail.Error | هر شکست، با Status، Type، Code، Param، DocURL، RequestID، RetryAfter، Fields و Body. |
ثابت‌ها
بستهٔ constants هر مجموعه از مقدارهایی را که API به کار می‌برد در خود دارد و از 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()))