Skip to content

MailSlurp JS

Table of contents

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

References

default

Renames and re-exports MailSlurp

Type aliases

Config

Ƭ Config: Object

MailSlurp config

remarks Obtain your API Key in your dashboard.

Type declaration

Name Type
apiKey string
attribution? string
basePath? string
fetchApi? FetchAPI

FetchAPI

Ƭ FetchAPI: WindowOrWorkerGlobalScope["fetch"]

GetMessagesOptions

Ƭ GetMessagesOptions: Object

Options for advanced message fetching

remarks For more control over fetching. See also Webhook endpoints

Type declaration

Name Type
limit? number
minCount? number
retryTimeout? number
since? Date
size? number
sort? SortEnum

HTTPBody

Ƭ HTTPBody: Json | FormData | URLSearchParams

HTTPHeaders

Ƭ HTTPHeaders: Object

Index signature

▪ [key: string]: string

HTTPMethod

Ƭ HTTPMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"

HTTPQuery

Ƭ HTTPQuery: Object

Index signature

▪ [key: string]: string | number | null | boolean | (string | number | null | boolean)[] | HTTPQuery

Json

Ƭ Json: any

ModelPropertyNaming

Ƭ ModelPropertyNaming: "camelCase" | "snake_case" | "PascalCase" | "original"

Variables

BASE_PATH

• BASE_PATH: string

MailSlurp API MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository

The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.

COLLECTION_FORMATS

• COLLECTION_FORMATS: Object

Type declaration

Name Type
csv string
pipes string
ssv string
tsv string

Functions

AbstractWebhookPayloadFromJSON

▸ AbstractWebhookPayloadFromJSON(json): AbstractWebhookPayload

Parameters

Name Type
json any

Returns

AbstractWebhookPayload

AbstractWebhookPayloadFromJSONTyped

▸ AbstractWebhookPayloadFromJSONTyped(json, ignoreDiscriminator): AbstractWebhookPayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

AbstractWebhookPayload

AbstractWebhookPayloadToJSON

▸ AbstractWebhookPayloadToJSON(value?): any

Parameters

Name Type
value? AbstractWebhookPayload

Returns

any

AliasDtoFromJSON

▸ AliasDtoFromJSON(json): AliasDto

Parameters

Name Type
json any

Returns

AliasDto

AliasDtoFromJSONTyped

▸ AliasDtoFromJSONTyped(json, ignoreDiscriminator): AliasDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

AliasDto

AliasDtoToJSON

▸ AliasDtoToJSON(value?): any

Parameters

Name Type
value? AliasDto

Returns

any

AliasProjectionFromJSON

▸ AliasProjectionFromJSON(json): AliasProjection

Parameters

Name Type
json any

Returns

AliasProjection

AliasProjectionFromJSONTyped

▸ AliasProjectionFromJSONTyped(json, ignoreDiscriminator): AliasProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

AliasProjection

AliasProjectionToJSON

▸ AliasProjectionToJSON(value?): any

Parameters

Name Type
value? AliasProjection

Returns

any

AttachmentEntityFromJSON

▸ AttachmentEntityFromJSON(json): AttachmentEntity

Parameters

Name Type
json any

Returns

AttachmentEntity

AttachmentEntityFromJSONTyped

▸ AttachmentEntityFromJSONTyped(json, ignoreDiscriminator): AttachmentEntity

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

AttachmentEntity

AttachmentEntityToJSON

▸ AttachmentEntityToJSON(value?): any

Parameters

Name Type
value? AttachmentEntity

Returns

any

AttachmentMetaDataFromJSON

▸ AttachmentMetaDataFromJSON(json): AttachmentMetaData

Parameters

Name Type
json any

Returns

AttachmentMetaData

AttachmentMetaDataFromJSONTyped

▸ AttachmentMetaDataFromJSONTyped(json, ignoreDiscriminator): AttachmentMetaData

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

AttachmentMetaData

AttachmentMetaDataToJSON

▸ AttachmentMetaDataToJSON(value?): any

Parameters

Name Type
value? AttachmentMetaData

Returns

any

AttachmentProjectionFromJSON

▸ AttachmentProjectionFromJSON(json): AttachmentProjection

Parameters

Name Type
json any

Returns

AttachmentProjection

AttachmentProjectionFromJSONTyped

▸ AttachmentProjectionFromJSONTyped(json, ignoreDiscriminator): AttachmentProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

AttachmentProjection

AttachmentProjectionToJSON

▸ AttachmentProjectionToJSON(value?): any

Parameters

Name Type
value? AttachmentProjection

Returns

any

BasicAuthOptionsFromJSON

▸ BasicAuthOptionsFromJSON(json): BasicAuthOptions

Parameters

Name Type
json any

Returns

BasicAuthOptions

BasicAuthOptionsFromJSONTyped

▸ BasicAuthOptionsFromJSONTyped(json, ignoreDiscriminator): BasicAuthOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

BasicAuthOptions

BasicAuthOptionsToJSON

▸ BasicAuthOptionsToJSON(value?): any

Parameters

Name Type
value? BasicAuthOptions

Returns

any

BounceProjectionFromJSON

▸ BounceProjectionFromJSON(json): BounceProjection

Parameters

Name Type
json any

Returns

BounceProjection

BounceProjectionFromJSONTyped

▸ BounceProjectionFromJSONTyped(json, ignoreDiscriminator): BounceProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

BounceProjection

BounceProjectionToJSON

▸ BounceProjectionToJSON(value?): any

Parameters

Name Type
value? BounceProjection

Returns

any

BounceRecipientFromJSON

▸ BounceRecipientFromJSON(json): BounceRecipient

Parameters

Name Type
json any

Returns

BounceRecipient

BounceRecipientFromJSONTyped

▸ BounceRecipientFromJSONTyped(json, ignoreDiscriminator): BounceRecipient

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

BounceRecipient

BounceRecipientToJSON

▸ BounceRecipientToJSON(value?): any

Parameters

Name Type
value? BounceRecipient

Returns

any

BouncedEmailDtoFromJSON

▸ BouncedEmailDtoFromJSON(json): BouncedEmailDto

Parameters

Name Type
json any

Returns

BouncedEmailDto

BouncedEmailDtoFromJSONTyped

▸ BouncedEmailDtoFromJSONTyped(json, ignoreDiscriminator): BouncedEmailDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

BouncedEmailDto

BouncedEmailDtoToJSON

▸ BouncedEmailDtoToJSON(value?): any

Parameters

Name Type
value? BouncedEmailDto

Returns

any

BouncedRecipientDtoFromJSON

▸ BouncedRecipientDtoFromJSON(json): BouncedRecipientDto

Parameters

Name Type
json any

Returns

BouncedRecipientDto

BouncedRecipientDtoFromJSONTyped

▸ BouncedRecipientDtoFromJSONTyped(json, ignoreDiscriminator): BouncedRecipientDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

BouncedRecipientDto

BouncedRecipientDtoToJSON

▸ BouncedRecipientDtoToJSON(value?): any

Parameters

Name Type
value? BouncedRecipientDto

Returns

any

BulkSendEmailOptionsFromJSON

▸ BulkSendEmailOptionsFromJSON(json): BulkSendEmailOptions

Parameters

Name Type
json any

Returns

BulkSendEmailOptions

BulkSendEmailOptionsFromJSONTyped

▸ BulkSendEmailOptionsFromJSONTyped(json, ignoreDiscriminator): BulkSendEmailOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

BulkSendEmailOptions

BulkSendEmailOptionsToJSON

▸ BulkSendEmailOptionsToJSON(value?): any

Parameters

Name Type
value? BulkSendEmailOptions

Returns

any

ConditionOptionFromJSON

▸ ConditionOptionFromJSON(json): ConditionOption

Parameters

Name Type
json any

Returns

ConditionOption

ConditionOptionFromJSONTyped

▸ ConditionOptionFromJSONTyped(json, ignoreDiscriminator): ConditionOption

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ConditionOption

ConditionOptionToJSON

▸ ConditionOptionToJSON(value?): any

Parameters

Name Type
value? ConditionOption

Returns

any

ContactDtoFromJSON

▸ ContactDtoFromJSON(json): ContactDto

Parameters

Name Type
json any

Returns

ContactDto

ContactDtoFromJSONTyped

▸ ContactDtoFromJSONTyped(json, ignoreDiscriminator): ContactDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ContactDto

ContactDtoToJSON

▸ ContactDtoToJSON(value?): any

Parameters

Name Type
value? ContactDto

Returns

any

ContactProjectionFromJSON

▸ ContactProjectionFromJSON(json): ContactProjection

Parameters

Name Type
json any

Returns

ContactProjection

ContactProjectionFromJSONTyped

▸ ContactProjectionFromJSONTyped(json, ignoreDiscriminator): ContactProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ContactProjection

ContactProjectionToJSON

▸ ContactProjectionToJSON(value?): any

Parameters

Name Type
value? ContactProjection

Returns

any

ContentMatchOptionsFromJSON

▸ ContentMatchOptionsFromJSON(json): ContentMatchOptions

Parameters

Name Type
json any

Returns

ContentMatchOptions

ContentMatchOptionsFromJSONTyped

▸ ContentMatchOptionsFromJSONTyped(json, ignoreDiscriminator): ContentMatchOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ContentMatchOptions

ContentMatchOptionsToJSON

▸ ContentMatchOptionsToJSON(value?): any

Parameters

Name Type
value? ContentMatchOptions

Returns

any

CountDtoFromJSON

▸ CountDtoFromJSON(json): CountDto

Parameters

Name Type
json any

Returns

CountDto

CountDtoFromJSONTyped

▸ CountDtoFromJSONTyped(json, ignoreDiscriminator): CountDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CountDto

CountDtoToJSON

▸ CountDtoToJSON(value?): any

Parameters

Name Type
value? CountDto

Returns

any

CreateAliasOptionsFromJSON

▸ CreateAliasOptionsFromJSON(json): CreateAliasOptions

Parameters

Name Type
json any

Returns

CreateAliasOptions

CreateAliasOptionsFromJSONTyped

▸ CreateAliasOptionsFromJSONTyped(json, ignoreDiscriminator): CreateAliasOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateAliasOptions

CreateAliasOptionsToJSON

▸ CreateAliasOptionsToJSON(value?): any

Parameters

Name Type
value? CreateAliasOptions

Returns

any

CreateContactOptionsFromJSON

▸ CreateContactOptionsFromJSON(json): CreateContactOptions

Parameters

Name Type
json any

