MailSlurp JS

Globals

# MailSlurp JS

# Index

# Namespaces

# Classes

# Interfaces

Alias
AliasDto
AliasProjection
AttachmentMetaData
BasicAuthOptions
BulkSendEmailOptions
ConfigurationParameters
ContactDto
ContactProjection
ContentMatchOptions
CreateAliasOptions
CreateContactOptions
CreateDomainOptions
CreateGroupOptions
CreateInboxDto
CreateTemplateOptions
CreateWebhookOptions
DNSLookupResults
DescribeDomainOptions
DescribeMailServerDomainResult
DomainDto
DomainPreview
DownloadAttachmentDto
Email
EmailAnalysis
EmailContentMatchResult
EmailPreview
EmailProjection
EmailTextLinesResult
EmailVerificationResult
ExpiredInboxDto
ExpiredInboxRecordProjection
FetchAPI
FetchArgs
ForwardEmailOptions
GroupContactsDto
GroupDto
GroupProjection
HTMLValidationResult
IPAddressResult
Inbox
InboxProjection
JsonNode
MatchOptions
NameServerRecord
PageAlias
PageContactProjection
PageEmailPreview
PageEmailProjection
PageExpiredInboxRecordProjection
PageGroupProjection
PageInboxProjection
PageSentEmailProjection
PageTemplateProjection
PageThreadProjection
PageWebhookProjection
Pageable
RawEmailJson
SentEmailDto
SentEmailProjection
SetInboxFavouritedOptions
SimpleSendEmailOptions
Sort
TemplateDto
TemplateProjection
ThreadProjection
UnreadCount
UpdateAliasOptions
UpdateGroupContacts
UpdateInboxOptions
UploadAttachmentOptions
ValidationDto
ValidationMessage
VerifyEmailAddressOptions
WebhookProjection
WebhookTestResponse
WebhookTestResult

# Type aliases

# Variables

BASE_PATH

# Functions

# Object literals

COLLECTION_FORMATS

# Type aliases

# Config

Ƭ Config: { apiKey: string ; attribution?: string ; basePath?: string ; fetchApi?: FetchAPI }

Defined in src/index.ts:40 (opens new window)

MailSlurp config

remarks Obtain your API Key (opens new window) in your dashboard.

# Type declaration:

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

# GetMessagesOptions

Ƭ GetMessagesOptions: { limit?: number ; minCount?: number ; retryTimeout?: number ; since?: Date ; size?: number ; sort?: SortEnum }

Defined in src/index.ts:497 (opens new window)

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

# SortEnum

Ƭ SortEnum: "ASC" | "DESC"

Defined in src/index.ts:33 (opens new window)

# Variables

# BASE_PATH

