Belgelere geç
SDK

Türler ve yardımcılar

Paketin başka neleri dışa aktardığı.

Çalışma zamanı dışa aktarımları

Dışa aktarımNedir
`init`, `openemail`Paylaşılan istemciyi bir kez yapılandırın, sonra openemail'i istediğiniz yerde içe aktarın. init hiç çalışmadıysa kendini OPENEMAIL_API_KEY üzerinden kurar.
`getClient`, `resetClient`Paylaşılan istemcinin kendisi ve bir sonraki çağrının yenisini kurması için onu bırakmanın yolu; bir testin durumlar arasında istediği şey budur.
`createOpenEmail`, `createClient`, `OpenEmail`Ayrı bir istemci. createOpenEmail, belirtmediğiniz her şey için ortamı okur (createClient aynı fonksiyondur) ve new OpenEmail (aynı zamanda varsayılan dışa aktarım) yalnızca verdiklerinizi alır.
`createTempMail`Hiç API anahtarı taşımayan bir tek kullanımlık gelen kutusu istemcisi; paketin tarayıcıda çalışan tek bölümü.
`OpenEmailApiError`, `OpenEmailNetworkError`İki hata sınıfı.
`verifyWebhookSignature`Sabit zamanlı, bir tekrar oynatma penceresiyle. Ayrıştırılmış yükü döndürür ve herhangi bir başarısızlıkta hata fırlatır.
`toBase64`Parçalı; ek dosya baytları için.
`isApiKey`Bir dizgenin oe_live_ veya oe_test_ biçiminde olup olmadığı. Bir biçim denetimidir, anahtarın hâlâ çalıştığının kanıtı değil.
`isSealed`, `MESSAGE_ENCRYPTION_FORMATS`Bir mesajın gövdesinin şifreli metin olup olmadığı ve alım sürecinin adlandırabileceği beş zarf. isSealed, gövdeleri açık hâlde gelen iki SIGNED biçimi için false'tur; bu yüzden çağıranın birleşim tipinden türetmesine bırakılmak yerine paketle birlikte gelir.
`LANGUAGES`, `resolveLanguage`, `languageByCode`, `isRtlLanguage`Pakete gömülü dil tablosu ve bir dil seçicinin ihtiyaç duyduğu aramalar.
`API_SCOPES`Kapsam sözlüğü; bir anahtar oluşturma ekranı için.
`WEBHOOK_EVENTS`, `WEBHOOK_SIGNATURE_HEADERS`Bir uç noktanın abone olabileceği olaylar ve bir teslimatın taşıdığı başlıkların adları.
`RULE_FIELDS`, `RULE_OPERATORS`, `RULE_ACTIONS`Bir kuralın koşullarının ve eylemlerinin kurulduğu sözlük.
`PAGE_LIMITS`Sayfalanan bir listede en büyük ve varsayılan limit değerleri: 100 ve 25.
`ERROR_TYPES`Donmuş hata sözlüğü.
`VERSION`Paket sürümü.

Türler