Returns

CreateContactOptions

CreateContactOptionsFromJSONTyped

▸ CreateContactOptionsFromJSONTyped(json, ignoreDiscriminator): CreateContactOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateContactOptions

CreateContactOptionsToJSON

▸ CreateContactOptionsToJSON(value?): any

Parameters

Name Type
value? CreateContactOptions

Returns

any

CreateDomainOptionsFromJSON

▸ CreateDomainOptionsFromJSON(json): CreateDomainOptions

Parameters

Name Type
json any

Returns

CreateDomainOptions

CreateDomainOptionsFromJSONTyped

▸ CreateDomainOptionsFromJSONTyped(json, ignoreDiscriminator): CreateDomainOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateDomainOptions

CreateDomainOptionsToJSON

▸ CreateDomainOptionsToJSON(value?): any

Parameters

Name Type
value? CreateDomainOptions

Returns

any

CreateGroupOptionsFromJSON

▸ CreateGroupOptionsFromJSON(json): CreateGroupOptions

Parameters

Name Type
json any

Returns

CreateGroupOptions

CreateGroupOptionsFromJSONTyped

▸ CreateGroupOptionsFromJSONTyped(json, ignoreDiscriminator): CreateGroupOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateGroupOptions

CreateGroupOptionsToJSON

▸ CreateGroupOptionsToJSON(value?): any

Parameters

Name Type
value? CreateGroupOptions

Returns

any

CreateInboxDtoFromJSON

▸ CreateInboxDtoFromJSON(json): CreateInboxDto

Parameters

Name Type
json any

Returns

CreateInboxDto

CreateInboxDtoFromJSONTyped

▸ CreateInboxDtoFromJSONTyped(json, ignoreDiscriminator): CreateInboxDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateInboxDto

CreateInboxDtoToJSON

▸ CreateInboxDtoToJSON(value?): any

Parameters

Name Type
value? CreateInboxDto

Returns

any

CreateInboxForwarderOptionsFromJSON

▸ CreateInboxForwarderOptionsFromJSON(json): CreateInboxForwarderOptions

Parameters

Name Type
json any

Returns

CreateInboxForwarderOptions

CreateInboxForwarderOptionsFromJSONTyped

▸ CreateInboxForwarderOptionsFromJSONTyped(json, ignoreDiscriminator): CreateInboxForwarderOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateInboxForwarderOptions

CreateInboxForwarderOptionsToJSON

▸ CreateInboxForwarderOptionsToJSON(value?): any

Parameters

Name Type
value? CreateInboxForwarderOptions

Returns

any

CreateInboxRulesetOptionsFromJSON

▸ CreateInboxRulesetOptionsFromJSON(json): CreateInboxRulesetOptions

Parameters

Name Type
json any

Returns

CreateInboxRulesetOptions

CreateInboxRulesetOptionsFromJSONTyped

▸ CreateInboxRulesetOptionsFromJSONTyped(json, ignoreDiscriminator): CreateInboxRulesetOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateInboxRulesetOptions

CreateInboxRulesetOptionsToJSON

▸ CreateInboxRulesetOptionsToJSON(value?): any

Parameters

Name Type
value? CreateInboxRulesetOptions

Returns

any

CreateTemplateOptionsFromJSON

▸ CreateTemplateOptionsFromJSON(json): CreateTemplateOptions

Parameters

Name Type
json any

Returns

CreateTemplateOptions

CreateTemplateOptionsFromJSONTyped

▸ CreateTemplateOptionsFromJSONTyped(json, ignoreDiscriminator): CreateTemplateOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateTemplateOptions

CreateTemplateOptionsToJSON

▸ CreateTemplateOptionsToJSON(value?): any

Parameters

Name Type
value? CreateTemplateOptions

Returns

any

CreateTrackingPixelOptionsFromJSON

▸ CreateTrackingPixelOptionsFromJSON(json): CreateTrackingPixelOptions

Parameters

Name Type
json any

Returns

CreateTrackingPixelOptions

CreateTrackingPixelOptionsFromJSONTyped

▸ CreateTrackingPixelOptionsFromJSONTyped(json, ignoreDiscriminator): CreateTrackingPixelOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateTrackingPixelOptions

CreateTrackingPixelOptionsToJSON

▸ CreateTrackingPixelOptionsToJSON(value?): any

Parameters

Name Type
value? CreateTrackingPixelOptions

Returns

any

CreateWebhookOptionsFromJSON

▸ CreateWebhookOptionsFromJSON(json): CreateWebhookOptions

Parameters

Name Type
json any

Returns

CreateWebhookOptions

CreateWebhookOptionsFromJSONTyped

▸ CreateWebhookOptionsFromJSONTyped(json, ignoreDiscriminator): CreateWebhookOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

CreateWebhookOptions

CreateWebhookOptionsToJSON

▸ CreateWebhookOptionsToJSON(value?): any

Parameters

Name Type
value? CreateWebhookOptions

Returns

any

DNSLookupOptionsFromJSON

▸ DNSLookupOptionsFromJSON(json): DNSLookupOptions

Parameters

Name Type
json any

Returns

DNSLookupOptions

DNSLookupOptionsFromJSONTyped

▸ DNSLookupOptionsFromJSONTyped(json, ignoreDiscriminator): DNSLookupOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DNSLookupOptions

DNSLookupOptionsToJSON

▸ DNSLookupOptionsToJSON(value?): any

Parameters

Name Type
value? DNSLookupOptions

Returns

any

DNSLookupResultFromJSON

▸ DNSLookupResultFromJSON(json): DNSLookupResult

Parameters

Name Type
json any

Returns

DNSLookupResult

DNSLookupResultFromJSONTyped

▸ DNSLookupResultFromJSONTyped(json, ignoreDiscriminator): DNSLookupResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DNSLookupResult

DNSLookupResultToJSON

▸ DNSLookupResultToJSON(value?): any

Parameters

Name Type
value? DNSLookupResult

Returns

any

DNSLookupResultsFromJSON

▸ DNSLookupResultsFromJSON(json): DNSLookupResults

Parameters

Name Type
json any

Returns

DNSLookupResults

DNSLookupResultsFromJSONTyped

▸ DNSLookupResultsFromJSONTyped(json, ignoreDiscriminator): DNSLookupResults

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DNSLookupResults

DNSLookupResultsToJSON

▸ DNSLookupResultsToJSON(value?): any

Parameters

Name Type
value? DNSLookupResults

Returns

any

DescribeDomainOptionsFromJSON

▸ DescribeDomainOptionsFromJSON(json): DescribeDomainOptions

Parameters

Name Type
json any

Returns

DescribeDomainOptions

DescribeDomainOptionsFromJSONTyped

▸ DescribeDomainOptionsFromJSONTyped(json, ignoreDiscriminator): DescribeDomainOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DescribeDomainOptions

DescribeDomainOptionsToJSON

▸ DescribeDomainOptionsToJSON(value?): any

Parameters

Name Type
value? DescribeDomainOptions

Returns

any

DescribeMailServerDomainResultFromJSON

▸ DescribeMailServerDomainResultFromJSON(json): DescribeMailServerDomainResult

Parameters

Name Type
json any

Returns

DescribeMailServerDomainResult

DescribeMailServerDomainResultFromJSONTyped

▸ DescribeMailServerDomainResultFromJSONTyped(json, ignoreDiscriminator): DescribeMailServerDomainResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DescribeMailServerDomainResult

DescribeMailServerDomainResultToJSON

▸ DescribeMailServerDomainResultToJSON(value?): any

Parameters

Name Type
value? DescribeMailServerDomainResult

Returns

any

DomainDtoFromJSON

▸ DomainDtoFromJSON(json): DomainDto

Parameters

Name Type
json any

Returns

DomainDto

DomainDtoFromJSONTyped

▸ DomainDtoFromJSONTyped(json, ignoreDiscriminator): DomainDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DomainDto

DomainDtoToJSON

▸ DomainDtoToJSON(value?): any

Parameters

Name Type
value? DomainDto

Returns

any

DomainNameRecordFromJSON

▸ DomainNameRecordFromJSON(json): DomainNameRecord

Parameters

Name Type
json any

Returns

DomainNameRecord

DomainNameRecordFromJSONTyped

▸ DomainNameRecordFromJSONTyped(json, ignoreDiscriminator): DomainNameRecord

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DomainNameRecord

DomainNameRecordToJSON

▸ DomainNameRecordToJSON(value?): any

Parameters

Name Type
value? DomainNameRecord

Returns

any

DomainPreviewFromJSON

▸ DomainPreviewFromJSON(json): DomainPreview

Parameters

Name Type
json any

Returns

DomainPreview

DomainPreviewFromJSONTyped

▸ DomainPreviewFromJSONTyped(json, ignoreDiscriminator): DomainPreview

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DomainPreview

DomainPreviewToJSON

▸ DomainPreviewToJSON(value?): any

Parameters

Name Type
value? DomainPreview

Returns

any

DownloadAttachmentDtoFromJSON

▸ DownloadAttachmentDtoFromJSON(json): DownloadAttachmentDto

Parameters

Name Type
json any

Returns

DownloadAttachmentDto

DownloadAttachmentDtoFromJSONTyped

▸ DownloadAttachmentDtoFromJSONTyped(json, ignoreDiscriminator): DownloadAttachmentDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

DownloadAttachmentDto

DownloadAttachmentDtoToJSON

▸ DownloadAttachmentDtoToJSON(value?): any

Parameters

Name Type
value? DownloadAttachmentDto

Returns

any

EmailAnalysisFromJSON

▸ EmailAnalysisFromJSON(json): EmailAnalysis

Parameters

Name Type
json any

Returns

EmailAnalysis

EmailAnalysisFromJSONTyped

▸ EmailAnalysisFromJSONTyped(json, ignoreDiscriminator): EmailAnalysis

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailAnalysis

EmailAnalysisToJSON

▸ EmailAnalysisToJSON(value?): any

Parameters

Name Type
value? EmailAnalysis

Returns

any

EmailContentMatchResultFromJSON

▸ EmailContentMatchResultFromJSON(json): EmailContentMatchResult

Parameters

Name Type
json any

Returns

EmailContentMatchResult

EmailContentMatchResultFromJSONTyped

▸ EmailContentMatchResultFromJSONTyped(json, ignoreDiscriminator): EmailContentMatchResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailContentMatchResult

EmailContentMatchResultToJSON

▸ EmailContentMatchResultToJSON(value?): any

Parameters

