Skip to Content

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'.

TypeWhat it is
AccountThe Account type of the TypeScript SDK, which accounts.get and accounts.restore take or answer.
AccountDeleteResultThe AccountDeleteResult type of the TypeScript SDK, which accounts.delete take or answer.
AccountEventsThe AccountEvents type of the TypeScript SDK, which accounts.listEvents take or answer.
AccountLimitInForceThe AccountLimitInForce type of the TypeScript SDK, part of AccountLimitsLimits.
AccountLimitsThe AccountLimits type of the TypeScript SDK, which accounts.getLimits take or answer.
AccountLimitsLimitsEvery 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…
AccountReceiveUsageThe AccountReceiveUsage type of the TypeScript SDK, which accounts.getReceiveUsage take or answer.
AccountReceiveUsageTopMailboxesItemThe AccountReceiveUsageTopMailboxesItem type of the TypeScript SDK, part of AccountReceiveUsage.
AccountRequestsThe AccountRequests type of the TypeScript SDK, which accounts.getRequests take or answer.
AccountRetentionThe AccountRetention type of the TypeScript SDK, which accounts.listRetention and 2 more methods take or answer.
AccountRetentionRowThe AccountRetentionRow type of the TypeScript SDK, which accounts.listRetention take or answer.
AccountSendUsageThe AccountSendUsage type of the TypeScript SDK, which accounts.getSendUsage take or answer.
AccountSendUsageCreatesThe AccountSendUsageCreates type of the TypeScript SDK, part of AccountSendUsage.
AccountSendUsageSendThe AccountSendUsageSend type of the TypeScript SDK, part of AccountSendUsage.
AccountStorageUsageThe AccountStorageUsage type of the TypeScript SDK, which accounts.getStorageUsage take or answer.
AccountTrafficThe AccountTraffic type of the TypeScript SDK, which accounts.getTraffic take or answer.
AccountTrafficEventThe AccountTrafficEvent type of the TypeScript SDK, which accounts.listEvents take or answer.
AccountTrafficTotalsThe AccountTrafficTotals type of the TypeScript SDK, part of AccountTraffic.
AccountUsageThe AccountUsage type of the TypeScript SDK, which accounts.getUsage take or answer.
AddressListThe AddressList type of the TypeScript SDK, which accountAddressLists.create and 7 more methods take or answer.
AddressListBatchResultThe AddressListBatchResult type of the TypeScript SDK, which accountAddressLists.addEntries and 3 more methods take or answer.
AddressListEntryThe AddressListEntry type of the TypeScript SDK, which accountAddressLists.addEntry and 3 more methods take or answer.
AddressListEntryPageThe AddressListEntryPage type of the TypeScript SDK, which accountAddressLists.listEntries and mailboxAddressLists.listEntries take or answer.
AddressListPageThe AddressListPage type of the TypeScript SDK, which accountAddressLists.list and mailboxAddressLists.list take or answer.
AddressListVerdictThe AddressListVerdict type of the TypeScript SDK, which accountAddressLists.evaluate and mailboxAddressLists.evaluate take or answer.
AddressListVerdictAllowUnvouchedMessage 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…
ApiKeyThe ApiKey type of the TypeScript SDK, which apiKeys.list take or answer.
ApiKeyCreatedThe ApiKeyCreated type of the TypeScript SDK, which apiKeys.create take or answer.
AppendResultThe AppendResult type of the TypeScript SDK, which messages.append and messages.compose take or answer.
AppendResultDeliveredThe AppendResultDelivered type of the TypeScript SDK, part of AppendResult.
AppendResultFilteredThe AppendResultFiltered type of the TypeScript SDK, part of AppendResult.
AttachmentRefThe AttachmentRef type of the TypeScript SDK, part of ContentResult.
AuditEventThe AuditEvent type of the TypeScript SDK, which accounts.listAudit take or answer.
BatchDeleteEntryThe BatchDeleteEntry type of the TypeScript SDK, part of BatchDeleteResult.
BatchDeleteResultThe BatchDeleteResult type of the TypeScript SDK, which messages.deleteMany take or answer.
BatchLearnEntryThe BatchLearnEntry type of the TypeScript SDK, part of BatchLearnResult.
BatchLearnResultThe BatchLearnResult type of the TypeScript SDK, which messages.learnMany take or answer.
BatchRestoreEntryThe BatchRestoreEntry type of the TypeScript SDK, part of BatchRestoreResult.
BatchRestoreResultThe BatchRestoreResult type of the TypeScript SDK, which messages.restoreMany take or answer.
BatchUnjunkEntryThe BatchUnjunkEntry type of the TypeScript SDK, part of BatchUnjunkResult.
BatchUnjunkResultThe BatchUnjunkResult type of the TypeScript SDK, which messages.unjunk take or answer.
BatchUntrashEntryThe BatchUntrashEntry type of the TypeScript SDK, part of BatchUntrashResult.
BatchUntrashResultThe BatchUntrashResult type of the TypeScript SDK, which messages.untrash take or answer.
BatchUpdateEntryThe BatchUpdateEntry type of the TypeScript SDK, part of BatchUpdateResult.
BatchUpdateResultThe BatchUpdateResult type of the TypeScript SDK, which messages.updateMany take or answer.
ContactSuggestionThe ContactSuggestion type of the TypeScript SDK, part of ContactSuggestions.
ContactSuggestionsThe ContactSuggestions type of the TypeScript SDK, which contacts.suggest take or answer.
ContentAddressThe ContentAddress type of the TypeScript SDK, part of ContentHeaders and 3 more types.
ContentBodyThe ContentBody type of the TypeScript SDK, part of ContentResult.
ContentHeadersMessage headers.
ContentResultThe ContentResult type of the TypeScript SDK, which messages.getContent take or answer.
CreatedIdentityThe CreatedIdentity type of the TypeScript SDK, which identities.create take or answer.
CreatedLabelThe CreatedLabel type of the TypeScript SDK, which labels.create take or answer.
CredentialThe Credential type of the TypeScript SDK, which credentials.list take or answer.
CredentialCreatedThe CredentialCreated type of the TypeScript SDK, which credentials.create take or answer.
CredentialCreatedAppPasswordThe CredentialCreatedAppPassword type of the TypeScript SDK, part of CredentialCreated.
CredentialCreatedPasswordThe CredentialCreatedPassword type of the TypeScript SDK, part of CredentialCreated.
DeletedMailboxThe DeletedMailbox type of the TypeScript SDK, which identities.list take or answer.
DeletedResultThe DeletedResult type of the TypeScript SDK, which verifiedRecipients.remove and 18 more methods take or answer.
DeliverResultThe DeliverResult type of the TypeScript SDK, which mta.submitOutbound and mta.deliverInbound take or answer.
DeliverResultDeliveredThe DeliverResultDelivered type of the TypeScript SDK, part of DeliverResult.
DeliverResultFilteredThe DeliverResultFiltered type of the TypeScript SDK, part of DeliverResult.
DeliverResultQueuedThe DeliverResultQueued type of the TypeScript SDK, part of DeliverResult.
DmarcBlockerThe DmarcBlocker type of the TypeScript SDK, part of DmarcReadiness.
DmarcReadinessPolicy enforcement readiness analysis.
DmarcReportThe DmarcReport type of the TypeScript SDK, which dmarc.listReports take or answer.
DmarcSourceThe DmarcSource type of the TypeScript SDK, part of DomainDmarc and 1 more types.
DnsRecordThe DnsRecord type of the TypeScript SDK, part of DnsRecordCheck.
DnsRecordCheckThe DnsRecordCheck type of the TypeScript SDK, which domains.create take or answer.
DnsStatusThe DnsStatus type of the TypeScript SDK, part of Domain and 1 more types.
DomainThe Domain type of the TypeScript SDK, which domains.create and 3 more methods take or answer.
DomainBrandingThe DomainBranding type of the TypeScript SDK, which domains.getBranding and 2 more methods take or answer.
DomainBrandingPatchThe DomainBrandingPatch type of the TypeScript SDK, which domains.setBranding take or answer.
DomainDmarcThe DomainDmarc type of the TypeScript SDK, which dmarc.getSummary take or answer.
DomainDmarcReportsThe DomainDmarcReports type of the TypeScript SDK, which dmarc.listReports take or answer.
DomainDmarcSourcesThe DomainDmarcSources type of the TypeScript SDK, which dmarc.listSources take or answer.
DomainDmarcTotalsThe DomainDmarcTotals type of the TypeScript SDK, part of DomainDmarc.
DomainDnsCheckThe DomainDnsCheck type of the TypeScript SDK, which domains.checkDns take or answer.
DomainEventsThe DomainEvents type of the TypeScript SDK, which domains.listEvents take or answer.
DomainHostnameThe DomainHostname type of the TypeScript SDK, part of DomainHostnameList.
DomainHostnameListThe DomainHostnameList type of the TypeScript SDK, which hostnames.list and 2 more methods take or answer.
DomainTrafficThe DomainTraffic type of the TypeScript SDK, which domains.getTraffic take or answer.
DomainTrafficTotalsThe DomainTrafficTotals type of the TypeScript SDK, part of DomainTraffic.
DomainUsageThe DomainUsage type of the TypeScript SDK, which domains.getUsage take or answer.
DomainUsageDayThe DomainUsageDay type of the TypeScript SDK, part of DomainUsage.
EmailSearchComparatorAn RFC 8620 §5.5 Comparator: {property, isAscending?, keyword?}. property is one of receivedAt|size|sentAt|from|subject|hasKeyword (a hasKeyword comparator…
EmailSearchConditionAn 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…
EmailSearchFilterAn RFC 8621 §4.4 FilterCondition, or a boolean tree of them ({operator: AND|OR|NOT, conditions: [...]}). Bounded, and refused (never truncated) past the bound…
EmailSearchFilterOperatorA boolean combination of nested EmailSearchFilter nodes. Full-text conditions may not appear under OR or NOT.
EmailSearchRequestThe EmailSearchRequest type of the TypeScript SDK, which search.query take or answer.
EmailSearchResultThe EmailSearchResult type of the TypeScript SDK, which search.query take or answer.
EmailSearchSnippetThe EmailSearchSnippet type of the TypeScript SDK, which search.fullText take or answer.
EmailSearchSnippetsRequestThe EmailSearchSnippetsRequest type of the TypeScript SDK, which search.snippets take or answer.
EmailSearchSnippetsResultThe EmailSearchSnippetsResult type of the TypeScript SDK, which search.snippets take or answer.
EmptyTrashResultThe EmptyTrashResult type of the TypeScript SDK, which messages.deleteMany take or answer.
ErrorBodyThe ErrorBody type of the TypeScript SDK, part of ErrorOrValidation.
ErrorOrValidationWhat 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.
EventWebhookThe EventWebhook type of the TypeScript SDK, which domains.getEventWebhook and 3 more methods take or answer.
EventWebhookActorWho caused it, or null when the platform did (a delivery, a retention sweep).
EventWebhookEventThe EventWebhookEvent type of the TypeScript SDK, part of EventWebhookPayload.
EventWebhookPayloadWhat parseEventWebhook answers: the batch of events an event webhook posts to your endpoint, its signature checked first.
EventWebhookPayloadSequenceThe contiguous outbox range this batch drains; store batches only.
EventWebhookTestResultThe EventWebhookTestResult type of the TypeScript SDK, which domains.testEventWebhook and mailboxes.testEventWebhook take or answer.
ExpungeNoticeThe ExpungeNotice type of the TypeScript SDK, part of MessageUpdateResult.
ExpungeResultThe ExpungeResult type of the TypeScript SDK, which labels.expunge take or answer.
ExpungedMessageMetaThe ExpungedMessageMeta type of the TypeScript SDK, which messages.list take or answer.
ExpungedUIDThe ExpungedUID type of the TypeScript SDK, part of ExpungeResult.
FilterRuleThe FilterRule type of the TypeScript SDK, part of FilterRulesPutResult and 2 more types.
FilterRulesDeletedThe FilterRulesDeleted type of the TypeScript SDK, which rules.delete take or answer.
FilterRulesPutResultThe FilterRulesPutResult type of the TypeScript SDK, which rules.set take or answer.
FilterRulesStateThe FilterRulesState type of the TypeScript SDK, which rules.get take or answer.
FilteringBodyThe FilteringBody type of the TypeScript SDK, which filtering.update take or answer.
FilteringSettingsThe FilteringSettings type of the TypeScript SDK, which filtering.get and filtering.update take or answer.
ForwardingThe Forwarding type of the TypeScript SDK, which forwarding.get and 3 more methods take or answer.
ForwardingDestinationThe ForwardingDestination type of the TypeScript SDK, part of Forwarding.
ForwardingDestinationPendingThe ForwardingDestinationPending type of the TypeScript SDK, which forwarding.addDestination take or answer.
ForwardingDestinationVerifiedThe ForwardingDestinationVerified type of the TypeScript SDK, which forwarding.confirmDestination take or answer.
ForwardingSettingThe forward-everything setting.
FreeBusyThe FreeBusy type of the TypeScript SDK, which freeBusy.get take or answer.
FreeBusyBatchResultThe FreeBusyBatchResult type of the TypeScript SDK, which freeBusy.getMany take or answer.
FreeBusyBatchResultResultsItemThe FreeBusyBatchResultResultsItem type of the TypeScript SDK, part of FreeBusyBatchResult.
FreeBusyBatchResultResultsItemBusyItemThe FreeBusyBatchResultResultsItemBusyItem type of the TypeScript SDK, part of FreeBusyBatchResultResultsItem.
FreeBusyBusyItemThe FreeBusyBusyItem type of the TypeScript SDK, part of FreeBusy.
HeadBatchThe HeadBatch type of the TypeScript SDK, which messages.getRawHeaders take or answer.
HeadEntryThe HeadEntry type of the TypeScript SDK, part of HeadBatch.
HostnameCheckStatusVerification details from the latest check.
HostnameCheckStatusCfCloudflare SaaS status (webmail/dav only).
HostnameServicePlatform service name.
IdentityThe Identity type of the TypeScript SDK, which identities.get take or answer.
IdentityActivityThe IdentityActivity type of the TypeScript SDK, which accounts.listIdentitiesByActivity take or answer.
IdentityAddressesThe IdentityAddresses type of the TypeScript SDK, which identities.listAddresses take or answer.
IdentityClientThe IdentityClient type of the TypeScript SDK, which identities.listClients take or answer.
IdentityFacetsThe IdentityFacets type of the TypeScript SDK, part of Identity.
IdentityFacetsMailMail store details if bound.
IdentityFacetsPimPIM (calendar and contacts) store details if bound.
KeywordCountThe KeywordCount type of the TypeScript SDK, part of KeywordListPage.
KeywordListPageThe KeywordListPage type of the TypeScript SDK, which messages.listKeywords take or answer.
LabelDeleteResultThe LabelDeleteResult type of the TypeScript SDK, which labels.delete and labels.deleteById take or answer.
LabelInfoThe LabelInfo type of the TypeScript SDK, part of LabelListPage and 1 more types.
LabelListPageThe LabelListPage type of the TypeScript SDK, which labels.list take or answer.
LabelMessagesUpdateResultThe LabelMessagesUpdateResult type of the TypeScript SDK, which labels.updateMessages and labels.updateMessagesById take or answer.
LabelUidEntryThe LabelUidEntry type of the TypeScript SDK, part of LabelUidPage.
LabelUidPageThe LabelUidPage type of the TypeScript SDK, which labels.listUids take or answer.
LimitIncidentThe LimitIncident type of the TypeScript SDK, which accounts.listLimitIncidents take or answer.
MailAddressThe MailAddress type of the TypeScript SDK, which messages.compose and messages.send take or answer.
MailShareThe MailShare type of the TypeScript SDK, which mailboxShares.grant and mailboxShares.list take or answer.
MailTemplateThe MailTemplate type of the TypeScript SDK, which templates.create and templates.update take or answer.
MailTemplateDetailThe MailTemplateDetail type of the TypeScript SDK, which templates.get take or answer.
MailTemplateListThe MailTemplateList type of the TypeScript SDK, which templates.list take or answer.
MailTemplateRenderThe MailTemplateRender type of the TypeScript SDK, which templates.render take or answer.
MailTemplateSendThe MailTemplateSend type of the TypeScript SDK, which templates.send take or answer.
MailTemplateSendRowThe MailTemplateSendRow type of the TypeScript SDK, part of MailTemplateSend.
MailTemplateVariableThe MailTemplateVariable type of the TypeScript SDK, part of MailTemplateRender.
MailTemplateVariablesValueThe MailTemplateVariablesValue type of the TypeScript SDK, part of MailTemplate.
MailTemplateVariantThe MailTemplateVariant type of the TypeScript SDK, part of MailTemplateDetail.
MailboxThe Mailbox type of the TypeScript SDK, which identities.update take or answer.
MailboxDeleteResultThe MailboxDeleteResult type of the TypeScript SDK, which identities.delete take or answer.
MailboxRestoreResultThe MailboxRestoreResult type of the TypeScript SDK, which identities.restore take or answer.
MailboxRoutingThe MailboxRouting type of the TypeScript SDK, which mailboxes.getRouting take or answer.
MailboxRoutingAddressesItemThe MailboxRoutingAddressesItem type of the TypeScript SDK, part of MailboxRouting.
MailboxWithStatsThe MailboxWithStats type of the TypeScript SDK, which mailboxes.get take or answer.
MailboxWithUsageThe MailboxWithUsage type of the TypeScript SDK, which identities.list take or answer.
MessageAuthStored SMTP authentication and original inbound junk verdicts. Missing verdicts are null; the object is null when none were recorded (including APPEND and…
MessageBatchThe MessageBatch type of the TypeScript SDK, which messages.getMany take or answer.
MessageChangesFeedThe MessageChangesFeed type of the TypeScript SDK, which messages.getChanges take or answer.
MessageCopyEntryThe MessageCopyEntry type of the TypeScript SDK, part of MessageCopyResult.
MessageCopyResultThe MessageCopyResult type of the TypeScript SDK, which messages.copy take or answer.
MessageDeleteResultThe MessageDeleteResult type of the TypeScript SDK, which messages.delete take or answer.
MessageDeliveryListThe MessageDeliveryList type of the TypeScript SDK, which deliveries.list take or answer.
MessageDeliveryStatusThe MessageDeliveryStatus type of the TypeScript SDK, which messages.getDelivery and deliveries.list take or answer.
MessageInvitationThe MessageInvitation type of the TypeScript SDK, which messages.getInvitation take or answer.
MessageLabelThe MessageLabel type of the TypeScript SDK, part of MessageMeta and 2 more types.
MessageMetaThe MessageMeta type of the TypeScript SDK, which labels.listMessages and 5 more methods take or answer.
MessageRestoreResultThe MessageRestoreResult type of the TypeScript SDK, which messages.restore take or answer.
MessageSyncEntryThe MessageSyncEntry type of the TypeScript SDK, part of MessageChangesFeed.
MessageUpdateResultThe MessageUpdateResult type of the TypeScript SDK, which messages.update take or answer.
MessageUpdatedThe MessageUpdated type of the TypeScript SDK, part of MessageUpdateResult.
MessageWebhookThe MessageWebhook type of the TypeScript SDK, which mailboxes.getMessageWebhook and mailboxes.setMessageWebhook take or answer.
MessageWebhookBodyThe MessageWebhookBody type of the TypeScript SDK, which mailboxes.setMessageWebhook take or answer.
MimeBatchThe MimeBatch type of the TypeScript SDK, which messages.getMimeStructures take or answer.
MimeEntryThe MimeEntry type of the TypeScript SDK, part of MimeBatch.
ObjectSchedulingLogThe ObjectSchedulingLog type of the TypeScript SDK, which calendarObjects.listScheduling take or answer.
ObjectSchedulingLogEntriesItemThe ObjectSchedulingLogEntriesItem type of the TypeScript SDK, part of ObjectSchedulingLog.
PasswordChangedThe PasswordChanged type of the TypeScript SDK, which passwords.change take or answer.
PatternThe Pattern type of the TypeScript SDK, which patterns.create and 2 more methods take or answer.
PickupDispatchState 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…
PickupRunResultThe PickupRunResult type of the TypeScript SDK, which pickups.run take or answer.
PickupSourceThe PickupSource type of the TypeScript SDK, which pickups.create and 3 more methods take or answer.
PimAttendeeThe PimAttendee type of the TypeScript SDK, part of MessageInvitation and 1 more types.
PimChangedRefThe PimChangedRef type of the TypeScript SDK, part of PimChanges.
PimChangesThe PimChanges type of the TypeScript SDK, which calendars.getChanges and addressbooks.getChanges take or answer.
PimCollectionThe PimCollection type of the TypeScript SDK, which calendars.create and 9 more methods take or answer.
PimCollectionRestoredThe PimCollectionRestored type of the TypeScript SDK, which calendars.restore and addressbooks.restore take or answer.
PimCollectionTaskCountsMembers 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.
PimImportItemThe PimImportItem type of the TypeScript SDK, part of PimImportResult.
PimImportResultThe PimImportResult type of the TypeScript SDK, which calendars.import and addressbooks.import take or answer.
PimInstanceThe PimInstance type of the TypeScript SDK, part of PimObjectPageObjectsItem.
PimInstanceSchedulingEffective occurrence participants, including RANGE overrides; present with expand=true and fields=json. Missing statuses are not inherited from the master.
PimInstanceSchedulingAttendeesItemThe PimInstanceSchedulingAttendeesItem type of the TypeScript SDK, part of PimInstanceScheduling.
PimInstanceSchedulingOrganizerThe PimInstanceSchedulingOrganizer type of the TypeScript SDK, part of PimInstanceScheduling.
PimInvitationStatusThe PimInvitationStatus type of the TypeScript SDK, which calendars.getInvitationStatus take or answer.
PimObjectJsonThe PimObjectJson type of the TypeScript SDK, which calendarObjects.get and addressbookObjects.get take or answer.
PimObjectMetaThe PimObjectMeta type of the TypeScript SDK, part of PimObjectJson and 2 more types.
PimObjectPageThe PimObjectPage type of the TypeScript SDK, which calendarObjects.list and addressbookObjects.list take or answer.
PimObjectPageObjectsItemThe PimObjectPageObjectsItem type of the TypeScript SDK, which calendarObjects.list and addressbookObjects.list take or answer.
PimObjectPageWindowThe effective range actually answered, echoed on ranged queries.
PimObjectRestoredThe PimObjectRestored type of the TypeScript SDK, which calendarObjects.restore and addressbookObjects.restore take or answer.
PimPublicCollectionThe PimPublicCollection type of the TypeScript SDK, which pim.listPublicDirectory and 2 more methods take or answer.
PimPutResultThe PimPutResult type of the TypeScript SDK, which calendarObjects.put and addressbookObjects.put take or answer.
PimRsvpResultThe PimRsvpResult type of the TypeScript SDK, which calendars.respondToInvitation take or answer.
PimShareThe PimShare type of the TypeScript SDK, which calendars.grantAccess and 3 more methods take or answer.
PimSharedWithMeThe PimSharedWithMe type of the TypeScript SDK, which pim.listSharedWithMe take or answer.
PimSharedWithMeTaskCountsMembers 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.
PimTokenThe PimToken type of the TypeScript SDK, which calendars.listFeedTokens and addressbooks.listFeedTokens take or answer.
PimTokenCreatedThe PimTokenCreated type of the TypeScript SDK, which calendars.createFeedToken and addressbooks.createFeedToken take or answer.
PimTrashPurgedThe PimTrashPurged type of the TypeScript SDK, which calendars.purge and 5 more methods take or answer.
PimTrashedCollectionThe PimTrashedCollection type of the TypeScript SDK, which calendars.listTrash and addressbooks.listTrash take or answer.
PimTrashedObjectThe PimTrashedObject type of the TypeScript SDK, which calendarObjects.listTrash and addressbookObjects.listTrash take or answer.
PimTrashedObjectPageThe PimTrashedObjectPage type of the TypeScript SDK, which calendarObjects.listTrash and addressbookObjects.listTrash take or answer.
PrefsThe Prefs type of the TypeScript SDK, which identities.getPreferences and identities.setPreferences take or answer.
PublicBrandingThe PublicBranding type of the TypeScript SDK, which branding.get take or answer.
PublicBrandingByHostThe PublicBrandingByHost type of the TypeScript SDK, which branding.getByHost take or answer.
PushSubscriptionThe PushSubscription type of the TypeScript SDK, which pushSubscriptions.create and pushSubscriptions.update take or answer.
PushSubscriptionPageThe PushSubscriptionPage type of the TypeScript SDK, which pushSubscriptions.list take or answer.
PutMailShareBodyThe PutMailShareBody type of the TypeScript SDK, which mailboxShares.grant take or answer.
QueryMessagesUpdateResultThe QueryMessagesUpdateResult type of the TypeScript SDK, which search.updateMatches take or answer.
RecipientAcceptedThe RecipientAccepted type of the TypeScript SDK, which mta.checkRecipient take or answer.
RecipientDeliveryStatusThe RecipientDeliveryStatus type of the TypeScript SDK, part of MessageDeliveryStatus.
RecoveryAddressDeletedThe RecoveryAddressDeleted type of the TypeScript SDK, which recovery.removeAddress take or answer.
RecoveryAddressPendingThe RecoveryAddressPending type of the TypeScript SDK, which recovery.setAddress take or answer.
RecoveryAddressVerifiedThe RecoveryAddressVerified type of the TypeScript SDK, which recovery.confirmAddress take or answer.
RecoveryCodesIssuedThe RecoveryCodesIssued type of the TypeScript SDK, which recovery.createCodes take or answer.
RecoveryCompletedThe RecoveryCompleted type of the TypeScript SDK, which passwords.reset take or answer.
RecoveryInvitationSentThe RecoveryInvitationSent type of the TypeScript SDK, which passwords.invite take or answer.
RecoveryPolicyThe RecoveryPolicy type of the TypeScript SDK, which accounts.setRecoveryPolicy take or answer.
RecoveryStatusThe RecoveryStatus type of the TypeScript SDK, which recovery.getStatus take or answer.
RecoveryStatusInvitationAn outstanding provisioning invitation, or null. This IS the idempotency answer for POST /identities/:id/invitation (§XVII.5): a caller that lost its create…
RenamedResultThe RenamedResult type of the TypeScript SDK, which labels.update and labels.updateById take or answer.
ReplyContextThe ReplyContext type of the TypeScript SDK, part of ThreadView.
RequestBreakdownRowThe RequestBreakdownRow type of the TypeScript SDK, part of AccountUsage.
RequestsSeriesPointThe RequestsSeriesPoint type of the TypeScript SDK, part of AccountRequests.
RetentionThe Retention type of the TypeScript SDK, which mailboxes.getRetention and 2 more methods take or answer.
RetentionPreviewThe RetentionPreview type of the TypeScript SDK, part of AccountRetentionRow and 1 more types.
RevokedResultThe RevokedResult type of the TypeScript SDK, which apiKeys.revoke and credentials.revoke take or answer.
RouteThe Route type of the TypeScript SDK, which routes.create and 3 more methods take or answer.
RouteMemberThe RouteMember type of the TypeScript SDK, which routes.listMembers and routes.replaceMembers take or answer.
RouteMemberBatchResultThe RouteMemberBatchResult type of the TypeScript SDK, which routes.addMembers take or answer.
RouteMemberRefThe RouteMemberRef type of the TypeScript SDK, which routes.addMember take or answer.
RuleActionThe RuleAction type of the TypeScript SDK, part of FilterRule.
RuleActionAddFlagThe RuleActionAddFlag type of the TypeScript SDK, part of RuleAction.
RuleActionDiscardThe RuleActionDiscard type of the TypeScript SDK, part of RuleAction.
RuleActionFileIntoThe RuleActionFileInto type of the TypeScript SDK, part of RuleAction.
RuleActionRedirectThe RuleActionRedirect type of the TypeScript SDK, part of RuleAction.
RuleConditionThe RuleCondition type of the TypeScript SDK, part of FilterRule.
RuleConditionOption1The RuleConditionOption1 type of the TypeScript SDK, part of RuleCondition.
RuleConditionOption2The RuleConditionOption2 type of the TypeScript SDK, part of RuleCondition.
RuleConditionOption3The RuleConditionOption3 type of the TypeScript SDK, part of RuleCondition.
RuleConditionOption4The RuleConditionOption4 type of the TypeScript SDK, part of RuleCondition.
RuleConditionOption5The RuleConditionOption5 type of the TypeScript SDK, part of RuleCondition.
RulesDocumentThe RulesDocument type of the TypeScript SDK, which rules.set take or answer.
ScheduledLegResultThe ScheduledLegResult type of the TypeScript SDK, part of ScheduledSend.
ScheduledSendThe ScheduledSend type of the TypeScript SDK, which messages.send and 5 more methods take or answer.
SchedulingInboxPageThe SchedulingInboxPage type of the TypeScript SDK, which schedulingInbox.list take or answer.
SchedulingInboxPageEntriesItemThe SchedulingInboxPageEntriesItem type of the TypeScript SDK, part of SchedulingInboxPage.
SemanticCoverageThe SemanticCoverage type of the TypeScript SDK, part of SemanticSearchResult and 1 more types.
SemanticSearchResultThe SemanticSearchResult type of the TypeScript SDK, which search.semantic take or answer.
SendAsAddressesThe SendAsAddresses type of the TypeScript SDK, which mailboxes.listSendAs take or answer.
SendAsAddressesAddressesItemThe SendAsAddressesAddressesItem type of the TypeScript SDK, part of SendAsAddresses.
SendRecipientResultThe SendRecipientResult type of the TypeScript SDK, part of SendResult.
SendResultThe SendResult type of the TypeScript SDK, which messages.send and 2 more methods take or answer.
SendStateThe SendState type of the TypeScript SDK, which mailboxes.getSendState take or answer.
SendUsageThe SendUsage type of the TypeScript SDK, which domains.getForwardUsage and mailboxes.getSendUsage take or answer.
SenderCheckThe SenderCheck type of the TypeScript SDK, which mailboxes.checkSendAs take or answer.
SharedMailboxThe SharedMailbox type of the TypeScript SDK, which mailboxShares.listSharedWithMe take or answer.
SieveActivatedThe SieveActivated type of the TypeScript SDK, which sieve.activate take or answer.
SieveActiveNameThe SieveActiveName type of the TypeScript SDK, which sieve.getActive take or answer.
SieveCapabilitiesThe SieveCapabilities type of the TypeScript SDK, which sieve.getCapabilities take or answer.
SieveCheckResultThe SieveCheckResult type of the TypeScript SDK, which sieve.check take or answer.
SieveDeactivatedThe SieveDeactivated type of the TypeScript SDK, which sieve.deactivate take or answer.
SieveDeletedThe SieveDeleted type of the TypeScript SDK, which sieve.deleteScript take or answer.
SievePutResultThe SievePutResult type of the TypeScript SDK, which sieve.putScript take or answer.
SieveRenamedThe SieveRenamed type of the TypeScript SDK, which sieve.renameScript take or answer.
SieveScriptThe SieveScript type of the TypeScript SDK, which sieve.listScripts take or answer.
SieveScriptBodyThe SieveScriptBody type of the TypeScript SDK, which sieve.getScript take or answer.
SimilarMessagesResultThe SimilarMessagesResult type of the TypeScript SDK, which search.similar take or answer.
SuppressionThe Suppression type of the TypeScript SDK, which suppressions.list and suppressions.get take or answer.
SuppressionListThe SuppressionList type of the TypeScript SDK, which suppressions.list take or answer.
ThreadListItemThe ThreadListItem type of the TypeScript SDK, which threads.list take or answer.
ThreadParticipantOne sender in the conversation; name is null when the From header carried no display name.
ThreadViewThe ThreadView type of the TypeScript SDK, which threads.get take or answer.
TrafficEventThe TrafficEvent type of the TypeScript SDK, which domains.listEvents take or answer.
TrafficEventTemplateThe 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…
TrafficRowThe TrafficRow type of the TypeScript SDK, part of AccountTraffic and 1 more types.
TrafficSeriesPointThe TrafficSeriesPoint type of the TypeScript SDK, part of AccountTraffic and 1 more types.
UploadResultThe UploadResult type of the TypeScript SDK, which uploads.create take or answer.
UsageDayThe UsageDay type of the TypeScript SDK, part of AccountUsage.
VacationThe Vacation type of the TypeScript SDK, which vacation.get and vacation.set take or answer.
ValidationErrorThe ValidationError type of the TypeScript SDK, part of ErrorOrValidation.
ValidationErrorIssuesItemThe ValidationErrorIssuesItem type of the TypeScript SDK, part of ValidationError.
VanishedResultThe VanishedResult type of the TypeScript SDK, which labels.listVanished take or answer.
VerifiedRecipientThe VerifiedRecipient type of the TypeScript SDK, which verifiedRecipients.list take or answer.
VerifiedRecipientAddedThe VerifiedRecipientAdded type of the TypeScript SDK, which verifiedRecipients.add take or answer.
WebauthnCredentialThe WebauthnCredential type of the TypeScript SDK, which securityKeys.finishRegistration and securityKeys.list take or answer.
WebauthnRegistrationOptionsThe WebauthnRegistrationOptions type of the TypeScript SDK, which securityKeys.beginRegistration take or answer.
WebauthnRegistrationOptionsAuthenticatorSelectionThe WebauthnRegistrationOptionsAuthenticatorSelection type of the TypeScript SDK, part of WebauthnRegistrationOptions.
WebauthnRegistrationOptionsExcludeCredentialsItemThe WebauthnRegistrationOptionsExcludeCredentialsItem type of the TypeScript SDK, part of WebauthnRegistrationOptions.
WebauthnRegistrationOptionsPubKeyCredParamsItemThe WebauthnRegistrationOptionsPubKeyCredParamsItem type of the TypeScript SDK, part of WebauthnRegistrationOptions.
WebauthnRegistrationOptionsRpThe WebauthnRegistrationOptionsRp type of the TypeScript SDK, part of WebauthnRegistrationOptions.
WebauthnRegistrationOptionsUserThe WebauthnRegistrationOptionsUser type of the TypeScript SDK, part of WebauthnRegistrationOptions.
WebhookDeliveryAttachmentThe WebhookDeliveryAttachment type of the TypeScript SDK, part of WebhookDeliveryMessage.
WebhookDeliveryAuthThe WebhookDeliveryAuth type of the TypeScript SDK, part of WebhookDeliveryMessage.
WebhookDeliveryMessageThe parsed message; degraded forms carry bodiesOmitted, never null.
WebhookDeliveryPayloadWhat parseMessageWebhook answers: the message a message webhook posts to your endpoint, its signature checked first.
WhoamiResultThe WhoamiResult type of the TypeScript SDK, which auth.whoami take or answer.