• Const BASE_PATH: string = 'https://api.mailslurp.com'.replace(//+$/, '')

Defined in src/generated/api.ts:19 (opens new window)

# Functions

# AliasControllerApiFactory

▸ ConstAliasControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:5053 (opens new window)

AliasControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`createAlias`	(createAliasOptions: CreateAliasOptions, options?: any) => Promise<AliasDto>
`deleteAlias`	(aliasId: string, options?: any) => Promise<Response>
`getAlias`	(aliasId: string, options?: any) => Promise<AliasDto>
`getAliasEmails`	(aliasId: string, page?: number, size?: number, sort?: "ASC"
`getAliasThreads`	(aliasId: string, page?: number, size?: number, sort?: "ASC"
`getAliases`	(page?: number, size?: number, sort?: "ASC"
`replyToAliasEmail`	(aliasId: string, emailId: string, replyToAliasEmailOptions: ReplyToAliasEmailOptions, options?: any) => Promise<SentEmailDto>
`sendAliasEmail`	(aliasId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise<SentEmailDto>
`updateAlias`	(aliasId: string, updateAliasOptions: UpdateAliasOptions, options?: any) => Promise<Response>

# AliasControllerApiFetchParamCreator

▸ ConstAliasControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:4100 (opens new window)

AliasControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createAlias`	(createAliasOptions: CreateAliasOptions, options: any) => FetchArgs
`deleteAlias`	(aliasId: string, options: any) => FetchArgs
`getAlias`	(aliasId: string, options: any) => FetchArgs
`getAliasEmails`	(aliasId: string, page?: number, size?: number, sort?: "ASC"
`getAliasThreads`	(aliasId: string, page?: number, size?: number, sort?: "ASC"
`getAliases`	(page?: number, size?: number, sort?: "ASC"
`replyToAliasEmail`	(aliasId: string, emailId: string, replyToAliasEmailOptions: ReplyToAliasEmailOptions, options: any) => FetchArgs
`sendAliasEmail`	(aliasId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
`updateAlias`	(aliasId: string, updateAliasOptions: UpdateAliasOptions, options: any) => FetchArgs

# AliasControllerApiFp

▸ ConstAliasControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:4739 (opens new window)

AliasControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createAlias`	(createAliasOptions: CreateAliasOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AliasDto>
`deleteAlias`	(aliasId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`getAlias`	(aliasId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AliasDto>
`getAliasEmails`	(aliasId: string, page?: number, size?: number, sort?: "ASC"
`getAliasThreads`	(aliasId: string, page?: number, size?: number, sort?: "ASC"
`getAliases`	(page?: number, size?: number, sort?: "ASC"
`replyToAliasEmail`	(aliasId: string, emailId: string, replyToAliasEmailOptions: ReplyToAliasEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
`sendAliasEmail`	(aliasId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
`updateAlias`	(aliasId: string, updateAliasOptions: UpdateAliasOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>

# AttachmentControllerApiFactory

▸ ConstAttachmentControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:5792 (opens new window)

AttachmentControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`uploadAttachment`	(uploadOptions: UploadAttachmentOptions, options?: any) => Promise<string[]>
`uploadAttachmentBytes`	(string?: string, byteArray?: string, filename?: string, options?: any) => Promise<string[]>
`uploadMultipartForm`	(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any) => Promise<string[]>

# AttachmentControllerApiFetchParamCreator

▸ ConstAttachmentControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:5434 (opens new window)

AttachmentControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`uploadAttachment`	(uploadOptions: UploadAttachmentOptions, options: any) => FetchArgs
`uploadAttachmentBytes`	(string?: string, byteArray?: string, filename?: string, options: any) => FetchArgs
`uploadMultipartForm`	(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options: any) => FetchArgs

# AttachmentControllerApiFp

▸ ConstAttachmentControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:5672 (opens new window)

AttachmentControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`uploadAttachment`	(uploadOptions: UploadAttachmentOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>
`uploadAttachmentBytes`	(string?: string, byteArray?: string, filename?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>
`uploadMultipartForm`	(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>

# BulkActionsControllerApiFactory

▸ ConstBulkActionsControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:6249 (opens new window)

BulkActionsControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`bulkCreateInboxes`	(count: number, options?: any) => Promise<Inbox[]>
`bulkDeleteInboxes`	(ids: Array<string>, options?: any) => Promise<Response>
`bulkSendEmails`	(bulkSendEmailOptions: BulkSendEmailOptions, options?: any) => Promise<Response>

# BulkActionsControllerApiFetchParamCreator

▸ ConstBulkActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:5953 (opens new window)

BulkActionsControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`bulkCreateInboxes`	(count: number, options: any) => FetchArgs
`bulkDeleteInboxes`	(ids: Array<string>, options: any) => FetchArgs
`bulkSendEmails`	(bulkSendEmailOptions: BulkSendEmailOptions, options: any) => FetchArgs

# BulkActionsControllerApiFp

▸ ConstBulkActionsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:6148 (opens new window)

BulkActionsControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`bulkCreateInboxes`	(count: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<Inbox>>
`bulkDeleteInboxes`	(ids: Array<string>, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`bulkSendEmails`	(bulkSendEmailOptions: BulkSendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>

# CommonActionsControllerApiFactory

▸ ConstCommonActionsControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:6772 (opens new window)

CommonActionsControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`createNewEmailAddress`	(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => Promise<Inbox>
`createNewEmailAddress1`	(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => Promise<Inbox>
`emptyInbox`	(inboxId: string, options?: any) => Promise<Response>
`sendEmailSimple`	(emailOptions: SimpleSendEmailOptions, options?: any) => Promise<Response>

# CommonActionsControllerApiFetchParamCreator

▸ ConstCommonActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:6360 (opens new window)

CommonActionsControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createNewEmailAddress`	(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options: any) => FetchArgs
`createNewEmailAddress1`	(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options: any) => FetchArgs
`emptyInbox`	(inboxId: string, options: any) => FetchArgs
`sendEmailSimple`	(emailOptions: SimpleSendEmailOptions, options: any) => FetchArgs

# CommonActionsControllerApiFp

▸ ConstCommonActionsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:6623 (opens new window)

CommonActionsControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createNewEmailAddress`	(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
`createNewEmailAddress1`	(expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
`emptyInbox`	(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`sendEmailSimple`	(emailOptions: SimpleSendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>

# ContactControllerApiFactory

▸ ConstContactControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:7411 (opens new window)

ContactControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`createContact`	(createContactOptions: CreateContactOptions, options?: any) => Promise<ContactDto>
`deleteContact`	(contactId: string, options?: any) => Promise<Response>
`getAllContacts`	(page?: number, size?: number, sort?: "ASC"
`getContact`	(contactId: string, options?: any) => Promise<ContactDto>
`getContacts`	(options?: any) => Promise<ContactProjection[]>

# ContactControllerApiFetchParamCreator

▸ ConstContactControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:6948 (opens new window)

ContactControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createContact`	(createContactOptions: CreateContactOptions, options: any) => FetchArgs
`deleteContact`	(contactId: string, options: any) => FetchArgs
`getAllContacts`	(page?: number, size?: number, sort?: "ASC"
`getContact`	(contactId: string, options: any) => FetchArgs
`getContacts`	(options: any) => FetchArgs

# ContactControllerApiFp

▸ ConstContactControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:7244 (opens new window)

ContactControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createContact`	(createContactOptions: CreateContactOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ContactDto>
`deleteContact`	(contactId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`getAllContacts`	(page?: number, size?: number, sort?: "ASC"
`getContact`	(contactId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ContactDto>
`getContacts`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<ContactProjection>>

# DomainControllerApiFactory

▸ ConstDomainControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:7953 (opens new window)

DomainControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`createDomain`	(domainOptions: CreateDomainOptions, options?: any) => Promise<DomainDto>
`deleteDomain`	(id: string, options?: any) => Promise<string[]>
`getDomain`	(id: string, options?: any) => Promise<DomainDto>
`getDomains`	(options?: any) => Promise<DomainPreview[]>

# DomainControllerApiFetchParamCreator

▸ ConstDomainControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:7594 (opens new window)

DomainControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createDomain`	(domainOptions: CreateDomainOptions, options: any) => FetchArgs
`deleteDomain`	(id: string, options: any) => FetchArgs
`getDomain`	(id: string, options: any) => FetchArgs
`getDomains`	(options: any) => FetchArgs

# DomainControllerApiFp

▸ ConstDomainControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:7823 (opens new window)

DomainControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createDomain`	(domainOptions: CreateDomainOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>
`deleteDomain`	(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>
`getDomain`	(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>
`getDomains`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<DomainPreview>>

# EmailControllerApiFactory

▸ ConstEmailControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:9858 (opens new window)

EmailControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`deleteAllEmails`	(options?: any) => Promise<Response>
`deleteEmail`	(emailId: string, options?: any) => Promise<Response>
`downloadAttachment`	(attachmentId: string, emailId: string, apiKey?: string, options?: any) => Promise<string>
`downloadAttachmentBase64`	(attachmentId: string, emailId: string, options?: any) => Promise<DownloadAttachmentDto>
`forwardEmail`	(emailId: string, forwardEmailOptions: ForwardEmailOptions, options?: any) => Promise<Response>
`getAttachmentMetaData`	(attachmentId: string, emailId: string, options?: any) => Promise<AttachmentMetaData>
`getAttachments`	(emailId: string, options?: any) => Promise<AttachmentMetaData[]>
`getEmail`	(emailId: string, decode?: boolean, options?: any) => Promise<Email>
`getEmailContentMatch`	(contentMatchOptions: ContentMatchOptions, emailId: string, options?: any) => Promise<EmailContentMatchResult>
`getEmailHTML`	(emailId: string, decode?: boolean, options?: any) => Promise<string>
`getEmailHTMLQuery`	(emailId: string, htmlSelector?: string, options?: any) => Promise<EmailTextLinesResult>
`getEmailTextLines`	(emailId: string, decodeHtmlEntities?: boolean, lineSeparator?: string, options?: any) => Promise<EmailTextLinesResult>
`getEmailsPaginated`	(inboxId?: Array<string>, page?: number, size?: number, sort?: "ASC"
`getRawEmailContents`	(emailId: string, options?: any) => Promise<string>
`getRawEmailJson`	(emailId: string, options?: any) => Promise<RawEmailJson>
`getUnreadEmailCount`	(options?: any) => Promise<UnreadCount>
`replyToEmail`	(emailId: string, replyToEmailOptions: ReplyToEmailOptions, options?: any) => Promise<SentEmailDto>
`validateEmail`	(emailId: string, options?: any) => Promise<ValidationDto>

# EmailControllerApiFetchParamCreator

▸ ConstEmailControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:8084 (opens new window)

EmailControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`deleteAllEmails`	(options: any) => FetchArgs
`deleteEmail`	(emailId: string, options: any) => FetchArgs
`downloadAttachment`	(attachmentId: string, emailId: string, apiKey?: string, options: any) => FetchArgs
`downloadAttachmentBase64`	(attachmentId: string, emailId: string, options: any) => FetchArgs
`forwardEmail`	(emailId: string, forwardEmailOptions: ForwardEmailOptions, options: any) => FetchArgs
`getAttachmentMetaData`	(attachmentId: string, emailId: string, options: any) => FetchArgs
`getAttachments`	(emailId: string, options: any) => FetchArgs
`getEmail`	(emailId: string, decode?: boolean, options: any) => FetchArgs
`getEmailContentMatch`	(contentMatchOptions: ContentMatchOptions, emailId: string, options: any) => FetchArgs
`getEmailHTML`	(emailId: string, decode?: boolean, options: any) => FetchArgs
`getEmailHTMLQuery`	(emailId: string, htmlSelector?: string, options: any) => FetchArgs
`getEmailTextLines`	(emailId: string, decodeHtmlEntities?: boolean, lineSeparator?: string, options: any) => FetchArgs
`getEmailsPaginated`	(inboxId?: Array<string>, page?: number, size?: number, sort?: "ASC"
`getRawEmailContents`	(emailId: string, options: any) => FetchArgs
`getRawEmailJson`	(emailId: string, options: any) => FetchArgs
`getUnreadEmailCount`	(options: any) => FetchArgs
`replyToEmail`	(emailId: string, replyToEmailOptions: ReplyToEmailOptions, options: any) => FetchArgs
`validateEmail`	(emailId: string, options: any) => FetchArgs

# EmailControllerApiFp

▸ ConstEmailControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:9248 (opens new window)

EmailControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`deleteAllEmails`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`deleteEmail`	(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`downloadAttachment`	(attachmentId: string, emailId: string, apiKey?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>
`downloadAttachmentBase64`	(attachmentId: string, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DownloadAttachmentDto>
`forwardEmail`	(emailId: string, forwardEmailOptions: ForwardEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`getAttachmentMetaData`	(attachmentId: string, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AttachmentMetaData>
`getAttachments`	(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<AttachmentMetaData>>
`getEmail`	(emailId: string, decode?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
`getEmailContentMatch`	(contentMatchOptions: ContentMatchOptions, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailContentMatchResult>
`getEmailHTML`	(emailId: string, decode?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>
`getEmailHTMLQuery`	(emailId: string, htmlSelector?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailTextLinesResult>
`getEmailTextLines`	(emailId: string, decodeHtmlEntities?: boolean, lineSeparator?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailTextLinesResult>
`getEmailsPaginated`	(inboxId?: Array<string>, page?: number, size?: number, sort?: "ASC"
`getRawEmailContents`	(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>
`getRawEmailJson`	(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<RawEmailJson>
`getUnreadEmailCount`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<UnreadCount>
`replyToEmail`	(emailId: string, replyToEmailOptions: ReplyToEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
`validateEmail`	(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ValidationDto>

# ExpiredControllerApiFactory

▸ ConstExpiredControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:10817 (opens new window)

ExpiredControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`getExpiredInboxByInboxId`	(inboxId: string, options?: any) => Promise<ExpiredInboxDto>
`getExpiredInboxRecord`	(expiredId: string, options?: any) => Promise<ExpiredInboxDto>
`getExpiredInboxes`	(page?: number, size?: number, sort?: "ASC"

# ExpiredControllerApiFetchParamCreator

▸ ConstExpiredControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:10523 (opens new window)

ExpiredControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`getExpiredInboxByInboxId`	(inboxId: string, options: any) => FetchArgs
`getExpiredInboxRecord`	(expiredId: string, options: any) => FetchArgs
`getExpiredInboxes`	(page?: number, size?: number, sort?: "ASC"

# ExpiredControllerApiFp

▸ ConstExpiredControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:10711 (opens new window)

ExpiredControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`getExpiredInboxByInboxId`	(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ExpiredInboxDto>
`getExpiredInboxRecord`	(expiredId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ExpiredInboxDto>
`getExpiredInboxes`	(page?: number, size?: number, sort?: "ASC"

# FormControllerApiFactory

▸ ConstFormControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:11108 (opens new window)

FormControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`submitForm`	(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, otherParameters?: string, options?: any) => Promise<string>

# FormControllerApiFetchParamCreator

▸ ConstFormControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:10938 (opens new window)

FormControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`submitForm`	(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, otherParameters?: string, options: any) => FetchArgs

# FormControllerApiFp

▸ ConstFormControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:11048 (opens new window)

FormControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`submitForm`	(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, otherParameters?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<string>

# GroupControllerApiFactory

▸ ConstGroupControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:12088 (opens new window)

GroupControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`addContactsToGroup`	(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => Promise<GroupContactsDto>
`createGroup`	(createGroupOptions: CreateGroupOptions, options?: any) => Promise<GroupDto>
`deleteGroup`	(groupId: string, options?: any) => Promise<Response>
`getAllGroups`	(page?: number, size?: number, sort?: "ASC"
`getGroup`	(groupId: string, options?: any) => Promise<GroupDto>
`getGroupWithContacts`	(groupId: string, options?: any) => Promise<GroupContactsDto>
`getGroupWithContactsPaginated`	(groupId: string, page?: number, size?: number, sort?: "ASC"
`getGroups`	(options?: any) => Promise<GroupProjection[]>
`removeContactsFromGroup`	(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => Promise<GroupContactsDto>

# GroupControllerApiFetchParamCreator

▸ ConstGroupControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:11199 (opens new window)

GroupControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`addContactsToGroup`	(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options: any) => FetchArgs
`createGroup`	(createGroupOptions: CreateGroupOptions, options: any) => FetchArgs
`deleteGroup`	(groupId: string, options: any) => FetchArgs
`getAllGroups`	(page?: number, size?: number, sort?: "ASC"
`getGroup`	(groupId: string, options: any) => FetchArgs
`getGroupWithContacts`	(groupId: string, options: any) => FetchArgs
`getGroupWithContactsPaginated`	(groupId: string, page?: number, size?: number, sort?: "ASC"
`getGroups`	(options: any) => FetchArgs
`removeContactsFromGroup`	(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options: any) => FetchArgs

# GroupControllerApiFp

▸ ConstGroupControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:11784 (opens new window)

GroupControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`addContactsToGroup`	(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupContactsDto>
`createGroup`	(createGroupOptions: CreateGroupOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupDto>
`deleteGroup`	(groupId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`getAllGroups`	(page?: number, size?: number, sort?: "ASC"
`getGroup`	(groupId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupDto>
`getGroupWithContacts`	(groupId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupContactsDto>
`getGroupWithContactsPaginated`	(groupId: string, page?: number, size?: number, sort?: "ASC"
`getGroups`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<GroupProjection>>
`removeContactsFromGroup`	(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<GroupContactsDto>

# InboxControllerApiFactory

▸ ConstInboxControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:14015 (opens new window)

InboxControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`createInbox`	(description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, name?: string, tags?: Array<string>, useDomainPool?: boolean, options?: any) => Promise<Inbox>
`createInboxWithOptions`	(createInboxDto: CreateInboxDto, options?: any) => Promise<Inbox>
`deleteAllInboxes`	(options?: any) => Promise<Response>
`deleteInbox`	(inboxId: string, options?: any) => Promise<Response>
`getAllInboxes`	(favourite?: boolean, page?: number, search?: string, size?: number, sort?: "ASC"
`getEmails`	(inboxId: string, limit?: number, minCount?: number, retryTimeout?: number, since?: Date, size?: number, sort?: "ASC"
`getInbox`	(inboxId: string, options?: any) => Promise<Inbox>
`getInboxEmailsPaginated`	(inboxId: string, page?: number, size?: number, sort?: "ASC"
`getInboxSentEmails`	(inboxId: string, page?: number, size?: number, sort?: "ASC"
`getInboxTags`	(options?: any) => Promise<string[]>
`getInboxes`	(size?: number, sort?: "ASC"
`sendEmail`	(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise<Response>
`sendEmailAndConfirm`	(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise<SentEmailDto>
`setInboxFavourited`	(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options?: any) => Promise<Inbox>
`updateInbox`	(inboxId: string, updateInboxOptions: UpdateInboxOptions, options?: any) => Promise<Inbox>

# InboxControllerApiFetchParamCreator

▸ ConstInboxControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:12423 (opens new window)

InboxControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createInbox`	(description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, name?: string, tags?: Array<string>, useDomainPool?: boolean, options: any) => FetchArgs
`createInboxWithOptions`	(createInboxDto: CreateInboxDto, options: any) => FetchArgs
`deleteAllInboxes`	(options: any) => FetchArgs
`deleteInbox`	(inboxId: string, options: any) => FetchArgs
`getAllInboxes`	(favourite?: boolean, page?: number, search?: string, size?: number, sort?: "ASC"
`getEmails`	(inboxId: string, limit?: number, minCount?: number, retryTimeout?: number, since?: Date, size?: number, sort?: "ASC"
`getInbox`	(inboxId: string, options: any) => FetchArgs
`getInboxEmailsPaginated`	(inboxId: string, page?: number, size?: number, sort?: "ASC"
`getInboxSentEmails`	(inboxId: string, page?: number, size?: number, sort?: "ASC"
`getInboxTags`	(options: any) => FetchArgs
`getInboxes`	(size?: number, sort?: "ASC"
`sendEmail`	(inboxId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
`sendEmailAndConfirm`	(inboxId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
`setInboxFavourited`	(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options: any) => FetchArgs
`updateInbox`	(inboxId: string, updateInboxOptions: UpdateInboxOptions, options: any) => FetchArgs

# InboxControllerApiFp

▸ ConstInboxControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:13474 (opens new window)

InboxControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createInbox`	(description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, name?: string, tags?: Array<string>, useDomainPool?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
`createInboxWithOptions`	(createInboxDto: CreateInboxDto, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
`deleteAllInboxes`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`deleteInbox`	(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`getAllInboxes`	(favourite?: boolean, page?: number, search?: string, size?: number, sort?: "ASC"
`getEmails`	(inboxId: string, limit?: number, minCount?: number, retryTimeout?: number, since?: Date, size?: number, sort?: "ASC"
`getInbox`	(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
`getInboxEmailsPaginated`	(inboxId: string, page?: number, size?: number, sort?: "ASC"
`getInboxSentEmails`	(inboxId: string, page?: number, size?: number, sort?: "ASC"
`getInboxTags`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<string>>
`getInboxes`	(size?: number, sort?: "ASC"
`sendEmail`	(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`sendEmailAndConfirm`	(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
`setInboxFavourited`	(inboxId: string, setInboxFavouritedOptions: SetInboxFavouritedOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>
`updateInbox`	(inboxId: string, updateInboxOptions: UpdateInboxOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Inbox>

# MailServerControllerApiFactory

▸ ConstMailServerControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:15075 (opens new window)

MailServerControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`describeMailServerDomain`	(describeOptions: DescribeDomainOptions, options?: any) => Promise<DescribeMailServerDomainResult>
`getDnsLookup`	(dnsLookupOptions: DNSLookupOptions, options?: any) => Promise<DNSLookupResults>
`getIpAddress`	(name: string, options?: any) => Promise<IPAddressResult>
`verifyEmailAddress`	(verifyOptions: VerifyEmailAddressOptions, options?: any) => Promise<EmailVerificationResult>

# MailServerControllerApiFetchParamCreator

▸ ConstMailServerControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:14679 (opens new window)

MailServerControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`describeMailServerDomain`	(describeOptions: DescribeDomainOptions, options: any) => FetchArgs
`getDnsLookup`	(dnsLookupOptions: DNSLookupOptions, options: any) => FetchArgs
`getIpAddress`	(name: string, options: any) => FetchArgs
`verifyEmailAddress`	(verifyOptions: VerifyEmailAddressOptions, options: any) => FetchArgs

# MailServerControllerApiFp

▸ ConstMailServerControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:14938 (opens new window)

MailServerControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`describeMailServerDomain`	(describeOptions: DescribeDomainOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DescribeMailServerDomainResult>
`getDnsLookup`	(dnsLookupOptions: DNSLookupOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DNSLookupResults>
`getIpAddress`	(name: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<IPAddressResult>
`verifyEmailAddress`	(verifyOptions: VerifyEmailAddressOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<EmailVerificationResult>

# SentEmailsControllerApiFactory

▸ ConstSentEmailsControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:15440 (opens new window)

SentEmailsControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`getSentEmail`	(id: string, options?: any) => Promise<SentEmailDto>
`getSentEmails`	(inboxId?: string, page?: number, size?: number, sort?: "ASC"

# SentEmailsControllerApiFetchParamCreator

▸ ConstSentEmailsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:15224 (opens new window)

SentEmailsControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`getSentEmail`	(id: string, options: any) => FetchArgs
`getSentEmails`	(inboxId?: string, page?: number, size?: number, sort?: "ASC"

# SentEmailsControllerApiFp

▸ ConstSentEmailsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:15360 (opens new window)

SentEmailsControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`getSentEmail`	(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
`getSentEmails`	(inboxId?: string, page?: number, size?: number, sort?: "ASC"

# TemplateControllerApiFactory

▸ ConstTemplateControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:16004 (opens new window)

TemplateControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`createTemplate`	(createTemplateOptions: CreateTemplateOptions, options?: any) => Promise<TemplateDto>
`deleteTemplate`	(templateId: string, options?: any) => Promise<Response>
`getAllTemplates`	(page?: number, size?: number, sort?: "ASC"
`getTemplate`	(templateId: string, options?: any) => Promise<TemplateDto>
`getTemplates`	(options?: any) => Promise<TemplateProjection[]>

# TemplateControllerApiFetchParamCreator

▸ ConstTemplateControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:15541 (opens new window)

TemplateControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createTemplate`	(createTemplateOptions: CreateTemplateOptions, options: any) => FetchArgs
`deleteTemplate`	(templateId: string, options: any) => FetchArgs
`getAllTemplates`	(page?: number, size?: number, sort?: "ASC"
`getTemplate`	(templateId: string, options: any) => FetchArgs
`getTemplates`	(options: any) => FetchArgs

# TemplateControllerApiFp

▸ ConstTemplateControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:15837 (opens new window)

TemplateControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createTemplate`	(createTemplateOptions: CreateTemplateOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<TemplateDto>
`deleteTemplate`	(templateId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`getAllTemplates`	(page?: number, size?: number, sort?: "ASC"
`getTemplate`	(templateId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<TemplateDto>
`getTemplates`	(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<TemplateProjection>>

# WaitForControllerApiFactory

▸ ConstWaitForControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:16869 (opens new window)

WaitForControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`waitFor`	(waitForConditions?: WaitForConditions, options?: any) => Promise<EmailPreview[]>
`waitForEmailCount`	(count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<EmailPreview[]>
`waitForLatestEmail`	(inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<Email>
`waitForMatchingEmail`	(matchOptions: MatchOptions, count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<EmailPreview[]>
`waitForMatchingFirstEmail`	(matchOptions: MatchOptions, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<Email>
`waitForNthEmail`	(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<Email>

# WaitForControllerApiFetchParamCreator

▸ ConstWaitForControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:16186 (opens new window)

WaitForControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`waitFor`	(waitForConditions?: WaitForConditions, options: any) => FetchArgs
`waitForEmailCount`	(count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
`waitForLatestEmail`	(inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
`waitForMatchingEmail`	(matchOptions: MatchOptions, count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
`waitForMatchingFirstEmail`	(matchOptions: MatchOptions, inboxId?: string, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs
`waitForNthEmail`	(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs

# WaitForControllerApiFp

▸ ConstWaitForControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:16628 (opens new window)

WaitForControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`waitFor`	(waitForConditions?: WaitForConditions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<EmailPreview>>
`waitForEmailCount`	(count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<EmailPreview>>
`waitForLatestEmail`	(inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
`waitForMatchingEmail`	(matchOptions: MatchOptions, count?: number, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<EmailPreview>>
`waitForMatchingFirstEmail`	(matchOptions: MatchOptions, inboxId?: string, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
`waitForNthEmail`	(inboxId?: string, index?: number, timeout?: number, unreadOnly?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>

# WebhookControllerApiFactory

▸ ConstWebhookControllerApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: string): object

Defined in src/generated/api.ts:17767 (opens new window)

WebhookControllerApi - factory interface

export

# Parameters:

Name	Type
`configuration?`	Configuration
`fetch?`	FetchAPI
`basePath?`	string

Returns: object

Name	Type
`createWebhook`	(inboxId: string, webhookOptions: CreateWebhookOptions, options?: any) => Promise<WebhookDto>
`deleteWebhook`	(inboxId: string, webhookId: string, options?: any) => Promise<Response>
`getAllWebhooks`	(page?: number, size?: number, sort?: "ASC"
`getWebhook`	(webhookId: string, options?: any) => Promise<WebhookDto>
`getWebhooks`	(inboxId: string, options?: any) => Promise<WebhookDto[]>
`sendTestData`	(webhookId: string, options?: any) => Promise<WebhookTestResult>

# WebhookControllerApiFetchParamCreator

▸ ConstWebhookControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:17182 (opens new window)

WebhookControllerApi - fetch parameter creator

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createWebhook`	(inboxId: string, webhookOptions: CreateWebhookOptions, options: any) => FetchArgs
`deleteWebhook`	(inboxId: string, webhookId: string, options: any) => FetchArgs
`getAllWebhooks`	(page?: number, size?: number, sort?: "ASC"
`getWebhook`	(webhookId: string, options: any) => FetchArgs
`getWebhooks`	(inboxId: string, options: any) => FetchArgs
`sendTestData`	(webhookId: string, options: any) => FetchArgs

# WebhookControllerApiFp

▸ ConstWebhookControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:17567 (opens new window)

WebhookControllerApi - functional programming interface

export

# Parameters:

Name	Type
`configuration?`	Configuration

Returns: object

Name	Type
`createWebhook`	(inboxId: string, webhookOptions: CreateWebhookOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookDto>
`deleteWebhook`	(inboxId: string, webhookId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Response>
`getAllWebhooks`	(page?: number, size?: number, sort?: "ASC"
`getWebhook`	(webhookId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookDto>
`getWebhooks`	(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<WebhookDto>>
`sendTestData`	(webhookId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookTestResult>

# wrapCall

▸ wrapCall<T>(tag: String, fn: () => Promise<T>): Promise<T>

Defined in src/index.ts:514 (opens new window)

# Type parameters:

Name
`T`

# Parameters:

Name	Type
`tag`	String
`fn`	() => Promise<T>

Returns: Promise<T>

# Object literals

# COLLECTION_FORMATS

▪ Const COLLECTION_FORMATS: object

Defined in src/generated/api.ts:25 (opens new window)

export

# Properties:

Name	Type	Value
`csv`	string	","
`pipes`	string	"
`ssv`	string	" "
`tsv`	string	" "