Name Type
value? EmailContentMatchResult

Returns

any

EmailFromJSON

▸ EmailFromJSON(json): Email

Parameters

Name Type
json any

Returns

Email

EmailFromJSONTyped

▸ EmailFromJSONTyped(json, ignoreDiscriminator): Email

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

Email

EmailLinksResultFromJSON

▸ EmailLinksResultFromJSON(json): EmailLinksResult

Parameters

Name Type
json any

Returns

EmailLinksResult

EmailLinksResultFromJSONTyped

▸ EmailLinksResultFromJSONTyped(json, ignoreDiscriminator): EmailLinksResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailLinksResult

EmailLinksResultToJSON

▸ EmailLinksResultToJSON(value?): any

Parameters

Name Type
value? EmailLinksResult

Returns

any

EmailPreviewFromJSON

▸ EmailPreviewFromJSON(json): EmailPreview

Parameters

Name Type
json any

Returns

EmailPreview

EmailPreviewFromJSONTyped

▸ EmailPreviewFromJSONTyped(json, ignoreDiscriminator): EmailPreview

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailPreview

EmailPreviewToJSON

▸ EmailPreviewToJSON(value?): any

Parameters

Name Type
value? EmailPreview

Returns

any

EmailPreviewUrlsFromJSON

▸ EmailPreviewUrlsFromJSON(json): EmailPreviewUrls

Parameters

Name Type
json any

Returns

EmailPreviewUrls

EmailPreviewUrlsFromJSONTyped

▸ EmailPreviewUrlsFromJSONTyped(json, ignoreDiscriminator): EmailPreviewUrls

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailPreviewUrls

EmailPreviewUrlsToJSON

▸ EmailPreviewUrlsToJSON(value?): any

Parameters

Name Type
value? EmailPreviewUrls

Returns

any

EmailProjectionFromJSON

▸ EmailProjectionFromJSON(json): EmailProjection

Parameters

Name Type
json any

Returns

EmailProjection

EmailProjectionFromJSONTyped

▸ EmailProjectionFromJSONTyped(json, ignoreDiscriminator): EmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailProjection

EmailProjectionToJSON

▸ EmailProjectionToJSON(value?): any

Parameters

Name Type
value? EmailProjection

Returns

any

EmailRecipientsFromJSON

▸ EmailRecipientsFromJSON(json): EmailRecipients

Parameters

Name Type
json any

Returns

EmailRecipients

EmailRecipientsFromJSONTyped

▸ EmailRecipientsFromJSONTyped(json, ignoreDiscriminator): EmailRecipients

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailRecipients

EmailRecipientsToJSON

▸ EmailRecipientsToJSON(value?): any

Parameters

Name Type
value? EmailRecipients

Returns

any

EmailTextLinesResultFromJSON

▸ EmailTextLinesResultFromJSON(json): EmailTextLinesResult

Parameters

Name Type
json any

Returns

EmailTextLinesResult

EmailTextLinesResultFromJSONTyped

▸ EmailTextLinesResultFromJSONTyped(json, ignoreDiscriminator): EmailTextLinesResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailTextLinesResult

EmailTextLinesResultToJSON

▸ EmailTextLinesResultToJSON(value?): any

Parameters

Name Type
value? EmailTextLinesResult

Returns

any

EmailToJSON

▸ EmailToJSON(value?): any

Parameters

Name Type
value? Email

Returns

any

EmailValidationRequestFromJSON

▸ EmailValidationRequestFromJSON(json): EmailValidationRequest

Parameters

Name Type
json any

Returns

EmailValidationRequest

EmailValidationRequestFromJSONTyped

▸ EmailValidationRequestFromJSONTyped(json, ignoreDiscriminator): EmailValidationRequest

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailValidationRequest

EmailValidationRequestToJSON

▸ EmailValidationRequestToJSON(value?): any

Parameters

Name Type
value? EmailValidationRequest

Returns

any

EmailVerificationResultFromJSON

▸ EmailVerificationResultFromJSON(json): EmailVerificationResult

Parameters

Name Type
json any

Returns

EmailVerificationResult

EmailVerificationResultFromJSONTyped

▸ EmailVerificationResultFromJSONTyped(json, ignoreDiscriminator): EmailVerificationResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

EmailVerificationResult

EmailVerificationResultToJSON

▸ EmailVerificationResultToJSON(value?): any

Parameters

Name Type
value? EmailVerificationResult

Returns

any

ExpirationDefaultsFromJSON

▸ ExpirationDefaultsFromJSON(json): ExpirationDefaults

Parameters

Name Type
json any

Returns

ExpirationDefaults

ExpirationDefaultsFromJSONTyped

▸ ExpirationDefaultsFromJSONTyped(json, ignoreDiscriminator): ExpirationDefaults

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ExpirationDefaults

ExpirationDefaultsToJSON

▸ ExpirationDefaultsToJSON(value?): any

Parameters

Name Type
value? ExpirationDefaults

Returns

any

ExpiredInboxDtoFromJSON

▸ ExpiredInboxDtoFromJSON(json): ExpiredInboxDto

Parameters

Name Type
json any

Returns

ExpiredInboxDto

ExpiredInboxDtoFromJSONTyped

▸ ExpiredInboxDtoFromJSONTyped(json, ignoreDiscriminator): ExpiredInboxDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ExpiredInboxDto

ExpiredInboxDtoToJSON

▸ ExpiredInboxDtoToJSON(value?): any

Parameters

Name Type
value? ExpiredInboxDto

Returns

any

ExpiredInboxRecordProjectionFromJSON

▸ ExpiredInboxRecordProjectionFromJSON(json): ExpiredInboxRecordProjection

Parameters

Name Type
json any

Returns

ExpiredInboxRecordProjection

ExpiredInboxRecordProjectionFromJSONTyped

▸ ExpiredInboxRecordProjectionFromJSONTyped(json, ignoreDiscriminator): ExpiredInboxRecordProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ExpiredInboxRecordProjection

ExpiredInboxRecordProjectionToJSON

▸ ExpiredInboxRecordProjectionToJSON(value?): any

Parameters

Name Type
value? ExpiredInboxRecordProjection

Returns

any

ExportLinkFromJSON

▸ ExportLinkFromJSON(json): ExportLink

Parameters

Name Type
json any

Returns

ExportLink

ExportLinkFromJSONTyped

▸ ExportLinkFromJSONTyped(json, ignoreDiscriminator): ExportLink

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ExportLink

ExportLinkToJSON

▸ ExportLinkToJSON(value?): any

Parameters

Name Type
value? ExportLink

Returns

any

ExportOptionsFromJSON

▸ ExportOptionsFromJSON(json): ExportOptions

Parameters

Name Type
json any

Returns

ExportOptions

ExportOptionsFromJSONTyped

▸ ExportOptionsFromJSONTyped(json, ignoreDiscriminator): ExportOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ExportOptions

ExportOptionsToJSON

▸ ExportOptionsToJSON(value?): any

Parameters

Name Type
value? ExportOptions

Returns

any

FilterBouncedRecipientsOptionsFromJSON

▸ FilterBouncedRecipientsOptionsFromJSON(json): FilterBouncedRecipientsOptions

Parameters

Name Type
json any

Returns

FilterBouncedRecipientsOptions

FilterBouncedRecipientsOptionsFromJSONTyped

▸ FilterBouncedRecipientsOptionsFromJSONTyped(json, ignoreDiscriminator): FilterBouncedRecipientsOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

FilterBouncedRecipientsOptions

FilterBouncedRecipientsOptionsToJSON

▸ FilterBouncedRecipientsOptionsToJSON(value?): any

Parameters

Name Type
value? FilterBouncedRecipientsOptions

Returns

any

FilterBouncedRecipientsResultFromJSON

▸ FilterBouncedRecipientsResultFromJSON(json): FilterBouncedRecipientsResult

Parameters

Name Type
json any

Returns

FilterBouncedRecipientsResult

FilterBouncedRecipientsResultFromJSONTyped

▸ FilterBouncedRecipientsResultFromJSONTyped(json, ignoreDiscriminator): FilterBouncedRecipientsResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

FilterBouncedRecipientsResult

FilterBouncedRecipientsResultToJSON

▸ FilterBouncedRecipientsResultToJSON(value?): any

Parameters

Name Type
value? FilterBouncedRecipientsResult

Returns

any

FlushExpiredInboxesResultFromJSON

▸ FlushExpiredInboxesResultFromJSON(json): FlushExpiredInboxesResult

Parameters

Name Type
json any

Returns

FlushExpiredInboxesResult

FlushExpiredInboxesResultFromJSONTyped

▸ FlushExpiredInboxesResultFromJSONTyped(json, ignoreDiscriminator): FlushExpiredInboxesResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

FlushExpiredInboxesResult

FlushExpiredInboxesResultToJSON

▸ FlushExpiredInboxesResultToJSON(value?): any

Parameters

Name Type
value? FlushExpiredInboxesResult

Returns

any

ForwardEmailOptionsFromJSON

▸ ForwardEmailOptionsFromJSON(json): ForwardEmailOptions

Parameters

Name Type
json any

Returns

ForwardEmailOptions

ForwardEmailOptionsFromJSONTyped

▸ ForwardEmailOptionsFromJSONTyped(json, ignoreDiscriminator): ForwardEmailOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ForwardEmailOptions

ForwardEmailOptionsToJSON

▸ ForwardEmailOptionsToJSON(value?): any

Parameters

Name Type
value? ForwardEmailOptions

Returns

any

GravatarUrlFromJSON

▸ GravatarUrlFromJSON(json): GravatarUrl

Parameters

Name Type
json any

Returns

GravatarUrl

GravatarUrlFromJSONTyped

▸ GravatarUrlFromJSONTyped(json, ignoreDiscriminator): GravatarUrl

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

GravatarUrl

GravatarUrlToJSON

▸ GravatarUrlToJSON(value?): any

Parameters

Name Type
value? GravatarUrl

Returns

any

GroupContactsDtoFromJSON

▸ GroupContactsDtoFromJSON(json): GroupContactsDto

Parameters

Name Type
json any

Returns

GroupContactsDto

GroupContactsDtoFromJSONTyped

▸ GroupContactsDtoFromJSONTyped(json, ignoreDiscriminator): GroupContactsDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

GroupContactsDto

GroupContactsDtoToJSON

▸ GroupContactsDtoToJSON(value?): any

Parameters

Name Type
value? GroupContactsDto

Returns

any

GroupDtoFromJSON

