MailSlurp JS

Globals

MailSlurp JS

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Config

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

Defined in src/.ts:48

MailSlurp config

remarks Obtain your API Key in your dashboard.

Type declaration:

NameType
apiKeystring
attribution?string
basePath?string
fetchApi?FetchAPI

GetMessagesOptions

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

Defined in src/.ts:545

Options for advanced message fetching

remarks For more control over fetching. See also Webhook endpoints

Type declaration:

NameType
limit?number
minCount?number
retryTimeout?number
since?Date
size?number
sort?SortEnum

SortEnum

Ƭ SortEnum: “ASC” | “DESC”

Defined in src/.ts:41

Variables

BASE_PATH

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

Defined in src/generated/api.ts:19


InboxTypeEnum

InboxTypeEnum: InboxTypeEnum

Defined in src/.ts:2

Functions

AliasControllerApiFactory

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

Defined in src/generated/api.ts:7731

AliasControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createAlias(createAliasOptions: CreateAliasOptions, options?: any) => Promise<AliasDto>
deleteAlias(aliasId: string, options?: any) => Promise
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

AliasControllerApiFetchParamCreator

ConstAliasControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:6778

AliasControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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:7417

AliasControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createAlias(createAliasOptions: CreateAliasOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AliasDto>
deleteAlias(aliasId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
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

AttachmentControllerApiFactory

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

Defined in src/generated/api.ts:9088

AttachmentControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
deleteAllAttachments(options?: any) => Promise
deleteAttachment(attachmentId: string, options?: any) => Promise
downloadAttachmentAsBase64Encoded(attachmentId: string, options?: any) => Promise<DownloadAttachmentDto>
downloadAttachmentAsBytes(attachmentId: string, options?: any) => Promise
getAttachment(attachmentId: string, options?: any) => Promise<AttachmentEntity>
getAttachmentInfo(attachmentId: string, options?: any) => Promise<AttachmentMetaData>
getAttachments(fileNameFilter?: string, page?: number, size?: number, sort?: “ASC”
uploadAttachment(uploadOptions: UploadAttachmentOptions, options?: any) => Promise<string[]>
uploadAttachmentBytes(byteArray?: string, contentType?: 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:8112

AttachmentControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
deleteAllAttachments(options: any) => FetchArgs
deleteAttachment(attachmentId: string, options: any) => FetchArgs
downloadAttachmentAsBase64Encoded(attachmentId: string, options: any) => FetchArgs
downloadAttachmentAsBytes(attachmentId: string, options: any) => FetchArgs
getAttachment(attachmentId: string, options: any) => FetchArgs
getAttachmentInfo(attachmentId: string, options: any) => FetchArgs
getAttachments(fileNameFilter?: string, page?: number, size?: number, sort?: “ASC”
uploadAttachment(uploadOptions: UploadAttachmentOptions, options: any) => FetchArgs
uploadAttachmentBytes(byteArray?: string, contentType?: 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:8745

AttachmentControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
deleteAllAttachments(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
deleteAttachment(attachmentId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
downloadAttachmentAsBase64Encoded(attachmentId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DownloadAttachmentDto>
downloadAttachmentAsBytes(attachmentId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
getAttachment(attachmentId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AttachmentEntity>
getAttachmentInfo(attachmentId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AttachmentMetaData>
getAttachments(fileNameFilter?: string, page?: number, size?: number, sort?: “ASC”
uploadAttachment(uploadOptions: UploadAttachmentOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array>
uploadAttachmentBytes(byteArray?: string, contentType?: string, filename?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array>
uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array>

BounceControllerApiFactory

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

Defined in src/generated/api.ts:9865

BounceControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
getBouncedEmail(id: string, options?: any) => Promise<BouncedEmailDto>
getBouncedEmails(page?: number, size?: number, sort?: “ASC”
getBouncedRecipient(id: string, options?: any) => Promise<BouncedRecipientDto>
getBouncedRecipients(page?: number, size?: number, sort?: “ASC”

BounceControllerApiFetchParamCreator

ConstBounceControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:9473

BounceControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getBouncedEmail(id: string, options: any) => FetchArgs
getBouncedEmails(page?: number, size?: number, sort?: “ASC”
getBouncedRecipient(id: string, options: any) => FetchArgs
getBouncedRecipients(page?: number, size?: number, sort?: “ASC”

BounceControllerApiFp

ConstBounceControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:9722

BounceControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getBouncedEmail(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<BouncedEmailDto>
getBouncedEmails(page?: number, size?: number, sort?: “ASC”
getBouncedRecipient(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<BouncedRecipientDto>
getBouncedRecipients(page?: number, size?: number, sort?: “ASC”

BulkActionsControllerApiFactory

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

Defined in src/generated/api.ts:10330

BulkActionsControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
bulkCreateInboxes(count: number, options?: any) => Promise<Inbox[]>
bulkDeleteInboxes(ids: Array, options?: any) => Promise
bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any) => Promise

BulkActionsControllerApiFetchParamCreator

ConstBulkActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:10034

BulkActionsControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
bulkCreateInboxes(count: number, options: any) => FetchArgs
bulkDeleteInboxes(ids: Array, options: any) => FetchArgs
bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options: any) => FetchArgs

BulkActionsControllerApiFp

ConstBulkActionsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:10229

BulkActionsControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

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

CommonActionsControllerApiFactory

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

Defined in src/generated/api.ts:10871

CommonActionsControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

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

CommonActionsControllerApiFetchParamCreator

ConstCommonActionsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:10441

CommonActionsControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createNewEmailAddress(allowTeamAccess?: boolean, expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options: any) => FetchArgs
createNewEmailAddress1(allowTeamAccess?: boolean, 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:10716

CommonActionsControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

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

ContactControllerApiFactory

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

Defined in src/generated/api.ts:11611

ContactControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createContact(createContactOptions: CreateContactOptions, options?: any) => Promise<ContactDto>
deleteContact(contactId: string, options?: any) => Promise
getAllContacts(page?: number, size?: number, sort?: “ASC”
getContact(contactId: string, options?: any) => Promise<ContactDto>
getContactVCard(contactId: string, options?: any) => Promise
getContacts(options?: any) => Promise<ContactProjection[]>

ContactControllerApiFetchParamCreator

ConstContactControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:11063

ContactControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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
getContactVCard(contactId: string, options: any) => FetchArgs
getContacts(options: any) => FetchArgs

ContactControllerApiFp

ConstContactControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:11414

ContactControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createContact(createContactOptions: CreateContactOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ContactDto>
deleteContact(contactId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
getAllContacts(page?: number, size?: number, sort?: “ASC”
getContact(contactId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ContactDto>
getContactVCard(contactId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
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:12374

DomainControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
addDomainWildcardCatchAll(id: string, options?: any) => Promise<DomainDto>
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[]>
updateDomain(id: string, updateDomainDto: UpdateDomainOptions, options?: any) => Promise<DomainDto>

DomainControllerApiFetchParamCreator

ConstDomainControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:11822

DomainControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
addDomainWildcardCatchAll(id: string, options: any) => FetchArgs
createDomain(domainOptions: CreateDomainOptions, options: any) => FetchArgs
deleteDomain(id: string, options: any) => FetchArgs
getDomain(id: string, options: any) => FetchArgs
getDomains(options: any) => FetchArgs
updateDomain(id: string, updateDomainDto: UpdateDomainOptions, options: any) => FetchArgs

DomainControllerApiFp

ConstDomainControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:12182

DomainControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
addDomainWildcardCatchAll(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>
createDomain(domainOptions: CreateDomainOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>
deleteDomain(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array>
getDomain(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>
getDomains(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array<DomainPreview»
updateDomain(id: string, updateDomainDto: UpdateDomainOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DomainDto>

EmailControllerApiFactory

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

Defined in src/generated/api.ts:14923

EmailControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
deleteAllEmails(options?: any) => Promise
deleteEmail(emailId: string, options?: any) => Promise
downloadAttachment(attachmentId: string, emailId: string, apiKey?: string, options?: any) => Promise
downloadAttachmentBase64(attachmentId: string, emailId: string, options?: any) => Promise<DownloadAttachmentDto>
downloadBody(emailId: string, options?: any) => Promise
downloadBodyBytes(emailId: string, options?: any) => Promise
forwardEmail(emailId: string, forwardEmailOptions: ForwardEmailOptions, options?: any) => Promise<SentEmailDto>
getAttachmentMetaData(attachmentId: string, emailId: string, options?: any) => Promise<AttachmentMetaData>
getAttachments1(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
getEmailHTMLQuery(emailId: string, htmlSelector?: string, options?: any) => Promise<EmailTextLinesResult>
getEmailTextLines(emailId: string, decodeHtmlEntities?: boolean, lineSeparator?: string, options?: any) => Promise<EmailTextLinesResult>
getEmailsPaginated(inboxId?: Array, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getLatestEmail(inboxIds?: Array, options?: any) => Promise<Email>
getLatestEmailInInbox(inboxId?: string, options?: any) => Promise<Email>
getOrganizationEmailsPaginated(inboxId?: Array, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getRawEmailContents(emailId: string, options?: any) => Promise
getRawEmailJson(emailId: string, options?: any) => Promise<RawEmailJson>
getUnreadEmailCount(options?: any) => Promise<UnreadCount>
replyToEmail(emailId: string, replyToEmailOptions: ReplyToEmailOptions, options?: any) => Promise<SentEmailDto>
sendEmailSourceOptional(inboxId?: string, sendEmailOptions?: SendEmailOptions, useDomainPool?: boolean, options?: any) => Promise
validateEmail(emailId: string, options?: any) => Promise<ValidationDto>

EmailControllerApiFetchParamCreator

ConstEmailControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:12571

EmailControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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
downloadBody(emailId: string, options: any) => FetchArgs
downloadBodyBytes(emailId: string, options: any) => FetchArgs
forwardEmail(emailId: string, forwardEmailOptions: ForwardEmailOptions, options: any) => FetchArgs
getAttachmentMetaData(attachmentId: string, emailId: string, options: any) => FetchArgs
getAttachments1(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, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getLatestEmail(inboxIds?: Array, options: any) => FetchArgs
getLatestEmailInInbox(inboxId?: string, options: any) => FetchArgs
getOrganizationEmailsPaginated(inboxId?: Array, page?: number, searchFilter?: string, 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
sendEmailSourceOptional(inboxId?: string, sendEmailOptions?: SendEmailOptions, useDomainPool?: boolean, options: any) => FetchArgs
validateEmail(emailId: string, options: any) => FetchArgs

EmailControllerApiFp

ConstEmailControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:14100

EmailControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
deleteAllEmails(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
deleteEmail(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
downloadAttachment(attachmentId: string, emailId: string, apiKey?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
downloadAttachmentBase64(attachmentId: string, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<DownloadAttachmentDto>
downloadBody(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
downloadBodyBytes(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
forwardEmail(emailId: string, forwardEmailOptions: ForwardEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
getAttachmentMetaData(attachmentId: string, emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<AttachmentMetaData>
getAttachments1(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
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, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getLatestEmail(inboxIds?: Array, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
getLatestEmailInInbox(inboxId?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Email>
getOrganizationEmailsPaginated(inboxId?: Array, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getRawEmailContents(emailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
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>
sendEmailSourceOptional(inboxId?: string, sendEmailOptions?: SendEmailOptions, useDomainPool?: boolean, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
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:16189

ExpiredControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
getExpirationDefaults(options?: any) => Promise<ExpirationDefaults>
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:15820

ExpiredControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getExpirationDefaults(options: any) => FetchArgs
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:16052

ExpiredControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getExpirationDefaults(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<ExpirationDefaults>
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”

ExportControllerApiFactory

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

Defined in src/generated/api.ts:16648

ExportControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
exportEntities(apiKey: string, exportType: “INBOXES”
getExportLink(exportOptions: ExportOptions, exportType: “INBOXES”

ExportControllerApiFetchParamCreator

ConstExportControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:16334

ExportControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
exportEntities(apiKey: string, exportType: “INBOXES”
getExportLink(exportOptions: ExportOptions, exportType: “INBOXES”

ExportControllerApiFp

ConstExportControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:16551

ExportControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
exportEntities(apiKey: string, exportType: “INBOXES”
getExportLink(exportOptions: ExportOptions, exportType: “INBOXES”

FormControllerApiFactory

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

Defined in src/generated/api.ts:16961

FormControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
submitForm(emailAddress?: string, redirectTo?: string, spamCheck?: string, subject?: string, successMessage?: string, to?: string, otherParameters?: string, options?: any) => Promise

FormControllerApiFetchParamCreator

ConstFormControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:16791

FormControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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:16901

FormControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

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

GroupControllerApiFactory

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

Defined in src/generated/api.ts:17941

GroupControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
addContactsToGroup(groupId: string, updateGroupContactsOption: UpdateGroupContacts, options?: any) => Promise<GroupContactsDto>
createGroup(createGroupOptions: CreateGroupOptions, options?: any) => Promise<GroupDto>
deleteGroup(groupId: string, options?: any) => Promise
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:17052

GroupControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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:17637

GroupControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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
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:20555

InboxControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createInbox(allowTeamAccess?: boolean, description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, inboxType?: “HTTP_INBOX”
createInboxRuleset(createInboxRulesetOptions: CreateInboxRulesetOptions, inboxId: string, options?: any) => Promise<InboxRulesetDto>
createInboxWithDefaults(options?: any) => Promise<Inbox>
createInboxWithOptions(createInboxDto: CreateInboxDto, options?: any) => Promise<Inbox>
deleteAllInboxes(options?: any) => Promise
deleteInbox(inboxId: string, options?: any) => Promise
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, searchFilter?: string, size?: number, sort?: “ASC”
getInboxTags(options?: any) => Promise<string[]>
getInboxes(size?: number, sort?: “ASC”
getOrganizationInboxes(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
listInboxRulesets(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
listInboxTrackingPixels(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise
sendEmailAndConfirm(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => Promise<SentEmailDto>
sendTestEmail(inboxId: string, options?: any) => Promise
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:18276

InboxControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createInbox(allowTeamAccess?: boolean, description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, inboxType?: “HTTP_INBOX”
createInboxRuleset(createInboxRulesetOptions: CreateInboxRulesetOptions, inboxId: string, options: any) => FetchArgs
createInboxWithDefaults(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, searchFilter?: string, size?: number, sort?: “ASC”
getInboxTags(options: any) => FetchArgs
getInboxes(size?: number, sort?: “ASC”
getOrganizationInboxes(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
listInboxRulesets(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
listInboxTrackingPixels(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
sendEmailAndConfirm(inboxId: string, sendEmailOptions?: SendEmailOptions, options: any) => FetchArgs
sendTestEmail(inboxId: string, 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:19763

InboxControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createInbox(allowTeamAccess?: boolean, description?: string, emailAddress?: string, expiresAt?: Date, expiresIn?: number, favourite?: boolean, inboxType?: “HTTP_INBOX”
createInboxRuleset(createInboxRulesetOptions: CreateInboxRulesetOptions, inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxRulesetDto>
createInboxWithDefaults(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
deleteInbox(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
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, searchFilter?: string, size?: number, sort?: “ASC”
getInboxTags(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<Array>
getInboxes(size?: number, sort?: “ASC”
getOrganizationInboxes(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
listInboxRulesets(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
listInboxTrackingPixels(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
sendEmail(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
sendEmailAndConfirm(inboxId: string, sendEmailOptions?: SendEmailOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
sendTestEmail(inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
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>

InboxForwarderControllerApiFactory

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

Defined in src/generated/api.ts:22340

InboxForwarderControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createNewInboxForwarder(createInboxForwarderOptions: CreateInboxForwarderOptions, inboxId?: string, options?: any) => Promise<InboxForwarderDto>
deleteInboxForwarder(id: string, options?: any) => Promise
deleteInboxForwarders(inboxId?: string, options?: any) => Promise
getInboxForwarder(id: string, options?: any) => Promise<InboxForwarderDto>
getInboxForwarders(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
testInboxForwarder(id: string, inboxForwarderTestOptions: InboxForwarderTestOptions, options?: any) => Promise<InboxForwarderTestResult>
testInboxForwardersForInbox(inboxForwarderTestOptions: InboxForwarderTestOptions, inboxId: string, options?: any) => Promise<InboxForwarderTestResult>
testNewInboxForwarder(testNewInboxForwarderOptions: TestNewInboxForwarderOptions, options?: any) => Promise<InboxForwarderTestResult>

InboxForwarderControllerApiFetchParamCreator

ConstInboxForwarderControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:21503

InboxForwarderControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createNewInboxForwarder(createInboxForwarderOptions: CreateInboxForwarderOptions, inboxId?: string, options: any) => FetchArgs
deleteInboxForwarder(id: string, options: any) => FetchArgs
deleteInboxForwarders(inboxId?: string, options: any) => FetchArgs
getInboxForwarder(id: string, options: any) => FetchArgs
getInboxForwarders(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
testInboxForwarder(id: string, inboxForwarderTestOptions: InboxForwarderTestOptions, options: any) => FetchArgs
testInboxForwardersForInbox(inboxForwarderTestOptions: InboxForwarderTestOptions, inboxId: string, options: any) => FetchArgs
testNewInboxForwarder(testNewInboxForwarderOptions: TestNewInboxForwarderOptions, options: any) => FetchArgs

InboxForwarderControllerApiFp

ConstInboxForwarderControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:22048

InboxForwarderControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createNewInboxForwarder(createInboxForwarderOptions: CreateInboxForwarderOptions, inboxId?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxForwarderDto>
deleteInboxForwarder(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
deleteInboxForwarders(inboxId?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
getInboxForwarder(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxForwarderDto>
getInboxForwarders(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
testInboxForwarder(id: string, inboxForwarderTestOptions: InboxForwarderTestOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxForwarderTestResult>
testInboxForwardersForInbox(inboxForwarderTestOptions: InboxForwarderTestOptions, inboxId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxForwarderTestResult>
testNewInboxForwarder(testNewInboxForwarderOptions: TestNewInboxForwarderOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxForwarderTestResult>

InboxRulesetControllerApiFactory

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

Defined in src/generated/api.ts:23502

InboxRulesetControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createNewInboxRuleset(createInboxRulesetOptions: CreateInboxRulesetOptions, inboxId?: string, options?: any) => Promise<InboxRulesetDto>
deleteInboxRuleset(id: string, options?: any) => Promise
deleteInboxRulesets(inboxId?: string, options?: any) => Promise
getInboxRuleset(id: string, options?: any) => Promise<InboxRulesetDto>
getInboxRulesets(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
testInboxRuleset(id: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options?: any) => Promise<InboxRulesetTestResult>
testInboxRulesetsForInbox(inboxId: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options?: any) => Promise<InboxRulesetTestResult>
testNewInboxRuleset(testNewInboxRulesetOptions: TestNewInboxRulesetOptions, options?: any) => Promise<InboxRulesetTestResult>

InboxRulesetControllerApiFetchParamCreator

ConstInboxRulesetControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:22665

InboxRulesetControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createNewInboxRuleset(createInboxRulesetOptions: CreateInboxRulesetOptions, inboxId?: string, options: any) => FetchArgs
deleteInboxRuleset(id: string, options: any) => FetchArgs
deleteInboxRulesets(inboxId?: string, options: any) => FetchArgs
getInboxRuleset(id: string, options: any) => FetchArgs
getInboxRulesets(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
testInboxRuleset(id: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options: any) => FetchArgs
testInboxRulesetsForInbox(inboxId: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options: any) => FetchArgs
testNewInboxRuleset(testNewInboxRulesetOptions: TestNewInboxRulesetOptions, options: any) => FetchArgs

InboxRulesetControllerApiFp

ConstInboxRulesetControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:23210

InboxRulesetControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createNewInboxRuleset(createInboxRulesetOptions: CreateInboxRulesetOptions, inboxId?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxRulesetDto>
deleteInboxRuleset(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
deleteInboxRulesets(inboxId?: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
getInboxRuleset(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxRulesetDto>
getInboxRulesets(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
testInboxRuleset(id: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxRulesetTestResult>
testInboxRulesetsForInbox(inboxId: string, inboxRulesetTestOptions: InboxRulesetTestOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxRulesetTestResult>
testNewInboxRuleset(testNewInboxRulesetOptions: TestNewInboxRulesetOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<InboxRulesetTestResult>

MailServerControllerApiFactory

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

Defined in src/generated/api.ts:24221

MailServerControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
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:23825

MailServerControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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:24084

MailServerControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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>

MissedEmailControllerApiFactory

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

Defined in src/generated/api.ts:24699

MissedEmailControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
getAllMissedEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getMissedEmail(missedEmailId: string, options?: any) => Promise<MissedEmail>
waitForNthMissedEmail(inboxId?: string, ?: number, timeout?: number, options?: any) => Promise<MissedEmail>

MissedEmailControllerApiFetchParamCreator

ConstMissedEmailControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:24370

MissedEmailControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getAllMissedEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getMissedEmail(missedEmailId: string, options: any) => FetchArgs
waitForNthMissedEmail(inboxId?: string, ?: number, timeout?: number, options: any) => FetchArgs

MissedEmailControllerApiFp

ConstMissedEmailControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:24576

MissedEmailControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getAllMissedEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getMissedEmail(missedEmailId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<MissedEmail>
waitForNthMissedEmail(inboxId?: string, ?: number, timeout?: number, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<MissedEmail>

SentEmailsControllerApiFactory

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

Defined in src/generated/api.ts:25522

SentEmailsControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
getAllSentTrackingPixels(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentEmail(id: string, options?: any) => Promise<SentEmailDto>
getSentEmailHTMLContent(id: string, options?: any) => Promise
getSentEmailTrackingPixels(id: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentOrganizationEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”

SentEmailsControllerApiFetchParamCreator

ConstSentEmailsControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:24850

SentEmailsControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getAllSentTrackingPixels(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentEmail(id: string, options: any) => FetchArgs
getSentEmailHTMLContent(id: string, options: any) => FetchArgs
getSentEmailTrackingPixels(id: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentOrganizationEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”

SentEmailsControllerApiFp

ConstSentEmailsControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:25275

SentEmailsControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
getAllSentTrackingPixels(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentEmail(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<SentEmailDto>
getSentEmailHTMLContent(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
getSentEmailTrackingPixels(id: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getSentOrganizationEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”

TemplateControllerApiFactory

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

Defined in src/generated/api.ts:26292

TemplateControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createTemplate(createTemplateOptions: CreateTemplateOptions, options?: any) => Promise<TemplateDto>
deleteTemplate(templateId: string, options?: any) => Promise
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:25829

TemplateControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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:26125

TemplateControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createTemplate(createTemplateOptions: CreateTemplateOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<TemplateDto>
deleteTemplate(templateId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise
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»

TrackingControllerApiFactory

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

Defined in src/generated/api.ts:26785

TrackingControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createTrackingPixel(createTrackingPixelOptions: CreateTrackingPixelOptions, options?: any) => Promise<TrackingPixelDto>
getAllTrackingPixels(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getTrackingPixel(id: string, options?: any) => Promise<TrackingPixelDto>

TrackingControllerApiFetchParamCreator

ConstTrackingControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:26474

TrackingControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createTrackingPixel(createTrackingPixelOptions: CreateTrackingPixelOptions, options: any) => FetchArgs
getAllTrackingPixels(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getTrackingPixel(id: string, options: any) => FetchArgs

TrackingControllerApiFp

ConstTrackingControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:26677

TrackingControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createTrackingPixel(createTrackingPixelOptions: CreateTrackingPixelOptions, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<TrackingPixelDto>
getAllTrackingPixels(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getTrackingPixel(id: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<TrackingPixelDto>

WaitForControllerApiFactory

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

Defined in src/generated/api.ts:27603

WaitForControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
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, ?: number, timeout?: number, unreadOnly?: boolean, options?: any) => Promise<Email>

WaitForControllerApiFetchParamCreator

ConstWaitForControllerApiFetchParamCreator(configuration?: Configuration): object

Defined in src/generated/api.ts:26920

WaitForControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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, ?: number, timeout?: number, unreadOnly?: boolean, options: any) => FetchArgs

WaitForControllerApiFp

ConstWaitForControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:27362

WaitForControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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, ?: 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:29358

WebhookControllerApi - factory interface

export

Parameters:

NameType
configuration?Configuration
fetch?FetchAPI
basePath?string

Returns: object

NameType
createWebhook(inboxId: string, webhookOptions: CreateWebhookOptions, options?: any) => Promise<WebhookDto>
deleteWebhook(inboxId: string, webhookId: string, options?: any) => Promise
getAllWebhookResults(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getAllWebhooks(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getInboxWebhooksPaginated(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getTestWebhookPayload(eventName?: “EMAIL_RECEIVED”
getTestWebhookPayloadEmailOpened(options?: any) => Promise<WebhookEmailOpenedPayload>
getTestWebhookPayloadNewAttachment(options?: any) => Promise<WebhookNewAttachmentPayload>
getTestWebhookPayloadNewContact(options?: any) => Promise<WebhookNewContactPayload>
getTestWebhookPayloadNewEmail(options?: any) => Promise<WebhookNewEmailPayload>
getWebhook(webhookId: string, options?: any) => Promise<WebhookDto>
getWebhookResult(webhookResultId: string, options?: any) => Promise<WebhookResultEntity>
getWebhookResults(webhookId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
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:27916

WebhookControllerApi - fetch parameter creator

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
createWebhook(inboxId: string, webhookOptions: CreateWebhookOptions, options: any) => FetchArgs
deleteWebhook(inboxId: string, webhookId: string, options: any) => FetchArgs
getAllWebhookResults(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getAllWebhooks(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getInboxWebhooksPaginated(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getTestWebhookPayload(eventName?: “EMAIL_RECEIVED”
getTestWebhookPayloadEmailOpened(options: any) => FetchArgs
getTestWebhookPayloadNewAttachment(options: any) => FetchArgs
getTestWebhookPayloadNewContact(options: any) => FetchArgs
getTestWebhookPayloadNewEmail(options: any) => FetchArgs
getWebhook(webhookId: string, options: any) => FetchArgs
getWebhookResult(webhookResultId: string, options: any) => FetchArgs
getWebhookResults(webhookId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getWebhooks(inboxId: string, options: any) => FetchArgs
sendTestData(webhookId: string, options: any) => FetchArgs

WebhookControllerApiFp

ConstWebhookControllerApiFp(configuration?: Configuration): object

Defined in src/generated/api.ts:28832

WebhookControllerApi - functional programming interface

export

Parameters:

NameType
configuration?Configuration

Returns: object

NameType
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
getAllWebhookResults(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getAllWebhooks(page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getInboxWebhooksPaginated(inboxId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
getTestWebhookPayload(eventName?: “EMAIL_RECEIVED”
getTestWebhookPayloadEmailOpened(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookEmailOpenedPayload>
getTestWebhookPayloadNewAttachment(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookNewAttachmentPayload>
getTestWebhookPayloadNewContact(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookNewContactPayload>
getTestWebhookPayloadNewEmail(options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookNewEmailPayload>
getWebhook(webhookId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookDto>
getWebhookResult(webhookResultId: string, options?: any) => (fetch?: FetchAPI, basePath?: string) => Promise<WebhookResultEntity>
getWebhookResults(webhookId: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC”
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(tag: String, fn: () => Promise): Promise

Defined in src/.ts:562

Type parameters:

Name
T

Parameters:

NameType
tagString
fn() => Promise

Returns: Promise


wrapException

wrapException(fn: () => Promise): Promise

Defined in src/.ts:570

Type parameters:

Name
T

Parameters:

NameType
fn() => Promise

Returns: Promise


wrapResult

wrapResult(fn: () => Promise): Promise<Result>

Defined in src/.ts:582

Type parameters:

Name
T

Parameters:

NameType
fn() => Promise

Returns: Promise<Result>

Object literals

COLLECTION_FORMATS

Const COLLECTION_FORMATS: object

Defined in src/generated/api.ts:25

export

Properties:

NameTypeValue
csvstring“,”
pipesstring"
ssvstring" "
tsvstring" "