TypeScript SDK types
Every type of the API the TypeScript SDK names, as TypeScript: each one's fields, and the methods that take or answer it.
The API's schemas are types of the SDK by their own names (Domain, Route, MessageMeta), all 314 of them here. A method's own types, its body's, its options' and its answer's, are named after it (MessagesSendBody, MessagesListOptions) and printed on its page. Every type is exported by the package: import type { Domain } from '@openemail/sdk'. So is every set of values a type names, as a constant in capitals its type derives from (ROUTE_DESTINATION_TYPES, LABEL_INFO_ROLES): import { ROUTE_DESTINATION_TYPES } from '@openemail/sdk'.
| Type | What it is |
|---|---|
Account | The Account type of the TypeScript SDK, which accounts.get and accounts.restore take or answer. |
AccountDeleteResult | The AccountDeleteResult type of the TypeScript SDK, which accounts.delete take or answer. |
AccountEvents | The AccountEvents type of the TypeScript SDK, which accounts.listEvents take or answer. |
AccountLimitInForce | The AccountLimitInForce type of the TypeScript SDK, part of AccountLimitsLimits. |
AccountLimits | The AccountLimits type of the TypeScript SDK, which accounts.getLimits take or answer. |
AccountLimitsLimits | Every plan limit, keyed by its field name on GET and PATCH /accounts/:accountId, which describe what each bounds. Each NULL value follows its platform default… |
AccountReceiveUsage | The AccountReceiveUsage type of the TypeScript SDK, which accounts.getReceiveUsage take or answer. |
AccountReceiveUsageTopMailboxesItem | The AccountReceiveUsageTopMailboxesItem type of the TypeScript SDK, part of AccountReceiveUsage. |
AccountRequests | The AccountRequests type of the TypeScript SDK, which accounts.getRequests take or answer. |
AccountRetention | The AccountRetention type of the TypeScript SDK, which accounts.listRetention and 2 more methods take or answer. |
AccountRetentionRow | The AccountRetentionRow type of the TypeScript SDK, which accounts.listRetention take or answer. |
AccountSendUsage | The AccountSendUsage type of the TypeScript SDK, which accounts.getSendUsage take or answer. |
AccountSendUsageCreates | The AccountSendUsageCreates type of the TypeScript SDK, part of AccountSendUsage. |
AccountSendUsageSend | The AccountSendUsageSend type of the TypeScript SDK, part of AccountSendUsage. |
AccountStorageUsage | The AccountStorageUsage type of the TypeScript SDK, which accounts.getStorageUsage take or answer. |
AccountTraffic | The AccountTraffic type of the TypeScript SDK, which accounts.getTraffic take or answer. |
AccountTrafficEvent | The AccountTrafficEvent type of the TypeScript SDK, which accounts.listEvents take or answer. |
AccountTrafficTotals | The AccountTrafficTotals type of the TypeScript SDK, part of AccountTraffic. |
AccountUsage | The AccountUsage type of the TypeScript SDK, which accounts.getUsage take or answer. |
AddressList | The AddressList type of the TypeScript SDK, which accountAddressLists.create and 7 more methods take or answer. |
AddressListBatchResult | The AddressListBatchResult type of the TypeScript SDK, which accountAddressLists.addEntries and 3 more methods take or answer. |
AddressListEntry | The AddressListEntry type of the TypeScript SDK, which accountAddressLists.addEntry and 3 more methods take or answer. |
AddressListEntryPage | The AddressListEntryPage type of the TypeScript SDK, which accountAddressLists.listEntries and mailboxAddressLists.listEntries take or answer. |
AddressListPage | The AddressListPage type of the TypeScript SDK, which accountAddressLists.list and mailboxAddressLists.list take or answer. |
AddressListVerdict | The AddressListVerdict type of the TypeScript SDK, which accountAddressLists.evaluate and mailboxAddressLists.evaluate take or answer. |
AddressListVerdictAllowUnvouched | Message simulation only: an allow MATCHED an identity that no SPF pass, DMARC pass or local submission vouched for, so it could not fire. The usual answer to… |
ApiKey | The ApiKey type of the TypeScript SDK, which apiKeys.list take or answer. |
ApiKeyCreated | The ApiKeyCreated type of the TypeScript SDK, which apiKeys.create take or answer. |
AppendResult | The AppendResult type of the TypeScript SDK, which messages.append and messages.compose take or answer. |
AppendResultDelivered | The AppendResultDelivered type of the TypeScript SDK, part of AppendResult. |
AppendResultFiltered | The AppendResultFiltered type of the TypeScript SDK, part of AppendResult. |
AttachmentRef | The AttachmentRef type of the TypeScript SDK, part of ContentResult. |
AuditEvent | The AuditEvent type of the TypeScript SDK, which accounts.listAudit take or answer. |
BatchDeleteEntry | The BatchDeleteEntry type of the TypeScript SDK, part of BatchDeleteResult. |
BatchDeleteResult | The BatchDeleteResult type of the TypeScript SDK, which messages.deleteMany take or answer. |
BatchLearnEntry | The BatchLearnEntry type of the TypeScript SDK, part of BatchLearnResult. |
BatchLearnResult | The BatchLearnResult type of the TypeScript SDK, which messages.learnMany take or answer. |
BatchRestoreEntry | The BatchRestoreEntry type of the TypeScript SDK, part of BatchRestoreResult. |
BatchRestoreResult | The BatchRestoreResult type of the TypeScript SDK, which messages.restoreMany take or answer. |
BatchUnjunkEntry | The BatchUnjunkEntry type of the TypeScript SDK, part of BatchUnjunkResult. |
BatchUnjunkResult | The BatchUnjunkResult type of the TypeScript SDK, which messages.unjunk take or answer. |
BatchUntrashEntry | The BatchUntrashEntry type of the TypeScript SDK, part of BatchUntrashResult. |
BatchUntrashResult | The BatchUntrashResult type of the TypeScript SDK, which messages.untrash take or answer. |
BatchUpdateEntry | The BatchUpdateEntry type of the TypeScript SDK, part of BatchUpdateResult. |
BatchUpdateResult | The BatchUpdateResult type of the TypeScript SDK, which messages.updateMany take or answer. |
ContactSuggestion | The ContactSuggestion type of the TypeScript SDK, part of ContactSuggestions. |
ContactSuggestions | The ContactSuggestions type of the TypeScript SDK, which contacts.suggest take or answer. |
ContentAddress | The ContentAddress type of the TypeScript SDK, part of ContentHeaders and 3 more types. |
ContentBody | The ContentBody type of the TypeScript SDK, part of ContentResult. |
ContentHeaders | Message headers. |
ContentResult | The ContentResult type of the TypeScript SDK, which messages.getContent take or answer. |
CreatedIdentity | The CreatedIdentity type of the TypeScript SDK, which identities.create take or answer. |
CreatedLabel | The CreatedLabel type of the TypeScript SDK, which labels.create take or answer. |
Credential | The Credential type of the TypeScript SDK, which credentials.list take or answer. |
CredentialCreated | The CredentialCreated type of the TypeScript SDK, which credentials.create take or answer. |
CredentialCreatedAppPassword | The CredentialCreatedAppPassword type of the TypeScript SDK, part of CredentialCreated. |
CredentialCreatedPassword | The CredentialCreatedPassword type of the TypeScript SDK, part of CredentialCreated. |
DeletedMailbox | The DeletedMailbox type of the TypeScript SDK, which identities.list take or answer. |
DeletedResult | The DeletedResult type of the TypeScript SDK, which verifiedRecipients.remove and 18 more methods take or answer. |
DeliverResult | The DeliverResult type of the TypeScript SDK, which mta.submitOutbound and mta.deliverInbound take or answer. |
DeliverResultDelivered | The DeliverResultDelivered type of the TypeScript SDK, part of DeliverResult. |
DeliverResultFiltered | The DeliverResultFiltered type of the TypeScript SDK, part of DeliverResult. |
DeliverResultQueued | The DeliverResultQueued type of the TypeScript SDK, part of DeliverResult. |
DmarcBlocker | The DmarcBlocker type of the TypeScript SDK, part of DmarcReadiness. |
DmarcReadiness | Policy enforcement readiness analysis. |
DmarcReport | The DmarcReport type of the TypeScript SDK, which dmarc.listReports take or answer. |
DmarcSource | The DmarcSource type of the TypeScript SDK, part of DomainDmarc and 1 more types. |
DnsRecord | The DnsRecord type of the TypeScript SDK, part of DnsRecordCheck. |
DnsRecordCheck | The DnsRecordCheck type of the TypeScript SDK, which domains.create take or answer. |
DnsStatus | The DnsStatus type of the TypeScript SDK, part of Domain and 1 more types. |
Domain | The Domain type of the TypeScript SDK, which domains.create and 3 more methods take or answer. |
DomainBranding | The DomainBranding type of the TypeScript SDK, which domains.getBranding and 2 more methods take or answer. |
DomainBrandingPatch | The DomainBrandingPatch type of the TypeScript SDK, which domains.setBranding take or answer. |
DomainDmarc | The DomainDmarc type of the TypeScript SDK, which dmarc.getSummary take or answer. |
DomainDmarcReports | The DomainDmarcReports type of the TypeScript SDK, which dmarc.listReports take or answer. |
DomainDmarcSources | The DomainDmarcSources type of the TypeScript SDK, which dmarc.listSources take or answer. |
DomainDmarcTotals | The DomainDmarcTotals type of the TypeScript SDK, part of DomainDmarc. |
DomainDnsCheck | The DomainDnsCheck type of the TypeScript SDK, which domains.checkDns take or answer. |
DomainEvents | The DomainEvents type of the TypeScript SDK, which domains.listEvents take or answer. |
DomainHostname | The DomainHostname type of the TypeScript SDK, part of DomainHostnameList. |
DomainHostnameList | The DomainHostnameList type of the TypeScript SDK, which hostnames.list and 2 more methods take or answer. |
DomainTraffic | The DomainTraffic type of the TypeScript SDK, which domains.getTraffic take or answer. |
DomainTrafficTotals | The DomainTrafficTotals type of the TypeScript SDK, part of DomainTraffic. |
DomainUsage | The DomainUsage type of the TypeScript SDK, which domains.getUsage take or answer. |
DomainUsageDay | The DomainUsageDay type of the TypeScript SDK, part of DomainUsage. |
EmailSearchComparator | An RFC 8620 §5.5 Comparator: {property, isAscending?, keyword?}. property is one of receivedAt|size|sentAt|from|subject|hasKeyword (a hasKeyword comparator… |
EmailSearchCondition | An RFC 8621 §4.4 FilterCondition; every key optional, conditions in one object AND together. At most one full-text condition (text/subject/body) per filter… |
EmailSearchFilter | An RFC 8621 §4.4 FilterCondition, or a boolean tree of them ({operator: AND|OR|NOT, conditions: [...]}). Bounded, and refused (never truncated) past the bound… |
EmailSearchFilterOperator | A boolean combination of nested EmailSearchFilter nodes. Full-text conditions may not appear under OR or NOT. |
EmailSearchRequest | The EmailSearchRequest type of the TypeScript SDK, which search.query take or answer. |
EmailSearchResult | The EmailSearchResult type of the TypeScript SDK, which search.query take or answer. |
EmailSearchSnippet | The EmailSearchSnippet type of the TypeScript SDK, which search.fullText take or answer. |
EmailSearchSnippetsRequest | The EmailSearchSnippetsRequest type of the TypeScript SDK, which search.snippets take or answer. |
EmailSearchSnippetsResult | The EmailSearchSnippetsResult type of the TypeScript SDK, which search.snippets take or answer. |
EmptyTrashResult | The EmptyTrashResult type of the TypeScript SDK, which messages.deleteMany take or answer. |
ErrorBody | The ErrorBody type of the TypeScript SDK, part of ErrorOrValidation. |
ErrorOrValidation | What the API answers a failed call with: an ErrorBody, or for validation_failed a ValidationError with its issues. A RequestError carries it as its body. |
EventWebhook | The EventWebhook type of the TypeScript SDK, which domains.getEventWebhook and 3 more methods take or answer. |
EventWebhookActor | Who caused it, or null when the platform did (a delivery, a retention sweep). |
EventWebhookEvent | The EventWebhookEvent type of the TypeScript SDK, part of EventWebhookPayload. |
EventWebhookPayload | What parseEventWebhook answers: the batch of events an event webhook posts to your endpoint, its signature checked first. |
EventWebhookPayloadSequence | The contiguous outbox range this batch drains; store batches only. |
EventWebhookTestResult | The EventWebhookTestResult type of the TypeScript SDK, which domains.testEventWebhook and mailboxes.testEventWebhook take or answer. |
ExpungeNotice | The ExpungeNotice type of the TypeScript SDK, part of MessageUpdateResult. |
ExpungeResult | The ExpungeResult type of the TypeScript SDK, which labels.expunge take or answer. |
ExpungedMessageMeta | The ExpungedMessageMeta type of the TypeScript SDK, which messages.list take or answer. |
ExpungedUID | The ExpungedUID type of the TypeScript SDK, part of ExpungeResult. |
FilterRule | The FilterRule type of the TypeScript SDK, part of FilterRulesPutResult and 2 more types. |
FilterRulesDeleted | The FilterRulesDeleted type of the TypeScript SDK, which rules.delete take or answer. |
FilterRulesPutResult | The FilterRulesPutResult type of the TypeScript SDK, which rules.set take or answer. |
FilterRulesState | The FilterRulesState type of the TypeScript SDK, which rules.get take or answer. |
FilteringBody | The FilteringBody type of the TypeScript SDK, which filtering.update take or answer. |
FilteringSettings | The FilteringSettings type of the TypeScript SDK, which filtering.get and filtering.update take or answer. |
Forwarding | The Forwarding type of the TypeScript SDK, which forwarding.get and 3 more methods take or answer. |
ForwardingDestination | The ForwardingDestination type of the TypeScript SDK, part of Forwarding. |
ForwardingDestinationPending | The ForwardingDestinationPending type of the TypeScript SDK, which forwarding.addDestination take or answer. |
ForwardingDestinationVerified | The ForwardingDestinationVerified type of the TypeScript SDK, which forwarding.confirmDestination take or answer. |
ForwardingSetting | The forward-everything setting. |
FreeBusy | The FreeBusy type of the TypeScript SDK, which freeBusy.get take or answer. |
FreeBusyBatchResult | The FreeBusyBatchResult type of the TypeScript SDK, which freeBusy.getMany take or answer. |
FreeBusyBatchResultResultsItem | The FreeBusyBatchResultResultsItem type of the TypeScript SDK, part of FreeBusyBatchResult. |
FreeBusyBatchResultResultsItemBusyItem | The FreeBusyBatchResultResultsItemBusyItem type of the TypeScript SDK, part of FreeBusyBatchResultResultsItem. |
FreeBusyBusyItem | The FreeBusyBusyItem type of the TypeScript SDK, part of FreeBusy. |
HeadBatch | The HeadBatch type of the TypeScript SDK, which messages.getRawHeaders take or answer. |
HeadEntry | The HeadEntry type of the TypeScript SDK, part of HeadBatch. |
HostnameCheckStatus | Verification details from the latest check. |
HostnameCheckStatusCf | Cloudflare SaaS status (webmail/dav only). |
HostnameService | Platform service name. |
Identity | The Identity type of the TypeScript SDK, which identities.get take or answer. |
IdentityActivity | The IdentityActivity type of the TypeScript SDK, which accounts.listIdentitiesByActivity take or answer. |
IdentityAddresses | The IdentityAddresses type of the TypeScript SDK, which identities.listAddresses take or answer. |
IdentityClient | The IdentityClient type of the TypeScript SDK, which identities.listClients take or answer. |
IdentityFacets | The IdentityFacets type of the TypeScript SDK, part of Identity. |
IdentityFacetsMail | Mail store details if bound. |
IdentityFacetsPim | PIM (calendar and contacts) store details if bound. |
KeywordCount | The KeywordCount type of the TypeScript SDK, part of KeywordListPage. |
KeywordListPage | The KeywordListPage type of the TypeScript SDK, which messages.listKeywords take or answer. |
LabelDeleteResult | The LabelDeleteResult type of the TypeScript SDK, which labels.delete and labels.deleteById take or answer. |
LabelInfo | The LabelInfo type of the TypeScript SDK, part of LabelListPage and 1 more types. |
LabelListPage | The LabelListPage type of the TypeScript SDK, which labels.list take or answer. |
LabelMessagesUpdateResult | The LabelMessagesUpdateResult type of the TypeScript SDK, which labels.updateMessages and labels.updateMessagesById take or answer. |
LabelUidEntry | The LabelUidEntry type of the TypeScript SDK, part of LabelUidPage. |
LabelUidPage | The LabelUidPage type of the TypeScript SDK, which labels.listUids take or answer. |
LimitIncident | The LimitIncident type of the TypeScript SDK, which accounts.listLimitIncidents take or answer. |
MailAddress | The MailAddress type of the TypeScript SDK, which messages.compose and messages.send take or answer. |
MailShare | The MailShare type of the TypeScript SDK, which mailboxShares.grant and mailboxShares.list take or answer. |
MailTemplate | The MailTemplate type of the TypeScript SDK, which templates.create and templates.update take or answer. |
MailTemplateDetail | The MailTemplateDetail type of the TypeScript SDK, which templates.get take or answer. |
MailTemplateList | The MailTemplateList type of the TypeScript SDK, which templates.list take or answer. |
MailTemplateRender | The MailTemplateRender type of the TypeScript SDK, which templates.render take or answer. |
MailTemplateSend | The MailTemplateSend type of the TypeScript SDK, which templates.send take or answer. |
MailTemplateSendRow | The MailTemplateSendRow type of the TypeScript SDK, part of MailTemplateSend. |
MailTemplateVariable | The MailTemplateVariable type of the TypeScript SDK, part of MailTemplateRender. |
MailTemplateVariablesValue | The MailTemplateVariablesValue type of the TypeScript SDK, part of MailTemplate. |
MailTemplateVariant | The MailTemplateVariant type of the TypeScript SDK, part of MailTemplateDetail. |
Mailbox | The Mailbox type of the TypeScript SDK, which identities.update take or answer. |
MailboxDeleteResult | The MailboxDeleteResult type of the TypeScript SDK, which identities.delete take or answer. |
MailboxRestoreResult | The MailboxRestoreResult type of the TypeScript SDK, which identities.restore take or answer. |
MailboxRouting | The MailboxRouting type of the TypeScript SDK, which mailboxes.getRouting take or answer. |
MailboxRoutingAddressesItem | The MailboxRoutingAddressesItem type of the TypeScript SDK, part of MailboxRouting. |
MailboxWithStats | The MailboxWithStats type of the TypeScript SDK, which mailboxes.get take or answer. |
MailboxWithUsage | The MailboxWithUsage type of the TypeScript SDK, which identities.list take or answer. |
MessageAuth | Stored SMTP authentication and original inbound junk verdicts. Missing verdicts are null; the object is null when none were recorded (including APPEND and… |
MessageBatch | The MessageBatch type of the TypeScript SDK, which messages.getMany take or answer. |
MessageChangesFeed | The MessageChangesFeed type of the TypeScript SDK, which messages.getChanges take or answer. |
MessageCopyEntry | The MessageCopyEntry type of the TypeScript SDK, part of MessageCopyResult. |
MessageCopyResult | The MessageCopyResult type of the TypeScript SDK, which messages.copy take or answer. |
MessageDeleteResult | The MessageDeleteResult type of the TypeScript SDK, which messages.delete take or answer. |
MessageDeliveryList | The MessageDeliveryList type of the TypeScript SDK, which deliveries.list take or answer. |
MessageDeliveryStatus | The MessageDeliveryStatus type of the TypeScript SDK, which messages.getDelivery and deliveries.list take or answer. |
MessageInvitation | The MessageInvitation type of the TypeScript SDK, which messages.getInvitation take or answer. |
MessageLabel | The MessageLabel type of the TypeScript SDK, part of MessageMeta and 2 more types. |
MessageMeta | The MessageMeta type of the TypeScript SDK, which labels.listMessages and 5 more methods take or answer. |
MessageRestoreResult | The MessageRestoreResult type of the TypeScript SDK, which messages.restore take or answer. |
MessageSyncEntry | The MessageSyncEntry type of the TypeScript SDK, part of MessageChangesFeed. |
MessageUpdateResult | The MessageUpdateResult type of the TypeScript SDK, which messages.update take or answer. |
MessageUpdated | The MessageUpdated type of the TypeScript SDK, part of MessageUpdateResult. |
MessageWebhook | The MessageWebhook type of the TypeScript SDK, which mailboxes.getMessageWebhook and mailboxes.setMessageWebhook take or answer. |
MessageWebhookBody | The MessageWebhookBody type of the TypeScript SDK, which mailboxes.setMessageWebhook take or answer. |
MimeBatch | The MimeBatch type of the TypeScript SDK, which messages.getMimeStructures take or answer. |
MimeEntry | The MimeEntry type of the TypeScript SDK, part of MimeBatch. |
ObjectSchedulingLog | The ObjectSchedulingLog type of the TypeScript SDK, which calendarObjects.listScheduling take or answer. |
ObjectSchedulingLogEntriesItem | The ObjectSchedulingLogEntriesItem type of the TypeScript SDK, part of ObjectSchedulingLog. |
PasswordChanged | The PasswordChanged type of the TypeScript SDK, which passwords.change take or answer. |
Pattern | The Pattern type of the TypeScript SDK, which patterns.create and 2 more methods take or answer. |
PickupDispatch | State of the last attempt to hand this source to the fetcher, read from the scheduler. Null when that read was not made (it failed, or the page exceeded the… |
PickupRunResult | The PickupRunResult type of the TypeScript SDK, which pickups.run take or answer. |
PickupSource | The PickupSource type of the TypeScript SDK, which pickups.create and 3 more methods take or answer. |
PimAttendee | The PimAttendee type of the TypeScript SDK, part of MessageInvitation and 1 more types. |
PimChangedRef | The PimChangedRef type of the TypeScript SDK, part of PimChanges. |
PimChanges | The PimChanges type of the TypeScript SDK, which calendars.getChanges and addressbooks.getChanges take or answer. |
PimCollection | The PimCollection type of the TypeScript SDK, which calendars.create and 9 more methods take or answer. |
PimCollectionRestored | The PimCollectionRestored type of the TypeScript SDK, which calendars.restore and addressbooks.restore take or answer. |
PimCollectionTaskCounts | Members that are tasks, split by the two progress buckets. Exact complements; events and contacts are in neither, so the pair need not sum to objectCount. |
PimImportItem | The PimImportItem type of the TypeScript SDK, part of PimImportResult. |
PimImportResult | The PimImportResult type of the TypeScript SDK, which calendars.import and addressbooks.import take or answer. |
PimInstance | The PimInstance type of the TypeScript SDK, part of PimObjectPageObjectsItem. |
PimInstanceScheduling | Effective occurrence participants, including RANGE overrides; present with expand=true and fields=json. Missing statuses are not inherited from the master. |
PimInstanceSchedulingAttendeesItem | The PimInstanceSchedulingAttendeesItem type of the TypeScript SDK, part of PimInstanceScheduling. |
PimInstanceSchedulingOrganizer | The PimInstanceSchedulingOrganizer type of the TypeScript SDK, part of PimInstanceScheduling. |
PimInvitationStatus | The PimInvitationStatus type of the TypeScript SDK, which calendars.getInvitationStatus take or answer. |
PimObjectJson | The PimObjectJson type of the TypeScript SDK, which calendarObjects.get and addressbookObjects.get take or answer. |
PimObjectMeta | The PimObjectMeta type of the TypeScript SDK, part of PimObjectJson and 2 more types. |
PimObjectPage | The PimObjectPage type of the TypeScript SDK, which calendarObjects.list and addressbookObjects.list take or answer. |
PimObjectPageObjectsItem | The PimObjectPageObjectsItem type of the TypeScript SDK, which calendarObjects.list and addressbookObjects.list take or answer. |
PimObjectPageWindow | The effective range actually answered, echoed on ranged queries. |
PimObjectRestored | The PimObjectRestored type of the TypeScript SDK, which calendarObjects.restore and addressbookObjects.restore take or answer. |
PimPublicCollection | The PimPublicCollection type of the TypeScript SDK, which pim.listPublicDirectory and 2 more methods take or answer. |
PimPutResult | The PimPutResult type of the TypeScript SDK, which calendarObjects.put and addressbookObjects.put take or answer. |
PimRsvpResult | The PimRsvpResult type of the TypeScript SDK, which calendars.respondToInvitation take or answer. |
PimShare | The PimShare type of the TypeScript SDK, which calendars.grantAccess and 3 more methods take or answer. |
PimSharedWithMe | The PimSharedWithMe type of the TypeScript SDK, which pim.listSharedWithMe take or answer. |
PimSharedWithMeTaskCounts | Members that are tasks, split by the two progress buckets. Exact complements; events and contacts are in neither, so the pair need not sum to objectCount. |
PimToken | The PimToken type of the TypeScript SDK, which calendars.listFeedTokens and addressbooks.listFeedTokens take or answer. |
PimTokenCreated | The PimTokenCreated type of the TypeScript SDK, which calendars.createFeedToken and addressbooks.createFeedToken take or answer. |
PimTrashPurged | The PimTrashPurged type of the TypeScript SDK, which calendars.purge and 5 more methods take or answer. |
PimTrashedCollection | The PimTrashedCollection type of the TypeScript SDK, which calendars.listTrash and addressbooks.listTrash take or answer. |
PimTrashedObject | The PimTrashedObject type of the TypeScript SDK, which calendarObjects.listTrash and addressbookObjects.listTrash take or answer. |
PimTrashedObjectPage | The PimTrashedObjectPage type of the TypeScript SDK, which calendarObjects.listTrash and addressbookObjects.listTrash take or answer. |
Prefs | The Prefs type of the TypeScript SDK, which identities.getPreferences and identities.setPreferences take or answer. |
PublicBranding | The PublicBranding type of the TypeScript SDK, which branding.get take or answer. |
PublicBrandingByHost | The PublicBrandingByHost type of the TypeScript SDK, which branding.getByHost take or answer. |
PushSubscription | The PushSubscription type of the TypeScript SDK, which pushSubscriptions.create and pushSubscriptions.update take or answer. |
PushSubscriptionPage | The PushSubscriptionPage type of the TypeScript SDK, which pushSubscriptions.list take or answer. |
PutMailShareBody | The PutMailShareBody type of the TypeScript SDK, which mailboxShares.grant take or answer. |
QueryMessagesUpdateResult | The QueryMessagesUpdateResult type of the TypeScript SDK, which search.updateMatches take or answer. |
RecipientAccepted | The RecipientAccepted type of the TypeScript SDK, which mta.checkRecipient take or answer. |
RecipientDeliveryStatus | The RecipientDeliveryStatus type of the TypeScript SDK, part of MessageDeliveryStatus. |
RecoveryAddressDeleted | The RecoveryAddressDeleted type of the TypeScript SDK, which recovery.removeAddress take or answer. |
RecoveryAddressPending | The RecoveryAddressPending type of the TypeScript SDK, which recovery.setAddress take or answer. |
RecoveryAddressVerified | The RecoveryAddressVerified type of the TypeScript SDK, which recovery.confirmAddress take or answer. |
RecoveryCodesIssued | The RecoveryCodesIssued type of the TypeScript SDK, which recovery.createCodes take or answer. |
RecoveryCompleted | The RecoveryCompleted type of the TypeScript SDK, which passwords.reset take or answer. |
RecoveryInvitationSent | The RecoveryInvitationSent type of the TypeScript SDK, which passwords.invite take or answer. |
RecoveryPolicy | The RecoveryPolicy type of the TypeScript SDK, which accounts.setRecoveryPolicy take or answer. |
RecoveryStatus | The RecoveryStatus type of the TypeScript SDK, which recovery.getStatus take or answer. |
RecoveryStatusInvitation | An outstanding provisioning invitation, or null. This IS the idempotency answer for POST /identities/:id/invitation (§XVII.5): a caller that lost its create… |
RenamedResult | The RenamedResult type of the TypeScript SDK, which labels.update and labels.updateById take or answer. |
ReplyContext | The ReplyContext type of the TypeScript SDK, part of ThreadView. |
RequestBreakdownRow | The RequestBreakdownRow type of the TypeScript SDK, part of AccountUsage. |
RequestsSeriesPoint | The RequestsSeriesPoint type of the TypeScript SDK, part of AccountRequests. |
Retention | The Retention type of the TypeScript SDK, which mailboxes.getRetention and 2 more methods take or answer. |
RetentionPreview | The RetentionPreview type of the TypeScript SDK, part of AccountRetentionRow and 1 more types. |
RevokedResult | The RevokedResult type of the TypeScript SDK, which apiKeys.revoke and credentials.revoke take or answer. |
Route | The Route type of the TypeScript SDK, which routes.create and 3 more methods take or answer. |
RouteMember | The RouteMember type of the TypeScript SDK, which routes.listMembers and routes.replaceMembers take or answer. |
RouteMemberBatchResult | The RouteMemberBatchResult type of the TypeScript SDK, which routes.addMembers take or answer. |
RouteMemberRef | The RouteMemberRef type of the TypeScript SDK, which routes.addMember take or answer. |
RuleAction | The RuleAction type of the TypeScript SDK, part of FilterRule. |
RuleActionAddFlag | The RuleActionAddFlag type of the TypeScript SDK, part of RuleAction. |
RuleActionDiscard | The RuleActionDiscard type of the TypeScript SDK, part of RuleAction. |
RuleActionFileInto | The RuleActionFileInto type of the TypeScript SDK, part of RuleAction. |
RuleActionRedirect | The RuleActionRedirect type of the TypeScript SDK, part of RuleAction. |
RuleCondition | The RuleCondition type of the TypeScript SDK, part of FilterRule. |
RuleConditionOption1 | The RuleConditionOption1 type of the TypeScript SDK, part of RuleCondition. |
RuleConditionOption2 | The RuleConditionOption2 type of the TypeScript SDK, part of RuleCondition. |
RuleConditionOption3 | The RuleConditionOption3 type of the TypeScript SDK, part of RuleCondition. |
RuleConditionOption4 | The RuleConditionOption4 type of the TypeScript SDK, part of RuleCondition. |
RuleConditionOption5 | The RuleConditionOption5 type of the TypeScript SDK, part of RuleCondition. |
RulesDocument | The RulesDocument type of the TypeScript SDK, which rules.set take or answer. |
ScheduledLegResult | The ScheduledLegResult type of the TypeScript SDK, part of ScheduledSend. |
ScheduledSend | The ScheduledSend type of the TypeScript SDK, which messages.send and 5 more methods take or answer. |
SchedulingInboxPage | The SchedulingInboxPage type of the TypeScript SDK, which schedulingInbox.list take or answer. |
SchedulingInboxPageEntriesItem | The SchedulingInboxPageEntriesItem type of the TypeScript SDK, part of SchedulingInboxPage. |
SemanticCoverage | The SemanticCoverage type of the TypeScript SDK, part of SemanticSearchResult and 1 more types. |
SemanticSearchResult | The SemanticSearchResult type of the TypeScript SDK, which search.semantic take or answer. |
SendAsAddresses | The SendAsAddresses type of the TypeScript SDK, which mailboxes.listSendAs take or answer. |
SendAsAddressesAddressesItem | The SendAsAddressesAddressesItem type of the TypeScript SDK, part of SendAsAddresses. |
SendRecipientResult | The SendRecipientResult type of the TypeScript SDK, part of SendResult. |
SendResult | The SendResult type of the TypeScript SDK, which messages.send and 2 more methods take or answer. |
SendState | The SendState type of the TypeScript SDK, which mailboxes.getSendState take or answer. |
SendUsage | The SendUsage type of the TypeScript SDK, which domains.getForwardUsage and mailboxes.getSendUsage take or answer. |
SenderCheck | The SenderCheck type of the TypeScript SDK, which mailboxes.checkSendAs take or answer. |
SharedMailbox | The SharedMailbox type of the TypeScript SDK, which mailboxShares.listSharedWithMe take or answer. |
SieveActivated | The SieveActivated type of the TypeScript SDK, which sieve.activate take or answer. |
SieveActiveName | The SieveActiveName type of the TypeScript SDK, which sieve.getActive take or answer. |
SieveCapabilities | The SieveCapabilities type of the TypeScript SDK, which sieve.getCapabilities take or answer. |
SieveCheckResult | The SieveCheckResult type of the TypeScript SDK, which sieve.check take or answer. |
SieveDeactivated | The SieveDeactivated type of the TypeScript SDK, which sieve.deactivate take or answer. |
SieveDeleted | The SieveDeleted type of the TypeScript SDK, which sieve.deleteScript take or answer. |
SievePutResult | The SievePutResult type of the TypeScript SDK, which sieve.putScript take or answer. |
SieveRenamed | The SieveRenamed type of the TypeScript SDK, which sieve.renameScript take or answer. |
SieveScript | The SieveScript type of the TypeScript SDK, which sieve.listScripts take or answer. |
SieveScriptBody | The SieveScriptBody type of the TypeScript SDK, which sieve.getScript take or answer. |
SimilarMessagesResult | The SimilarMessagesResult type of the TypeScript SDK, which search.similar take or answer. |
Suppression | The Suppression type of the TypeScript SDK, which suppressions.list and suppressions.get take or answer. |
SuppressionList | The SuppressionList type of the TypeScript SDK, which suppressions.list take or answer. |
ThreadListItem | The ThreadListItem type of the TypeScript SDK, which threads.list take or answer. |
ThreadParticipant | One sender in the conversation; name is null when the From header carried no display name. |
ThreadView | The ThreadView type of the TypeScript SDK, which threads.get take or answer. |
TrafficEvent | The TrafficEvent type of the TypeScript SDK, which domains.listEvents take or answer. |
TrafficEventTemplate | The prepared email this message was sent from, or null for any other mail. Present on each recipient's admission row and on every relay attempt after it… |
TrafficRow | The TrafficRow type of the TypeScript SDK, part of AccountTraffic and 1 more types. |
TrafficSeriesPoint | The TrafficSeriesPoint type of the TypeScript SDK, part of AccountTraffic and 1 more types. |
UploadResult | The UploadResult type of the TypeScript SDK, which uploads.create take or answer. |
UsageDay | The UsageDay type of the TypeScript SDK, part of AccountUsage. |
Vacation | The Vacation type of the TypeScript SDK, which vacation.get and vacation.set take or answer. |
ValidationError | The ValidationError type of the TypeScript SDK, part of ErrorOrValidation. |
ValidationErrorIssuesItem | The ValidationErrorIssuesItem type of the TypeScript SDK, part of ValidationError. |
VanishedResult | The VanishedResult type of the TypeScript SDK, which labels.listVanished take or answer. |
VerifiedRecipient | The VerifiedRecipient type of the TypeScript SDK, which verifiedRecipients.list take or answer. |
VerifiedRecipientAdded | The VerifiedRecipientAdded type of the TypeScript SDK, which verifiedRecipients.add take or answer. |
WebauthnCredential | The WebauthnCredential type of the TypeScript SDK, which securityKeys.finishRegistration and securityKeys.list take or answer. |
WebauthnRegistrationOptions | The WebauthnRegistrationOptions type of the TypeScript SDK, which securityKeys.beginRegistration take or answer. |
WebauthnRegistrationOptionsAuthenticatorSelection | The WebauthnRegistrationOptionsAuthenticatorSelection type of the TypeScript SDK, part of WebauthnRegistrationOptions. |
WebauthnRegistrationOptionsExcludeCredentialsItem | The WebauthnRegistrationOptionsExcludeCredentialsItem type of the TypeScript SDK, part of WebauthnRegistrationOptions. |
WebauthnRegistrationOptionsPubKeyCredParamsItem | The WebauthnRegistrationOptionsPubKeyCredParamsItem type of the TypeScript SDK, part of WebauthnRegistrationOptions. |
WebauthnRegistrationOptionsRp | The WebauthnRegistrationOptionsRp type of the TypeScript SDK, part of WebauthnRegistrationOptions. |
WebauthnRegistrationOptionsUser | The WebauthnRegistrationOptionsUser type of the TypeScript SDK, part of WebauthnRegistrationOptions. |
WebhookDeliveryAttachment | The WebhookDeliveryAttachment type of the TypeScript SDK, part of WebhookDeliveryMessage. |
WebhookDeliveryAuth | The WebhookDeliveryAuth type of the TypeScript SDK, part of WebhookDeliveryMessage. |
WebhookDeliveryMessage | The parsed message; degraded forms carry bodiesOmitted, never null. |
WebhookDeliveryPayload | What parseMessageWebhook answers: the message a message webhook posts to your endpoint, its signature checked first. |
WhoamiResult | The WhoamiResult type of the TypeScript SDK, which auth.whoami take or answer. |