▸ GroupDtoFromJSON(json): GroupDto

Parameters

Name Type
json any

Returns

GroupDto

GroupDtoFromJSONTyped

▸ GroupDtoFromJSONTyped(json, ignoreDiscriminator): GroupDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

GroupDto

GroupDtoToJSON

▸ GroupDtoToJSON(value?): any

Parameters

Name Type
value? GroupDto

Returns

any

GroupProjectionFromJSON

▸ GroupProjectionFromJSON(json): GroupProjection

Parameters

Name Type
json any

Returns

GroupProjection

GroupProjectionFromJSONTyped

▸ GroupProjectionFromJSONTyped(json, ignoreDiscriminator): GroupProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

GroupProjection

GroupProjectionToJSON

▸ GroupProjectionToJSON(value?): any

Parameters

Name Type
value? GroupProjection

Returns

any

HTMLValidationResultFromJSON

▸ HTMLValidationResultFromJSON(json): HTMLValidationResult

Parameters

Name Type
json any

Returns

HTMLValidationResult

HTMLValidationResultFromJSONTyped

▸ HTMLValidationResultFromJSONTyped(json, ignoreDiscriminator): HTMLValidationResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

HTMLValidationResult

HTMLValidationResultToJSON

▸ HTMLValidationResultToJSON(value?): any

Parameters

Name Type
value? HTMLValidationResult

Returns

any

IPAddressResultFromJSON

▸ IPAddressResultFromJSON(json): IPAddressResult

Parameters

Name Type
json any

Returns

IPAddressResult

IPAddressResultFromJSONTyped

▸ IPAddressResultFromJSONTyped(json, ignoreDiscriminator): IPAddressResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

IPAddressResult

IPAddressResultToJSON

▸ IPAddressResultToJSON(value?): any

Parameters

Name Type
value? IPAddressResult

Returns

any

ImapFlagOperationOptionsFromJSON

▸ ImapFlagOperationOptionsFromJSON(json): ImapFlagOperationOptions

Parameters

Name Type
json any

Returns

ImapFlagOperationOptions

ImapFlagOperationOptionsFromJSONTyped

▸ ImapFlagOperationOptionsFromJSONTyped(json, ignoreDiscriminator): ImapFlagOperationOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ImapFlagOperationOptions

ImapFlagOperationOptionsToJSON

▸ ImapFlagOperationOptionsToJSON(value?): any

Parameters

Name Type
value? ImapFlagOperationOptions

Returns

any

ImapSmtpAccessDetailsFromJSON

▸ ImapSmtpAccessDetailsFromJSON(json): ImapSmtpAccessDetails

Parameters

Name Type
json any

Returns

ImapSmtpAccessDetails

ImapSmtpAccessDetailsFromJSONTyped

▸ ImapSmtpAccessDetailsFromJSONTyped(json, ignoreDiscriminator): ImapSmtpAccessDetails

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ImapSmtpAccessDetails

ImapSmtpAccessDetailsToJSON

▸ ImapSmtpAccessDetailsToJSON(value?): any

Parameters

Name Type
value? ImapSmtpAccessDetails

Returns

any

InboxByEmailAddressResultFromJSON

▸ InboxByEmailAddressResultFromJSON(json): InboxByEmailAddressResult

Parameters

Name Type
json any

Returns

InboxByEmailAddressResult

InboxByEmailAddressResultFromJSONTyped

▸ InboxByEmailAddressResultFromJSONTyped(json, ignoreDiscriminator): InboxByEmailAddressResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxByEmailAddressResult

InboxByEmailAddressResultToJSON

▸ InboxByEmailAddressResultToJSON(value?): any

Parameters

Name Type
value? InboxByEmailAddressResult

Returns

any

InboxDtoFromJSON

▸ InboxDtoFromJSON(json): InboxDto

Parameters

Name Type
json any

Returns

InboxDto

InboxDtoFromJSONTyped

▸ InboxDtoFromJSONTyped(json, ignoreDiscriminator): InboxDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxDto

InboxDtoToJSON

▸ InboxDtoToJSON(value?): any

Parameters

Name Type
value? InboxDto

Returns

any

InboxExistsDtoFromJSON

▸ InboxExistsDtoFromJSON(json): InboxExistsDto

Parameters

Name Type
json any

Returns

InboxExistsDto

InboxExistsDtoFromJSONTyped

▸ InboxExistsDtoFromJSONTyped(json, ignoreDiscriminator): InboxExistsDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxExistsDto

InboxExistsDtoToJSON

▸ InboxExistsDtoToJSON(value?): any

Parameters

Name Type
value? InboxExistsDto

Returns

any

InboxForwarderDtoFromJSON

▸ InboxForwarderDtoFromJSON(json): InboxForwarderDto

Parameters

Name Type
json any

Returns

InboxForwarderDto

InboxForwarderDtoFromJSONTyped

▸ InboxForwarderDtoFromJSONTyped(json, ignoreDiscriminator): InboxForwarderDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxForwarderDto

InboxForwarderDtoToJSON

▸ InboxForwarderDtoToJSON(value?): any

Parameters

Name Type
value? InboxForwarderDto

Returns

any

InboxForwarderTestOptionsFromJSON

▸ InboxForwarderTestOptionsFromJSON(json): InboxForwarderTestOptions

Parameters

Name Type
json any

Returns

InboxForwarderTestOptions

InboxForwarderTestOptionsFromJSONTyped

▸ InboxForwarderTestOptionsFromJSONTyped(json, ignoreDiscriminator): InboxForwarderTestOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxForwarderTestOptions

InboxForwarderTestOptionsToJSON

▸ InboxForwarderTestOptionsToJSON(value?): any

Parameters

Name Type
value? InboxForwarderTestOptions

Returns

any

InboxForwarderTestResultFromJSON

▸ InboxForwarderTestResultFromJSON(json): InboxForwarderTestResult

Parameters

Name Type
json any

Returns

InboxForwarderTestResult

InboxForwarderTestResultFromJSONTyped

▸ InboxForwarderTestResultFromJSONTyped(json, ignoreDiscriminator): InboxForwarderTestResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxForwarderTestResult

InboxForwarderTestResultToJSON

▸ InboxForwarderTestResultToJSON(value?): any

Parameters

Name Type
value? InboxForwarderTestResult

Returns

any

InboxIdItemFromJSON

▸ InboxIdItemFromJSON(json): InboxIdItem

Parameters

Name Type
json any

Returns

InboxIdItem

InboxIdItemFromJSONTyped

▸ InboxIdItemFromJSONTyped(json, ignoreDiscriminator): InboxIdItem

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxIdItem

InboxIdItemToJSON

▸ InboxIdItemToJSON(value?): any

Parameters

Name Type
value? InboxIdItem

Returns

any

InboxIdsResultFromJSON

▸ InboxIdsResultFromJSON(json): InboxIdsResult

Parameters

Name Type
json any

Returns

InboxIdsResult

InboxIdsResultFromJSONTyped

▸ InboxIdsResultFromJSONTyped(json, ignoreDiscriminator): InboxIdsResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxIdsResult

InboxIdsResultToJSON

▸ InboxIdsResultToJSON(value?): any

Parameters

Name Type
value? InboxIdsResult

Returns

any

InboxPreviewFromJSON

▸ InboxPreviewFromJSON(json): InboxPreview

Parameters

Name Type
json any

Returns

InboxPreview

InboxPreviewFromJSONTyped

▸ InboxPreviewFromJSONTyped(json, ignoreDiscriminator): InboxPreview

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxPreview

InboxPreviewToJSON

▸ InboxPreviewToJSON(value?): any

Parameters

Name Type
value? InboxPreview

Returns

any

InboxRulesetDtoFromJSON

▸ InboxRulesetDtoFromJSON(json): InboxRulesetDto

Parameters

Name Type
json any

Returns

InboxRulesetDto

InboxRulesetDtoFromJSONTyped

▸ InboxRulesetDtoFromJSONTyped(json, ignoreDiscriminator): InboxRulesetDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxRulesetDto

InboxRulesetDtoToJSON

▸ InboxRulesetDtoToJSON(value?): any

Parameters

Name Type
value? InboxRulesetDto

Returns

any

InboxRulesetTestOptionsFromJSON

▸ InboxRulesetTestOptionsFromJSON(json): InboxRulesetTestOptions

Parameters

Name Type
json any

Returns

InboxRulesetTestOptions

InboxRulesetTestOptionsFromJSONTyped

▸ InboxRulesetTestOptionsFromJSONTyped(json, ignoreDiscriminator): InboxRulesetTestOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxRulesetTestOptions

InboxRulesetTestOptionsToJSON

▸ InboxRulesetTestOptionsToJSON(value?): any

Parameters

Name Type
value? InboxRulesetTestOptions

Returns

any

InboxRulesetTestResultFromJSON

▸ InboxRulesetTestResultFromJSON(json): InboxRulesetTestResult

Parameters

Name Type
json any

Returns

InboxRulesetTestResult

InboxRulesetTestResultFromJSONTyped

▸ InboxRulesetTestResultFromJSONTyped(json, ignoreDiscriminator): InboxRulesetTestResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InboxRulesetTestResult

InboxRulesetTestResultToJSON

▸ InboxRulesetTestResultToJSON(value?): any

Parameters

Name Type
value? InboxRulesetTestResult

Returns

any

InlineObjectFromJSON

▸ InlineObjectFromJSON(json): InlineObject

Parameters

Name Type
json any

Returns

InlineObject

InlineObjectFromJSONTyped

▸ InlineObjectFromJSONTyped(json, ignoreDiscriminator): InlineObject

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

InlineObject

InlineObjectToJSON

▸ InlineObjectToJSON(value?): any

Parameters

Name Type
value? InlineObject

Returns

any

JSONSchemaDtoFromJSON

▸ JSONSchemaDtoFromJSON(json): JSONSchemaDto

Parameters

Name Type
json any

Returns

JSONSchemaDto

JSONSchemaDtoFromJSONTyped

▸ JSONSchemaDtoFromJSONTyped(json, ignoreDiscriminator): JSONSchemaDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

JSONSchemaDto

JSONSchemaDtoToJSON

▸ JSONSchemaDtoToJSON(value?): any

Parameters

Name Type
value? JSONSchemaDto

Returns

any

MatchOptionFromJSON

▸ MatchOptionFromJSON(json): MatchOption

Parameters

Name Type
json any

Returns

MatchOption

MatchOptionFromJSONTyped

▸ MatchOptionFromJSONTyped(json, ignoreDiscriminator): MatchOption

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

