MailSlurp Documentation

Typescript Email Client

Initializing search

MailSlurp Documentation

Getting started
Tutorial guides
Example projects
Creating inboxes
Sending emails
Receiving emails
Overview
IMAP SMTP
Phone TXT/SMS
Webhooks
Api
Api
Cpp restsdk
Cpp restsdk
Crystal
Crystal
Csharp
Csharp
- Docs
  Docs
Csharp netstandard 2x
Csharp netstandard 2x
- Docs
  Docs
Cypress mailslurp
Cypress mailslurp
- Cypress
  Cypress
  - E2e
    
    E2e
  - Fixtures
    
    Fixtures
  - Plugins
    
    Plugins
  - Support
    
    Support
- Src
  Src
- Test
  Test
Dart
Dart
- Doc
  Doc
Deno
Deno
Elixir
Elixir
Erlang
Erlang
Go
Go
- Docs
  Docs
Graphql
Graphql
- Docs
  Docs
Haskell
Haskell
Java
Java
- Docs
  Docs
Js
Js
- Docs
  Docs
Kotlin
Kotlin
- Docs
  Docs
Lua
Lua
Nim
Nim
Objc
Objc
- Docs
  Docs
Ocaml
Ocaml
Perl
Perl
- Docs
  Docs
Php
Php
- Docs
  Docs
  - Api
    
    Api
    
    MailSlurp\AliasControllerApi
    
    MailSlurp\ApiUserControllerApi
    
    MailSlurp\AttachmentControllerApi
    
    MailSlurp\BounceControllerApi
    
    MailSlurp\BulkActionsControllerApi
    
    MailSlurp\CommonActionsControllerApi
    
    MailSlurp\ContactControllerApi
    
    MailSlurp\DomainControllerApi
    
    MailSlurp\EmailControllerApi
    
    MailSlurp\EmailVerificationControllerApi
    
    MailSlurp\ExpiredControllerApi
    
    MailSlurp\ExportControllerApi
    
    MailSlurp\FormControllerApi
    
    MailSlurp\GroupControllerApi
    
    MailSlurp\InboxControllerApi
    
    MailSlurp\InboxForwarderControllerApi
    
    MailSlurp\InboxRulesetControllerApi
    
    MailSlurp\MailServerControllerApi
    
    MailSlurp\MissedEmailControllerApi
    
    MailSlurp\PhoneControllerApi
    
    MailSlurp\SentEmailsControllerApi
    
    MailSlurp\SmsControllerApi
    
    MailSlurp\TemplateControllerApi
    
    MailSlurp\TrackingControllerApi
    
    MailSlurp\WaitForControllerApi
    
    MailSlurp\WebhookControllerApi
  - Model
    
    Model
    
    # AbstractWebhookPayload
    
    # AliasDto
    
    # AliasProjection
    
    # AttachmentEntity
    
    # AttachmentMetaData
    
    # AttachmentProjection
    
    # BasicAuthOptions
    
    # BounceProjection
    
    # BounceRecipientProjection
    
    # BouncedEmailDto
    
    # BouncedRecipientDto
    
    # BulkSendEmailOptions
    
    # Complaint
    
    # ConditionOption
    
    # ContactDto
    
    # ContactProjection
    
    # ContentMatchOptions
    
    # CountDto
    
    # CreateAliasOptions
    
    # CreateContactOptions
    
    # CreateDomainOptions
    
    # CreateEmergencyAddressOptions
    
    # CreateGroupOptions
    
    # CreateInboxDto
    
    # CreateInboxForwarderOptions
    
    # CreateInboxRulesetOptions
    
    # CreateTemplateOptions
    
    # CreateTrackingPixelOptions
    
    # CreateWebhookOptions
    
    # DNSLookupOptions
    
    # DNSLookupResult
    
    # DNSLookupResults
    
    # DeliveryStatusDto
    
    # DescribeDomainOptions
    
    # DescribeMailServerDomainResult
    
    # DomainDto
    
    # DomainNameRecord
    
    # DomainPreview
    
    # DownloadAttachmentDto
    
    # Email
    
    # EmailAnalysis
    
    # EmailContentMatchResult
    
    # EmailHtmlDto
    
    # EmailLinksResult
    
    # EmailPreview
    
    # EmailPreviewUrls
    
    # EmailProjection
    
    # EmailRecipients
    
    # EmailTextLinesResult
    
    # EmailValidationRequestDto
    
    # EmailVerificationResult
    
    # EmergencyAddress
    
    # EmergencyAddressDto
    
    # EmptyResponseDto
    
    # ExpirationDefaults
    
    # ExpiredInboxDto
    
    # ExpiredInboxRecordProjection
    
    # ExportLink
    
    # ExportOptions
    
    # FilterBouncedRecipientsOptions
    
    # FilterBouncedRecipientsResult
    
    # FlushExpiredInboxesResult
    
    # ForwardEmailOptions
    
    # GravatarUrl
    
    # GroupContactsDto
    
    # GroupDto
    
    # GroupProjection
    
    # HTMLValidationResult
    
    # IPAddressResult
    
    # ImapFlagOperationOptions
    
    # ImapSmtpAccessDetails
    
    # InboxByEmailAddressResult
    
    # InboxByNameResult
    
    # InboxDto
    
    # InboxExistsDto
    
    # InboxForwarderDto
    
    # InboxForwarderTestOptions
    
    # InboxForwarderTestResult
    
    # InboxIdItem
    
    # InboxIdsResult
    
    # InboxPreview
    
    # InboxRulesetDto
    
    # InboxRulesetTestOptions
    
    # InboxRulesetTestResult
    
    # InlineObject
    
    # InlineObject1
    
    # JSONSchemaDto
    
    # MatchOption
    
    # MatchOptions
    
    # MissedEmailDto
    
    # MissedEmailProjection
    
    # NameServerRecord
    
    # OrganizationInboxProjection
    
    # PageAlias
    
    # PageAttachmentEntity
    
    # PageBouncedEmail
    
    # PageBouncedRecipients
    
    # PageComplaint
    
    # PageContactProjection
    
    # PageDeliveryStatus
    
    # PageEmailPreview
    
    # PageEmailProjection
    
    # PageEmailValidationRequest
    
    # PageExpiredInboxRecordProjection
    
    # PageGroupProjection
    
    # PageInboxForwarderDto
    
    # PageInboxProjection
    
    # PageInboxRulesetDto
    
    # PageMissedEmailProjection
    
    # PageOrganizationInboxProjection
    
    # PagePhoneNumberProjection
    
    # PageScheduledJobs
    
    # PageSentEmailProjection
    
    # PageSentEmailWithQueueProjection
    
    # PageSmsProjection
    
    # PageTemplateProjection
    
    # PageThreadProjection
    
    # PageTrackingPixelProjection
    
    # PageUnknownMissedEmailProjection
    
    # PageWebhookProjection
    
    # PageWebhookResult
    
    # PageableObject
    
    # PhoneNumberDto
    
    # PhoneNumberProjection
    
    # PhonePlanDto
    
    # RawEmailJson
    
    # Recipient
    
    # ReplyToAliasEmailOptions
    
    # ReplyToEmailOptions
    
    # ScheduledJob
    
    # SendEmailOptions
    
    # SendSMTPEnvelopeOptions
    
    # SendWithQueueResult
    
    # Sender
    
    # SentEmailDto
    
    # SentEmailProjection
    
    # SetInboxFavouritedOptions
    
    # SimpleSendEmailOptions
    
    # SmsDto
    
    # SmsMatchOption
    
    # SmsPreview
    
    # SmsProjection
    
    # Sort
    
    # TemplateDto
    
    # TemplatePreview
    
    # TemplateProjection
    
    # TemplateVariable
    
    # TestNewInboxForwarderOptions
    
    # TestNewInboxRulesetOptions
    
    # TestPhoneNumberOptions
    
    # ThreadProjection
    
    # TrackingPixelDto
    
    # TrackingPixelProjection
    
    # UnknownMissedEmailProjection
    
    # UnreadCount
    
    # UnseenErrorCountDto
    
    # UpdateAliasOptions
    
    # UpdateDomainOptions
    
    # UpdateGroupContacts
    
    # UpdateInboxOptions
    
    # UploadAttachmentOptions
    
    # UserInfoDto
    
    # ValidateEmailAddressListOptions
    
    # ValidateEmailAddressListResult
    
    # ValidationDto
    
    # ValidationMessage
    
    # VerifyEmailAddressOptions
    
    # VerifyWebhookSignatureOptions
    
    # VerifyWebhookSignatureResults
    
    # WaitForConditions
    
    # WaitForSingleSmsOptions
    
    # WaitForSmsConditions
    
    # WebhookBouncePayload
    
    # WebhookBounceRecipientPayload
    
    # WebhookDeliveryStatusPayload
    
    # WebhookDto
    
    # WebhookEmailOpenedPayload
    
    # WebhookEmailReadPayload
    
    # WebhookHeaderNameValue
    
    # WebhookHeaders
    
    # WebhookNewAttachmentPayload
    
    # WebhookNewContactPayload
    
    # WebhookNewEmailPayload
    
    # WebhookNewSmsPayload
    
    # WebhookProjection
    
    # WebhookRedriveResult
    
    # WebhookResultDto
    
    # WebhookTestRequest
    
    # WebhookTestResponse
    
    # WebhookTestResult
Powershell
Powershell
- Docs
  Docs
Protobuf
Protobuf
- Docs
  Docs
Python
Python
- Docs
  Docs
Ruby
Ruby
- Docs
  Docs
Rust
Rust
- Docs
  Docs
Scala
Scala
Swift
Swift
- Docs
  Docs
Typescript fetch
Typescript fetch
- Docs
  Docs
Zapier
Zapier
- Src
  Src
  - Creates
    
    Creates
  - Fields
    
    Fields
  - Test
    
    Test
  - Triggers
    
    Triggers

Typescript Email Client

Alternative bindings for MailSlurp email API.

See main package for documentation.

Previous WebhookTestResult

Next MailSlurp Typescript Fetch Client