Her isteğin ve yanıtın bir tipi vardır ve bunlar paket kökünden dışa aktarılır. Derin içe aktarım yoktur; dolayısıyla dosya düzeni, bir ana sürüm gerektirmeden taşınabilecek bir uygulama ayrıntısı olarak kalır. …Resource API'nin döndürdüğü, …Create, …Patch, …Input ve …Send sizin geçirdiğiniz tiplerdir; …Options ise filtreleri ve çağrı başına seçenekleri tutar.

  • İstemci: ClientOptions, TempMailOptions, TransportOptions, RequestOptions, RequestScope, SendScope, InboxScope, ListOptions, Page, ApiKeyMode, FetchLike.
  • Hatalar: ErrorType, ApiErrorPayload, ApiErrorProps.
  • E-postalar: EmailSend, EmailListOptions, EmailTranslate, EmailResource, SentEmailResource, EmailRecipientResource, EmailEventResource, EmailStatus, EmailSource, EmailTransport, EmailTrackingSummary, EmailTranslationResource, TranslationResource, RecipientStatus, BatchItemResource, BatchResultResource.
  • Şablonlar: TemplateCreate, TemplatePatch, TemplateContent, TemplateListOptions, TemplatePreviewInput, TemplateSend, TemplateResource, TemplateDetailResource, TemplateVersionResource, TemplatePreviewResource, SentTemplateEmailResource, DeletedTemplateResource, TemplateEngine, TemplateProp, TemplateSlot, TemplateStatus, TemplateValueKind.
  • İzleme: TrackingListOptions, TrackingStatsOptions, TrackingHitOptions, TrackingResource, TrackingSummary, TrackingRecipientResource, TrackingLinkResource, TrackingOpenResource, TrackingClickResource, TrackingStatsResource, TrackingGrain.
  • İleti dizileri ve taslaklar: ThreadListOptions, ThreadPatch, ThreadResource, ThreadSummaryResource, UpdatedThreadResource, TrashedThreadResource, SnoozedThreadResource, DraftInput, DraftListOptions, DraftResource, DraftSummaryResource, SavedDraftResource, DeletedDraftResource.
  • Etiketler, kişiler, alan adları ve adresler: LabelInput, LabelColor, LabelResource, SavedLabelResource, DeletedLabelResource, ContactCreate, ContactPatch, ContactListOptions, ContactSource, ContactResource, ContactDetailResource, ContactAudienceResource, DeletedContactResource, DomainPatch, DomainResource, DomainDetailResource, DomainSendingState, DomainTracking, DomainTrackingState, AddressBookResource, AddressResource, SendableDomainResource.
  • Kurallar: RuleCreate, RulePatch, RuleListOptions, RuleRunListOptions, RuleTestInput, RuleResource, RuleRunResource, RuleTestResource, DeletedRuleResource, RuleCondition, RuleConditionInput, RuleAction, RuleActionType, RuleField, RuleOperator.
  • Webhook'lar: WebhookCreate, WebhookPatch, WebhookResource, CreatedWebhookResource, DeletedWebhookResource, WebhookDeliveryResource, WebhookTestResource, WebhookEvent, WebhookPayload, EmailOpenedData, EmailClickedData, EmailDownloadedData, VerifyWebhookProps, WebhookSignatureHeaders.
  • Takvim ve ayarlar: CalendarRangeOptions, CalendarOccurrenceResource, CalendarEventResource, CalendarAttendeeResource, SettingsPatch, SettingsResource.
  • Roller, üyeler ve anahtarlar: RoleCreate, RolePatch, RoleDeleteOptions, RoleResource, DeletedRoleResource, PermissionResource, MemberAdd, MemberPatch, MemberAddressGrant, MemberResource, MemberAddressResource, RemovedMemberResource, MemberAccess, KeyResource, PingResource.
  • Tek kullanımlık gelen kutuları: TempInboxCreate, TempMessageListOptions, TempInboxResource, CreatedTempInboxResource, DeletedTempInboxResource, TempDomainResource, TempMessageResource, TempMessagesResource, TempMessageDetailResource, DeletedTempMessageResource.
  • Paylaşılan: RecipientInput, AttachmentInput, AttachmentResource, MessageResource, MessageEncryption, MessageEncryptionFormat, TrackingRequest, TranslateOptions, SendTranslateOptions, LanguageResource, ApiScope, Permission, BuiltinRole, HitKind.

Henüz sarmalanmayan bir uç nokta

Bir SDK sürümü, hâlihazırda çalışan bir uç nokta ile aranıza asla girmemelidir. openemail.raw.request() bir yol ve seçenekler alır ve istemcinin anahtarı, temel URL'si, zaman aşımı ve yeniden deneme politikası uygulanmış hâlde, ayrıştırılmış gövdeyle sonuçlanır.

escape-hatch.ts
const result = await openemail.raw.request<Whatever>('/something-new', {  method: 'POST',  query: { dryRun: true },  body: { name: 'Invoices' },  repeatable: true,})

GET, diğer tüm okumalar gibi yeniden denenir. Diğer tüm yöntemler, iki kez gönderilebileceğine dair beyanınız olan repeatable: true iletmediğiniz sürece bir kez gönderilir. query, undefined olan değerleri atlar; signal ise diğer tüm yöntemlerde olduğu gibi çalışır.

Bilerek yapmadıkları

  • Hiçbir istek gövdesini doğrulamaz. Kuralların tek kopyası sunucunun şemasıdır; buradaki ikinci bir kopya er ya da geç, birinin iki yıl önce sabitlediği bir sürümde, daha yeni bir sunucunun kabul ettiği bir adresi reddederdi.
  • Ne zod ne de herhangi bir çalışma zamanı bağımlılığı içerir.
  • Bir yanıtı yalnızca tek bir biçimde yeniden şekillendirir: bir koleksiyonun data dizisi zarfından çıkarılır. Sayfalanmış bir liste bunu hasMore ve nextCursor yanında items olarak, emails.sendBatch sent ve failed yanında items olarak, tempMail.listMessages expiresAt yanında items olarak ve addresses.list unrestricted ve domains yanında addresses olarak geri verir. Diğer her yerde düz bir dizidir. İçindeki her kaynak, belgelenen HTTP biçimini korur.

Paketin eşleşme denetimi bunu dürüst tutar. Belgelenmiş bir işlemin karşılığında bir yöntem yoksa, bir yöntem OpenAPI belgesinde bulunmayan bir işleme işaret ediyor ya da farklı bir istek gönderiyorsa ve bir yöntem işlemin gerektirmediği kapsamları bildiriyorsa derlemeyi başarısız kılar.