MatchOption

MatchOptionToJSON

▸ MatchOptionToJSON(value?): any

Parameters

Name Type
value? MatchOption

Returns

any

MatchOptionsFromJSON

▸ MatchOptionsFromJSON(json): MatchOptions

Parameters

Name Type
json any

Returns

MatchOptions

MatchOptionsFromJSONTyped

▸ MatchOptionsFromJSONTyped(json, ignoreDiscriminator): MatchOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

MatchOptions

MatchOptionsToJSON

▸ MatchOptionsToJSON(value?): any

Parameters

Name Type
value? MatchOptions

Returns

any

MissedEmailFromJSON

▸ MissedEmailFromJSON(json): MissedEmail

Parameters

Name Type
json any

Returns

MissedEmail

MissedEmailFromJSONTyped

▸ MissedEmailFromJSONTyped(json, ignoreDiscriminator): MissedEmail

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

MissedEmail

MissedEmailProjectionFromJSON

▸ MissedEmailProjectionFromJSON(json): MissedEmailProjection

Parameters

Name Type
json any

Returns

MissedEmailProjection

MissedEmailProjectionFromJSONTyped

▸ MissedEmailProjectionFromJSONTyped(json, ignoreDiscriminator): MissedEmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

MissedEmailProjection

MissedEmailProjectionToJSON

▸ MissedEmailProjectionToJSON(value?): any

Parameters

Name Type
value? MissedEmailProjection

Returns

any

MissedEmailToJSON

▸ MissedEmailToJSON(value?): any

Parameters

Name Type
value? MissedEmail

Returns

any

NameServerRecordFromJSON

▸ NameServerRecordFromJSON(json): NameServerRecord

Parameters

Name Type
json any

Returns

NameServerRecord

NameServerRecordFromJSONTyped

▸ NameServerRecordFromJSONTyped(json, ignoreDiscriminator): NameServerRecord

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

NameServerRecord

NameServerRecordToJSON

▸ NameServerRecordToJSON(value?): any

Parameters

Name Type
value? NameServerRecord

Returns

any

OrganizationInboxProjectionFromJSON

▸ OrganizationInboxProjectionFromJSON(json): OrganizationInboxProjection

Parameters

Name Type
json any

Returns

OrganizationInboxProjection

OrganizationInboxProjectionFromJSONTyped

▸ OrganizationInboxProjectionFromJSONTyped(json, ignoreDiscriminator): OrganizationInboxProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

OrganizationInboxProjection

OrganizationInboxProjectionToJSON

▸ OrganizationInboxProjectionToJSON(value?): any

Parameters

Name Type
value? OrganizationInboxProjection

Returns

any

PageAliasFromJSON

▸ PageAliasFromJSON(json): PageAlias

Parameters

Name Type
json any

Returns

PageAlias

PageAliasFromJSONTyped

▸ PageAliasFromJSONTyped(json, ignoreDiscriminator): PageAlias

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageAlias

PageAliasToJSON

▸ PageAliasToJSON(value?): any

Parameters

Name Type
value? PageAlias

Returns

any

PageAttachmentEntityFromJSON

▸ PageAttachmentEntityFromJSON(json): PageAttachmentEntity

Parameters

Name Type
json any

Returns

PageAttachmentEntity

PageAttachmentEntityFromJSONTyped

▸ PageAttachmentEntityFromJSONTyped(json, ignoreDiscriminator): PageAttachmentEntity

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageAttachmentEntity

PageAttachmentEntityToJSON

▸ PageAttachmentEntityToJSON(value?): any

Parameters

Name Type
value? PageAttachmentEntity

Returns

any

PageBouncedEmailFromJSON

▸ PageBouncedEmailFromJSON(json): PageBouncedEmail

Parameters

Name Type
json any

Returns

PageBouncedEmail

PageBouncedEmailFromJSONTyped

▸ PageBouncedEmailFromJSONTyped(json, ignoreDiscriminator): PageBouncedEmail

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageBouncedEmail

PageBouncedEmailToJSON

▸ PageBouncedEmailToJSON(value?): any

Parameters

Name Type
value? PageBouncedEmail

Returns

any

PageBouncedRecipientsFromJSON

▸ PageBouncedRecipientsFromJSON(json): PageBouncedRecipients

Parameters

Name Type
json any

Returns

PageBouncedRecipients

PageBouncedRecipientsFromJSONTyped

▸ PageBouncedRecipientsFromJSONTyped(json, ignoreDiscriminator): PageBouncedRecipients

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageBouncedRecipients

PageBouncedRecipientsToJSON

▸ PageBouncedRecipientsToJSON(value?): any

Parameters

Name Type
value? PageBouncedRecipients

Returns

any

PageContactProjectionFromJSON

▸ PageContactProjectionFromJSON(json): PageContactProjection

Parameters

Name Type
json any

Returns

PageContactProjection

PageContactProjectionFromJSONTyped

▸ PageContactProjectionFromJSONTyped(json, ignoreDiscriminator): PageContactProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageContactProjection

PageContactProjectionToJSON

▸ PageContactProjectionToJSON(value?): any

Parameters

Name Type
value? PageContactProjection

Returns

any

PageEmailPreviewFromJSON

▸ PageEmailPreviewFromJSON(json): PageEmailPreview

Parameters

Name Type
json any

Returns

PageEmailPreview

PageEmailPreviewFromJSONTyped

▸ PageEmailPreviewFromJSONTyped(json, ignoreDiscriminator): PageEmailPreview

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageEmailPreview

PageEmailPreviewToJSON

▸ PageEmailPreviewToJSON(value?): any

Parameters

Name Type
value? PageEmailPreview

Returns

any

PageEmailProjectionFromJSON

▸ PageEmailProjectionFromJSON(json): PageEmailProjection

Parameters

Name Type
json any

Returns

PageEmailProjection

PageEmailProjectionFromJSONTyped

▸ PageEmailProjectionFromJSONTyped(json, ignoreDiscriminator): PageEmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageEmailProjection

PageEmailProjectionToJSON

▸ PageEmailProjectionToJSON(value?): any

Parameters

Name Type
value? PageEmailProjection

Returns

any

PageEmailValidationRequestFromJSON

▸ PageEmailValidationRequestFromJSON(json): PageEmailValidationRequest

Parameters

Name Type
json any

Returns

PageEmailValidationRequest

PageEmailValidationRequestFromJSONTyped

▸ PageEmailValidationRequestFromJSONTyped(json, ignoreDiscriminator): PageEmailValidationRequest

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageEmailValidationRequest

PageEmailValidationRequestToJSON

▸ PageEmailValidationRequestToJSON(value?): any

Parameters

Name Type
value? PageEmailValidationRequest

Returns

any

PageExpiredInboxRecordProjectionFromJSON

▸ PageExpiredInboxRecordProjectionFromJSON(json): PageExpiredInboxRecordProjection

Parameters

Name Type
json any

Returns

PageExpiredInboxRecordProjection

PageExpiredInboxRecordProjectionFromJSONTyped

▸ PageExpiredInboxRecordProjectionFromJSONTyped(json, ignoreDiscriminator): PageExpiredInboxRecordProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageExpiredInboxRecordProjection

PageExpiredInboxRecordProjectionToJSON

▸ PageExpiredInboxRecordProjectionToJSON(value?): any

Parameters

Name Type
value? PageExpiredInboxRecordProjection

Returns

any

PageGroupProjectionFromJSON

▸ PageGroupProjectionFromJSON(json): PageGroupProjection

Parameters

Name Type
json any

Returns

PageGroupProjection

PageGroupProjectionFromJSONTyped

▸ PageGroupProjectionFromJSONTyped(json, ignoreDiscriminator): PageGroupProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageGroupProjection

PageGroupProjectionToJSON

▸ PageGroupProjectionToJSON(value?): any

Parameters

Name Type
value? PageGroupProjection

Returns

any

PageInboxForwarderDtoFromJSON

▸ PageInboxForwarderDtoFromJSON(json): PageInboxForwarderDto

Parameters

Name Type
json any

Returns

PageInboxForwarderDto

PageInboxForwarderDtoFromJSONTyped

▸ PageInboxForwarderDtoFromJSONTyped(json, ignoreDiscriminator): PageInboxForwarderDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageInboxForwarderDto

PageInboxForwarderDtoToJSON

▸ PageInboxForwarderDtoToJSON(value?): any

Parameters

Name Type
value? PageInboxForwarderDto

Returns

any

PageInboxProjectionFromJSON

▸ PageInboxProjectionFromJSON(json): PageInboxProjection

Parameters

Name Type
json any

Returns

PageInboxProjection

PageInboxProjectionFromJSONTyped

▸ PageInboxProjectionFromJSONTyped(json, ignoreDiscriminator): PageInboxProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageInboxProjection

PageInboxProjectionToJSON

▸ PageInboxProjectionToJSON(value?): any

Parameters

Name Type
value? PageInboxProjection

Returns

any

PageInboxRulesetDtoFromJSON

▸ PageInboxRulesetDtoFromJSON(json): PageInboxRulesetDto

Parameters

Name Type
json any

Returns

PageInboxRulesetDto

PageInboxRulesetDtoFromJSONTyped

▸ PageInboxRulesetDtoFromJSONTyped(json, ignoreDiscriminator): PageInboxRulesetDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageInboxRulesetDto

PageInboxRulesetDtoToJSON

▸ PageInboxRulesetDtoToJSON(value?): any

Parameters

Name Type
value? PageInboxRulesetDto

Returns

any

PageMissedEmailProjectionFromJSON

▸ PageMissedEmailProjectionFromJSON(json): PageMissedEmailProjection

Parameters

Name Type
json any

Returns

PageMissedEmailProjection

PageMissedEmailProjectionFromJSONTyped

▸ PageMissedEmailProjectionFromJSONTyped(json, ignoreDiscriminator): PageMissedEmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageMissedEmailProjection

PageMissedEmailProjectionToJSON

▸ PageMissedEmailProjectionToJSON(value?): any

Parameters

Name Type
value? PageMissedEmailProjection

Returns

any

PageOrganizationInboxProjectionFromJSON

▸ PageOrganizationInboxProjectionFromJSON(json): PageOrganizationInboxProjection

Parameters

Name Type
json any

Returns

PageOrganizationInboxProjection

PageOrganizationInboxProjectionFromJSONTyped

▸ PageOrganizationInboxProjectionFromJSONTyped(json, ignoreDiscriminator): PageOrganizationInboxProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageOrganizationInboxProjection

PageOrganizationInboxProjectionToJSON

▸ PageOrganizationInboxProjectionToJSON(value?): any

Parameters

Name Type
value? PageOrganizationInboxProjection

Returns

any

PageSentEmailProjectionFromJSON

▸ PageSentEmailProjectionFromJSON(json): PageSentEmailProjection

Parameters

Name Type
json any

Returns

PageSentEmailProjection

PageSentEmailProjectionFromJSONTyped

▸ PageSentEmailProjectionFromJSONTyped(json, ignoreDiscriminator): PageSentEmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageSentEmailProjection

PageSentEmailProjectionToJSON

▸ PageSentEmailProjectionToJSON(value?): any

Parameters

Name Type
value? PageSentEmailProjection

Returns

any

PageTemplateProjectionFromJSON

▸ PageTemplateProjectionFromJSON(json): PageTemplateProjection

Parameters

Name Type
json any

Returns

PageTemplateProjection

PageTemplateProjectionFromJSONTyped

▸ PageTemplateProjectionFromJSONTyped(json, ignoreDiscriminator): PageTemplateProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageTemplateProjection

PageTemplateProjectionToJSON

▸ PageTemplateProjectionToJSON(value?): any

Parameters

Name Type
value? PageTemplateProjection

Returns

any

PageThreadProjectionFromJSON

▸ PageThreadProjectionFromJSON(json): PageThreadProjection

Parameters

Name Type
json any

Returns

PageThreadProjection

PageThreadProjectionFromJSONTyped

▸ PageThreadProjectionFromJSONTyped(json, ignoreDiscriminator): PageThreadProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageThreadProjection

PageThreadProjectionToJSON

▸ PageThreadProjectionToJSON(value?): any

Parameters

Name Type
value? PageThreadProjection

Returns

any

PageTrackingPixelProjectionFromJSON

▸ PageTrackingPixelProjectionFromJSON(json): PageTrackingPixelProjection

Parameters

Name Type
json any

Returns

PageTrackingPixelProjection

PageTrackingPixelProjectionFromJSONTyped

▸ PageTrackingPixelProjectionFromJSONTyped(json, ignoreDiscriminator): PageTrackingPixelProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageTrackingPixelProjection

PageTrackingPixelProjectionToJSON

▸ PageTrackingPixelProjectionToJSON(value?): any

Parameters

Name Type
value? PageTrackingPixelProjection

Returns

any

PageUnknownMissedEmailProjectionFromJSON

▸ PageUnknownMissedEmailProjectionFromJSON(json): PageUnknownMissedEmailProjection

Parameters

Name Type
json any

Returns

PageUnknownMissedEmailProjection

PageUnknownMissedEmailProjectionFromJSONTyped

▸ PageUnknownMissedEmailProjectionFromJSONTyped(json, ignoreDiscriminator): PageUnknownMissedEmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageUnknownMissedEmailProjection

PageUnknownMissedEmailProjectionToJSON

▸ PageUnknownMissedEmailProjectionToJSON(value?): any

Parameters

Name Type
value? PageUnknownMissedEmailProjection

Returns

any

PageWebhookProjectionFromJSON

▸ PageWebhookProjectionFromJSON(json): PageWebhookProjection

Parameters

Name Type
json any

Returns

PageWebhookProjection

PageWebhookProjectionFromJSONTyped

▸ PageWebhookProjectionFromJSONTyped(json, ignoreDiscriminator): PageWebhookProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageWebhookProjection

PageWebhookProjectionToJSON

▸ PageWebhookProjectionToJSON(value?): any

Parameters

Name Type
value? PageWebhookProjection

Returns

any

PageWebhookResultFromJSON

▸ PageWebhookResultFromJSON(json): PageWebhookResult

Parameters

Name Type
json any

Returns

PageWebhookResult

PageWebhookResultFromJSONTyped

▸ PageWebhookResultFromJSONTyped(json, ignoreDiscriminator): PageWebhookResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageWebhookResult

PageWebhookResultToJSON

▸ PageWebhookResultToJSON(value?): any

Parameters

Name Type
value? PageWebhookResult

Returns

any

PageableObjectFromJSON

▸ PageableObjectFromJSON(json): PageableObject

Parameters

Name Type
json any

Returns

PageableObject

PageableObjectFromJSONTyped

▸ PageableObjectFromJSONTyped(json, ignoreDiscriminator): PageableObject

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

PageableObject

PageableObjectToJSON

▸ PageableObjectToJSON(value?): any

Parameters

Name Type
value? PageableObject

Returns

any

RawEmailJsonFromJSON

▸ RawEmailJsonFromJSON(json): RawEmailJson

Parameters

Name Type
json any

Returns

RawEmailJson

RawEmailJsonFromJSONTyped

▸ RawEmailJsonFromJSONTyped(json, ignoreDiscriminator): RawEmailJson

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

RawEmailJson

RawEmailJsonToJSON

▸ RawEmailJsonToJSON(value?): any

Parameters

Name Type
value? RawEmailJson

Returns

any

RecipientFromJSON

▸ RecipientFromJSON(json): Recipient

Parameters

Name Type
json any

Returns

Recipient

RecipientFromJSONTyped

▸ RecipientFromJSONTyped(json, ignoreDiscriminator): Recipient

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

Recipient

RecipientToJSON

▸ RecipientToJSON(value?): any

Parameters

Name Type
value? Recipient

Returns

any

ReplyToAliasEmailOptionsFromJSON

▸ ReplyToAliasEmailOptionsFromJSON(json): ReplyToAliasEmailOptions

Parameters

Name Type
json any

Returns

ReplyToAliasEmailOptions

ReplyToAliasEmailOptionsFromJSONTyped

▸ ReplyToAliasEmailOptionsFromJSONTyped(json, ignoreDiscriminator): ReplyToAliasEmailOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ReplyToAliasEmailOptions

ReplyToAliasEmailOptionsToJSON

▸ ReplyToAliasEmailOptionsToJSON(value?): any

Parameters

Name Type
value? ReplyToAliasEmailOptions

Returns

any

ReplyToEmailOptionsFromJSON

▸ ReplyToEmailOptionsFromJSON(json): ReplyToEmailOptions

Parameters

Name Type
json any

Returns

ReplyToEmailOptions

ReplyToEmailOptionsFromJSONTyped

▸ ReplyToEmailOptionsFromJSONTyped(json, ignoreDiscriminator): ReplyToEmailOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ReplyToEmailOptions

ReplyToEmailOptionsToJSON

▸ ReplyToEmailOptionsToJSON(value?): any

Parameters

Name Type
value? ReplyToEmailOptions

Returns

any

SendEmailOptionsFromJSON

▸ SendEmailOptionsFromJSON(json): SendEmailOptions

Parameters

Name Type
json any

Returns

SendEmailOptions

SendEmailOptionsFromJSONTyped

▸ SendEmailOptionsFromJSONTyped(json, ignoreDiscriminator): SendEmailOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

SendEmailOptions

SendEmailOptionsToJSON

▸ SendEmailOptionsToJSON(value?): any

Parameters

Name Type
value? SendEmailOptions

Returns

any

SendSMTPEnvelopeOptionsFromJSON

▸ SendSMTPEnvelopeOptionsFromJSON(json): SendSMTPEnvelopeOptions

Parameters

Name Type
json any

Returns

SendSMTPEnvelopeOptions

SendSMTPEnvelopeOptionsFromJSONTyped

▸ SendSMTPEnvelopeOptionsFromJSONTyped(json, ignoreDiscriminator): SendSMTPEnvelopeOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

SendSMTPEnvelopeOptions

SendSMTPEnvelopeOptionsToJSON

▸ SendSMTPEnvelopeOptionsToJSON(value?): any

Parameters

Name Type
value? SendSMTPEnvelopeOptions

Returns

any

SenderFromJSON

▸ SenderFromJSON(json): Sender

Parameters

Name Type
json any

Returns

Sender

SenderFromJSONTyped

▸ SenderFromJSONTyped(json, ignoreDiscriminator): Sender

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

Sender

SenderToJSON

▸ SenderToJSON(value?): any

Parameters

Name Type
value? Sender

Returns

any

SentEmailDtoFromJSON

▸ SentEmailDtoFromJSON(json): SentEmailDto

Parameters

Name Type
json any

Returns

SentEmailDto

SentEmailDtoFromJSONTyped

▸ SentEmailDtoFromJSONTyped(json, ignoreDiscriminator): SentEmailDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

SentEmailDto

SentEmailDtoToJSON

▸ SentEmailDtoToJSON(value?): any

Parameters

Name Type
value? SentEmailDto

Returns

any

SentEmailProjectionFromJSON

▸ SentEmailProjectionFromJSON(json): SentEmailProjection

Parameters

Name Type
json any

Returns

SentEmailProjection

SentEmailProjectionFromJSONTyped

▸ SentEmailProjectionFromJSONTyped(json, ignoreDiscriminator): SentEmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

SentEmailProjection

SentEmailProjectionToJSON

▸ SentEmailProjectionToJSON(value?): any

Parameters

Name Type
value? SentEmailProjection

Returns

any

SetInboxFavouritedOptionsFromJSON

▸ SetInboxFavouritedOptionsFromJSON(json): SetInboxFavouritedOptions

Parameters

Name Type
json any

Returns

SetInboxFavouritedOptions

SetInboxFavouritedOptionsFromJSONTyped

▸ SetInboxFavouritedOptionsFromJSONTyped(json, ignoreDiscriminator): SetInboxFavouritedOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

SetInboxFavouritedOptions

SetInboxFavouritedOptionsToJSON

▸ SetInboxFavouritedOptionsToJSON(value?): any

Parameters

Name Type
value? SetInboxFavouritedOptions

Returns

any

SimpleSendEmailOptionsFromJSON

▸ SimpleSendEmailOptionsFromJSON(json): SimpleSendEmailOptions

Parameters

Name Type
json any

Returns

SimpleSendEmailOptions

SimpleSendEmailOptionsFromJSONTyped

▸ SimpleSendEmailOptionsFromJSONTyped(json, ignoreDiscriminator): SimpleSendEmailOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

SimpleSendEmailOptions

SimpleSendEmailOptionsToJSON

▸ SimpleSendEmailOptionsToJSON(value?): any

Parameters

Name Type
value? SimpleSendEmailOptions

Returns

any

SortFromJSON

▸ SortFromJSON(json): Sort

Parameters

Name Type
json any

Returns

Sort

SortFromJSONTyped

▸ SortFromJSONTyped(json, ignoreDiscriminator): Sort

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

Sort

SortToJSON

▸ SortToJSON(value?): any

Parameters

Name Type
value? Sort

Returns

any

TemplateDtoFromJSON

▸ TemplateDtoFromJSON(json): TemplateDto

Parameters

Name Type
json any

Returns

TemplateDto

TemplateDtoFromJSONTyped

▸ TemplateDtoFromJSONTyped(json, ignoreDiscriminator): TemplateDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

TemplateDto

TemplateDtoToJSON

▸ TemplateDtoToJSON(value?): any

Parameters

Name Type
value? TemplateDto

Returns

any

TemplateProjectionFromJSON

▸ TemplateProjectionFromJSON(json): TemplateProjection

Parameters

Name Type
json any

Returns

TemplateProjection

TemplateProjectionFromJSONTyped

▸ TemplateProjectionFromJSONTyped(json, ignoreDiscriminator): TemplateProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

TemplateProjection

TemplateProjectionToJSON

▸ TemplateProjectionToJSON(value?): any

Parameters

Name Type
value? TemplateProjection

Returns

any

TemplateVariableFromJSON

▸ TemplateVariableFromJSON(json): TemplateVariable

Parameters

Name Type
json any

Returns

TemplateVariable

TemplateVariableFromJSONTyped

▸ TemplateVariableFromJSONTyped(json, ignoreDiscriminator): TemplateVariable

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

TemplateVariable

TemplateVariableToJSON

▸ TemplateVariableToJSON(value?): any

Parameters

Name Type
value? TemplateVariable

Returns

any

TestNewInboxForwarderOptionsFromJSON

▸ TestNewInboxForwarderOptionsFromJSON(json): TestNewInboxForwarderOptions

Parameters

Name Type
json any

Returns

TestNewInboxForwarderOptions

TestNewInboxForwarderOptionsFromJSONTyped

▸ TestNewInboxForwarderOptionsFromJSONTyped(json, ignoreDiscriminator): TestNewInboxForwarderOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

TestNewInboxForwarderOptions

TestNewInboxForwarderOptionsToJSON

▸ TestNewInboxForwarderOptionsToJSON(value?): any

Parameters

Name Type
value? TestNewInboxForwarderOptions

Returns

any

TestNewInboxRulesetOptionsFromJSON

▸ TestNewInboxRulesetOptionsFromJSON(json): TestNewInboxRulesetOptions

Parameters

Name Type
json any

Returns

TestNewInboxRulesetOptions

TestNewInboxRulesetOptionsFromJSONTyped

▸ TestNewInboxRulesetOptionsFromJSONTyped(json, ignoreDiscriminator): TestNewInboxRulesetOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

TestNewInboxRulesetOptions

TestNewInboxRulesetOptionsToJSON

▸ TestNewInboxRulesetOptionsToJSON(value?): any

Parameters

Name Type
value? TestNewInboxRulesetOptions

Returns

any

ThreadProjectionFromJSON

▸ ThreadProjectionFromJSON(json): ThreadProjection

Parameters

Name Type
json any

Returns

ThreadProjection

ThreadProjectionFromJSONTyped

▸ ThreadProjectionFromJSONTyped(json, ignoreDiscriminator): ThreadProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ThreadProjection

ThreadProjectionToJSON

▸ ThreadProjectionToJSON(value?): any

Parameters

Name Type
value? ThreadProjection

Returns

any

TrackingPixelDtoFromJSON

▸ TrackingPixelDtoFromJSON(json): TrackingPixelDto

Parameters

Name Type
json any

Returns

TrackingPixelDto

TrackingPixelDtoFromJSONTyped

▸ TrackingPixelDtoFromJSONTyped(json, ignoreDiscriminator): TrackingPixelDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

TrackingPixelDto

TrackingPixelDtoToJSON

▸ TrackingPixelDtoToJSON(value?): any

Parameters

Name Type
value? TrackingPixelDto

Returns

any

TrackingPixelProjectionFromJSON

▸ TrackingPixelProjectionFromJSON(json): TrackingPixelProjection

Parameters

Name Type
json any

Returns

TrackingPixelProjection

TrackingPixelProjectionFromJSONTyped

▸ TrackingPixelProjectionFromJSONTyped(json, ignoreDiscriminator): TrackingPixelProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

TrackingPixelProjection

TrackingPixelProjectionToJSON

▸ TrackingPixelProjectionToJSON(value?): any

Parameters

Name Type
value? TrackingPixelProjection

Returns

any

UnknownMissedEmailProjectionFromJSON

▸ UnknownMissedEmailProjectionFromJSON(json): UnknownMissedEmailProjection

Parameters

Name Type
json any

Returns

UnknownMissedEmailProjection

UnknownMissedEmailProjectionFromJSONTyped

▸ UnknownMissedEmailProjectionFromJSONTyped(json, ignoreDiscriminator): UnknownMissedEmailProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UnknownMissedEmailProjection

UnknownMissedEmailProjectionToJSON

▸ UnknownMissedEmailProjectionToJSON(value?): any

Parameters

Name Type
value? UnknownMissedEmailProjection

Returns

any

UnreadCountFromJSON

▸ UnreadCountFromJSON(json): UnreadCount

Parameters

Name Type
json any

Returns

UnreadCount

UnreadCountFromJSONTyped

▸ UnreadCountFromJSONTyped(json, ignoreDiscriminator): UnreadCount

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UnreadCount

UnreadCountToJSON

▸ UnreadCountToJSON(value?): any

Parameters

Name Type
value? UnreadCount

Returns

any

UnseenErrorCountDtoFromJSON

▸ UnseenErrorCountDtoFromJSON(json): UnseenErrorCountDto

Parameters

Name Type
json any

Returns

UnseenErrorCountDto

UnseenErrorCountDtoFromJSONTyped

▸ UnseenErrorCountDtoFromJSONTyped(json, ignoreDiscriminator): UnseenErrorCountDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UnseenErrorCountDto

UnseenErrorCountDtoToJSON

▸ UnseenErrorCountDtoToJSON(value?): any

Parameters

Name Type
value? UnseenErrorCountDto

Returns

any

UpdateAliasOptionsFromJSON

▸ UpdateAliasOptionsFromJSON(json): UpdateAliasOptions

Parameters

Name Type
json any

Returns

UpdateAliasOptions

UpdateAliasOptionsFromJSONTyped

▸ UpdateAliasOptionsFromJSONTyped(json, ignoreDiscriminator): UpdateAliasOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UpdateAliasOptions

UpdateAliasOptionsToJSON

▸ UpdateAliasOptionsToJSON(value?): any

Parameters

Name Type
value? UpdateAliasOptions

Returns

any

UpdateDomainOptionsFromJSON

▸ UpdateDomainOptionsFromJSON(json): UpdateDomainOptions

Parameters

Name Type
json any

Returns

UpdateDomainOptions

UpdateDomainOptionsFromJSONTyped

▸ UpdateDomainOptionsFromJSONTyped(json, ignoreDiscriminator): UpdateDomainOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UpdateDomainOptions

UpdateDomainOptionsToJSON

▸ UpdateDomainOptionsToJSON(value?): any

Parameters

Name Type
value? UpdateDomainOptions

Returns

any

UpdateGroupContactsFromJSON

▸ UpdateGroupContactsFromJSON(json): UpdateGroupContacts

Parameters

Name Type
json any

Returns

UpdateGroupContacts

UpdateGroupContactsFromJSONTyped

▸ UpdateGroupContactsFromJSONTyped(json, ignoreDiscriminator): UpdateGroupContacts

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UpdateGroupContacts

UpdateGroupContactsToJSON

▸ UpdateGroupContactsToJSON(value?): any

Parameters

Name Type
value? UpdateGroupContacts

Returns

any

UpdateInboxOptionsFromJSON

▸ UpdateInboxOptionsFromJSON(json): UpdateInboxOptions

Parameters

Name Type
json any

Returns

UpdateInboxOptions

UpdateInboxOptionsFromJSONTyped

▸ UpdateInboxOptionsFromJSONTyped(json, ignoreDiscriminator): UpdateInboxOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UpdateInboxOptions

UpdateInboxOptionsToJSON

▸ UpdateInboxOptionsToJSON(value?): any

Parameters

Name Type
value? UpdateInboxOptions

Returns

any

UploadAttachmentOptionsFromJSON

▸ UploadAttachmentOptionsFromJSON(json): UploadAttachmentOptions

Parameters

Name Type
json any

Returns

UploadAttachmentOptions

UploadAttachmentOptionsFromJSONTyped

▸ UploadAttachmentOptionsFromJSONTyped(json, ignoreDiscriminator): UploadAttachmentOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

UploadAttachmentOptions

UploadAttachmentOptionsToJSON

▸ UploadAttachmentOptionsToJSON(value?): any

Parameters

Name Type
value? UploadAttachmentOptions

Returns

any

ValidateEmailAddressListOptionsFromJSON

▸ ValidateEmailAddressListOptionsFromJSON(json): ValidateEmailAddressListOptions

Parameters

Name Type
json any

Returns

ValidateEmailAddressListOptions

ValidateEmailAddressListOptionsFromJSONTyped

▸ ValidateEmailAddressListOptionsFromJSONTyped(json, ignoreDiscriminator): ValidateEmailAddressListOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ValidateEmailAddressListOptions

ValidateEmailAddressListOptionsToJSON

▸ ValidateEmailAddressListOptionsToJSON(value?): any

Parameters

Name Type
value? ValidateEmailAddressListOptions

Returns

any

ValidateEmailAddressListResultFromJSON

▸ ValidateEmailAddressListResultFromJSON(json): ValidateEmailAddressListResult

Parameters

Name Type
json any

Returns

ValidateEmailAddressListResult

ValidateEmailAddressListResultFromJSONTyped

▸ ValidateEmailAddressListResultFromJSONTyped(json, ignoreDiscriminator): ValidateEmailAddressListResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ValidateEmailAddressListResult

ValidateEmailAddressListResultToJSON

▸ ValidateEmailAddressListResultToJSON(value?): any

Parameters

Name Type
value? ValidateEmailAddressListResult

Returns

any

ValidationDtoFromJSON

▸ ValidationDtoFromJSON(json): ValidationDto

Parameters

Name Type
json any

Returns

ValidationDto

ValidationDtoFromJSONTyped

▸ ValidationDtoFromJSONTyped(json, ignoreDiscriminator): ValidationDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ValidationDto

ValidationDtoToJSON

▸ ValidationDtoToJSON(value?): any

Parameters

Name Type
value? ValidationDto

Returns

any

ValidationMessageFromJSON

▸ ValidationMessageFromJSON(json): ValidationMessage

Parameters

Name Type
json any

Returns

ValidationMessage

ValidationMessageFromJSONTyped

▸ ValidationMessageFromJSONTyped(json, ignoreDiscriminator): ValidationMessage

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

ValidationMessage

ValidationMessageToJSON

▸ ValidationMessageToJSON(value?): any

Parameters

Name Type
value? ValidationMessage

Returns

any

VerifyEmailAddressOptionsFromJSON

▸ VerifyEmailAddressOptionsFromJSON(json): VerifyEmailAddressOptions

Parameters

Name Type
json any

Returns

VerifyEmailAddressOptions

VerifyEmailAddressOptionsFromJSONTyped

▸ VerifyEmailAddressOptionsFromJSONTyped(json, ignoreDiscriminator): VerifyEmailAddressOptions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

VerifyEmailAddressOptions

VerifyEmailAddressOptionsToJSON

▸ VerifyEmailAddressOptionsToJSON(value?): any

Parameters

Name Type
value? VerifyEmailAddressOptions

Returns

any

WaitForConditionsFromJSON

▸ WaitForConditionsFromJSON(json): WaitForConditions

Parameters

Name Type
json any

Returns

WaitForConditions

WaitForConditionsFromJSONTyped

▸ WaitForConditionsFromJSONTyped(json, ignoreDiscriminator): WaitForConditions

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WaitForConditions

WaitForConditionsToJSON

▸ WaitForConditionsToJSON(value?): any

Parameters

Name Type
value? WaitForConditions

Returns

any

WebhookBouncePayloadFromJSON

▸ WebhookBouncePayloadFromJSON(json): WebhookBouncePayload

Parameters

Name Type
json any

Returns

WebhookBouncePayload

WebhookBouncePayloadFromJSONTyped

▸ WebhookBouncePayloadFromJSONTyped(json, ignoreDiscriminator): WebhookBouncePayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookBouncePayload

WebhookBouncePayloadToJSON

▸ WebhookBouncePayloadToJSON(value?): any

Parameters

Name Type
value? WebhookBouncePayload

Returns

any

WebhookBounceRecipientPayloadFromJSON

▸ WebhookBounceRecipientPayloadFromJSON(json): WebhookBounceRecipientPayload

Parameters

Name Type
json any

Returns

WebhookBounceRecipientPayload

WebhookBounceRecipientPayloadFromJSONTyped

▸ WebhookBounceRecipientPayloadFromJSONTyped(json, ignoreDiscriminator): WebhookBounceRecipientPayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookBounceRecipientPayload

WebhookBounceRecipientPayloadToJSON

▸ WebhookBounceRecipientPayloadToJSON(value?): any

Parameters

Name Type
value? WebhookBounceRecipientPayload

Returns

any

WebhookDtoFromJSON

▸ WebhookDtoFromJSON(json): WebhookDto

Parameters

Name Type
json any

Returns

WebhookDto

WebhookDtoFromJSONTyped

▸ WebhookDtoFromJSONTyped(json, ignoreDiscriminator): WebhookDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookDto

WebhookDtoToJSON

▸ WebhookDtoToJSON(value?): any

Parameters

Name Type
value? WebhookDto

Returns

any

WebhookEmailOpenedPayloadFromJSON

▸ WebhookEmailOpenedPayloadFromJSON(json): WebhookEmailOpenedPayload

Parameters

Name Type
json any

Returns

WebhookEmailOpenedPayload

WebhookEmailOpenedPayloadFromJSONTyped

▸ WebhookEmailOpenedPayloadFromJSONTyped(json, ignoreDiscriminator): WebhookEmailOpenedPayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookEmailOpenedPayload

WebhookEmailOpenedPayloadToJSON

▸ WebhookEmailOpenedPayloadToJSON(value?): any

Parameters

Name Type
value? WebhookEmailOpenedPayload

Returns

any

WebhookEmailReadPayloadFromJSON

▸ WebhookEmailReadPayloadFromJSON(json): WebhookEmailReadPayload

Parameters

Name Type
json any

Returns

WebhookEmailReadPayload

WebhookEmailReadPayloadFromJSONTyped

▸ WebhookEmailReadPayloadFromJSONTyped(json, ignoreDiscriminator): WebhookEmailReadPayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookEmailReadPayload

WebhookEmailReadPayloadToJSON

▸ WebhookEmailReadPayloadToJSON(value?): any

Parameters

Name Type
value? WebhookEmailReadPayload

Returns

any

WebhookNewAttachmentPayloadFromJSON

▸ WebhookNewAttachmentPayloadFromJSON(json): WebhookNewAttachmentPayload

Parameters

Name Type
json any

Returns

WebhookNewAttachmentPayload

WebhookNewAttachmentPayloadFromJSONTyped

▸ WebhookNewAttachmentPayloadFromJSONTyped(json, ignoreDiscriminator): WebhookNewAttachmentPayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookNewAttachmentPayload

WebhookNewAttachmentPayloadToJSON

▸ WebhookNewAttachmentPayloadToJSON(value?): any

Parameters

Name Type
value? WebhookNewAttachmentPayload

Returns

any

WebhookNewContactPayloadFromJSON

▸ WebhookNewContactPayloadFromJSON(json): WebhookNewContactPayload

Parameters

Name Type
json any

Returns

WebhookNewContactPayload

WebhookNewContactPayloadFromJSONTyped

▸ WebhookNewContactPayloadFromJSONTyped(json, ignoreDiscriminator): WebhookNewContactPayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookNewContactPayload

WebhookNewContactPayloadToJSON

▸ WebhookNewContactPayloadToJSON(value?): any

Parameters

Name Type
value? WebhookNewContactPayload

Returns

any

WebhookNewEmailPayloadFromJSON

▸ WebhookNewEmailPayloadFromJSON(json): WebhookNewEmailPayload

Parameters

Name Type
json any

Returns

WebhookNewEmailPayload

WebhookNewEmailPayloadFromJSONTyped

▸ WebhookNewEmailPayloadFromJSONTyped(json, ignoreDiscriminator): WebhookNewEmailPayload

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookNewEmailPayload

WebhookNewEmailPayloadToJSON

▸ WebhookNewEmailPayloadToJSON(value?): any

Parameters

Name Type
value? WebhookNewEmailPayload

Returns

any

WebhookProjectionFromJSON

▸ WebhookProjectionFromJSON(json): WebhookProjection

Parameters

Name Type
json any

Returns

WebhookProjection

WebhookProjectionFromJSONTyped

▸ WebhookProjectionFromJSONTyped(json, ignoreDiscriminator): WebhookProjection

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookProjection

WebhookProjectionToJSON

▸ WebhookProjectionToJSON(value?): any

Parameters

Name Type
value? WebhookProjection

Returns

any

WebhookRedriveResultFromJSON

▸ WebhookRedriveResultFromJSON(json): WebhookRedriveResult

Parameters

Name Type
json any

Returns

WebhookRedriveResult

WebhookRedriveResultFromJSONTyped

▸ WebhookRedriveResultFromJSONTyped(json, ignoreDiscriminator): WebhookRedriveResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookRedriveResult

WebhookRedriveResultToJSON

▸ WebhookRedriveResultToJSON(value?): any

Parameters

Name Type
value? WebhookRedriveResult

Returns

any

WebhookResultDtoFromJSON

▸ WebhookResultDtoFromJSON(json): WebhookResultDto

Parameters

Name Type
json any

Returns

WebhookResultDto

WebhookResultDtoFromJSONTyped

▸ WebhookResultDtoFromJSONTyped(json, ignoreDiscriminator): WebhookResultDto

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookResultDto

WebhookResultDtoToJSON

▸ WebhookResultDtoToJSON(value?): any

Parameters

Name Type
value? WebhookResultDto

Returns

any

WebhookTestRequestFromJSON

▸ WebhookTestRequestFromJSON(json): WebhookTestRequest

Parameters

Name Type
json any

Returns

WebhookTestRequest

WebhookTestRequestFromJSONTyped

▸ WebhookTestRequestFromJSONTyped(json, ignoreDiscriminator): WebhookTestRequest

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookTestRequest

WebhookTestRequestToJSON

▸ WebhookTestRequestToJSON(value?): any

Parameters

Name Type
value? WebhookTestRequest

Returns

any

WebhookTestResponseFromJSON

▸ WebhookTestResponseFromJSON(json): WebhookTestResponse

Parameters

Name Type
json any

Returns

WebhookTestResponse

WebhookTestResponseFromJSONTyped

▸ WebhookTestResponseFromJSONTyped(json, ignoreDiscriminator): WebhookTestResponse

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookTestResponse

WebhookTestResponseToJSON

▸ WebhookTestResponseToJSON(value?): any

Parameters

Name Type
value? WebhookTestResponse

Returns

any

WebhookTestResultFromJSON

▸ WebhookTestResultFromJSON(json): WebhookTestResult

Parameters

Name Type
json any

Returns

WebhookTestResult

WebhookTestResultFromJSONTyped

▸ WebhookTestResultFromJSONTyped(json, ignoreDiscriminator): WebhookTestResult

Parameters

Name Type
json any
ignoreDiscriminator boolean

Returns

WebhookTestResult

WebhookTestResultToJSON

▸ WebhookTestResultToJSON(value?): any

Parameters

Name Type
value? WebhookTestResult

Returns

any

canConsumeForm

▸ canConsumeForm(consumes): boolean

Parameters

Name Type
consumes Consume[]

Returns

boolean

exists

▸ exists(json, key): boolean

Parameters

Name Type
json any
key string

Returns

boolean

mapValues

▸ mapValues(data, fn): Object

Parameters

Name Type
data any
fn (item: any) => any

Returns

Object

querystring

▸ querystring(params, prefix?): string

Parameters

Name Type Default value
params HTTPQuery undefined
prefix string ''

Returns

string

wrapException

▸ wrapException<T>(fn): Promise<T>

Type parameters

Name
T

Parameters

Name Type
fn () => Promise<T>

Returns

Promise<T>

wrapResult

▸ wrapResult<T>(fn): Promise<Result<T>>

Type parameters

Name
T

Parameters

Name Type
fn () => Promise<T>

Returns

Promise<Result<T>>