Other Libraries

  • C++ MailSlurp library for embedded email processing. Email APIs for C and CPP. Send and download emails in C plus plus.

  • Dart-lang email library for MailSlurp Pubspec. Dart Email API for creating email addresses in code or test that can send and receive real emails.

  • Send and receive emails in Erlang

  • Javascript email library with GraphQL types for MailSlurp API.

  • Send and receive emails in Haskell

  • Send and receive emails in OCaml

  • Send and receive emails in Powershell

  • MailSlurp API Protobuf definitions

Basics

Sections

Pages

  • How to create an inbox with MailSlurp to send and receive emails with.

  • Use regex or server side matching to extract email content

  • Create an account and API Key. How to sign-up and login. Manage your settings and plan.

  • Use your api access token to call the MailSlurp API and control your inboxes remotely.

  • Send and receive email attachments.

  • Configure inbox forwarders to automatically forward received emails matching rules you setup.

  • Send and receive emails and attachments programmatically. Use REST API or official SDK libraries to write applications and tests using real email addresses.

  • How to create email address with wild-card catch all using MailSlurp. Screenshots included.

  • Check email addresses are real and exist using MailSlurp email verification.

  • See if emails are opened by sending tracking pixels. Receive open events via Webhook or view which recipients opened an email in the MailSlurp dashboard

  • MailSlurps free Email API is a great way to build and test applications

  • Account suspension and how to re-enable frozen accounts.

  • Diagnosing receiving errors with Gmail, Yahoo, etc.

  • How to allow support team to access your account for you.

  • MailSlurp lets you create and interact with email inboxes in code, tests, and online. How to enable email API in REST, CSharp, Java, NodeJS and more.

  • Alter billing details and subscription

  • Manage payment, access, and usage limits. How to upgrade, alter your subscription, and view invoices.

  • Starting sending and receiving emails in no time with MailSlurp's official NodeJS Client.

  • Test email account generation API for MailSlurp. Rest API documentation for HTTP email clients. Get a free API Key.

  • Solving MailSlurp sign-in problems

  • MailSlurp let's you create real email addresses on demand with a visual dashboard, REST API and SDKs in several languages.

  • How to wait for emails in code that match search criteria. Pattern matching and regular expressions.

More

  • Docs

    Index More links For more help and documentation see the MailSlurp developer portal.

  • Apis

    Index AttachmentControllerApi BulkActionsControllerApi CommonActionsControllerApi AliasControllerApi …

  • AliasControllerApi

    AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description createAlias …

  • AttachmentControllerApi

    AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BounceControllerApi

    BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BulkActionsControllerApi

    BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • CommonActionsControllerApi

    CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ContactControllerApi

    ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • DomainControllerApi

    DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • EmailControllerApi

    EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExpiredControllerApi

    ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExportControllerApi

    ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • FormControllerApi

    FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description submitForm …

  • GroupControllerApi

    GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxControllerApi

    InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description createInbox …

  • InboxForwarderControllerApi

    InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxRulesetControllerApi

    InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MailServerControllerApi

    MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MissedEmailControllerApi

    MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • SentEmailsControllerApi

    SentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TemplateControllerApi

    TemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TrackingControllerApi

    TrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WaitForControllerApi

    WaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description waitFor …

  • WebhookControllerApi

    WebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • Models

    Index AbstractWebhookPayload AliasDto AliasProjection AttachmentMetaData AttachmentEntity AttachmentProjection …

  • AbstractWebhookPayload

    AbstractWebhookPayload Properties Name Type Description Notes eventName String [default to null] messageId …

  • AliasDto

    AliasDto Properties Name Type Description Notes createdAt Date [optional] [default to null] emailAddress …

  • AliasProjection

    AliasProjection Properties Name Type Description Notes createdAt Date [default to null] emailAddress String …

  • AttachmentEntity

    AttachmentEntity Properties Name Type Description Notes attachmentId String [default to null] contentLength …

  • AttachmentMetaData

    AttachmentMetaData Properties Name Type Description Notes contentLength Long Size of attachment in bytes …

  • AttachmentProjection

    AttachmentProjection Properties Name Type Description Notes attachmentId String Attachment ID [optional] [default …

  • BasicAuthOptions

    BasicAuthOptions Properties Name Type Description Notes username String [default to null] password String …

  • BouncedEmailDto

    BouncedEmailDto Properties Name Type Description Notes bounceMta String [optional] [default to null] …

  • BouncedRecipientDto

    BouncedRecipientDto Properties Name Type Description Notes createdAt Date [default to null] id UUID …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes createdAt Date [default to null] id UUID [optional] …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes createdAt Date [default to null] id UUID [optional] …

  • BulkSendEmailOptions

    BulkSendEmailOptions Properties Name Type Description Notes inboxIds List Inboxes to send the email from …

  • ConditionOption

    ConditionOption Properties Name Type Description Notes condition String The condition to evaluate against the …

  • ContactDto

    ContactDto Properties Name Type Description Notes company String [optional] [default to null] createdAt Date …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes company String [optional] [default to null] createdAt …

  • ContentMatchOptions

    ContentMatchOptions Properties Name Type Description Notes pattern String Java style regex pattern. Do not …

  • CountDto

    CountDto Properties Name Type Description Notes totalElements Long [default to null] [Back to Model list] …

  • CreateAliasOptions

    CreateAliasOptions Properties Name Type Description Notes emailAddress String Email address to be hidden behind …

  • CreateContactOptions

    CreateContactOptions Properties Name Type Description Notes emailAddresses List Set of email addresses belonging …

  • CreateDomainOptions

    CreateDomainOptions Properties Name Type Description Notes createdCatchAllInbox Boolean Whether to create a catch …

  • CreateGroupOptions

    CreateGroupOptions Properties Name Type Description Notes name String [default to null] description String …

  • CreateInboxDto

    CreateInboxDto Properties Name Type Description Notes allowTeamAccess Boolean DEPRECATED (team access is always …

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Properties Name Type Description Notes field String Field to match against to trigger …

  • CreateInboxRulesetOptions

    CreateInboxRulesetOptions Properties Name Type Description Notes action String Action to be taken when the …

  • CreateTemplateOptions

    CreateTemplateOptions Properties Name Type Description Notes name String [default to null] content String …

  • CreateTrackingPixelOptions

    CreateTrackingPixelOptions Properties Name Type Description Notes name String [optional] [default to null] …

  • CreateWebhookOptions

    CreateWebhookOptions Properties Name Type Description Notes basicAuth BasicAuthOptions [optional] [default to …

  • DescribeDomainOptions

    DescribeDomainOptions Properties Name Type Description Notes domain String [default to null] [Back to Model …

  • DescribeMailServerDomainResult

    DescribeMailServerDomainResult Properties Name Type Description Notes domain String [default to null] message …

  • DNSLookupOptions

    DNSLookupOptions Properties Name Type Description Notes hostname String List of record types you wish to query …

  • DNSLookupResult

    DNSLookupResult Properties Name Type Description Notes name String [default to null] recordEntries List …

  • DNSLookupResults

    DNSLookupResults Properties Name Type Description Notes results List [default to null] [Back to Model list] …

  • DomainDto

    DomainDto Properties Name Type Description Notes catchAllInboxId UUID The optional catch all inbox that will …

  • DomainNameRecord

    DomainNameRecord Properties Name Type Description Notes name String [default to null] recordEntries List …

  • DomainPreview

    DomainPreview Properties Name Type Description Notes catchAllInboxId UUID [optional] [default to null] …

  • DownloadAttachmentDto

    DownloadAttachmentDto Properties Name Type Description Notes base64FileContents String Base64 encoded string of …

  • Email

    Email Properties Name Type Description Notes analysis EmailAnalysis [optional] [default to null] attachments …

  • EmailAnalysis

    EmailAnalysis Properties Name Type Description Notes dkimVerdict String Verdict of DomainKeys Identified Mail …

  • EmailContentMatchResult

    EmailContentMatchResult Properties Name Type Description Notes matches List [default to null] pattern String …

  • EmailLinksResult

    EmailLinksResult Properties Name Type Description Notes body String [default to null] links List [default to …

  • EmailPreview

    EmailPreview Properties Name Type Description Notes attachments List List of IDs of attachments found in the …

  • EmailProjection

    EmailProjection Properties Name Type Description Notes attachments List [optional] [default to null] bcc List …

  • EmailRecipients

    EmailRecipients Properties Name Type Description Notes bcc List [optional] [default to null] cc List …

  • EmailTextLinesResult

    EmailTextLinesResult Properties Name Type Description Notes body String [default to null] lines List [default …

  • EmailVerificationResult

    EmailVerificationResult Properties Name Type Description Notes domainName String [default to null] …

  • ExpirationDefaults

    ExpirationDefaults Properties Name Type Description Notes canPermanentInbox Boolean [default to null] …

  • ExpiredInboxDto

    ExpiredInboxDto Properties Name Type Description Notes emailAddress String [default to null] id UUID [default …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes createdAt Date [default to null] …

  • ExportLink

    ExportLink Properties Name Type Description Notes downloadLink String [default to null] [Back to Model list] …

  • ExportOptions

    ExportOptions Properties Name Type Description Notes outputFormat String [default to null] …

  • FlushExpiredInboxesResult

    FlushExpiredInboxesResult Properties Name Type Description Notes expireBefore Date [default to null] inboxIds …

  • ForwardEmailOptions

    ForwardEmailOptions Properties Name Type Description Notes bcc List Optional bcc recipients [optional] [default …

  • GravatarUrl

    GravatarUrl Properties Name Type Description Notes hash String [default to null] url String [default to null] …

  • GroupContactsDto

    GroupContactsDto Properties Name Type Description Notes contacts List [default to null] group GroupDto …

  • GroupDto

    GroupDto Properties Name Type Description Notes createdAt Date [default to null] description String …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes createdAt Date [default to null] description String …

  • HTMLValidationResult

    HTMLValidationResult Properties Name Type Description Notes errors List Optional errors resulting from HTML …

  • Inbox

    Inbox Properties Name Type Description Notes createdAt Date When the inbox was created. Time stamps are in ISO …

  • InboxExistsDto

    InboxExistsDto Properties Name Type Description Notes exists Boolean [default to null] [Back to Model list] …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes createdAt Date [default to null] field String …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes testValue String [default to null] [Back to …

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes doesMatch Boolean [default to null] matches …

  • InboxPreview

    InboxPreview Properties Name Type Description Notes createdAt Date When the inbox was created. Time stamps are in …

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes action String [default to null] createdAt Date …

  • InboxRulesetTestOptions

    InboxRulesetTestOptions Properties Name Type Description Notes testTarget String [default to null] [Back to …

  • InboxRulesetTestResult

    InboxRulesetTestResult Properties Name Type Description Notes matches Boolean [default to null] rulesetMatches …

  • IPAddressResult

    IPAddressResult Properties Name Type Description Notes address String [default to null] hostname String …

  • JSONSchemaDto

    JSONSchemaDto Properties Name Type Description Notes value String [default to null] [Back to Model list] …

  • MatchOption

    MatchOption Properties Name Type Description Notes field String The email property to match on. One of SUBJECT, …

  • MatchOptions

    MatchOptions Properties Name Type Description Notes conditions List Zero or more conditions such as { condition: …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes attachmentCount Integer [default to null] bcc List …

  • MissedEmailProjection

    MissedEmailProjection Properties Name Type Description Notes createdAt Date [default to null] from String …

  • NameServerRecord

    NameServerRecord Properties Name Type Description Notes priority String [default to null] raw String [default …

  • OrganizationInboxProjection

    OrganizationInboxProjection Properties Name Type Description Notes createdAt Date When the inbox was created. …

  • Pageable

    Pageable Properties Name Type Description Notes offset Long [optional] [default to null] pageNumber Integer …

  • PageAlias

    PageAlias Properties Name Type Description Notes content List [optional] [default to null] empty Boolean …

  • PageAttachmentEntity

    PageAttachmentEntity Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageBouncedEmail

    PageBouncedEmail Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageBouncedRecipients

    PageBouncedRecipients Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageContactProjection

    PageContactProjection Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageEmailPreview

    PageEmailPreview Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageEmailProjection

    PageEmailProjection Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageExpiredInboxRecordProjecti …

    PageExpiredInboxRecordProjection Properties Name Type Description Notes content List [optional] [default to …

  • PageGroupProjection

    PageGroupProjection Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageInboxForwarderDto

    PageInboxForwarderDto Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageInboxProjection

    PageInboxProjection Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageInboxRulesetDto

    PageInboxRulesetDto Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageMissedEmailProjection

    PageMissedEmailProjection Properties Name Type Description Notes content List [optional] [default to null] …

  • PageOrganizationInboxProjectio …

    PageOrganizationInboxProjection Properties Name Type Description Notes content List [optional] [default to null] …

  • PageSentEmailProjection

    PageSentEmailProjection Properties Name Type Description Notes content List Collection of items [optional] …

  • PageTemplateProjection

    PageTemplateProjection Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageThreadProjection

    PageThreadProjection Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Properties Name Type Description Notes content List [optional] [default to null] …

  • PageUnknownMissedEmailProjecti …

    PageUnknownMissedEmailProjection Properties Name Type Description Notes content List [optional] [default to …

  • PageWebhookProjection

    PageWebhookProjection Properties Name Type Description Notes content List [optional] [default to null] empty …

  • PageWebhookResult

    PageWebhookResult Properties Name Type Description Notes content List [optional] [default to null] empty …

  • RawEmailJson

    RawEmailJson Properties Name Type Description Notes content String [default to null] [Back to Model list] …

  • Recipient

    Recipient Properties Name Type Description Notes emailAddress String [default to null] name String [optional] …

  • ReplyToAliasEmailOptions

    ReplyToAliasEmailOptions Properties Name Type Description Notes attachments List List of uploaded attachments to …

  • ReplyToEmailOptions

    ReplyToEmailOptions Properties Name Type Description Notes attachments List List of uploaded attachments to send …

  • SendEmailOptions

    SendEmailOptions Properties Name Type Description Notes addTrackingPixel Boolean Add tracking pixel to email …

  • Sender

    Sender Properties Name Type Description Notes emailAddress String [default to null] name String [optional] …

  • SentEmailDto

    SentEmailDto Properties Name Type Description Notes attachments List Array of IDs of attachments that were sent …

  • SentEmailProjection

    SentEmailProjection Properties Name Type Description Notes attachments List [default to null] bcc List …

  • SetInboxFavouritedOptions

    SetInboxFavouritedOptions Properties Name Type Description Notes state Boolean Is the inbox a favorite. Marking …

  • SimpleSendEmailOptions

    SimpleSendEmailOptions Properties Name Type Description Notes body String Body of the email message. Supports …

  • Sort

    Sort Properties Name Type Description Notes empty Boolean [optional] [default to null] sorted Boolean …

  • TemplateDto

    TemplateDto Properties Name Type Description Notes content String [default to null] createdAt Date [default …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes createdAt Date [default to null] id UUID [default …

  • TemplateVariable

    TemplateVariable Properties Name Type Description Notes name String [default to null] variableType String …

  • TestNewInboxForwarderOptions

    TestNewInboxForwarderOptions Properties Name Type Description Notes inboxForwarderTestOptions …

  • TestNewInboxRulesetOptions

    TestNewInboxRulesetOptions Properties Name Type Description Notes inboxRulesetTestOptions InboxRulesetTestOptions …

  • ThreadProjection

    ThreadProjection Properties Name Type Description Notes aliasId UUID [default to null] bcc List [optional] …

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes createdAt Date [default to null] html String [default …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes createdAt Date [default to null] id UUID …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes createdAt Date [default to null] from …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes count Long [default to null] [Back to Model list] [Back to …

  • UnseenErrorCountDto

    UnseenErrorCountDto Properties Name Type Description Notes count Long [default to null] [Back to Model list] …

  • UpdateAliasOptions

    UpdateAliasOptions Properties Name Type Description Notes name String Optional name for alias [optional] [default …

  • UpdateDomainOptions

    UpdateDomainOptions Properties Name Type Description Notes catchAllInboxId UUID [optional] [default to null] …

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes contactIds List [default to null] [Back to Model …

  • UpdateInboxOptions

    UpdateInboxOptions Properties Name Type Description Notes description String Description of an inbox for …

  • UploadAttachmentOptions

    UploadAttachmentOptions Properties Name Type Description Notes base64Contents String Base64 encoded string of …

  • ValidationDto

    ValidationDto Properties Name Type Description Notes emailId UUID ID of the email validated [optional] [default …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes lineNumber Integer [default to null] message String …

  • VerifyEmailAddressOptions

    VerifyEmailAddressOptions Properties Name Type Description Notes mailServerDomain String [optional] [default to …

  • WaitForConditions

    WaitForConditions Properties Name Type Description Notes before Date ISO Date Time latest time of email to …

  • WebhookDto

    WebhookDto Properties Name Type Description Notes basicAuth Boolean Does webhook expect basic authentication? If …

  • WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload Properties Name Type Description Notes createdAt Date Date time of event creation …

  • WebhookEmailReadPayload

    WebhookEmailReadPayload Properties Name Type Description Notes createdAt Date Date time of event creation …

  • WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload Properties Name Type Description Notes attachmentId String ID of attachment. Use the …

  • WebhookNewContactPayload

    WebhookNewContactPayload Properties Name Type Description Notes company String [optional] [default to null] …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload Properties Name Type Description Notes attachmentMetaDatas List List of attachment meta …

  • WebhookProjection

    WebhookProjection Properties Name Type Description Notes createdAt Date [default to null] eventName String …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes message String [optional] [default to null] …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes createdAt Date [default to null] httpMethod String …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes headers Map [default to null] method String …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes message String [optional] [default to null] …

  • WebhookTestResult

    WebhookTestResult Properties Name Type Description Notes message String [optional] [default to null] request …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    mailslurp_netstandard_2x.Model.AbstractWebhookPayload Abstract webhook payload. Use the correct payload type for your …

  • AliasControllerApi

    mailslurp_netstandard_2x.Api.AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • AliasDto

    mailslurp_netstandard_2x.Model.AliasDto Email alias representation Properties Name Type Description Notes …

  • AliasProjection

    mailslurp_netstandard_2x.Model.AliasProjection Representation of a alias Properties Name Type Description Notes …

  • AttachmentControllerApi

    mailslurp_netstandard_2x.Api.AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • AttachmentEntity

    mailslurp_netstandard_2x.Model.AttachmentEntity Properties Name Type Description Notes AttachmentId string …

  • AttachmentMetaData

    mailslurp_netstandard_2x.Model.AttachmentMetaData Meta data associated with an attachment. Attachments are stored as …

  • AttachmentProjection

    mailslurp_netstandard_2x.Model.AttachmentProjection Properties Name Type Description Notes AttachmentId string …

  • BasicAuthOptions

    mailslurp_netstandard_2x.Model.BasicAuthOptions Basic Authentication options for webhooks. Will be used is present when …

  • BounceControllerApi

    mailslurp_netstandard_2x.Api.BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • BouncedEmailDto

    mailslurp_netstandard_2x.Model.BouncedEmailDto Bounced email Properties Name Type Description Notes BounceMta …

  • BouncedRecipientDto

    mailslurp_netstandard_2x.Model.BouncedRecipientDto Bounced recipient Properties Name Type Description Notes …

  • BounceProjection

    mailslurp_netstandard_2x.Model.BounceProjection Properties Name Type Description Notes CreatedAt DateTime Id …

  • BounceRecipient

    mailslurp_netstandard_2x.Model.BounceRecipient Properties Name Type Description Notes CreatedAt DateTime Id …

  • BulkActionsControllerApi

    mailslurp_netstandard_2x.Api.BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • BulkSendEmailOptions

    mailslurp_netstandard_2x.Model.BulkSendEmailOptions Options for bulk sending an email from multiple addresses. See …

  • CommonActionsControllerApi

    mailslurp_netstandard_2x.Api.CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method …

  • ConditionOption

    mailslurp_netstandard_2x.Model.ConditionOption Options for matching emails in an inbox based on a condition such as …

  • ContactControllerApi

    mailslurp_netstandard_2x.Api.ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • ContactDto

    mailslurp_netstandard_2x.Model.ContactDto Properties Name Type Description Notes Company string [optional] …

  • ContactProjection

    mailslurp_netstandard_2x.Model.ContactProjection Properties Name Type Description Notes Company string …

  • ContentMatchOptions

    mailslurp_netstandard_2x.Model.ContentMatchOptions Options for matching content using regex patterns based on Java …

  • CountDto

    mailslurp_netstandard_2x.Model.CountDto Properties Name Type Description Notes TotalElements long [Back to …

  • CreateAliasOptions

    mailslurp_netstandard_2x.Model.CreateAliasOptions Create email alias options. Email aliases can be used to mask real …

  • CreateContactOptions

    mailslurp_netstandard_2x.Model.CreateContactOptions Properties Name Type Description Notes EmailAddresses List …

  • CreateDomainOptions

    mailslurp_netstandard_2x.Model.CreateDomainOptions Options for creating a domain to use with MailSlurp. You must have …

  • CreateGroupOptions

    mailslurp_netstandard_2x.Model.CreateGroupOptions Properties Name Type Description Notes Name string …

  • CreateInboxDto

    mailslurp_netstandard_2x.Model.CreateInboxDto Options for creating an inbox. An inbox has a real email address that can …

  • CreateInboxForwarderOptions

    mailslurp_netstandard_2x.Model.CreateInboxForwarderOptions Options for creating an inbox forwarder Properties Name …

  • CreateInboxRulesetOptions

    mailslurp_netstandard_2x.Model.CreateInboxRulesetOptions Options for creating inbox rulesets. Inbox rulesets can be used …

  • CreateTemplateOptions

    mailslurp_netstandard_2x.Model.CreateTemplateOptions Properties Name Type Description Notes Name string …

  • CreateTrackingPixelOptions

    mailslurp_netstandard_2x.Model.CreateTrackingPixelOptions Properties Name Type Description Notes Name string …

  • CreateWebhookOptions

    mailslurp_netstandard_2x.Model.CreateWebhookOptions Options for creating a webhook. Webhooks can be attached to inboxes …

  • DescribeDomainOptions

    mailslurp_netstandard_2x.Model.DescribeDomainOptions Properties Name Type Description Notes Domain string …

  • DescribeMailServerDomainResult

    mailslurp_netstandard_2x.Model.DescribeMailServerDomainResult Name Server lookup result Properties Name Type …

  • DNSLookupOptions

    mailslurp_netstandard_2x.Model.DNSLookupOptions Options for DNS query. Properties Name Type Description Notes …

  • DNSLookupResult

    mailslurp_netstandard_2x.Model.DNSLookupResult DNS lookup result. Includes record type, time to live, raw response, and …

  • DNSLookupResults

    mailslurp_netstandard_2x.Model.DNSLookupResults Results of query on domain name servers Properties Name Type …

  • DomainControllerApi

    mailslurp_netstandard_2x.Api.DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • DomainDto

    mailslurp_netstandard_2x.Model.DomainDto Domain plus verification records and status Properties Name Type Description …

  • DomainNameRecord

    mailslurp_netstandard_2x.Model.DomainNameRecord DNS Record required for verification of a domain. Record vary depending …

  • DomainPreview

    mailslurp_netstandard_2x.Model.DomainPreview Preview object for domain entity Properties Name Type Description Notes …

  • DownloadAttachmentDto

    mailslurp_netstandard_2x.Model.DownloadAttachmentDto Content of attachment Properties Name Type Description Notes …

  • Email

    mailslurp_netstandard_2x.Model.Email Email entity (also known as EmailDto). When an SMTP email message is received by …

  • EmailAnalysis

    mailslurp_netstandard_2x.Model.EmailAnalysis Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY …

  • EmailContentMatchResult

    mailslurp_netstandard_2x.Model.EmailContentMatchResult Matches for the given pattern Properties Name Type Description …

  • EmailControllerApi

    mailslurp_netstandard_2x.Api.EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • EmailLinksResult

    mailslurp_netstandard_2x.Model.EmailLinksResult Links found in HTML Properties Name Type Description Notes Body …

  • EmailPreview

    mailslurp_netstandard_2x.Model.EmailPreview Preview of an email message. For full message (including body and …

  • EmailProjection

    mailslurp_netstandard_2x.Model.EmailProjection A compact representation of a full email. Used in list endpoints to keep …

  • EmailRecipients

    mailslurp_netstandard_2x.Model.EmailRecipients Properties Name Type Description Notes Bcc List [optional] Cc …

  • EmailTextLinesResult

    mailslurp_netstandard_2x.Model.EmailTextLinesResult Parsed text of an email Properties Name Type Description Notes …

  • EmailVerificationResult

    mailslurp_netstandard_2x.Model.EmailVerificationResult Email verification result. Valid means email address exists …

  • ExpirationDefaults

    mailslurp_netstandard_2x.Model.ExpirationDefaults Expiration defaults for your account Properties Name Type …

  • ExpiredControllerApi

    mailslurp_netstandard_2x.Api.ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • ExpiredInboxDto

    mailslurp_netstandard_2x.Model.ExpiredInboxDto Expired inbox Properties Name Type Description Notes EmailAddress …

  • ExpiredInboxRecordProjection

    mailslurp_netstandard_2x.Model.ExpiredInboxRecordProjection Properties Name Type Description Notes CreatedAt …

  • ExportControllerApi

    mailslurp_netstandard_2x.Api.ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • ExportLink

    mailslurp_netstandard_2x.Model.ExportLink Export download link Properties Name Type Description Notes …

  • ExportOptions

    mailslurp_netstandard_2x.Model.ExportOptions Options for exporting user data Properties Name Type Description Notes …

  • FlushExpiredInboxesResult

    mailslurp_netstandard_2x.Model.FlushExpiredInboxesResult Properties Name Type Description Notes ExpireBefore …

  • FormControllerApi

    mailslurp_netstandard_2x.Api.FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ForwardEmailOptions

    mailslurp_netstandard_2x.Model.ForwardEmailOptions Options for forwarding an email Properties Name Type Description …

  • GravatarUrl

    mailslurp_netstandard_2x.Model.GravatarUrl Properties Name Type Description Notes Hash string Url string …

  • GroupContactsDto

    mailslurp_netstandard_2x.Model.GroupContactsDto Properties Name Type Description Notes Contacts List Group …

  • GroupControllerApi

    mailslurp_netstandard_2x.Api.GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • GroupDto

    mailslurp_netstandard_2x.Model.GroupDto Properties Name Type Description Notes CreatedAt DateTime Description …

  • GroupProjection

    mailslurp_netstandard_2x.Model.GroupProjection Properties Name Type Description Notes CreatedAt DateTime …

  • HTMLValidationResult

    mailslurp_netstandard_2x.Model.HTMLValidationResult HTML Validation Results Properties Name Type Description Notes …

  • Inbox

    mailslurp_netstandard_2x.Model.Inbox Representation of a MailSlurp inbox. An inbox has an ID and a real email address. …

  • InboxControllerApi

    mailslurp_netstandard_2x.Api.InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • InboxExistsDto

    mailslurp_netstandard_2x.Model.InboxExistsDto Properties Name Type Description Notes Exists bool [Back to …

  • InboxForwarderControllerApi

    mailslurp_netstandard_2x.Api.InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method …

  • InboxForwarderDto

    mailslurp_netstandard_2x.Model.InboxForwarderDto Properties Name Type Description Notes CreatedAt DateTime …

  • InboxForwarderTestOptions

    mailslurp_netstandard_2x.Model.InboxForwarderTestOptions Properties Name Type Description Notes TestValue string …

  • InboxForwarderTestResult

    mailslurp_netstandard_2x.Model.InboxForwarderTestResult Properties Name Type Description Notes DoesMatch bool …

  • InboxPreview

    mailslurp_netstandard_2x.Model.InboxPreview Properties Name Type Description Notes CreatedAt DateTime When the …

  • InboxRulesetControllerApi

    mailslurp_netstandard_2x.Api.InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • InboxRulesetDto

    mailslurp_netstandard_2x.Model.InboxRulesetDto Properties Name Type Description Notes Action string CreatedAt …

  • InboxRulesetTestOptions

    mailslurp_netstandard_2x.Model.InboxRulesetTestOptions Properties Name Type Description Notes TestTarget string …

  • InboxRulesetTestResult

    mailslurp_netstandard_2x.Model.InboxRulesetTestResult Properties Name Type Description Notes Matches bool …

  • IPAddressResult

    mailslurp_netstandard_2x.Model.IPAddressResult IP Address look up result for a given domain / hostname Properties …

  • JSONSchemaDto

    mailslurp_netstandard_2x.Model.JSONSchemaDto Properties Name Type Description Notes Value string [Back to …

  • MailServerControllerApi

    mailslurp_netstandard_2x.Api.MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • MatchOption

    mailslurp_netstandard_2x.Model.MatchOption Options for matching emails in an inbox. Each match option object contains a …

  • MatchOptions

    mailslurp_netstandard_2x.Model.MatchOptions Optional filter for matching emails based on fields. For instance filter …

  • MissedEmail

    mailslurp_netstandard_2x.Model.MissedEmail Properties Name Type Description Notes AttachmentCount int Bcc …

  • MissedEmailControllerApi

    mailslurp_netstandard_2x.Api.MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • MissedEmailProjection

    mailslurp_netstandard_2x.Model.MissedEmailProjection Properties Name Type Description Notes CreatedAt DateTime …

  • NameServerRecord

    mailslurp_netstandard_2x.Model.NameServerRecord Name Server Record Properties Name Type Description Notes …

  • OrganizationInboxProjection

    mailslurp_netstandard_2x.Model.OrganizationInboxProjection Properties Name Type Description Notes CreatedAt …

  • Pageable

    mailslurp_netstandard_2x.Model.Pageable Properties Name Type Description Notes Offset long [optional] …

  • PageAlias

    mailslurp_netstandard_2x.Model.PageAlias Paginated email alias results. Page starts at zero. Projection results may omit …

  • PageAttachmentEntity

    mailslurp_netstandard_2x.Model.PageAttachmentEntity Paginated attachment entity results. Page starts at zero. Projection …

  • PageBouncedEmail

    mailslurp_netstandard_2x.Model.PageBouncedEmail Paginated bounced email. Page starts at zero. Projection results may …

  • PageBouncedRecipients

    mailslurp_netstandard_2x.Model.PageBouncedRecipients Paginated bounced recipients. Page starts at zero. Projection …

  • PageContactProjection

    mailslurp_netstandard_2x.Model.PageContactProjection Paginated contact results. Page starts at zero. Projection results …

  • PageEmailPreview

    mailslurp_netstandard_2x.Model.PageEmailPreview Paginated email preview results. EmailProjections and EmailPreviews are …

  • PageEmailProjection

    mailslurp_netstandard_2x.Model.PageEmailProjection Paginated email projection results. EmailProjections and …

  • PageExpiredInboxRecordProjecti …

    mailslurp_netstandard_2x.Model.PageExpiredInboxRecordProjection Paginated expired inbox results. Page starts at zero. …

  • PageGroupProjection

    mailslurp_netstandard_2x.Model.PageGroupProjection Paginated missed email results. Page starts at zero. Projection …

  • PageInboxForwarderDto

    mailslurp_netstandard_2x.Model.PageInboxForwarderDto Paginated inbox forwarder results. Page starts at zero. Projection …

  • PageInboxProjection

    mailslurp_netstandard_2x.Model.PageInboxProjection Paginated inbox results. Page starts at zero. Projection results may …

  • PageInboxRulesetDto

    mailslurp_netstandard_2x.Model.PageInboxRulesetDto Paginated inbox ruleset results. Page starts at zero. Projection …

  • PageMissedEmailProjection

    mailslurp_netstandard_2x.Model.PageMissedEmailProjection Paginated MissedEmail results. Page starts at zero. Projection …

  • PageOrganizationInboxProjectio …

    mailslurp_netstandard_2x.Model.PageOrganizationInboxProjection Paginated organization inbox results. Page starts at …

  • PageSentEmailProjection

    mailslurp_netstandard_2x.Model.PageSentEmailProjection Paginated sent email results. Page starts at zero. Projection …

  • PageTemplateProjection

    mailslurp_netstandard_2x.Model.PageTemplateProjection Paginated email template results. Page starts at zero. Projection …

  • PageThreadProjection

    mailslurp_netstandard_2x.Model.PageThreadProjection Paginated email projection results. EmailProjections and …

  • PageTrackingPixelProjection

    mailslurp_netstandard_2x.Model.PageTrackingPixelProjection Paginated TrackingPixel results. Page starts at zero. …

  • PageUnknownMissedEmailProjecti …

    mailslurp_netstandard_2x.Model.PageUnknownMissedEmailProjection Paginated unknown MissedEmail results. Unknown missed …

  • PageWebhookProjection

    mailslurp_netstandard_2x.Model.PageWebhookProjection Paginated webhook entity. Page starts at zero. Projection results …

  • PageWebhookResult

    mailslurp_netstandard_2x.Model.PageWebhookResult Paginated webhook results. Page starts at zero. Projection results may …

  • RawEmailJson

    mailslurp_netstandard_2x.Model.RawEmailJson Content in raw format Properties Name Type Description Notes Content …

  • Recipient

    mailslurp_netstandard_2x.Model.Recipient Properties Name Type Description Notes EmailAddress string Name …

  • ReplyToAliasEmailOptions

    mailslurp_netstandard_2x.Model.ReplyToAliasEmailOptions Options for replying to an alias email using the alias inbox …

  • ReplyToEmailOptions

    mailslurp_netstandard_2x.Model.ReplyToEmailOptions Options for replying to email with API Properties Name Type …

  • SendEmailOptions

    mailslurp_netstandard_2x.Model.SendEmailOptions Options for sending an email message from an inbox. You must provide one …

  • Sender

    mailslurp_netstandard_2x.Model.Sender Properties Name Type Description Notes EmailAddress string Name string …

  • SentEmailDto

    mailslurp_netstandard_2x.Model.SentEmailDto Sent email details Properties Name Type Description Notes Attachments …

  • SentEmailProjection

    mailslurp_netstandard_2x.Model.SentEmailProjection Properties Name Type Description Notes Attachments List …

  • SentEmailsControllerApi

    mailslurp_netstandard_2x.Api.SentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • SetInboxFavouritedOptions

    mailslurp_netstandard_2x.Model.SetInboxFavouritedOptions Options for setting inbox favourite state Properties Name …

  • SimpleSendEmailOptions

    mailslurp_netstandard_2x.Model.SimpleSendEmailOptions Properties Name Type Description Notes Body string Body of …

  • Sort

    mailslurp_netstandard_2x.Model.Sort Properties Name Type Description Notes Empty bool [optional] Sorted bool …

  • TemplateControllerApi

    mailslurp_netstandard_2x.Api.TemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • TemplateDto

    mailslurp_netstandard_2x.Model.TemplateDto Properties Name Type Description Notes Content string CreatedAt …

  • TemplateProjection

    mailslurp_netstandard_2x.Model.TemplateProjection Properties Name Type Description Notes CreatedAt DateTime …

  • TemplateVariable

    mailslurp_netstandard_2x.Model.TemplateVariable Properties Name Type Description Notes Name string …

  • TestNewInboxForwarderOptions

    mailslurp_netstandard_2x.Model.TestNewInboxForwarderOptions Properties Name Type Description Notes …

  • TestNewInboxRulesetOptions

    mailslurp_netstandard_2x.Model.TestNewInboxRulesetOptions Properties Name Type Description Notes …

  • ThreadProjection

    mailslurp_netstandard_2x.Model.ThreadProjection A thread is a message thread created for a message received by an alias …

  • TrackingControllerApi

    mailslurp_netstandard_2x.Api.TrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • TrackingPixelDto

    mailslurp_netstandard_2x.Model.TrackingPixelDto Properties Name Type Description Notes CreatedAt DateTime …

  • TrackingPixelProjection

    mailslurp_netstandard_2x.Model.TrackingPixelProjection Properties Name Type Description Notes CreatedAt DateTime …

  • UnknownMissedEmailProjection

    mailslurp_netstandard_2x.Model.UnknownMissedEmailProjection Properties Name Type Description Notes CreatedAt …

  • UnreadCount

    mailslurp_netstandard_2x.Model.UnreadCount Properties Name Type Description Notes Count long [Back to Model …

  • UnseenErrorCountDto

    mailslurp_netstandard_2x.Model.UnseenErrorCountDto Properties Name Type Description Notes Count long [Back …

  • UpdateAliasOptions

    mailslurp_netstandard_2x.Model.UpdateAliasOptions Update an email alias Properties Name Type Description Notes …

  • UpdateDomainOptions

    mailslurp_netstandard_2x.Model.UpdateDomainOptions Options for creating a domain to use with MailSlurp. You must have …

  • UpdateGroupContacts

    mailslurp_netstandard_2x.Model.UpdateGroupContacts Properties Name Type Description Notes ContactIds List …

  • UpdateInboxOptions

    mailslurp_netstandard_2x.Model.UpdateInboxOptions Options for updating inbox properties Properties Name Type …

  • UploadAttachmentOptions

    mailslurp_netstandard_2x.Model.UploadAttachmentOptions Options for uploading files for attachments. When sending emails …

  • ValidationDto

    mailslurp_netstandard_2x.Model.ValidationDto Response object for email validation operation Properties Name Type …

  • ValidationMessage

    mailslurp_netstandard_2x.Model.ValidationMessage Properties Name Type Description Notes LineNumber int …

  • VerifyEmailAddressOptions

    mailslurp_netstandard_2x.Model.VerifyEmailAddressOptions Options for verifying that an email address exists at a remote …

  • WaitForConditions

    mailslurp_netstandard_2x.Model.WaitForConditions Conditions that a waitForXEmails endpoint operates on. The methods wait …

  • WaitForControllerApi

    mailslurp_netstandard_2x.Api.WaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • WebhookControllerApi

    mailslurp_netstandard_2x.Api.WebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP …

  • WebhookDto

    mailslurp_netstandard_2x.Model.WebhookDto Representation of a webhook for an inbox. The URL specified will be using by …

  • WebhookEmailOpenedPayload

    mailslurp_netstandard_2x.Model.WebhookEmailOpenedPayload EMAIL_OPENED webhook payload. Sent to your webhook url endpoint …

  • WebhookEmailReadPayload

    mailslurp_netstandard_2x.Model.WebhookEmailReadPayload EMAIL_READ webhook payload. Sent to your webhook url endpoint via …

  • WebhookNewAttachmentPayload

    mailslurp_netstandard_2x.Model.WebhookNewAttachmentPayload NEW_ATTACHMENT webhook payload. Sent to your webhook url …

  • WebhookNewContactPayload

    mailslurp_netstandard_2x.Model.WebhookNewContactPayload NEW_CONTACT webhook payload. Sent to your webhook url endpoint …

  • WebhookNewEmailPayload

    mailslurp_netstandard_2x.Model.WebhookNewEmailPayload NEW_EMAIL webhook payload. Sent to your webhook url endpoint via …

  • WebhookProjection

    mailslurp_netstandard_2x.Model.WebhookProjection Representation of a webhook Properties Name Type Description Notes …

  • WebhookRedriveResult

    mailslurp_netstandard_2x.Model.WebhookRedriveResult Properties Name Type Description Notes Message string …

  • WebhookResultDto

    mailslurp_netstandard_2x.Model.WebhookResultDto Properties Name Type Description Notes CreatedAt DateTime …

  • WebhookTestRequest

    mailslurp_netstandard_2x.Model.WebhookTestRequest Properties Name Type Description Notes Headers …

  • WebhookTestResponse

    mailslurp_netstandard_2x.Model.WebhookTestResponse Properties Name Type Description Notes Message string …

  • WebhookTestResult

    mailslurp_netstandard_2x.Model.WebhookTestResult Results of testing a webhook Properties Name Type Description Notes …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    mailslurp.Model.AbstractWebhookPayload Abstract webhook payload. Use the correct payload type for your webhook event …

  • AliasControllerApi

    mailslurp.Api.AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AliasDto

    mailslurp.Model.AliasDto Email alias representation Properties Name Type Description Notes CreatedAt DateTime …

  • AliasProjection

    mailslurp.Model.AliasProjection Representation of a alias Properties Name Type Description Notes CreatedAt …

  • AttachmentControllerApi

    mailslurp.Api.AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • AttachmentEntity

    mailslurp.Model.AttachmentEntity Properties Name Type Description Notes AttachmentId string ContentLength …

  • AttachmentMetaData

    mailslurp.Model.AttachmentMetaData Meta data associated with an attachment. Attachments are stored as byte blobs so the …

  • AttachmentProjection

    mailslurp.Model.AttachmentProjection Properties Name Type Description Notes AttachmentId string Attachment ID …

  • BasicAuthOptions

    mailslurp.Model.BasicAuthOptions Basic Authentication options for webhooks. Will be used is present when calling webhook …

  • BounceControllerApi

    mailslurp.Api.BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BouncedEmailDto

    mailslurp.Model.BouncedEmailDto Bounced email Properties Name Type Description Notes BounceMta string [optional] …

  • BouncedRecipientDto

    mailslurp.Model.BouncedRecipientDto Bounced recipient Properties Name Type Description Notes CreatedAt DateTime …

  • BounceProjection

    mailslurp.Model.BounceProjection Properties Name Type Description Notes CreatedAt DateTime Id Guid …

  • BounceRecipient

    mailslurp.Model.BounceRecipient Properties Name Type Description Notes CreatedAt DateTime Id Guid [optional] …

  • BulkActionsControllerApi

    mailslurp.Api.BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • BulkSendEmailOptions

    mailslurp.Model.BulkSendEmailOptions Options for bulk sending an email from multiple addresses. See regular sendEmail …

  • CommonActionsControllerApi

    mailslurp.Api.CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ConditionOption

    mailslurp.Model.ConditionOption Options for matching emails in an inbox based on a condition such as …

  • ContactControllerApi

    mailslurp.Api.ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ContactDto

    mailslurp.Model.ContactDto Properties Name Type Description Notes Company string [optional] CreatedAt DateTime …

  • ContactProjection

    mailslurp.Model.ContactProjection Properties Name Type Description Notes Company string [optional] CreatedAt …

  • ContentMatchOptions

    mailslurp.Model.ContentMatchOptions Options for matching content using regex patterns based on Java Pattern syntax …

  • CountDto

    mailslurp.Model.CountDto Properties Name Type Description Notes TotalElements long [Back to Model list] …

  • CreateAliasOptions

    mailslurp.Model.CreateAliasOptions Create email alias options. Email aliases can be used to mask real email addresses …

  • CreateContactOptions

    mailslurp.Model.CreateContactOptions Properties Name Type Description Notes EmailAddresses List Set of email …

  • CreateDomainOptions

    mailslurp.Model.CreateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access …

  • CreateGroupOptions

    mailslurp.Model.CreateGroupOptions Properties Name Type Description Notes Name string Description string …

  • CreateInboxDto

    mailslurp.Model.CreateInboxDto Options for creating an inbox. An inbox has a real email address that can send and …

  • CreateInboxForwarderOptions

    mailslurp.Model.CreateInboxForwarderOptions Options for creating an inbox forwarder Properties Name Type Description …

  • CreateInboxRulesetOptions

    mailslurp.Model.CreateInboxRulesetOptions Options for creating inbox rulesets. Inbox rulesets can be used to block, …

  • CreateTemplateOptions

    mailslurp.Model.CreateTemplateOptions Properties Name Type Description Notes Name string Content string …

  • CreateTrackingPixelOptions

    mailslurp.Model.CreateTrackingPixelOptions Properties Name Type Description Notes Name string [optional] …

  • CreateWebhookOptions

    mailslurp.Model.CreateWebhookOptions Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp …

  • DescribeDomainOptions

    mailslurp.Model.DescribeDomainOptions Properties Name Type Description Notes Domain string [Back to Model …

  • DescribeMailServerDomainResult

    mailslurp.Model.DescribeMailServerDomainResult Name Server lookup result Properties Name Type Description Notes …

  • DNSLookupOptions

    mailslurp.Model.DNSLookupOptions Options for DNS query. Properties Name Type Description Notes Hostname string …

  • DNSLookupResult

    mailslurp.Model.DNSLookupResult DNS lookup result. Includes record type, time to live, raw response, and name value for …

  • DNSLookupResults

    mailslurp.Model.DNSLookupResults Results of query on domain name servers Properties Name Type Description Notes …

  • DomainControllerApi

    mailslurp.Api.DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • DomainDto

    mailslurp.Model.DomainDto Domain plus verification records and status Properties Name Type Description Notes …

  • DomainNameRecord

    mailslurp.Model.DomainNameRecord DNS Record required for verification of a domain. Record vary depending on domain type. …

  • DomainPreview

    mailslurp.Model.DomainPreview Preview object for domain entity Properties Name Type Description Notes …

  • DownloadAttachmentDto

    mailslurp.Model.DownloadAttachmentDto Content of attachment Properties Name Type Description Notes …

  • Email

    mailslurp.Model.Email Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is …

  • EmailAnalysis

    mailslurp.Model.EmailAnalysis Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic …

  • EmailContentMatchResult

    mailslurp.Model.EmailContentMatchResult Matches for the given pattern Properties Name Type Description Notes …

  • EmailControllerApi

    mailslurp.Api.EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • EmailLinksResult

    mailslurp.Model.EmailLinksResult Links found in HTML Properties Name Type Description Notes Body string Links …

  • EmailPreview

    mailslurp.Model.EmailPreview Preview of an email message. For full message (including body and attachments) call the …

  • EmailProjection

    mailslurp.Model.EmailProjection A compact representation of a full email. Used in list endpoints to keep response sizes …

  • EmailRecipients

    mailslurp.Model.EmailRecipients Properties Name Type Description Notes Bcc List [optional] Cc List [optional] …

  • EmailTextLinesResult

    mailslurp.Model.EmailTextLinesResult Parsed text of an email Properties Name Type Description Notes Body string …

  • EmailVerificationResult

    mailslurp.Model.EmailVerificationResult Email verification result. Valid means email address exists according to …

  • ExpirationDefaults

    mailslurp.Model.ExpirationDefaults Expiration defaults for your account Properties Name Type Description Notes …

  • ExpiredControllerApi

    mailslurp.Api.ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExpiredInboxDto

    mailslurp.Model.ExpiredInboxDto Expired inbox Properties Name Type Description Notes EmailAddress string Id …

  • ExpiredInboxRecordProjection

    mailslurp.Model.ExpiredInboxRecordProjection Properties Name Type Description Notes CreatedAt DateTime …

  • ExportControllerApi

    mailslurp.Api.ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExportLink

    mailslurp.Model.ExportLink Export download link Properties Name Type Description Notes DownloadLink string …

  • ExportOptions

    mailslurp.Model.ExportOptions Options for exporting user data Properties Name Type Description Notes OutputFormat …

  • FlushExpiredInboxesResult

    mailslurp.Model.FlushExpiredInboxesResult Properties Name Type Description Notes ExpireBefore DateTime …

  • FormControllerApi

    mailslurp.Api.FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ForwardEmailOptions

    mailslurp.Model.ForwardEmailOptions Options for forwarding an email Properties Name Type Description Notes Bcc …

  • GravatarUrl

    mailslurp.Model.GravatarUrl Properties Name Type Description Notes Hash string Url string [Back to Model …

  • GroupContactsDto

    mailslurp.Model.GroupContactsDto Properties Name Type Description Notes Contacts List Group GroupDto …

  • GroupControllerApi

    mailslurp.Api.GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • GroupDto

    mailslurp.Model.GroupDto Properties Name Type Description Notes CreatedAt DateTime Description string …

  • GroupProjection

    mailslurp.Model.GroupProjection Properties Name Type Description Notes CreatedAt DateTime Description string …

  • HTMLValidationResult

    mailslurp.Model.HTMLValidationResult HTML Validation Results Properties Name Type Description Notes Errors List …

  • Inbox

    mailslurp.Model.Inbox Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be …

  • InboxControllerApi

    mailslurp.Api.InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxExistsDto

    mailslurp.Model.InboxExistsDto Properties Name Type Description Notes Exists bool [Back to Model list] [Back …

  • InboxForwarderControllerApi

    mailslurp.Api.InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxForwarderDto

    mailslurp.Model.InboxForwarderDto Properties Name Type Description Notes CreatedAt DateTime Field string …

  • InboxForwarderTestOptions

    mailslurp.Model.InboxForwarderTestOptions Properties Name Type Description Notes TestValue string [Back to …

  • InboxForwarderTestResult

    mailslurp.Model.InboxForwarderTestResult Properties Name Type Description Notes DoesMatch bool Matches …

  • InboxPreview

    mailslurp.Model.InboxPreview Properties Name Type Description Notes CreatedAt DateTime When the inbox was …

  • InboxRulesetControllerApi

    mailslurp.Api.InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxRulesetDto

    mailslurp.Model.InboxRulesetDto Properties Name Type Description Notes Action string CreatedAt DateTime …

  • InboxRulesetTestOptions

    mailslurp.Model.InboxRulesetTestOptions Properties Name Type Description Notes TestTarget string [Back to …

  • InboxRulesetTestResult

    mailslurp.Model.InboxRulesetTestResult Properties Name Type Description Notes Matches bool RulesetMatches …

  • IPAddressResult

    mailslurp.Model.IPAddressResult IP Address look up result for a given domain / hostname Properties Name Type …

  • JSONSchemaDto

    mailslurp.Model.JSONSchemaDto Properties Name Type Description Notes Value string [Back to Model list] [Back …

  • MailServerControllerApi

    mailslurp.Api.MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • MatchOption

    mailslurp.Model.MatchOption Options for matching emails in an inbox. Each match option object contains a field, should …

  • MatchOptions

    mailslurp.Model.MatchOptions Optional filter for matching emails based on fields. For instance filter results to only …

  • MissedEmail

    mailslurp.Model.MissedEmail Properties Name Type Description Notes AttachmentCount int Bcc List …

  • MissedEmailControllerApi

    mailslurp.Api.MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • MissedEmailProjection

    mailslurp.Model.MissedEmailProjection Properties Name Type Description Notes CreatedAt DateTime From string …

  • NameServerRecord

    mailslurp.Model.NameServerRecord Name Server Record Properties Name Type Description Notes Priority string …

  • OrganizationInboxProjection

    mailslurp.Model.OrganizationInboxProjection Properties Name Type Description Notes CreatedAt DateTime When the …

  • Pageable

    mailslurp.Model.Pageable Properties Name Type Description Notes Offset long [optional] PageNumber int …

  • PageAlias

    mailslurp.Model.PageAlias Paginated email alias results. Page starts at zero. Projection results may omit larger entity …

  • PageAttachmentEntity

    mailslurp.Model.PageAttachmentEntity Paginated attachment entity results. Page starts at zero. Projection results may …

  • PageBouncedEmail

    mailslurp.Model.PageBouncedEmail Paginated bounced email. Page starts at zero. Projection results may omit larger entity …

  • PageBouncedRecipients

    mailslurp.Model.PageBouncedRecipients Paginated bounced recipients. Page starts at zero. Projection results may omit …

  • PageContactProjection

    mailslurp.Model.PageContactProjection Paginated contact results. Page starts at zero. Projection results may omit larger …

  • PageEmailPreview

    mailslurp.Model.PageEmailPreview Paginated email preview results. EmailProjections and EmailPreviews are essentially the …

  • PageEmailProjection

    mailslurp.Model.PageEmailProjection Paginated email projection results. EmailProjections and EmailPreviews are …

  • PageExpiredInboxRecordProjecti …

    mailslurp.Model.PageExpiredInboxRecordProjection Paginated expired inbox results. Page starts at zero. Projection …

  • PageGroupProjection

    mailslurp.Model.PageGroupProjection Paginated missed email results. Page starts at zero. Projection results may omit …

  • PageInboxForwarderDto

    mailslurp.Model.PageInboxForwarderDto Paginated inbox forwarder results. Page starts at zero. Projection results may …

  • PageInboxProjection

    mailslurp.Model.PageInboxProjection Paginated inbox results. Page starts at zero. Projection results may omit larger …

  • PageInboxRulesetDto

    mailslurp.Model.PageInboxRulesetDto Paginated inbox ruleset results. Page starts at zero. Projection results may omit …

  • PageMissedEmailProjection

    mailslurp.Model.PageMissedEmailProjection Paginated MissedEmail results. Page starts at zero. Projection results may …

  • PageOrganizationInboxProjectio …

    mailslurp.Model.PageOrganizationInboxProjection Paginated organization inbox results. Page starts at zero. Projection …

  • PageSentEmailProjection

    mailslurp.Model.PageSentEmailProjection Paginated sent email results. Page starts at zero. Projection results may omit …

  • PageTemplateProjection

    mailslurp.Model.PageTemplateProjection Paginated email template results. Page starts at zero. Projection results may …

  • PageThreadProjection

    mailslurp.Model.PageThreadProjection Paginated email projection results. EmailProjections and EmailPreviews are …

  • PageTrackingPixelProjection

    mailslurp.Model.PageTrackingPixelProjection Paginated TrackingPixel results. Page starts at zero. Projection results may …

  • PageUnknownMissedEmailProjecti …

    mailslurp.Model.PageUnknownMissedEmailProjection Paginated unknown MissedEmail results. Unknown missed emails are emails …

  • PageWebhookProjection

    mailslurp.Model.PageWebhookProjection Paginated webhook entity. Page starts at zero. Projection results may omit larger …

  • PageWebhookResult

    mailslurp.Model.PageWebhookResult Paginated webhook results. Page starts at zero. Projection results may omit larger …

  • RawEmailJson

    mailslurp.Model.RawEmailJson Content in raw format Properties Name Type Description Notes Content string …

  • Recipient

    mailslurp.Model.Recipient Properties Name Type Description Notes EmailAddress string Name string [optional] …

  • ReplyToAliasEmailOptions

    mailslurp.Model.ReplyToAliasEmailOptions Options for replying to an alias email using the alias inbox Properties Name …

  • ReplyToEmailOptions

    mailslurp.Model.ReplyToEmailOptions Options for replying to email with API Properties Name Type Description Notes …

  • SendEmailOptions

    mailslurp.Model.SendEmailOptions Options for sending an email message from an inbox. You must provide one of: to, …

  • Sender

    mailslurp.Model.Sender Properties Name Type Description Notes EmailAddress string Name string [optional] …

  • SentEmailDto

    mailslurp.Model.SentEmailDto Sent email details Properties Name Type Description Notes Attachments List Array of …

  • SentEmailProjection

    mailslurp.Model.SentEmailProjection Properties Name Type Description Notes Attachments List Bcc List …

  • SentEmailsControllerApi

    mailslurp.Api.SentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • SetInboxFavouritedOptions

    mailslurp.Model.SetInboxFavouritedOptions Options for setting inbox favourite state Properties Name Type Description …

  • SimpleSendEmailOptions

    mailslurp.Model.SimpleSendEmailOptions Properties Name Type Description Notes Body string Body of the email …

  • Sort

    mailslurp.Model.Sort Properties Name Type Description Notes Empty bool [optional] Sorted bool [optional] …

  • TemplateControllerApi

    mailslurp.Api.TemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • TemplateDto

    mailslurp.Model.TemplateDto Properties Name Type Description Notes Content string CreatedAt DateTime Id …

  • TemplateProjection

    mailslurp.Model.TemplateProjection Properties Name Type Description Notes CreatedAt DateTime Id Guid Name …

  • TemplateVariable

    mailslurp.Model.TemplateVariable Properties Name Type Description Notes Name string VariableType string …

  • TestNewInboxForwarderOptions

    mailslurp.Model.TestNewInboxForwarderOptions Properties Name Type Description Notes InboxForwarderTestOptions …

  • TestNewInboxRulesetOptions

    mailslurp.Model.TestNewInboxRulesetOptions Properties Name Type Description Notes InboxRulesetTestOptions …

  • ThreadProjection

    mailslurp.Model.ThreadProjection A thread is a message thread created for a message received by an alias Properties …

  • TrackingControllerApi

    mailslurp.Api.TrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • TrackingPixelDto

    mailslurp.Model.TrackingPixelDto Properties Name Type Description Notes CreatedAt DateTime Html string Id …

  • TrackingPixelProjection

    mailslurp.Model.TrackingPixelProjection Properties Name Type Description Notes CreatedAt DateTime Id Guid …

  • UnknownMissedEmailProjection

    mailslurp.Model.UnknownMissedEmailProjection Properties Name Type Description Notes CreatedAt DateTime From …

  • UnreadCount

    mailslurp.Model.UnreadCount Properties Name Type Description Notes Count long [Back to Model list] [Back to …

  • UnseenErrorCountDto

    mailslurp.Model.UnseenErrorCountDto Properties Name Type Description Notes Count long [Back to Model list] …

  • UpdateAliasOptions

    mailslurp.Model.UpdateAliasOptions Update an email alias Properties Name Type Description Notes Name string …

  • UpdateDomainOptions

    mailslurp.Model.UpdateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access …

  • UpdateGroupContacts

    mailslurp.Model.UpdateGroupContacts Properties Name Type Description Notes ContactIds List [Back to Model …

  • UpdateInboxOptions

    mailslurp.Model.UpdateInboxOptions Options for updating inbox properties Properties Name Type Description Notes …

  • UploadAttachmentOptions

    mailslurp.Model.UploadAttachmentOptions Options for uploading files for attachments. When sending emails with the API …

  • ValidationDto

    mailslurp.Model.ValidationDto Response object for email validation operation Properties Name Type Description Notes …

  • ValidationMessage

    mailslurp.Model.ValidationMessage Properties Name Type Description Notes LineNumber int Message string …

  • VerifyEmailAddressOptions

    mailslurp.Model.VerifyEmailAddressOptions Options for verifying that an email address exists at a remote mail server. …

  • WaitForConditions

    mailslurp.Model.WaitForConditions Conditions that a waitForXEmails endpoint operates on. The methods wait until given …

  • WaitForControllerApi

    mailslurp.Api.WaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WebhookControllerApi

    mailslurp.Api.WebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WebhookDto

    mailslurp.Model.WebhookDto Representation of a webhook for an inbox. The URL specified will be using by MailSlurp …

  • WebhookEmailOpenedPayload

    mailslurp.Model.WebhookEmailOpenedPayload EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST …

  • WebhookEmailReadPayload

    mailslurp.Model.WebhookEmailReadPayload EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when …

  • WebhookNewAttachmentPayload

    mailslurp.Model.WebhookNewAttachmentPayload NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP …

  • WebhookNewContactPayload

    mailslurp.Model.WebhookNewContactPayload NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST …

  • WebhookNewEmailPayload

    mailslurp.Model.WebhookNewEmailPayload NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when …

  • WebhookProjection

    mailslurp.Model.WebhookProjection Representation of a webhook Properties Name Type Description Notes CreatedAt …

  • WebhookRedriveResult

    mailslurp.Model.WebhookRedriveResult Properties Name Type Description Notes Message string [optional] Success …

  • WebhookResultDto

    mailslurp.Model.WebhookResultDto Properties Name Type Description Notes CreatedAt DateTime HttpMethod string …

  • WebhookTestRequest

    mailslurp.Model.WebhookTestRequest Properties Name Type Description Notes Headers Dictionary<string, …

  • WebhookTestResponse

    mailslurp.Model.WebhookTestResponse Properties Name Type Description Notes Message string [optional] …

  • WebhookTestResult

    mailslurp.Model.WebhookTestResult Results of testing a webhook Properties Name Type Description Notes Message …

  • Doc

    Index AliasControllerApi AbstractWebhookPayload AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    mailslurp.model.AbstractWebhookPayload Load the model package import 'package:mailslurp/api.dart'; Properties …

  • AliasControllerApi

    mailslurp.api.AliasControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are relative …

  • AliasDto

    mailslurp.model.AliasDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • AliasProjection

    mailslurp.model.AliasProjection Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • AttachmentControllerApi

    mailslurp.api.AttachmentControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • AttachmentEntity

    mailslurp.model.AttachmentEntity Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • AttachmentMetaData

    mailslurp.model.AttachmentMetaData Load the model package import 'package:mailslurp/api.dart'; Properties …

  • AttachmentProjection

    mailslurp.model.AttachmentProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • BasicAuthOptions

    mailslurp.model.BasicAuthOptions Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • BounceControllerApi

    mailslurp.api.BounceControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • BouncedEmailDto

    mailslurp.model.BouncedEmailDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • BouncedRecipientDto

    mailslurp.model.BouncedRecipientDto Load the model package import 'package:mailslurp/api.dart'; Properties …

  • BounceProjection

    mailslurp.model.BounceProjection Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • BounceRecipient

    mailslurp.model.BounceRecipient Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • BulkActionsControllerApi

    mailslurp.api.BulkActionsControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • BulkSendEmailOptions

    mailslurp.model.BulkSendEmailOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CommonActionsControllerApi

    mailslurp.api.CommonActionsControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • ConditionOption

    mailslurp.model.ConditionOption Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • ContactControllerApi

    mailslurp.api.ContactControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • ContactDto

    mailslurp.model.ContactDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • ContactProjection

    mailslurp.model.ContactProjection Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • ContentMatchOptions

    mailslurp.model.ContentMatchOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CountDto

    mailslurp.model.CountDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • CreateAliasOptions

    mailslurp.model.CreateAliasOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CreateContactOptions

    mailslurp.model.CreateContactOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CreateDomainOptions

    mailslurp.model.CreateDomainOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CreateGroupOptions

    mailslurp.model.CreateGroupOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CreateInboxDto

    mailslurp.model.CreateInboxDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • CreateInboxForwarderOptions

    mailslurp.model.CreateInboxForwarderOptions Load the model package import 'package:mailslurp/api.dart'; …

  • CreateInboxRulesetOptions

    mailslurp.model.CreateInboxRulesetOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CreateTemplateOptions

    mailslurp.model.CreateTemplateOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • CreateTrackingPixelOptions

    mailslurp.model.CreateTrackingPixelOptions Load the model package import 'package:mailslurp/api.dart'; …

  • CreateWebhookOptions

    mailslurp.model.CreateWebhookOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • DescribeDomainOptions

    mailslurp.model.DescribeDomainOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • DescribeMailServerDomainResult

    mailslurp.model.DescribeMailServerDomainResult Load the model package import 'package:mailslurp/api.dart'; …

  • DNSLookupOptions

    mailslurp.model.DNSLookupOptions Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • DNSLookupResult

    mailslurp.model.DNSLookupResult Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • DNSLookupResults

    mailslurp.model.DNSLookupResults Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • DomainControllerApi

    mailslurp.api.DomainControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • DomainDto

    mailslurp.model.DomainDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • DomainNameRecord

    mailslurp.model.DomainNameRecord Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • DomainPreview

    mailslurp.model.DomainPreview Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • DownloadAttachmentDto

    mailslurp.model.DownloadAttachmentDto Load the model package import 'package:mailslurp/api.dart'; Properties …

  • Email

    mailslurp.model.Email Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • EmailAnalysis

    mailslurp.model.EmailAnalysis Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • EmailContentMatchResult

    mailslurp.model.EmailContentMatchResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • EmailControllerApi

    mailslurp.api.EmailControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are relative …

  • EmailLinksResult

    mailslurp.model.EmailLinksResult Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • EmailPreview

    mailslurp.model.EmailPreview Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • EmailProjection

    mailslurp.model.EmailProjection Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • EmailRecipients

    mailslurp.model.EmailRecipients Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • EmailTextLinesResult

    mailslurp.model.EmailTextLinesResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • EmailVerificationResult

    mailslurp.model.EmailVerificationResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • ExpirationDefaults

    mailslurp.model.ExpirationDefaults Load the model package import 'package:mailslurp/api.dart'; Properties …

  • ExpiredControllerApi

    mailslurp.api.ExpiredControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • ExpiredInboxDto

    mailslurp.model.ExpiredInboxDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • ExpiredInboxRecordProjection

    mailslurp.model.ExpiredInboxRecordProjection Load the model package import 'package:mailslurp/api.dart'; …

  • ExportControllerApi

    mailslurp.api.ExportControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • ExportLink

    mailslurp.model.ExportLink Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • ExportOptions

    mailslurp.model.ExportOptions Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • FlushExpiredInboxesResult

    mailslurp.model.FlushExpiredInboxesResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • FormControllerApi

    mailslurp.api.FormControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are relative …

  • ForwardEmailOptions

    mailslurp.model.ForwardEmailOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • GravatarUrl

    mailslurp.model.GravatarUrl Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • GroupContactsDto

    mailslurp.model.GroupContactsDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • GroupControllerApi

    mailslurp.api.GroupControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are relative …

  • GroupDto

    mailslurp.model.GroupDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • GroupProjection

    mailslurp.model.GroupProjection Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • HTMLValidationResult

    mailslurp.model.HTMLValidationResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • Inbox

    mailslurp.model.Inbox Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • InboxControllerApi

    mailslurp.api.InboxControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are relative …

  • InboxExistsDto

    mailslurp.model.InboxExistsDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • InboxForwarderControllerApi

    mailslurp.api.InboxForwarderControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • InboxForwarderDto

    mailslurp.model.InboxForwarderDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • InboxForwarderTestOptions

    mailslurp.model.InboxForwarderTestOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • InboxForwarderTestResult

    mailslurp.model.InboxForwarderTestResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • InboxPreview

    mailslurp.model.InboxPreview Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • InboxRulesetControllerApi

    mailslurp.api.InboxRulesetControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • InboxRulesetDto

    mailslurp.model.InboxRulesetDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • InboxRulesetTestOptions

    mailslurp.model.InboxRulesetTestOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • InboxRulesetTestResult

    mailslurp.model.InboxRulesetTestResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • IPAddressResult

    mailslurp.model.IPAddressResult Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • JSONSchemaDto

    mailslurp.model.JSONSchemaDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • MailServerControllerApi

    mailslurp.api.MailServerControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • MatchOption

    mailslurp.model.MatchOption Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • MatchOptions

    mailslurp.model.MatchOptions Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • MissedEmail

    mailslurp.model.MissedEmail Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • MissedEmailControllerApi

    mailslurp.api.MissedEmailControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • MissedEmailProjection

    mailslurp.model.MissedEmailProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • NameServerRecord

    mailslurp.model.NameServerRecord Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • OrganizationInboxProjection

    mailslurp.model.OrganizationInboxProjection Load the model package import 'package:mailslurp/api.dart'; …

  • Pageable

    mailslurp.model.Pageable Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • PageAlias

    mailslurp.model.PageAlias Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • PageAttachmentEntity

    mailslurp.model.PageAttachmentEntity Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageBouncedEmail

    mailslurp.model.PageBouncedEmail Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • PageBouncedRecipients

    mailslurp.model.PageBouncedRecipients Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageContactProjection

    mailslurp.model.PageContactProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageEmailPreview

    mailslurp.model.PageEmailPreview Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • PageEmailProjection

    mailslurp.model.PageEmailProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageExpiredInboxRecordProjecti …

    mailslurp.model.PageExpiredInboxRecordProjection Load the model package import 'package:mailslurp/api.dart'; …

  • PageGroupProjection

    mailslurp.model.PageGroupProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageInboxForwarderDto

    mailslurp.model.PageInboxForwarderDto Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageInboxProjection

    mailslurp.model.PageInboxProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageInboxRulesetDto

    mailslurp.model.PageInboxRulesetDto Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageMissedEmailProjection

    mailslurp.model.PageMissedEmailProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageOrganizationInboxProjectio …

    mailslurp.model.PageOrganizationInboxProjection Load the model package import 'package:mailslurp/api.dart'; …

  • PageSentEmailProjection

    mailslurp.model.PageSentEmailProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageTemplateProjection

    mailslurp.model.PageTemplateProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageThreadProjection

    mailslurp.model.PageThreadProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageTrackingPixelProjection

    mailslurp.model.PageTrackingPixelProjection Load the model package import 'package:mailslurp/api.dart'; …

  • PageUnknownMissedEmailProjecti …

    mailslurp.model.PageUnknownMissedEmailProjection Load the model package import 'package:mailslurp/api.dart'; …

  • PageWebhookProjection

    mailslurp.model.PageWebhookProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • PageWebhookResult

    mailslurp.model.PageWebhookResult Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • RawEmailJson

    mailslurp.model.RawEmailJson Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • Recipient

    mailslurp.model.Recipient Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • ReplyToAliasEmailOptions

    mailslurp.model.ReplyToAliasEmailOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • ReplyToEmailOptions

    mailslurp.model.ReplyToEmailOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • SendEmailOptions

    mailslurp.model.SendEmailOptions Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • Sender

    mailslurp.model.Sender Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • SentEmailDto

    mailslurp.model.SentEmailDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • SentEmailProjection

    mailslurp.model.SentEmailProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • SentEmailsControllerApi

    mailslurp.api.SentEmailsControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • SetInboxFavouritedOptions

    mailslurp.model.SetInboxFavouritedOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • SimpleSendEmailOptions

    mailslurp.model.SimpleSendEmailOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • Sort

    mailslurp.model.Sort Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • TemplateControllerApi

    mailslurp.api.TemplateControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • TemplateDto

    mailslurp.model.TemplateDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • TemplateProjection

    mailslurp.model.TemplateProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • TemplateVariable

    mailslurp.model.TemplateVariable Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • TestNewInboxForwarderOptions

    mailslurp.model.TestNewInboxForwarderOptions Load the model package import 'package:mailslurp/api.dart'; …

  • TestNewInboxRulesetOptions

    mailslurp.model.TestNewInboxRulesetOptions Load the model package import 'package:mailslurp/api.dart'; …

  • ThreadProjection

    mailslurp.model.ThreadProjection Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • TrackingControllerApi

    mailslurp.api.TrackingControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • TrackingPixelDto

    mailslurp.model.TrackingPixelDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • TrackingPixelProjection

    mailslurp.model.TrackingPixelProjection Load the model package import 'package:mailslurp/api.dart'; Properties …

  • UnknownMissedEmailProjection

    mailslurp.model.UnknownMissedEmailProjection Load the model package import 'package:mailslurp/api.dart'; …

  • UnreadCount

    mailslurp.model.UnreadCount Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • UnseenErrorCountDto

    mailslurp.model.UnseenErrorCountDto Load the model package import 'package:mailslurp/api.dart'; Properties …

  • UpdateAliasOptions

    mailslurp.model.UpdateAliasOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • UpdateDomainOptions

    mailslurp.model.UpdateDomainOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • UpdateGroupContacts

    mailslurp.model.UpdateGroupContacts Load the model package import 'package:mailslurp/api.dart'; Properties …

  • UpdateInboxOptions

    mailslurp.model.UpdateInboxOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • UploadAttachmentOptions

    mailslurp.model.UploadAttachmentOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • ValidationDto

    mailslurp.model.ValidationDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • ValidationMessage

    mailslurp.model.ValidationMessage Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • VerifyEmailAddressOptions

    mailslurp.model.VerifyEmailAddressOptions Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WaitForConditions

    mailslurp.model.WaitForConditions Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • WaitForControllerApi

    mailslurp.api.WaitForControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • WebhookControllerApi

    mailslurp.api.WebhookControllerApi Load the API package import 'package:mailslurp/api.dart'; All URIs are …

  • WebhookDto

    mailslurp.model.WebhookDto Load the model package import 'package:mailslurp/api.dart'; Properties Name Type …

  • WebhookEmailOpenedPayload

    mailslurp.model.WebhookEmailOpenedPayload Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WebhookEmailReadPayload

    mailslurp.model.WebhookEmailReadPayload Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WebhookNewAttachmentPayload

    mailslurp.model.WebhookNewAttachmentPayload Load the model package import 'package:mailslurp/api.dart'; …

  • WebhookNewContactPayload

    mailslurp.model.WebhookNewContactPayload Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WebhookNewEmailPayload

    mailslurp.model.WebhookNewEmailPayload Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WebhookProjection

    mailslurp.model.WebhookProjection Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • WebhookRedriveResult

    mailslurp.model.WebhookRedriveResult Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WebhookResultDto

    mailslurp.model.WebhookResultDto Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • WebhookTestRequest

    mailslurp.model.WebhookTestRequest Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WebhookTestResponse

    mailslurp.model.WebhookTestResponse Load the model package import 'package:mailslurp/api.dart'; Properties …

  • WebhookTestResult

    mailslurp.model.WebhookTestResult Load the model package import 'package:mailslurp/api.dart'; Properties Name …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AttachmentControllerApi AliasProjection AttachmentEntity …

  • AbstractWebhookPayload

    AbstractWebhookPayload Properties Name Type Description Notes EventName string MessageId string WebhookId …

  • AliasControllerApi

    MailSlurpAliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AliasDto

    AliasDto Properties Name Type Description Notes CreatedAt time.Time [optional] EmailAddress string The …

  • AliasProjection

    AliasProjection Properties Name Type Description Notes CreatedAt time.Time EmailAddress string Id string …

  • AttachmentControllerApi

    MailSlurpAttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AttachmentEntity

    AttachmentEntity Properties Name Type Description Notes AttachmentId string ContentLength int64 [optional] …

  • AttachmentMetaData

    AttachmentMetaData Properties Name Type Description Notes ContentLength int64 Size of attachment in bytes …

  • AttachmentProjection

    AttachmentProjection Properties Name Type Description Notes AttachmentId string Attachment ID [optional] …

  • BasicAuthOptions

    BasicAuthOptions Properties Name Type Description Notes Username string Password string [Back to Model …

  • BounceControllerApi

    MailSlurpBounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BouncedEmailDto

    BouncedEmailDto Properties Name Type Description Notes BounceMta string [optional] BounceRecipients []string …

  • BouncedRecipientDto

    BouncedRecipientDto Properties Name Type Description Notes CreatedAt time.Time Id string [optional] …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes CreatedAt time.Time Id string [optional] Sender …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes CreatedAt time.Time Id string [optional] Recipient …

  • BulkActionsControllerApi

    MailSlurpBulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BulkSendEmailOptions

    BulkSendEmailOptions Properties Name Type Description Notes InboxIds []string Inboxes to send the email from …

  • CommonActionsControllerApi

    MailSlurpCommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ConditionOption

    ConditionOption Properties Name Type Description Notes Condition string The condition to evaluate against the …

  • ContactControllerApi

    MailSlurpContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ContactDto

    ContactDto Properties Name Type Description Notes Company string [optional] CreatedAt time.Time …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes Company string [optional] CreatedAt time.Time …

  • ContentMatchOptions

    ContentMatchOptions Properties Name Type Description Notes Pattern string Java style regex pattern. Do not …

  • CountDto

    CountDto Properties Name Type Description Notes TotalElements int64 [Back to Model list] [Back to API list] …

  • CreateAliasOptions

    CreateAliasOptions Properties Name Type Description Notes EmailAddress string Email address to be hidden behind …

  • CreateContactOptions

    CreateContactOptions Properties Name Type Description Notes EmailAddresses []string Set of email addresses …

  • CreateDomainOptions

    CreateDomainOptions Properties Name Type Description Notes CreatedCatchAllInbox bool Whether to create a catch …

  • CreateGroupOptions

    CreateGroupOptions Properties Name Type Description Notes Name string Description string [optional] [Back …

  • CreateInboxDto

    CreateInboxDto Properties Name Type Description Notes AllowTeamAccess bool DEPRECATED (team access is always …

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Properties Name Type Description Notes Field string Field to match against to trigger …

  • CreateInboxRulesetOptions

    CreateInboxRulesetOptions Properties Name Type Description Notes Action string Action to be taken when the …

  • CreateTemplateOptions

    CreateTemplateOptions Properties Name Type Description Notes Name string Content string [Back to Model …

  • CreateTrackingPixelOptions

    CreateTrackingPixelOptions Properties Name Type Description Notes Name string [optional] Recipient string …

  • CreateWebhookOptions

    CreateWebhookOptions Properties Name Type Description Notes BasicAuth BasicAuthOptions [optional] EventName …

  • DescribeDomainOptions

    DescribeDomainOptions Properties Name Type Description Notes Domain string [Back to Model list] [Back to API …

  • DescribeMailServerDomainResult

    DescribeMailServerDomainResult Properties Name Type Description Notes Domain string Message string …

  • DnsLookupOptions

    DnsLookupOptions Properties Name Type Description Notes Hostname string List of record types you wish to query …

  • DnsLookupResult

    DnsLookupResult Properties Name Type Description Notes Name string RecordEntries []string RecordType …

  • DnsLookupResults

    DnsLookupResults Properties Name Type Description Notes Results **[]DnsLookupResult** [Back to Model list] …

  • DomainControllerApi

    MailSlurpDomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • DomainDto

    DomainDto Properties Name Type Description Notes CatchAllInboxId string The optional catch all inbox that will …

  • DomainNameRecord

    DomainNameRecord Properties Name Type Description Notes Name string RecordEntries []string RecordType …

  • DomainPreview

    DomainPreview Properties Name Type Description Notes CatchAllInboxId string [optional] CreatedAt time.Time …

  • DownloadAttachmentDto

    DownloadAttachmentDto Properties Name Type Description Notes Base64FileContents string Base64 encoded string of …

  • Email

    Email Properties Name Type Description Notes Analysis EmailAnalysis [optional] Attachments []string List of …

  • EmailAnalysis

    EmailAnalysis Properties Name Type Description Notes DkimVerdict string Verdict of DomainKeys Identified Mail …

  • EmailContentMatchResult

    EmailContentMatchResult Properties Name Type Description Notes Matches []string Pattern string [Back to …

  • EmailControllerApi

    MailSlurpEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • EmailLinksResult

    EmailLinksResult Properties Name Type Description Notes Body string Links []string [Back to Model list] …

  • EmailPreview

    EmailPreview Properties Name Type Description Notes Attachments []string List of IDs of attachments found in the …

  • EmailProjection

    EmailProjection Properties Name Type Description Notes Attachments []string [optional] Bcc []string …

  • EmailRecipients

    EmailRecipients Properties Name Type Description Notes Bcc **[]Recipient** [optional] Cc **[]Recipient** …

  • EmailTextLinesResult

    EmailTextLinesResult Properties Name Type Description Notes Body string Lines []string [Back to Model …

  • EmailVerificationResult

    EmailVerificationResult Properties Name Type Description Notes DomainName string EmailAddress string …

  • ExpirationDefaults

    ExpirationDefaults Properties Name Type Description Notes CanPermanentInbox bool DefaultExpirationMillis …

  • ExpiredControllerApi

    MailSlurpExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExpiredInboxDto

    ExpiredInboxDto Properties Name Type Description Notes EmailAddress string Id string InboxId string …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes CreatedAt time.Time EmailAddress string …

  • ExportControllerApi

    MailSlurpExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExportLink

    ExportLink Properties Name Type Description Notes DownloadLink string [Back to Model list] [Back to API …

  • ExportOptions

    ExportOptions Properties Name Type Description Notes OutputFormat string ExcludePreviouslyExported bool …

  • FlushExpiredInboxesResult

    FlushExpiredInboxesResult Properties Name Type Description Notes ExpireBefore time.Time InboxIds []string …

  • FormControllerApi

    MailSlurpFormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ForwardEmailOptions

    ForwardEmailOptions Properties Name Type Description Notes Bcc []string Optional bcc recipients [optional] Cc …

  • GravatarUrl

    GravatarUrl Properties Name Type Description Notes Hash string Url string [Back to Model list] [Back to …

  • GroupContactsDto

    GroupContactsDto Properties Name Type Description Notes Contacts **[]ContactDto** Group GroupDto [Back …

  • GroupControllerApi

    MailSlurpGroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • GroupDto

    GroupDto Properties Name Type Description Notes CreatedAt time.Time Description string [optional] Id …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes CreatedAt time.Time Description string [optional] …

  • HtmlValidationResult

    HtmlValidationResult Properties Name Type Description Notes Errors **[]ValidationMessage** Optional errors …

  • Inbox

    Inbox Properties Name Type Description Notes CreatedAt time.Time When the inbox was created. Time stamps are in …

  • InboxControllerApi

    MailSlurpInboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxExistsDto

    InboxExistsDto Properties Name Type Description Notes Exists bool [Back to Model list] [Back to API list] …

  • InboxForwarderControllerApi

    MailSlurpInboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes CreatedAt time.Time Field string …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes TestValue string [Back to Model list] [Back …

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes DoesMatch bool Matches map[string]bool …

  • InboxPreview

    InboxPreview Properties Name Type Description Notes CreatedAt time.Time When the inbox was created. Time stamps …

  • InboxRulesetControllerApi

    MailSlurpInboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes Action string CreatedAt time.Time Handler string …

  • InboxRulesetTestOptions

    InboxRulesetTestOptions Properties Name Type Description Notes TestTarget string [Back to Model list] [Back …

  • InboxRulesetTestResult

    InboxRulesetTestResult Properties Name Type Description Notes Matches bool RulesetMatches map[string]bool Map …

  • IpAddressResult

    IpAddressResult Properties Name Type Description Notes Address string Hostname string [Back to Model …

  • JsonSchemaDto

    JsonSchemaDto Properties Name Type Description Notes Value string [Back to Model list] [Back to API list] …

  • MailServerControllerApi

    MailSlurpMailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MatchOption

    MatchOption Properties Name Type Description Notes Field string The email property to match on. One of SUBJECT, …

  • MatchOptions

    MatchOptions Properties Name Type Description Notes Conditions **[]ConditionOption** Zero or more conditions such …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes AttachmentCount int32 Bcc []string BodyExcerpt string …

  • MissedEmailControllerApi

    MailSlurpMissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MissedEmailProjection

    MissedEmailProjection Properties Name Type Description Notes CreatedAt time.Time From string [optional] Id …

  • NameServerRecord

    NameServerRecord Properties Name Type Description Notes Priority string Raw string RecordType string …

  • OrganizationInboxProjection

    OrganizationInboxProjection Properties Name Type Description Notes CreatedAt time.Time When the inbox was …

  • Pageable

    Pageable Properties Name Type Description Notes Offset int64 [optional] PageNumber int32 [optional] …

  • PageAlias

    PageAlias Properties Name Type Description Notes Content **[]AliasProjection** [optional] Empty bool …

  • PageAttachmentEntity

    PageAttachmentEntity Properties Name Type Description Notes Content **[]AttachmentProjection** [optional] …

  • PageBouncedEmail

    PageBouncedEmail Properties Name Type Description Notes Content **[]BounceProjection** [optional] Empty bool …

  • PageBouncedRecipients

    PageBouncedRecipients Properties Name Type Description Notes Content **[]BounceRecipient** [optional] Empty …

  • PageContactProjection

    PageContactProjection Properties Name Type Description Notes Content **[]ContactProjection** [optional] Empty …

  • PageEmailPreview

    PageEmailPreview Properties Name Type Description Notes Content **[]EmailPreview** [optional] Empty bool …

  • PageEmailProjection

    PageEmailProjection Properties Name Type Description Notes Content **[]EmailProjection** [optional] Empty bool …

  • PageExpiredInboxRecordProjecti …

    PageExpiredInboxRecordProjection Properties Name Type Description Notes Content …

  • PageGroupProjection

    PageGroupProjection Properties Name Type Description Notes Content **[]GroupProjection** [optional] Empty bool …

  • PageInboxForwarderDto

    PageInboxForwarderDto Properties Name Type Description Notes Content **[]InboxForwarderDto** [optional] Empty …

  • PageInboxProjection

    PageInboxProjection Properties Name Type Description Notes Content **[]InboxPreview** [optional] Empty bool …

  • PageInboxRulesetDto

    PageInboxRulesetDto Properties Name Type Description Notes Content **[]InboxRulesetDto** [optional] Empty bool …

  • PageMissedEmailProjection

    PageMissedEmailProjection Properties Name Type Description Notes Content **[]MissedEmailProjection** [optional] …

  • PageOrganizationInboxProjectio …

    PageOrganizationInboxProjection Properties Name Type Description Notes Content **[]OrganizationInboxProjection** …

  • PageSentEmailProjection

    PageSentEmailProjection Properties Name Type Description Notes Content **[]SentEmailProjection** Collection of …

  • PageTemplateProjection

    PageTemplateProjection Properties Name Type Description Notes Content **[]TemplateProjection** [optional] …

  • PageThreadProjection

    PageThreadProjection Properties Name Type Description Notes Content **[]ThreadProjection** [optional] Empty …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Properties Name Type Description Notes Content **[]TrackingPixelProjection** …

  • PageUnknownMissedEmailProjecti …

    PageUnknownMissedEmailProjection Properties Name Type Description Notes Content …

  • PageWebhookProjection

    PageWebhookProjection Properties Name Type Description Notes Content **[]WebhookProjection** [optional] Empty …

  • PageWebhookResult

    PageWebhookResult Properties Name Type Description Notes Content **[]WebhookResultDto** [optional] Empty bool …

  • RawEmailJson

    RawEmailJson Properties Name Type Description Notes Content string [Back to Model list] [Back to API list] …

  • Recipient

    Recipient Properties Name Type Description Notes EmailAddress string Name string [optional] RawValue …

  • ReplyToAliasEmailOptions

    ReplyToAliasEmailOptions Properties Name Type Description Notes Attachments []string List of uploaded attachments …

  • ReplyToEmailOptions

    ReplyToEmailOptions Properties Name Type Description Notes Attachments []string List of uploaded attachments to …

  • SendEmailOptions

    SendEmailOptions Properties Name Type Description Notes AddTrackingPixel bool Add tracking pixel to email …

  • Sender

    Sender Properties Name Type Description Notes EmailAddress string Name string [optional] RawValue string …

  • SentEmailDto

    SentEmailDto Properties Name Type Description Notes Attachments []string Array of IDs of attachments that were …

  • SentEmailProjection

    SentEmailProjection Properties Name Type Description Notes Attachments []string Bcc []string BodyMD5Hash …

  • SentEmailsControllerApi

    MailSlurpSentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • SetInboxFavouritedOptions

    SetInboxFavouritedOptions Properties Name Type Description Notes State bool Is the inbox a favorite. Marking an …

  • SimpleSendEmailOptions

    SimpleSendEmailOptions Properties Name Type Description Notes Body string Body of the email message. Supports …

  • Sort

    Sort Properties Name Type Description Notes Empty bool [optional] Sorted bool [optional] Unsorted bool …

  • TemplateControllerApi

    MailSlurpTemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TemplateDto

    TemplateDto Properties Name Type Description Notes Content string CreatedAt time.Time Id string Name …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes CreatedAt time.Time Id string Name string …

  • TemplateVariable

    TemplateVariable Properties Name Type Description Notes Name string VariableType string [Back to Model …

  • TestNewInboxForwarderOptions

    TestNewInboxForwarderOptions Properties Name Type Description Notes InboxForwarderTestOptions …

  • TestNewInboxRulesetOptions

    TestNewInboxRulesetOptions Properties Name Type Description Notes InboxRulesetTestOptions InboxRulesetTestOptions …

  • ThreadProjection

    ThreadProjection Properties Name Type Description Notes AliasId string Bcc []string [optional] Cc []string …

  • TrackingControllerApi

    MailSlurpTrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes CreatedAt time.Time Html string Id string …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes CreatedAt time.Time Id string InboxId …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes CreatedAt time.Time From string …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes Count int64 [Back to Model list] [Back to API list] [Back …

  • UnseenErrorCountDto

    UnseenErrorCountDto Properties Name Type Description Notes Count int64 [Back to Model list] [Back to API …

  • UpdateAliasOptions

    UpdateAliasOptions Properties Name Type Description Notes Name string Optional name for alias [optional] [Back …

  • UpdateDomainOptions

    UpdateDomainOptions Properties Name Type Description Notes CatchAllInboxId string [optional] [Back to Model …

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes ContactIds []string [Back to Model list] [Back to …

  • UpdateInboxOptions

    UpdateInboxOptions Properties Name Type Description Notes Description string Description of an inbox for …

  • UploadAttachmentOptions

    UploadAttachmentOptions Properties Name Type Description Notes Base64Contents string Base64 encoded string of …

  • ValidationDto

    ValidationDto Properties Name Type Description Notes EmailId string ID of the email validated [optional] Html …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes LineNumber int32 Message string [optional] [Back …

  • VerifyEmailAddressOptions

    VerifyEmailAddressOptions Properties Name Type Description Notes MailServerDomain string [optional] …

  • WaitForConditions

    WaitForConditions Properties Name Type Description Notes Before time.Time ISO Date Time latest time of email to …

  • WaitForControllerApi

    MailSlurpWaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WebhookControllerApi

    MailSlurpWebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WebhookDto

    WebhookDto Properties Name Type Description Notes BasicAuth bool Does webhook expect basic authentication? If …

  • WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload Properties Name Type Description Notes CreatedAt time.Time Date time of event creation …

  • WebhookEmailReadPayload

    WebhookEmailReadPayload Properties Name Type Description Notes CreatedAt time.Time Date time of event creation …

  • WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload Properties Name Type Description Notes AttachmentId string ID of attachment. Use the …

  • WebhookNewContactPayload

    WebhookNewContactPayload Properties Name Type Description Notes Company string [optional] ContactId string …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload Properties Name Type Description Notes AttachmentMetaDatas **[]AttachmentMetaData** List …

  • WebhookProjection

    WebhookProjection Properties Name Type Description Notes CreatedAt time.Time EventName string [optional] …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes Message string [optional] Success bool …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes CreatedAt time.Time HttpMethod string Id string …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes Headers map[string]string Method string Payload …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes Message string [optional] StatusCode int32 …

  • WebhookTestResult

    WebhookTestResult Properties Name Type Description Notes Message string [optional] Request WebhookTestRequest …

  • golang

    Golang MailSlurp See golang docs.

  • Docs

    MailSlurp GraphQL Schemas Generated graphql schema for MailSlurp email API. See models and api documentation for schema …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    AbstractWebhookPayload Abstract webhook payload. Use the correct payload type for your webhook event type in order to …

  • AliasControllerApi

    AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description createAlias …

  • AliasDto

    AliasDto Email alias representation Properties Name Type Description Notes createdAt OffsetDateTime [optional] …

  • AliasProjection

    AliasProjection Representation of a alias Properties Name Type Description Notes createdAt OffsetDateTime …

  • AttachmentControllerApi

    AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AttachmentEntity

    AttachmentEntity Properties Name Type Description Notes attachmentId String contentLength Long [optional] …

  • AttachmentMetaData

    AttachmentMetaData Meta data associated with an attachment. Attachments are stored as byte blobs so the meta data is …

  • AttachmentProjection

    AttachmentProjection Properties Name Type Description Notes attachmentId String Attachment ID [optional] …

  • BasicAuthOptions

    BasicAuthOptions Basic Authentication options for webhooks. Will be used is present when calling webhook endpoints. …

  • BounceControllerApi

    BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BouncedEmailDto

    BouncedEmailDto Bounced email Properties Name Type Description Notes bounceMta String [optional] …

  • BouncedRecipientDto

    BouncedRecipientDto Bounced recipient Properties Name Type Description Notes createdAt OffsetDateTime id UUID …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes createdAt OffsetDateTime id UUID [optional] sender …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes createdAt OffsetDateTime id UUID [optional] …

  • BulkActionsControllerApi

    BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BulkSendEmailOptions

    BulkSendEmailOptions Options for bulk sending an email from multiple addresses. See regular sendEmail methods for more …

  • CommonActionsControllerApi

    CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ConditionOption

    ConditionOption Options for matching emails in an inbox based on a condition such as HAS_ATTACHMENTS=TRUE Properties …

  • ContactControllerApi

    ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ContactDto

    ContactDto Properties Name Type Description Notes company String [optional] createdAt OffsetDateTime …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes company String [optional] createdAt OffsetDateTime …

  • ContentMatchOptions

    ContentMatchOptions Options for matching content using regex patterns based on Java Pattern syntax Properties Name …

  • CountDto

    CountDto Properties Name Type Description Notes totalElements Long

  • CreateAliasOptions

    CreateAliasOptions Create email alias options. Email aliases can be used to mask real email addresses behind an ID. You …

  • CreateContactOptions

    CreateContactOptions Properties Name Type Description Notes emailAddresses List Set of email addresses belonging …

  • CreateDomainOptions

    CreateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to this domain …

  • CreateGroupOptions

    CreateGroupOptions Properties Name Type Description Notes name String description String [optional]

  • CreateInboxDto

    CreateInboxDto Options for creating an inbox. An inbox has a real email address that can send and receive emails. …

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Options for creating an inbox forwarder Properties Name Type Description Notes field …

  • CreateInboxRulesetOptions

    CreateInboxRulesetOptions Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or …

  • CreateTemplateOptions

    CreateTemplateOptions Properties Name Type Description Notes name String content String

  • CreateTrackingPixelOptions

    CreateTrackingPixelOptions Properties Name Type Description Notes name String [optional] recipient String …

  • CreateWebhookOptions

    CreateWebhookOptions Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a …

  • DescribeDomainOptions

    DescribeDomainOptions Properties Name Type Description Notes domain String

  • DescribeMailServerDomainResult

    DescribeMailServerDomainResult Name Server lookup result Properties Name Type Description Notes domain String …

  • DNSLookupOptions

    DNSLookupOptions Options for DNS query. Properties Name Type Description Notes hostname String List of record …

  • DNSLookupResult

    DNSLookupResult DNS lookup result. Includes record type, time to live, raw response, and name value for the name server …

  • DNSLookupResults

    DNSLookupResults Results of query on domain name servers Properties Name Type Description Notes results List …

  • DomainControllerApi

    DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • DomainDto

    DomainDto Domain plus verification records and status Properties Name Type Description Notes catchAllInboxId UUID …

  • DomainNameRecord

    DomainNameRecord DNS Record required for verification of a domain. Record vary depending on domain type. Properties …

  • DomainPreview

    DomainPreview Preview object for domain entity Properties Name Type Description Notes catchAllInboxId UUID …

  • DownloadAttachmentDto

    DownloadAttachmentDto Content of attachment Properties Name Type Description Notes base64FileContents String …

  • Email

    Email Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body …

  • EmailAnalysis

    EmailAnalysis Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic error message …

  • EmailContentMatchResult

    EmailContentMatchResult Matches for the given pattern Properties Name Type Description Notes matches List …

  • EmailControllerApi

    EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • EmailLinksResult

    EmailLinksResult Links found in HTML Properties Name Type Description Notes body String links List

  • EmailPreview

    EmailPreview Preview of an email message. For full message (including body and attachments) call the getEmail or other …

  • EmailProjection

    EmailProjection A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and …

  • EmailRecipients

    EmailRecipients Properties Name Type Description Notes bcc List [optional] cc List [optional] to List …

  • EmailTextLinesResult

    EmailTextLinesResult Parsed text of an email Properties Name Type Description Notes body String lines List …

  • EmailVerificationResult

    EmailVerificationResult Email verification result. Valid means email address exists according to response from mail …

  • ExpirationDefaults

    ExpirationDefaults Expiration defaults for your account Properties Name Type Description Notes canPermanentInbox …

  • ExpiredControllerApi

    ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExpiredInboxDto

    ExpiredInboxDto Expired inbox Properties Name Type Description Notes emailAddress String id UUID inboxId …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes createdAt OffsetDateTime emailAddress …

  • ExportControllerApi

    ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExportLink

    ExportLink Export download link Properties Name Type Description Notes downloadLink String

  • ExportOptions

    ExportOptions Options for exporting user data Properties Name Type Description Notes outputFormat …

  • FlushExpiredInboxesResult

    FlushExpiredInboxesResult Properties Name Type Description Notes expireBefore OffsetDateTime inboxIds List …

  • FormControllerApi

    FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description submitForm …

  • ForwardEmailOptions

    ForwardEmailOptions Options for forwarding an email Properties Name Type Description Notes bcc List Optional bcc …

  • GravatarUrl

    GravatarUrl Properties Name Type Description Notes hash String url String

  • GroupContactsDto

    GroupContactsDto Properties Name Type Description Notes contacts List group GroupDto

  • GroupControllerApi

    GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • GroupDto

    GroupDto Properties Name Type Description Notes createdAt OffsetDateTime description String [optional] id …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes createdAt OffsetDateTime description String …

  • HTMLValidationResult

    HTMLValidationResult HTML Validation Results Properties Name Type Description Notes errors List Optional errors …

  • Inbox

    Inbox Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from …

  • InboxControllerApi

    InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description createInbox …

  • InboxExistsDto

    InboxExistsDto Properties Name Type Description Notes exists Boolean

  • InboxForwarderControllerApi

    InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes createdAt OffsetDateTime field FieldEnum …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes testValue String

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes doesMatch Boolean matches Map<String, …

  • InboxPreview

    InboxPreview Properties Name Type Description Notes createdAt OffsetDateTime When the inbox was created. Time …

  • InboxRulesetControllerApi

    InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes action ActionEnum createdAt OffsetDateTime handler …

  • InboxRulesetTestOptions

    InboxRulesetTestOptions Properties Name Type Description Notes testTarget String

  • InboxRulesetTestResult

    InboxRulesetTestResult Properties Name Type Description Notes matches Boolean rulesetMatches Map<String, …

  • IPAddressResult

    IPAddressResult IP Address look up result for a given domain / hostname Properties Name Type Description Notes …

  • JSONSchemaDto

    JSONSchemaDto Properties Name Type Description Notes value String

  • MailServerControllerApi

    MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MatchOption

    MatchOption Options for matching emails in an inbox. Each match option object contains a field, should and value …

  • MatchOptions

    MatchOptions Optional filter for matching emails based on fields. For instance filter results to only include emails …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes attachmentCount Integer bcc List bodyExcerpt String …

  • MissedEmailControllerApi

    MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MissedEmailProjection

    MissedEmailProjection Properties Name Type Description Notes createdAt OffsetDateTime from String [optional] …

  • NameServerRecord

    NameServerRecord Name Server Record Properties Name Type Description Notes priority String raw String …

  • OrganizationInboxProjection

    OrganizationInboxProjection Properties Name Type Description Notes createdAt OffsetDateTime When the inbox was …

  • Pageable

    Pageable Properties Name Type Description Notes offset Long [optional] pageNumber Integer [optional] …

  • PageAlias

    PageAlias Paginated email alias results. Page starts at zero. Projection results may omit larger entity fields. For …

  • PageAttachmentEntity

    PageAttachmentEntity Paginated attachment entity results. Page starts at zero. Projection results may omit larger entity …

  • PageBouncedEmail

    PageBouncedEmail Paginated bounced email. Page starts at zero. Projection results may omit larger entity fields. For …

  • PageBouncedRecipients

    PageBouncedRecipients Paginated bounced recipients. Page starts at zero. Projection results may omit larger entity …

  • PageContactProjection

    PageContactProjection Paginated contact results. Page starts at zero. Projection results may omit larger entity fields. …

  • PageEmailPreview

    PageEmailPreview Paginated email preview results. EmailProjections and EmailPreviews are essentially the same but have …

  • PageEmailProjection

    PageEmailProjection Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but …

  • PageExpiredInboxRecordProjecti …

    PageExpiredInboxRecordProjection Paginated expired inbox results. Page starts at zero. Projection results may omit …

  • PageGroupProjection

    PageGroupProjection Paginated missed email results. Page starts at zero. Projection results may omit larger entity …

  • PageInboxForwarderDto

    PageInboxForwarderDto Paginated inbox forwarder results. Page starts at zero. Projection results may omit larger entity …

  • PageInboxProjection

    PageInboxProjection Paginated inbox results. Page starts at zero. Projection results may omit larger entity fields. For …

  • PageInboxRulesetDto

    PageInboxRulesetDto Paginated inbox ruleset results. Page starts at zero. Projection results may omit larger entity …

  • PageMissedEmailProjection

    PageMissedEmailProjection Paginated MissedEmail results. Page starts at zero. Projection results may omit larger entity …

  • PageOrganizationInboxProjectio …

    PageOrganizationInboxProjection Paginated organization inbox results. Page starts at zero. Projection results may omit …

  • PageSentEmailProjection

    PageSentEmailProjection Paginated sent email results. Page starts at zero. Projection results may omit larger entity …

  • PageTemplateProjection

    PageTemplateProjection Paginated email template results. Page starts at zero. Projection results may omit larger entity …

  • PageThreadProjection

    PageThreadProjection Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Paginated TrackingPixel results. Page starts at zero. Projection results may omit larger …

  • PageUnknownMissedEmailProjecti …

    PageUnknownMissedEmailProjection Paginated unknown MissedEmail results. Unknown missed emails are emails that were sent …

  • PageWebhookProjection

    PageWebhookProjection Paginated webhook entity. Page starts at zero. Projection results may omit larger entity fields. …

  • PageWebhookResult

    PageWebhookResult Paginated webhook results. Page starts at zero. Projection results may omit larger entity fields. For …

  • RawEmailJson

    RawEmailJson Content in raw format Properties Name Type Description Notes content String

  • Recipient

    Recipient Properties Name Type Description Notes emailAddress String name String [optional] rawValue …

  • ReplyToAliasEmailOptions

    ReplyToAliasEmailOptions Options for replying to an alias email using the alias inbox Properties Name Type …

  • ReplyToEmailOptions

    ReplyToEmailOptions Options for replying to email with API Properties Name Type Description Notes attachments …

  • SendEmailOptions

    SendEmailOptions Options for sending an email message from an inbox. You must provide one of: to, toGroup, or toContacts …

  • Sender

    Sender Properties Name Type Description Notes emailAddress String name String [optional] rawValue String …

  • SentEmailDto

    SentEmailDto Sent email details Properties Name Type Description Notes attachments List Array of IDs of …

  • SentEmailProjection

    SentEmailProjection Properties Name Type Description Notes attachments List bcc List bodyMD5Hash String …

  • SentEmailsControllerApi

    SentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • SetInboxFavouritedOptions

    SetInboxFavouritedOptions Options for setting inbox favourite state Properties Name Type Description Notes state …

  • SimpleSendEmailOptions

    SimpleSendEmailOptions Properties Name Type Description Notes body String Body of the email message. Supports …

  • Sort

    Sort Properties Name Type Description Notes empty Boolean [optional] sorted Boolean [optional] unsorted …

  • TemplateControllerApi

    TemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TemplateDto

    TemplateDto Properties Name Type Description Notes content String createdAt OffsetDateTime id UUID …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes createdAt OffsetDateTime id UUID name String …

  • TemplateVariable

    TemplateVariable Properties Name Type Description Notes name String variableType VariableTypeEnum Enum: …

  • TestNewInboxForwarderOptions

    TestNewInboxForwarderOptions Properties Name Type Description Notes inboxForwarderTestOptions …

  • TestNewInboxRulesetOptions

    TestNewInboxRulesetOptions Properties Name Type Description Notes inboxRulesetTestOptions InboxRulesetTestOptions …

  • ThreadProjection

    ThreadProjection A thread is a message thread created for a message received by an alias Properties Name Type …

  • TrackingControllerApi

    TrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes createdAt OffsetDateTime html String id UUID …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes createdAt OffsetDateTime id UUID inboxId …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes createdAt OffsetDateTime from String …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes count Long

  • UnseenErrorCountDto

    UnseenErrorCountDto Properties Name Type Description Notes count Long

  • UpdateAliasOptions

    UpdateAliasOptions Update an email alias Properties Name Type Description Notes name String Optional name for …

  • UpdateDomainOptions

    UpdateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to this domain …

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes contactIds List

  • UpdateInboxOptions

    UpdateInboxOptions Options for updating inbox properties Properties Name Type Description Notes description …

  • UploadAttachmentOptions

    UploadAttachmentOptions Options for uploading files for attachments. When sending emails with the API that require …

  • ValidationDto

    ValidationDto Response object for email validation operation Properties Name Type Description Notes emailId UUID …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes lineNumber Integer message String [optional]

  • VerifyEmailAddressOptions

    VerifyEmailAddressOptions Options for verifying that an email address exists at a remote mail server. Properties Name …

  • WaitForConditions

    WaitForConditions Conditions that a waitForXEmails endpoint operates on. The methods wait until given conditions are met …

  • WaitForControllerApi

    WaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description waitFor …

  • WebhookControllerApi

    WebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WebhookDto

    WebhookDto Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is …

  • WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email …

  • WebhookEmailReadPayload

    WebhookEmailReadPayload EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is …

  • WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an …

  • WebhookNewContactPayload

    WebhookNewContactPayload NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is …

  • WebhookProjection

    WebhookProjection Representation of a webhook Properties Name Type Description Notes createdAt OffsetDateTime …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes message String [optional] success Boolean …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes createdAt OffsetDateTime httpMethod HttpMethodEnum …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes headers Map<String, String> method MethodEnum …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes message String [optional] statusCode Integer …

  • WebhookTestResult

    WebhookTestResult Results of testing a webhook Properties Name Type Description Notes message String [optional] …

  • Docs

    MailSlurp JS Table of contents References default Enumerations AbstractWebhookPayloadEventNameEnum …

  • Classes

    Index AliasControllerApi AttachmentControllerApi BlobApiResponse BaseAPI BounceControllerApi BulkActionsControllerApi …

  • AliasControllerApi

    Class: AliasControllerApi Hierarchy BaseAPI ↳ AliasControllerApi Table of contents Constructors constructor …

  • AttachmentControllerApi

    Class: AttachmentControllerApi Hierarchy BaseAPI ↳ AttachmentControllerApi Table of contents Constructors …

  • BaseAPI

    Class: BaseAPI This is the base class for all generated API classes. Hierarchy BaseAPI ↳ AliasControllerApi ↳ …

  • BlobApiResponse

    Class: BlobApiResponse Table of contents Constructors constructor Properties raw Methods value Constructors …

  • BounceControllerApi

    Class: BounceControllerApi Hierarchy BaseAPI ↳ BounceControllerApi Table of contents Constructors constructor …

  • BulkActionsControllerApi

    Class: BulkActionsControllerApi Hierarchy BaseAPI ↳ BulkActionsControllerApi Table of contents Constructors …

  • CommonActionsControllerApi

    Class: CommonActionsControllerApi Hierarchy BaseAPI ↳ CommonActionsControllerApi Table of contents Constructors …

  • Configuration

    Class: Configuration Table of contents Constructors constructor Accessors accessToken apiKey basePath credentials …

  • ContactControllerApi

    Class: ContactControllerApi Hierarchy BaseAPI ↳ ContactControllerApi Table of contents Constructors constructor …

  • DomainControllerApi

    Class: DomainControllerApi Hierarchy BaseAPI ↳ DomainControllerApi Table of contents Constructors constructor …

  • EmailControllerApi

    Class: EmailControllerApi Hierarchy BaseAPI ↳ EmailControllerApi Table of contents Constructors constructor …

  • ExpiredControllerApi

    Class: ExpiredControllerApi Hierarchy BaseAPI ↳ ExpiredControllerApi Table of contents Constructors constructor …

  • ExportControllerApi

    Class: ExportControllerApi Hierarchy BaseAPI ↳ ExportControllerApi Table of contents Constructors constructor …

  • FormControllerApi

    Class: FormControllerApi Hierarchy BaseAPI ↳ FormControllerApi Table of contents Constructors constructor …

  • GroupControllerApi

    Class: GroupControllerApi Hierarchy BaseAPI ↳ GroupControllerApi Table of contents Constructors constructor …

  • InboxControllerApi

    Class: InboxControllerApi Hierarchy BaseAPI ↳ InboxControllerApi Table of contents Constructors constructor …

  • InboxForwarderControllerApi

    Class: InboxForwarderControllerApi Hierarchy BaseAPI ↳ InboxForwarderControllerApi Table of contents Constructors …

  • InboxRulesetControllerApi

    Class: InboxRulesetControllerApi Hierarchy BaseAPI ↳ InboxRulesetControllerApi Table of contents Constructors …

  • JSONApiResponse

    Class: JSONApiResponse Type parameters Name T Table of contents Constructors constructor Properties raw …

  • MailServerControllerApi

    Class: MailServerControllerApi Hierarchy BaseAPI ↳ MailServerControllerApi Table of contents Constructors …

  • MailSlurp

    Class: MailSlurp The official MailSlurp Javascript library. A wrapper around the MailSlurp REST API. Create an instance …

  • MissedEmailControllerApi

    Class: MissedEmailControllerApi Hierarchy BaseAPI ↳ MissedEmailControllerApi Table of contents Constructors …

  • RequiredError

    Class: RequiredError Hierarchy Error ↳ RequiredError Table of contents Constructors constructor Properties field …

  • SentEmailsControllerApi

    Class: SentEmailsControllerApi Hierarchy BaseAPI ↳ SentEmailsControllerApi Table of contents Constructors …

  • TemplateControllerApi

    Class: TemplateControllerApi Hierarchy BaseAPI ↳ TemplateControllerApi Table of contents Constructors constructor …

  • TextApiResponse

    Class: TextApiResponse Table of contents Constructors constructor Properties raw Methods value Constructors …

  • TrackingControllerApi

    Class: TrackingControllerApi Hierarchy BaseAPI ↳ TrackingControllerApi Table of contents Constructors constructor …

  • VoidApiResponse

    Class: VoidApiResponse Table of contents Constructors constructor Properties raw Methods value Constructors …

  • WaitForControllerApi

    Class: WaitForControllerApi Hierarchy BaseAPI ↳ WaitForControllerApi Table of contents Constructors constructor …

  • WebhookControllerApi

    Class: WebhookControllerApi Hierarchy BaseAPI ↳ WebhookControllerApi Table of contents Constructors constructor …

  • Enums

    Index AbstractWebhookPayloadEventNameEnum ConditionOptionConditionEnum ConditionOptionValueEnum …

  • AbstractWebhookPayloadEventNam …

    Enumeration: AbstractWebhookPayloadEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • ConditionOptionConditionEnum

    Enumeration: ConditionOptionConditionEnum export Table of contents Enumeration members HAS_ATTACHMENTS Enumeration …

  • ConditionOptionValueEnum

    Enumeration: ConditionOptionValueEnum export Table of contents Enumeration members FALSE TRUE Enumeration members …

  • CreateDomainOptionsDomainTypeE …

    Enumeration: CreateDomainOptionsDomainTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_DOMAIN …

  • CreateInboxDtoInboxTypeEnum

    Enumeration: CreateInboxDtoInboxTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_INBOX …

  • CreateInboxForwarderOptionsFie …

    Enumeration: CreateInboxForwarderOptionsFieldEnum export Table of contents Enumeration members ATTACHMENTS RECIPIENTS …

  • CreateInboxInboxTypeEnum

    Enumeration: CreateInboxInboxTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_INBOX Enumeration …

  • CreateInboxRulesetOptionsActio …

    Enumeration: CreateInboxRulesetOptionsActionEnum export Table of contents Enumeration members ALLOW BLOCK FILTER_REMOVE …

  • CreateInboxRulesetOptionsScope …

    Enumeration: CreateInboxRulesetOptionsScopeEnum export Table of contents Enumeration members RECEIVING_EMAILS …

  • CreateNewEmailAddress1InboxTyp …

    Enumeration: CreateNewEmailAddress1InboxTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_INBOX …

  • CreateNewEmailAddressInboxType …

    Enumeration: CreateNewEmailAddressInboxTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_INBOX …

  • CreateWebhookOptionsEventNameE …

    Enumeration: CreateWebhookOptionsEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • DNSLookupOptionsRecordTypesEnu …

    Enumeration: DNSLookupOptionsRecordTypesEnum export Table of contents Enumeration members A A6 AAAA AFSDB AMTRELAY ANY …

  • DNSLookupResultRecordTypeEnum

    Enumeration: DNSLookupResultRecordTypeEnum export Table of contents Enumeration members A A6 AAAA AFSDB AMTRELAY ANY …

  • DomainDtoDomainTypeEnum

    Enumeration: DomainDtoDomainTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_DOMAIN Enumeration …

  • DomainNameRecordRecordTypeEnum

    Enumeration: DomainNameRecordRecordTypeEnum export Table of contents Enumeration members A A6 AAAA AFSDB AMTRELAY ANY …

  • DomainPreviewDomainTypeEnum

    Enumeration: DomainPreviewDomainTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_DOMAIN …

  • ExportEntitiesExportTypeEnum

    Enumeration: ExportEntitiesExportTypeEnum export Table of contents Enumeration members ATTACHMENTS CONTACTS EMAILS …

  • ExportEntitiesOutputFormatEnum

    Enumeration: ExportEntitiesOutputFormatEnum export Table of contents Enumeration members DEFAULT EXCEL Enumeration …

  • ExportOptionsOutputFormatEnum

    Enumeration: ExportOptionsOutputFormatEnum export Table of contents Enumeration members DEFAULT EXCEL Enumeration …

  • GetAliasEmailsSortEnum

    Enumeration: GetAliasEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetAliasesSortEnum

    Enumeration: GetAliasesSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • ASC = …

  • GetAliasThreadsSortEnum

    Enumeration: GetAliasThreadsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetAllContactsSortEnum

    Enumeration: GetAllContactsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetAllGroupsSortEnum

    Enumeration: GetAllGroupsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • ASC …

  • GetAllInboxesSortEnum

    Enumeration: GetAllInboxesSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • ASC …

  • GetAllMissedEmailsSortEnum

    Enumeration: GetAllMissedEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC …

  • GetAllSentTrackingPixelsSortEn …

    Enumeration: GetAllSentTrackingPixelsSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • GetAllTemplatesSortEnum

    Enumeration: GetAllTemplatesSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetAllTrackingPixelsSortEnum

    Enumeration: GetAllTrackingPixelsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members …

  • GetAllUnknownMissedEmailsSortE …

    Enumeration: GetAllUnknownMissedEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • GetAllWebhookResultsSortEnum

    Enumeration: GetAllWebhookResultsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members …

  • GetAllWebhooksSortEnum

    Enumeration: GetAllWebhooksSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetAttachmentsSortEnum

    Enumeration: GetAttachmentsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetBouncedEmailsSortEnum

    Enumeration: GetBouncedEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetBouncedRecipientsSortEnum

    Enumeration: GetBouncedRecipientsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members …

  • GetEmailsPaginatedSortEnum

    Enumeration: GetEmailsPaginatedSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC …

  • GetEmailsSortEnum

    Enumeration: GetEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • ASC = …

  • GetExpiredInboxesSortEnum

    Enumeration: GetExpiredInboxesSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetExportLinkExportTypeEnum

    Enumeration: GetExportLinkExportTypeEnum export Table of contents Enumeration members ATTACHMENTS CONTACTS EMAILS …

  • GetGroupWithContactsPaginatedS …

    Enumeration: GetGroupWithContactsPaginatedSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • GetInboxEmailsPaginatedSortEnu …

    Enumeration: GetInboxEmailsPaginatedSortEnum export Table of contents Enumeration members ASC DESC Enumeration members …

  • GetInboxesSortEnum

    Enumeration: GetInboxesSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • ASC = …

  • GetInboxForwardersSortEnum

    Enumeration: GetInboxForwardersSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC …

  • GetInboxRulesetsSortEnum

    Enumeration: GetInboxRulesetsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • GetInboxSentEmailsSortEnum

    Enumeration: GetInboxSentEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC …

  • GetInboxWebhooksPaginatedSortE …

    Enumeration: GetInboxWebhooksPaginatedSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • GetOrganizationEmailsPaginated …

    Enumeration: GetOrganizationEmailsPaginatedSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • GetOrganizationInboxesSortEnum

    Enumeration: GetOrganizationInboxesSortEnum export Table of contents Enumeration members ASC DESC Enumeration members …

  • GetSentEmailsSortEnum

    Enumeration: GetSentEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • ASC …

  • GetSentEmailTrackingPixelsSort …

    Enumeration: GetSentEmailTrackingPixelsSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • GetSentOrganizationEmailsSortE …

    Enumeration: GetSentOrganizationEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • GetTestWebhookPayloadEventName …

    Enumeration: GetTestWebhookPayloadEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • GetWebhookResultsSortEnum

    Enumeration: GetWebhookResultsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • InboxForwarderDtoFieldEnum

    Enumeration: InboxForwarderDtoFieldEnum export Table of contents Enumeration members ATTACHMENTS RECIPIENTS SENDER …

  • InboxInboxTypeEnum

    Enumeration: InboxInboxTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_INBOX Enumeration members …

  • InboxPreviewInboxTypeEnum

    Enumeration: InboxPreviewInboxTypeEnum export Table of contents Enumeration members HTTP_INBOX SMTP_INBOX Enumeration …

  • InboxRulesetDtoActionEnum

    Enumeration: InboxRulesetDtoActionEnum export Table of contents Enumeration members ALLOW BLOCK FILTER_REMOVE …

  • InboxRulesetDtoHandlerEnum

    Enumeration: InboxRulesetDtoHandlerEnum export Table of contents Enumeration members EXCEPTION Enumeration members …

  • InboxRulesetDtoScopeEnum

    Enumeration: InboxRulesetDtoScopeEnum export Table of contents Enumeration members RECEIVING_EMAILS SENDING_EMAILS …

  • ListInboxRulesetsSortEnum

    Enumeration: ListInboxRulesetsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • ListInboxTrackingPixelsSortEnu …

    Enumeration: ListInboxTrackingPixelsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members …

  • MatchOptionFieldEnum

    Enumeration: MatchOptionFieldEnum export Table of contents Enumeration members BCC CC FROM SUBJECT TO Enumeration …

  • MatchOptionShouldEnum

    Enumeration: MatchOptionShouldEnum export Table of contents Enumeration members CONTAIN EQUAL Enumeration members …

  • OrganizationInboxProjectionInb …

    Enumeration: OrganizationInboxProjectionInboxTypeEnum export Table of contents Enumeration members HTTP_INBOX …

  • ReplyToAliasEmailOptionsSendSt …

    Enumeration: ReplyToAliasEmailOptionsSendStrategyEnum export Table of contents Enumeration members SINGLE_MESSAGE …

  • ReplyToEmailOptionsSendStrateg …

    Enumeration: ReplyToEmailOptionsSendStrategyEnum export Table of contents Enumeration members SINGLE_MESSAGE …

  • SendEmailOptionsSendStrategyEn …

    Enumeration: SendEmailOptionsSendStrategyEnum export Table of contents Enumeration members SINGLE_MESSAGE Enumeration …

  • TemplateVariableVariableTypeEn …

    Enumeration: TemplateVariableVariableTypeEnum export Table of contents Enumeration members STRING Enumeration members …

  • WaitForConditionsCountTypeEnum

    Enumeration: WaitForConditionsCountTypeEnum export Table of contents Enumeration members ATLEAST EXACTLY Enumeration …

  • WaitForConditionsSortDirection …

    Enumeration: WaitForConditionsSortDirectionEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • WaitForEmailCountSortEnum

    Enumeration: WaitForEmailCountSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • WaitForLatestEmailSortEnum

    Enumeration: WaitForLatestEmailSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC …

  • WaitForMatchingEmailsSortEnum

    Enumeration: WaitForMatchingEmailsSortEnum export Table of contents Enumeration members ASC DESC Enumeration members …

  • WaitForMatchingFirstEmailSortE …

    Enumeration: WaitForMatchingFirstEmailSortEnum export Table of contents Enumeration members ASC DESC Enumeration …

  • WaitForNthEmailSortEnum

    Enumeration: WaitForNthEmailSortEnum export Table of contents Enumeration members ASC DESC Enumeration members ASC • …

  • WebhookDtoEventNameEnum

    Enumeration: WebhookDtoEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • WebhookDtoMethodEnum

    Enumeration: WebhookDtoMethodEnum export Table of contents Enumeration members DELETE GET HEAD OPTIONS PATCH POST PUT …

  • WebhookEmailOpenedPayloadEvent …

    Enumeration: WebhookEmailOpenedPayloadEventNameEnum export Table of contents Enumeration members EMAIL_OPENED …

  • WebhookEmailReadPayloadEventNa …

    Enumeration: WebhookEmailReadPayloadEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • WebhookNewAttachmentPayloadEve …

    Enumeration: WebhookNewAttachmentPayloadEventNameEnum export Table of contents Enumeration members EMAIL_OPENED …

  • WebhookNewContactPayloadEventN …

    Enumeration: WebhookNewContactPayloadEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • WebhookNewEmailPayloadEventNam …

    Enumeration: WebhookNewEmailPayloadEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • WebhookProjectionEventNameEnum

    Enumeration: WebhookProjectionEventNameEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • WebhookResultDtoHttpMethodEnum

    Enumeration: WebhookResultDtoHttpMethodEnum export Table of contents Enumeration members DELETE GET HEAD OPTIONS PATCH …

  • WebhookResultDtoResultTypeEnum

    Enumeration: WebhookResultDtoResultTypeEnum export Table of contents Enumeration members BAD_RESPONSE EXCEPTION SUCCESS …

  • WebhookResultDtoWebhookEventEn …

    Enumeration: WebhookResultDtoWebhookEventEnum export Table of contents Enumeration members EMAIL_OPENED EMAIL_READ …

  • WebhookTestRequestMethodEnum

    Enumeration: WebhookTestRequestMethodEnum export Table of contents Enumeration members DELETE GET HEAD OPTIONS PATCH …

  • Interfaces

    Index AbstractWebhookPayload AddContactsToGroupRequest AddDomainWildcardCatchAllRequest AliasDto AliasProjection …

  • AbstractWebhookPayload

    Interface: AbstractWebhookPayload Abstract webhook payload. Use the correct payload type for your webhook event type in …

  • AddContactsToGroupRequest

    Interface: AddContactsToGroupRequest Table of contents Properties groupId updateGroupContactsOption Properties groupId …

  • AddDomainWildcardCatchAllReque …

    Interface: AddDomainWildcardCatchAllRequest Table of contents Properties id Properties id • id: string

  • AliasDto

    Interface: AliasDto Email alias representation export interface AliasDto Table of contents Properties createdAt …

  • AliasProjection

    Interface: AliasProjection Representation of a alias export interface AliasProjection Table of contents Properties …

  • ApiResponse

    Interface: ApiResponse Type parameters Name T Table of contents Properties raw Methods value Properties …

  • AttachmentEntity

    Interface: AttachmentEntity export interface AttachmentEntity Table of contents Properties attachmentId contentLength …

  • AttachmentMetaData

    Interface: AttachmentMetaData Meta data associated with an attachment. Attachments are stored as byte blobs so the meta …

  • AttachmentProjection

    Interface: AttachmentProjection export interface AttachmentProjection Table of contents Properties attachmentId …

  • BasicAuthOptions

    Interface: BasicAuthOptions Basic Authentication options for webhooks. Will be used is present when calling webhook …

  • BouncedEmailDto

    Interface: BouncedEmailDto Bounced email export interface BouncedEmailDto Table of contents Properties bounceMta …

  • BouncedRecipientDto

    Interface: BouncedRecipientDto Bounced recipient export interface BouncedRecipientDto Table of contents Properties …

  • BounceProjection

    Interface: BounceProjection export interface BounceProjection Table of contents Properties createdAt id sender …

  • BounceRecipient

    Interface: BounceRecipient export interface BounceRecipient Table of contents Properties createdAt id recipient …

  • BulkCreateInboxesRequest

    Interface: BulkCreateInboxesRequest Table of contents Properties count Properties count • count: number

  • BulkDeleteInboxesRequest

    Interface: BulkDeleteInboxesRequest Table of contents Properties ids Properties ids • ids: string[]

  • BulkSendEmailOptions

    Interface: BulkSendEmailOptions Options for bulk sending an email from multiple addresses. See regular sendEmail methods …

  • BulkSendEmailsRequest

    Interface: BulkSendEmailsRequest Table of contents Properties bulkSendEmailOptions Properties bulkSendEmailOptions • …

  • ConditionOption

    Interface: ConditionOption Options for matching emails in an inbox based on a condition such as HAS_ATTACHMENTS=TRUE …

  • ConfigurationParameters

    Interface: ConfigurationParameters Table of contents Properties accessToken apiKey basePath credentials fetchApi …

  • Consume

    Interface: Consume Table of contents Properties contentType Properties contentType • contentType: string

  • ContactDto

    Interface: ContactDto export interface ContactDto Table of contents Properties company createdAt emailAddresses …

  • ContactProjection

    Interface: ContactProjection export interface ContactProjection Table of contents Properties company createdAt …

  • ContentMatchOptions

    Interface: ContentMatchOptions Options for matching content using regex patterns based on Java Pattern syntax export …

  • CreateAliasOptions

    Interface: CreateAliasOptions Create email alias options. Email aliases can be used to mask real email addresses behind …

  • CreateAliasRequest

    Interface: CreateAliasRequest Table of contents Properties createAliasOptions Properties createAliasOptions • …

  • CreateContactOptions

    Interface: CreateContactOptions export interface CreateContactOptions Table of contents Properties company …

  • CreateContactRequest

    Interface: CreateContactRequest Table of contents Properties createContactOptions Properties createContactOptions • …

  • CreateDomainOptions

    Interface: CreateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to …

  • CreateDomainRequest

    Interface: CreateDomainRequest Table of contents Properties domainOptions Properties domainOptions • domainOptions: …

  • CreateGroupOptions

    Interface: CreateGroupOptions export interface CreateGroupOptions Table of contents Properties description name …

  • CreateGroupRequest

    Interface: CreateGroupRequest Table of contents Properties createGroupOptions Properties createGroupOptions • …

  • CreateInboxDto

    Interface: CreateInboxDto Options for creating an inbox. An inbox has a real email address that can send and receive …

  • CreateInboxForwarderOptions

    Interface: CreateInboxForwarderOptions Options for creating an inbox forwarder export interface …

  • CreateInboxRequest

    Interface: CreateInboxRequest Table of contents Properties allowTeamAccess description emailAddress expiresAt expiresIn …

  • CreateInboxRulesetOptions

    Interface: CreateInboxRulesetOptions Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, …

  • CreateInboxRulesetRequest

    Interface: CreateInboxRulesetRequest Table of contents Properties createInboxRulesetOptions inboxId Properties …

  • CreateInboxWithOptionsRequest

    Interface: CreateInboxWithOptionsRequest Table of contents Properties createInboxDto Properties createInboxDto • …

  • CreateNewEmailAddress1Request

    Interface: CreateNewEmailAddress1Request Table of contents Properties allowTeamAccess description emailAddress …

  • CreateNewEmailAddressRequest

    Interface: CreateNewEmailAddressRequest Table of contents Properties allowTeamAccess description emailAddress expiresAt …

  • CreateNewInboxForwarderRequest

    Interface: CreateNewInboxForwarderRequest Table of contents Properties createInboxForwarderOptions inboxId Properties …

  • CreateNewInboxRulesetRequest

    Interface: CreateNewInboxRulesetRequest Table of contents Properties createInboxRulesetOptions inboxId Properties …

  • CreateTemplateOptions

    Interface: CreateTemplateOptions export interface CreateTemplateOptions Table of contents Properties content name …

  • CreateTemplateRequest

    Interface: CreateTemplateRequest Table of contents Properties createTemplateOptions Properties createTemplateOptions • …

  • CreateTrackingPixelOptions

    Interface: CreateTrackingPixelOptions export interface CreateTrackingPixelOptions Table of contents Properties name …

  • CreateTrackingPixelRequest

    Interface: CreateTrackingPixelRequest Table of contents Properties createTrackingPixelOptions Properties …

  • CreateWebhookOptions

    Interface: CreateWebhookOptions Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will …

  • CreateWebhookRequest

    Interface: CreateWebhookRequest Table of contents Properties inboxId webhookOptions Properties inboxId • inboxId: …

  • DeleteAliasRequest

    Interface: DeleteAliasRequest Table of contents Properties aliasId Properties aliasId • aliasId: string

  • DeleteAttachmentRequest

    Interface: DeleteAttachmentRequest Table of contents Properties attachmentId Properties attachmentId • attachmentId: …

  • DeleteContactRequest

    Interface: DeleteContactRequest Table of contents Properties contactId Properties contactId • contactId: string

  • DeleteDomainRequest

    Interface: DeleteDomainRequest Table of contents Properties id Properties id • id: string

  • DeleteEmailRequest

    Interface: DeleteEmailRequest Table of contents Properties emailId Properties emailId • emailId: string

  • DeleteGroupRequest

    Interface: DeleteGroupRequest Table of contents Properties groupId Properties groupId • groupId: string

  • DeleteInboxForwarderRequest

    Interface: DeleteInboxForwarderRequest Table of contents Properties id Properties id • id: string

  • DeleteInboxForwardersRequest

    Interface: DeleteInboxForwardersRequest Table of contents Properties inboxId Properties inboxId • Optional inboxId: …

  • DeleteInboxRequest

    Interface: DeleteInboxRequest Table of contents Properties inboxId Properties inboxId • inboxId: string

  • DeleteInboxRulesetRequest

    Interface: DeleteInboxRulesetRequest Table of contents Properties id Properties id • id: string

  • DeleteInboxRulesetsRequest

    Interface: DeleteInboxRulesetsRequest Table of contents Properties inboxId Properties inboxId • Optional inboxId: …

  • DeleteTemplateRequest

    Interface: DeleteTemplateRequest Table of contents Properties templateId Properties templateId • templateId: string

  • DeleteWebhookRequest

    Interface: DeleteWebhookRequest Table of contents Properties inboxId webhookId Properties inboxId • inboxId: string …

  • DescribeDomainOptions

    Interface: DescribeDomainOptions export interface DescribeDomainOptions Table of contents Properties domain Properties …

  • DescribeMailServerDomainReques …

    Interface: DescribeMailServerDomainRequest Table of contents Properties describeOptions Properties describeOptions • …

  • DescribeMailServerDomainResult

    Interface: DescribeMailServerDomainResult Name Server lookup result export interface DescribeMailServerDomainResult …

  • DNSLookupOptions

    Interface: DNSLookupOptions Options for DNS query. export interface DNSLookupOptions Table of contents Properties …

  • DNSLookupResult

    Interface: DNSLookupResult DNS lookup result. Includes record type, time to live, raw response, and name value for the …

  • DNSLookupResults

    Interface: DNSLookupResults Results of query on domain name servers export interface DNSLookupResults Table of contents …

  • DoesInboxExistRequest

    Interface: DoesInboxExistRequest Table of contents Properties emailAddress Properties emailAddress • emailAddress: …

  • DomainDto

    Interface: DomainDto Domain plus verification records and status export interface DomainDto Table of contents Properties …

  • DomainNameRecord

    Interface: DomainNameRecord DNS Record required for verification of a domain. Record vary depending on domain type. …

  • DomainPreview

    Interface: DomainPreview Preview object for domain entity export interface DomainPreview Table of contents Properties …

  • DownloadAttachmentAsBase64Enco …

    Interface: DownloadAttachmentAsBase64EncodedRequest Table of contents Properties attachmentId Properties attachmentId …

  • DownloadAttachmentAsBytesReque …

    Interface: DownloadAttachmentAsBytesRequest Table of contents Properties attachmentId Properties attachmentId • …

  • DownloadAttachmentBase64Reques …

    Interface: DownloadAttachmentBase64Request Table of contents Properties attachmentId emailId Properties attachmentId • …

  • DownloadAttachmentDto

    Interface: DownloadAttachmentDto Content of attachment export interface DownloadAttachmentDto Table of contents …

  • DownloadAttachmentRequest

    Interface: DownloadAttachmentRequest Table of contents Properties apiKey attachmentId emailId Properties apiKey • …

  • DownloadBodyBytesRequest

    Interface: DownloadBodyBytesRequest Table of contents Properties emailId Properties emailId • emailId: string

  • DownloadBodyRequest

    Interface: DownloadBodyRequest Table of contents Properties emailId Properties emailId • emailId: string

  • Email

    Interface: Email Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is …

  • EmailAnalysis

    Interface: EmailAnalysis Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic error …

  • EmailContentMatchResult

    Interface: EmailContentMatchResult Matches for the given pattern export interface EmailContentMatchResult Table of …

  • EmailLinksResult

    Interface: EmailLinksResult Links found in HTML export interface EmailLinksResult Table of contents Properties body …

  • EmailPreview

    Interface: EmailPreview Preview of an email message. For full message (including body and attachments) call the getEmail …

  • EmailProjection

    Interface: EmailProjection A compact representation of a full email. Used in list endpoints to keep response sizes low. …

  • EmailRecipients

    Interface: EmailRecipients export interface EmailRecipients Table of contents Properties bcc cc to Properties bcc • …

  • EmailTextLinesResult

    Interface: EmailTextLinesResult Parsed text of an email export interface EmailTextLinesResult Table of contents …

  • EmailVerificationResult

    Interface: EmailVerificationResult Email verification result. Valid means email address exists according to response …

  • EmptyInboxRequest

    Interface: EmptyInboxRequest Table of contents Properties inboxId Properties inboxId • inboxId: string

  • ExpirationDefaults

    Interface: ExpirationDefaults Expiration defaults for your account export interface ExpirationDefaults Table of contents …

  • ExpiredInboxDto

    Interface: ExpiredInboxDto Expired inbox export interface ExpiredInboxDto Table of contents Properties emailAddress id …

  • ExpiredInboxRecordProjection

    Interface: ExpiredInboxRecordProjection export interface ExpiredInboxRecordProjection Table of contents Properties …

  • ExportEntitiesRequest

    Interface: ExportEntitiesRequest Table of contents Properties apiKey createdEarliestTime createdOldestTime …

  • ExportLink

    Interface: ExportLink Export download link export interface ExportLink Table of contents Properties downloadLink …

  • ExportOptions

    Interface: ExportOptions Options for exporting user data export interface ExportOptions Table of contents Properties …

  • FetchParams

    Interface: FetchParams Table of contents Properties init url Properties init • init: RequestInit url • url: string

  • FlushExpiredInboxesResult

    Interface: FlushExpiredInboxesResult export interface FlushExpiredInboxesResult Table of contents Properties …

  • FlushExpiredRequest

    Interface: FlushExpiredRequest Table of contents Properties before Properties before • Optional before: Date

  • ForwardEmailOptions

    Interface: ForwardEmailOptions Options for forwarding an email export interface ForwardEmailOptions Table of contents …

  • ForwardEmailRequest

    Interface: ForwardEmailRequest Table of contents Properties emailId forwardEmailOptions Properties emailId • emailId: …

  • GetAliasEmailsRequest

    Interface: GetAliasEmailsRequest Table of contents Properties aliasId before page since size sort Properties aliasId • …

  • GetAliasesRequest

    Interface: GetAliasesRequest Table of contents Properties before page since size sort Properties before • Optional …

  • GetAliasRequest

    Interface: GetAliasRequest Table of contents Properties aliasId Properties aliasId • aliasId: string

  • GetAliasThreadsRequest

    Interface: GetAliasThreadsRequest Table of contents Properties aliasId before page since size sort Properties aliasId …

  • GetAllContactsRequest

    Interface: GetAllContactsRequest Table of contents Properties before page since size sort Properties before • Optional …

  • GetAllGroupsRequest

    Interface: GetAllGroupsRequest Table of contents Properties before page since size sort Properties before • Optional …

  • GetAllInboxesRequest

    Interface: GetAllInboxesRequest Table of contents Properties before favourite page search since size sort tag …

  • GetAllMissedEmailsRequest

    Interface: GetAllMissedEmailsRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • GetAllSentTrackingPixelsReques …

    Interface: GetAllSentTrackingPixelsRequest Table of contents Properties before page searchFilter since size sort …

  • GetAllTemplatesRequest

    Interface: GetAllTemplatesRequest Table of contents Properties before page since size sort Properties before • …

  • GetAllTrackingPixelsRequest

    Interface: GetAllTrackingPixelsRequest Table of contents Properties before page searchFilter since size sort …

  • GetAllUnknownMissedEmailsReque …

    Interface: GetAllUnknownMissedEmailsRequest Table of contents Properties before inboxId page searchFilter since size …

  • GetAllWebhookResultsRequest

    Interface: GetAllWebhookResultsRequest Table of contents Properties before page searchFilter since size sort unseenOnly …

  • GetAllWebhooksRequest

    Interface: GetAllWebhooksRequest Table of contents Properties before page searchFilter since size sort Properties …

  • GetAttachmentInfoRequest

    Interface: GetAttachmentInfoRequest Table of contents Properties attachmentId Properties attachmentId • attachmentId: …

  • GetAttachmentMetaDataRequest

    Interface: GetAttachmentMetaDataRequest Table of contents Properties attachmentId emailId Properties attachmentId • …

  • GetAttachmentRequest

    Interface: GetAttachmentRequest Table of contents Properties attachmentId Properties attachmentId • attachmentId: …

  • GetAttachments1Request

    Interface: GetAttachments1Request Table of contents Properties emailId Properties emailId • emailId: string

  • GetAttachmentsRequest

    Interface: GetAttachmentsRequest Table of contents Properties before fileNameFilter page since size sort Properties …

  • GetBouncedEmailRequest

    Interface: GetBouncedEmailRequest Table of contents Properties id Properties id • id: string

  • GetBouncedEmailsRequest

    Interface: GetBouncedEmailsRequest Table of contents Properties before page since size sort Properties before • …

  • GetBouncedRecipientRequest

    Interface: GetBouncedRecipientRequest Table of contents Properties id Properties id • id: string

  • GetBouncedRecipientsRequest

    Interface: GetBouncedRecipientsRequest Table of contents Properties before page since size sort Properties before • …

  • GetContactRequest

    Interface: GetContactRequest Table of contents Properties contactId Properties contactId • contactId: string

  • GetContactVCardRequest

    Interface: GetContactVCardRequest Table of contents Properties contactId Properties contactId • contactId: string

  • GetDnsLookupRequest

    Interface: GetDnsLookupRequest Table of contents Properties dnsLookupOptions Properties dnsLookupOptions • …

  • GetDomainRequest

    Interface: GetDomainRequest Table of contents Properties id Properties id • id: string

  • GetEmailContentMatchRequest

    Interface: GetEmailContentMatchRequest Table of contents Properties contentMatchOptions emailId Properties …

  • GetEmailHTMLQueryRequest

    Interface: GetEmailHTMLQueryRequest Table of contents Properties emailId htmlSelector Properties emailId • emailId: …

  • GetEmailHTMLRequest

    Interface: GetEmailHTMLRequest Table of contents Properties decode emailId Properties decode • Optional decode: …

  • GetEmailLinksRequest

    Interface: GetEmailLinksRequest Table of contents Properties emailId Properties emailId • emailId: string

  • GetEmailRequest

    Interface: GetEmailRequest Table of contents Properties decode emailId Properties decode • Optional decode: boolean …

  • GetEmailsPaginatedRequest

    Interface: GetEmailsPaginatedRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • GetEmailsRequest

    Interface: GetEmailsRequest Table of contents Properties before delayTimeout inboxId limit minCount retryTimeout since …

  • GetEmailTextLinesRequest

    Interface: GetEmailTextLinesRequest Table of contents Properties decodeHtmlEntities emailId lineSeparator Properties …

  • GetExpiredInboxByInboxIdReques …

    Interface: GetExpiredInboxByInboxIdRequest Table of contents Properties inboxId Properties inboxId • inboxId: string

  • GetExpiredInboxesRequest

    Interface: GetExpiredInboxesRequest Table of contents Properties before page since size sort Properties before • …

  • GetExpiredInboxRecordRequest

    Interface: GetExpiredInboxRecordRequest Table of contents Properties expiredId Properties expiredId • expiredId: …

  • GetExportLinkRequest

    Interface: GetExportLinkRequest Table of contents Properties apiKey exportOptions exportType Properties apiKey • …

  • GetGravatarUrlForEmailAddressR …

    Interface: GetGravatarUrlForEmailAddressRequest Table of contents Properties emailAddress size Properties emailAddress …

  • GetGroupRequest

    Interface: GetGroupRequest Table of contents Properties groupId Properties groupId • groupId: string

  • GetGroupWithContactsPaginatedR …

    Interface: GetGroupWithContactsPaginatedRequest Table of contents Properties before groupId page since size sort …

  • GetGroupWithContactsRequest

    Interface: GetGroupWithContactsRequest Table of contents Properties groupId Properties groupId • groupId: string

  • GetInboxEmailsPaginatedRequest

    Interface: GetInboxEmailsPaginatedRequest Table of contents Properties before inboxId page since size sort Properties …

  • GetInboxesRequest

    Interface: GetInboxesRequest Table of contents Properties before since size sort Properties before • Optional before: …

  • GetInboxForwarderRequest

    Interface: GetInboxForwarderRequest Table of contents Properties id Properties id • id: string

  • GetInboxForwardersRequest

    Interface: GetInboxForwardersRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • GetInboxRequest

    Interface: GetInboxRequest Table of contents Properties inboxId Properties inboxId • inboxId: string

  • GetInboxRulesetRequest

    Interface: GetInboxRulesetRequest Table of contents Properties id Properties id • id: string

  • GetInboxRulesetsRequest

    Interface: GetInboxRulesetsRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • GetInboxSentEmailsRequest

    Interface: GetInboxSentEmailsRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • GetInboxWebhooksPaginatedReque …

    Interface: GetInboxWebhooksPaginatedRequest Table of contents Properties before inboxId page searchFilter since size …

  • GetIpAddressRequest

    Interface: GetIpAddressRequest Table of contents Properties name Properties name • name: string

  • GetJsonSchemaForWebhookPayload …

    Interface: GetJsonSchemaForWebhookPayloadRequest Table of contents Properties webhookId Properties webhookId • …

  • GetLatestEmailInInboxRequest

    Interface: GetLatestEmailInInboxRequest Table of contents Properties inboxId Properties inboxId • Optional inboxId: …

  • GetLatestEmailRequest

    Interface: GetLatestEmailRequest Table of contents Properties inboxIds Properties inboxIds • Optional inboxIds: …

  • GetMissedEmailRequest

    Interface: GetMissedEmailRequest Table of contents Properties missedEmailId Properties missedEmailId • missedEmailId: …

  • GetOrganizationEmailsPaginated …

    Interface: GetOrganizationEmailsPaginatedRequest Table of contents Properties before inboxId page searchFilter since …

  • GetOrganizationInboxesRequest

    Interface: GetOrganizationInboxesRequest Table of contents Properties before page searchFilter since size sort …

  • GetRawEmailContentsRequest

    Interface: GetRawEmailContentsRequest Table of contents Properties emailId Properties emailId • emailId: string

  • GetRawEmailJsonRequest

    Interface: GetRawEmailJsonRequest Table of contents Properties emailId Properties emailId • emailId: string

  • GetSentEmailHTMLContentRequest

    Interface: GetSentEmailHTMLContentRequest Table of contents Properties id Properties id • id: string

  • GetSentEmailRequest

    Interface: GetSentEmailRequest Table of contents Properties id Properties id • id: string

  • GetSentEmailsRequest

    Interface: GetSentEmailsRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • GetSentEmailTrackingPixelsRequ …

    Interface: GetSentEmailTrackingPixelsRequest Table of contents Properties before id page searchFilter since size sort …

  • GetSentOrganizationEmailsReque …

    Interface: GetSentOrganizationEmailsRequest Table of contents Properties before inboxId page searchFilter since size …

  • GetTemplateRequest

    Interface: GetTemplateRequest Table of contents Properties templateId Properties templateId • templateId: string

  • GetTestWebhookPayloadForWebhoo …

    Interface: GetTestWebhookPayloadForWebhookRequest Table of contents Properties webhookId Properties webhookId • …

  • GetTestWebhookPayloadRequest

    Interface: GetTestWebhookPayloadRequest Table of contents Properties eventName Properties eventName • Optional …

  • GetTrackingPixelRequest

    Interface: GetTrackingPixelRequest Table of contents Properties id Properties id • id: string

  • GetWebhookRequest

    Interface: GetWebhookRequest Table of contents Properties webhookId Properties webhookId • webhookId: string

  • GetWebhookResultRequest

    Interface: GetWebhookResultRequest Table of contents Properties webhookResultId Properties webhookResultId • …

  • GetWebhookResultsRequest

    Interface: GetWebhookResultsRequest Table of contents Properties before page searchFilter since size sort unseenOnly …

  • GetWebhookResultsUnseenErrorCo …

    Interface: GetWebhookResultsUnseenErrorCountRequest Table of contents Properties inboxId Properties inboxId • inboxId: …

  • GetWebhooksRequest

    Interface: GetWebhooksRequest Table of contents Properties inboxId Properties inboxId • inboxId: string

  • GravatarUrl

    Interface: GravatarUrl export interface GravatarUrl Table of contents Properties hash url Properties hash • hash: …

  • GroupContactsDto

    Interface: GroupContactsDto export interface GroupContactsDto Table of contents Properties contacts group Properties …

  • GroupDto

    Interface: GroupDto export interface GroupDto Table of contents Properties createdAt description id name Properties …

  • GroupProjection

    Interface: GroupProjection export interface GroupProjection Table of contents Properties createdAt description id name …

  • HTMLValidationResult

    Interface: HTMLValidationResult HTML Validation Results export interface HTMLValidationResult Table of contents …

  • Inbox

    Interface: Inbox Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to …

  • InboxExistsDto

    Interface: InboxExistsDto export interface InboxExistsDto Table of contents Properties _exists Properties _exists • …

  • InboxForwarderDto

    Interface: InboxForwarderDto export interface InboxForwarderDto Table of contents Properties createdAt field …

  • InboxForwarderTestOptions

    Interface: InboxForwarderTestOptions export interface InboxForwarderTestOptions Table of contents Properties testValue …

  • InboxForwarderTestResult

    Interface: InboxForwarderTestResult export interface InboxForwarderTestResult Table of contents Properties doesMatch …

  • InboxPreview

    Interface: InboxPreview export interface InboxPreview Table of contents Properties createdAt emailAddress expiresAt …

  • InboxRulesetDto

    Interface: InboxRulesetDto export interface InboxRulesetDto Table of contents Properties action createdAt handler id …

  • InboxRulesetTestOptions

    Interface: InboxRulesetTestOptions export interface InboxRulesetTestOptions Table of contents Properties testTarget …

  • InboxRulesetTestResult

    Interface: InboxRulesetTestResult export interface InboxRulesetTestResult Table of contents Properties matches …

  • IPAddressResult

    Interface: IPAddressResult IP Address look up result for a given domain / hostname export interface IPAddressResult …

  • JSONSchemaDto

    Interface: JSONSchemaDto export interface JSONSchemaDto Table of contents Properties value Properties value • value: …

  • ListInboxRulesetsRequest

    Interface: ListInboxRulesetsRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • ListInboxTrackingPixelsRequest

    Interface: ListInboxTrackingPixelsRequest Table of contents Properties before inboxId page searchFilter since size sort …

  • MarkAsReadRequest

    Interface: MarkAsReadRequest Table of contents Properties emailId read Properties emailId • emailId: string read • …

  • MatchOption

    Interface: MatchOption Options for matching emails in an inbox. Each match option object contains a field, should and …

  • MatchOptions

    Interface: MatchOptions Optional filter for matching emails based on fields. For instance filter results to only include …

  • Middleware

    Interface: Middleware Table of contents Methods post pre Methods post ▸ Optional post(context): Promise<void | …

  • MissedEmail

    Interface: MissedEmail export interface MissedEmail Table of contents Properties attachmentCount bcc bodyExcerpt cc …

  • MissedEmailProjection

    Interface: MissedEmailProjection export interface MissedEmailProjection Table of contents Properties createdAt from id …

  • NameServerRecord

    Interface: NameServerRecord Name Server Record export interface NameServerRecord Table of contents Properties priority …

  • OrganizationInboxProjection

    Interface: OrganizationInboxProjection export interface OrganizationInboxProjection Table of contents Properties …

  • Pageable

    Interface: Pageable export interface Pageable Table of contents Properties offset pageNumber pageSize paged sort …

  • PageAlias

    Interface: PageAlias Paginated email alias results. Page starts at zero. Projection results may omit larger entity …

  • PageAttachmentEntity

    Interface: PageAttachmentEntity Paginated attachment entity results. Page starts at zero. Projection results may omit …

  • PageBouncedEmail

    Interface: PageBouncedEmail Paginated bounced email. Page starts at zero. Projection results may omit larger entity …

  • PageBouncedRecipients

    Interface: PageBouncedRecipients Paginated bounced recipients. Page starts at zero. Projection results may omit larger …

  • PageContactProjection

    Interface: PageContactProjection Paginated contact results. Page starts at zero. Projection results may omit larger …

  • PageEmailPreview

    Interface: PageEmailPreview Paginated email preview results. EmailProjections and EmailPreviews are essentially the same …

  • PageEmailProjection

    Interface: PageEmailProjection Paginated email projection results. EmailProjections and EmailPreviews are essentially …

  • PageExpiredInboxRecordProjecti …

    Interface: PageExpiredInboxRecordProjection Paginated expired inbox results. Page starts at zero. Projection results may …

  • PageGroupProjection

    Interface: PageGroupProjection Paginated missed email results. Page starts at zero. Projection results may omit larger …

  • PageInboxForwarderDto

    Interface: PageInboxForwarderDto Paginated inbox forwarder results. Page starts at zero. Projection results may omit …

  • PageInboxProjection

    Interface: PageInboxProjection Paginated inbox results. Page starts at zero. Projection results may omit larger entity …

  • PageInboxRulesetDto

    Interface: PageInboxRulesetDto Paginated inbox ruleset results. Page starts at zero. Projection results may omit larger …

  • PageMissedEmailProjection

    Interface: PageMissedEmailProjection Paginated MissedEmail results. Page starts at zero. Projection results may omit …

  • PageOrganizationInboxProjectio …

    Interface: PageOrganizationInboxProjection Paginated organization inbox results. Page starts at zero. Projection results …

  • PageSentEmailProjection

    Interface: PageSentEmailProjection Paginated sent email results. Page starts at zero. Projection results may omit larger …

  • PageTemplateProjection

    Interface: PageTemplateProjection Paginated email template results. Page starts at zero. Projection results may omit …

  • PageThreadProjection

    Interface: PageThreadProjection Paginated email projection results. EmailProjections and EmailPreviews are essentially …

  • PageTrackingPixelProjection

    Interface: PageTrackingPixelProjection Paginated TrackingPixel results. Page starts at zero. Projection results may omit …

  • PageUnknownMissedEmailProjecti …

    Interface: PageUnknownMissedEmailProjection Paginated unknown MissedEmail results. Unknown missed emails are emails that …

  • PageWebhookProjection

    Interface: PageWebhookProjection Paginated webhook entity. Page starts at zero. Projection results may omit larger …

  • PageWebhookResult

    Interface: PageWebhookResult Paginated webhook results. Page starts at zero. Projection results may omit larger entity …

  • RawEmailJson

    Interface: RawEmailJson Content in raw format export interface RawEmailJson Table of contents Properties content …

  • Recipient

    Interface: Recipient export interface Recipient Table of contents Properties emailAddress name rawValue Properties …

  • RedriveWebhookResultRequest

    Interface: RedriveWebhookResultRequest Table of contents Properties webhookResultId Properties webhookResultId • …

  • RemoveContactsFromGroupRequest

    Interface: RemoveContactsFromGroupRequest Table of contents Properties groupId updateGroupContactsOption Properties …

  • ReplyToAliasEmailOptions

    Interface: ReplyToAliasEmailOptions Options for replying to an alias email using the alias inbox export interface …

  • ReplyToAliasEmailRequest

    Interface: ReplyToAliasEmailRequest Table of contents Properties aliasId emailId replyToAliasEmailOptions Properties …

  • ReplyToEmailOptions

    Interface: ReplyToEmailOptions Options for replying to email with API export interface ReplyToEmailOptions Table of …

  • ReplyToEmailRequest

    Interface: ReplyToEmailRequest Table of contents Properties emailId replyToEmailOptions Properties emailId • emailId: …

  • RequestContext

    Interface: RequestContext Table of contents Properties fetch init url Properties fetch • fetch: (input: RequestInfo, …

  • RequestOpts

    Interface: RequestOpts Table of contents Properties body headers method path query Properties body • Optional body: …

  • ResponseContext

    Interface: ResponseContext Table of contents Properties fetch init response url Properties fetch • fetch: (input: …

  • ResponseTransformer

    Interface: ResponseTransformer Type parameters Name T Callable ResponseTransformer ▸ …

  • Result

    Interface: Result Type parameters Name T Table of contents Properties content error Properties content • …

  • SendAliasEmailRequest

    Interface: SendAliasEmailRequest Table of contents Properties aliasId sendEmailOptions Properties aliasId • aliasId: …

  • SendEmailAndConfirmRequest

    Interface: SendEmailAndConfirmRequest Table of contents Properties inboxId sendEmailOptions Properties inboxId • …

  • SendEmailOptions

    Interface: SendEmailOptions Options for sending an email message from an inbox. You must provide one of: to, toGroup, or …

  • SendEmailRequest

    Interface: SendEmailRequest Table of contents Properties inboxId sendEmailOptions Properties inboxId • inboxId: string …

  • SendEmailSimpleRequest

    Interface: SendEmailSimpleRequest Table of contents Properties emailOptions Properties emailOptions • emailOptions: …

  • SendEmailSourceOptionalRequest

    Interface: SendEmailSourceOptionalRequest Table of contents Properties inboxId sendEmailOptions useDomainPool …

  • Sender

    Interface: Sender export interface Sender Table of contents Properties emailAddress name rawValue Properties …

  • SendTestDataRequest

    Interface: SendTestDataRequest Table of contents Properties webhookId Properties webhookId • webhookId: string

  • SendTestEmailRequest

    Interface: SendTestEmailRequest Table of contents Properties inboxId Properties inboxId • inboxId: string

  • SentEmailDto

    Interface: SentEmailDto Sent email details export interface SentEmailDto Table of contents Properties attachments bcc …

  • SentEmailProjection

    Interface: SentEmailProjection export interface SentEmailProjection Table of contents Properties attachments bcc …

  • SetInboxFavouritedOptions

    Interface: SetInboxFavouritedOptions Options for setting inbox favourite state export interface …

  • SetInboxFavouritedRequest

    Interface: SetInboxFavouritedRequest Table of contents Properties inboxId setInboxFavouritedOptions Properties inboxId …

  • SimpleSendEmailOptions

    Interface: SimpleSendEmailOptions export interface SimpleSendEmailOptions Table of contents Properties body senderId …

  • Sort

    Interface: Sort export interface Sort Table of contents Properties empty sorted unsorted Properties empty • Optional …

  • SubmitFormRequest

    Interface: SubmitFormRequest Table of contents Properties emailAddress otherParameters redirectTo spamCheck subject …

  • TemplateDto

    Interface: TemplateDto export interface TemplateDto Table of contents Properties content createdAt id name variables …

  • TemplateProjection

    Interface: TemplateProjection export interface TemplateProjection Table of contents Properties createdAt id name …

  • TemplateVariable

    Interface: TemplateVariable export interface TemplateVariable Table of contents Properties name variableType …

  • TestInboxForwarderRequest

    Interface: TestInboxForwarderRequest Table of contents Properties id inboxForwarderTestOptions Properties id • id: …

  • TestInboxForwardersForInboxReq …

    Interface: TestInboxForwardersForInboxRequest Table of contents Properties inboxForwarderTestOptions inboxId …

  • TestInboxRulesetRequest

    Interface: TestInboxRulesetRequest Table of contents Properties id inboxRulesetTestOptions Properties id • id: string …

  • TestInboxRulesetsForInboxReque …

    Interface: TestInboxRulesetsForInboxRequest Table of contents Properties inboxId inboxRulesetTestOptions Properties …

  • TestNewInboxForwarderOptions

    Interface: TestNewInboxForwarderOptions export interface TestNewInboxForwarderOptions Table of contents Properties …

  • TestNewInboxForwarderRequest

    Interface: TestNewInboxForwarderRequest Table of contents Properties testNewInboxForwarderOptions Properties …

  • TestNewInboxRulesetOptions

    Interface: TestNewInboxRulesetOptions export interface TestNewInboxRulesetOptions Table of contents Properties …

  • TestNewInboxRulesetRequest

    Interface: TestNewInboxRulesetRequest Table of contents Properties testNewInboxRulesetOptions Properties …

  • ThreadProjection

    Interface: ThreadProjection A thread is a message thread created for a message received by an alias export interface …

  • TrackingPixelDto

    Interface: TrackingPixelDto export interface TrackingPixelDto Table of contents Properties createdAt html id inboxId …

  • TrackingPixelProjection

    Interface: TrackingPixelProjection export interface TrackingPixelProjection Table of contents Properties createdAt id …

  • UnknownMissedEmailProjection

    Interface: UnknownMissedEmailProjection export interface UnknownMissedEmailProjection Table of contents Properties …

  • UnreadCount

    Interface: UnreadCount export interface UnreadCount Table of contents Properties count Properties count • count: …

  • UnseenErrorCountDto

    Interface: UnseenErrorCountDto export interface UnseenErrorCountDto Table of contents Properties count Properties …

  • UpdateAliasOptions

    Interface: UpdateAliasOptions Update an email alias export interface UpdateAliasOptions Table of contents Properties …

  • UpdateAliasRequest

    Interface: UpdateAliasRequest Table of contents Properties aliasId updateAliasOptions Properties aliasId • aliasId: …

  • UpdateDomainOptions

    Interface: UpdateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to …

  • UpdateDomainRequest

    Interface: UpdateDomainRequest Table of contents Properties id updateDomainDto Properties id • id: string …

  • UpdateGroupContacts

    Interface: UpdateGroupContacts export interface UpdateGroupContacts Table of contents Properties contactIds Properties …

  • UpdateInboxOptions

    Interface: UpdateInboxOptions Options for updating inbox properties export interface UpdateInboxOptions Table of …

  • UpdateInboxRequest

    Interface: UpdateInboxRequest Table of contents Properties inboxId updateInboxOptions Properties inboxId • inboxId: …

  • UpdateTemplateRequest

    Interface: UpdateTemplateRequest Table of contents Properties createTemplateOptions templateId Properties …

  • UploadAttachmentBytesRequest

    Interface: UploadAttachmentBytesRequest Table of contents Properties byteArray contentType filename Properties …

  • UploadAttachmentOptions

    Interface: UploadAttachmentOptions Options for uploading files for attachments. When sending emails with the API that …

  • UploadAttachmentRequest

    Interface: UploadAttachmentRequest Table of contents Properties uploadOptions Properties uploadOptions • …

  • UploadMultipartFormRequest

    Interface: UploadMultipartFormRequest Table of contents Properties contentType file filename xFilename Properties …

  • ValidateEmailRequest

    Interface: ValidateEmailRequest Table of contents Properties emailId Properties emailId • emailId: string

  • ValidationDto

    Interface: ValidationDto Response object for email validation operation export interface ValidationDto Table of contents …

  • ValidationMessage

    Interface: ValidationMessage export interface ValidationMessage Table of contents Properties lineNumber message …

  • VerifyEmailAddressOptions

    Interface: VerifyEmailAddressOptions Options for verifying that an email address exists at a remote mail server. export …

  • VerifyEmailAddressRequest

    Interface: VerifyEmailAddressRequest Table of contents Properties verifyOptions Properties verifyOptions • …

  • WaitForConditions

    Interface: WaitForConditions Conditions that a waitForXEmails endpoint operates on. The methods wait until given …

  • WaitForEmailCountRequest

    Interface: WaitForEmailCountRequest Table of contents Properties before count delay inboxId since sort timeout …

  • WaitForLatestEmailRequest

    Interface: WaitForLatestEmailRequest Table of contents Properties before delay inboxId since sort timeout unreadOnly …

  • WaitForMatchingEmailsRequest

    Interface: WaitForMatchingEmailsRequest Table of contents Properties before count delay inboxId matchOptions since sort …

  • WaitForMatchingFirstEmailReque …

    Interface: WaitForMatchingFirstEmailRequest Table of contents Properties before delay inboxId matchOptions since sort …

  • WaitForNthEmailRequest

    Interface: WaitForNthEmailRequest Table of contents Properties before delay inboxId since sort timeout unreadOnly …

  • WaitForNthMissedEmailRequest

    Interface: WaitForNthMissedEmailRequest Table of contents Properties before inboxId since timeout Properties before • …

  • WaitForRequest

    Interface: WaitForRequest Table of contents Properties waitForConditions Properties waitForConditions • Optional …

  • WebhookDto

    Interface: WebhookDto Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an …

  • WebhookEmailOpenedPayload

    Interface: WebhookEmailOpenedPayload EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when …

  • WebhookEmailReadPayload

    Interface: WebhookEmailReadPayload EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an …

  • WebhookNewAttachmentPayload

    Interface: WebhookNewAttachmentPayload NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST …

  • WebhookNewContactPayload

    Interface: WebhookNewContactPayload NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an …

  • WebhookNewEmailPayload

    Interface: WebhookNewEmailPayload NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an …

  • WebhookProjection

    Interface: WebhookProjection Representation of a webhook export interface WebhookProjection Table of contents Properties …

  • WebhookRedriveResult

    Interface: WebhookRedriveResult export interface WebhookRedriveResult Table of contents Properties message success …

  • WebhookResultDto

    Interface: WebhookResultDto export interface WebhookResultDto Table of contents Properties createdAt httpMethod id …

  • WebhookTestRequest

    Interface: WebhookTestRequest export interface WebhookTestRequest Table of contents Properties headers method payload …

  • WebhookTestResponse

    Interface: WebhookTestResponse export interface WebhookTestResponse Table of contents Properties message statusCode …

  • WebhookTestResult

    Interface: WebhookTestResult Results of testing a webhook export interface WebhookTestResult Table of contents …

  • _index.archive

    MailSlurp Javascript Client Create real email addresses on demand. Send and receive emails and attachments from code …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    AbstractWebhookPayload Properties Name Type Description Notes eventName inline messageId kotlin.String …

  • AliasControllerApi

    AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description createAlias …

  • AliasDto

    AliasDto Properties Name Type Description Notes id java.util.UUID userId java.util.UUID createdAt …

  • AliasProjection

    AliasProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime emailAddress …

  • AttachmentControllerApi

    AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AttachmentEntity

    AttachmentEntity Properties Name Type Description Notes attachmentId kotlin.String createdAt …

  • AttachmentMetaData

    AttachmentMetaData Properties Name Type Description Notes contentLength kotlin.Long Size of attachment in bytes …

  • AttachmentProjection

    AttachmentProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime updatedAt …

  • BasicAuthOptions

    BasicAuthOptions Properties Name Type Description Notes username kotlin.String password kotlin.String

  • BounceControllerApi

    BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BouncedEmailDto

    BouncedEmailDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime notificationType …

  • BouncedRecipientDto

    BouncedRecipientDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime recipient …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime sender …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes createdAt java.time.OffsetDateTime recipient …

  • BulkActionsControllerApi

    BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BulkSendEmailOptions

    BulkSendEmailOptions Properties Name Type Description Notes inboxIds …

  • CommonActionsControllerApi

    CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ConditionOption

    ConditionOption Properties Name Type Description Notes condition inline The condition to evaluate against the …

  • ContactControllerApi

    ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ContactDto

    ContactDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime emailAddresses …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id java.util.UUID …

  • ContentMatchOptions

    ContentMatchOptions Properties Name Type Description Notes pattern kotlin.String Java style regex pattern. Do not …

  • CountDto

    CountDto Properties Name Type Description Notes totalElements kotlin.Long

  • CreateAliasOptions

    CreateAliasOptions Properties Name Type Description Notes emailAddress kotlin.String Email address to be hidden …

  • CreateContactOptions

    CreateContactOptions Properties Name Type Description Notes emailAddresses …

  • CreateDomainOptions

    CreateDomainOptions Properties Name Type Description Notes createdCatchAllInbox kotlin.Boolean Whether to create …

  • CreateGroupOptions

    CreateGroupOptions Properties Name Type Description Notes name kotlin.String description kotlin.String …

  • CreateInboxDto

    CreateInboxDto Properties Name Type Description Notes allowTeamAccess kotlin.Boolean DEPRECATED (team access is …

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Properties Name Type Description Notes field inline Field to match against to trigger …

  • CreateInboxRulesetOptions

    CreateInboxRulesetOptions Properties Name Type Description Notes action inline Action to be taken when the …

  • CreateTemplateOptions

    CreateTemplateOptions Properties Name Type Description Notes name kotlin.String content kotlin.String

  • CreateTrackingPixelOptions

    CreateTrackingPixelOptions Properties Name Type Description Notes name kotlin.String [optional] recipient …

  • CreateWebhookOptions

    CreateWebhookOptions Properties Name Type Description Notes basicAuth BasicAuthOptions [optional] eventName …

  • DescribeDomainOptions

    DescribeDomainOptions Properties Name Type Description Notes domain kotlin.String

  • DescribeMailServerDomainResult

    DescribeMailServerDomainResult Properties Name Type Description Notes domain kotlin.String mxRecords …

  • DNSLookupOptions

    DNSLookupOptions Properties Name Type Description Notes hostname kotlin.String List of record types you wish to …

  • DNSLookupResult

    DNSLookupResult Properties Name Type Description Notes name kotlin.String recordEntries …

  • DNSLookupResults

    DNSLookupResults Properties Name Type Description Notes results kotlin.collections.List

  • DomainControllerApi

    DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • DomainDto

    DomainDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime id java.util.UUID …

  • DomainNameRecord

    DomainNameRecord Properties Name Type Description Notes name kotlin.String recordEntries …

  • DomainPreview

    DomainPreview Properties Name Type Description Notes createdAt java.time.OffsetDateTime domain kotlin.String …

  • DownloadAttachmentDto

    DownloadAttachmentDto Properties Name Type Description Notes base64FileContents kotlin.String Base64 encoded …

  • Email

    Email Properties Name Type Description Notes analysis EmailAnalysis [optional] attachments …

  • EmailAnalysis

    EmailAnalysis Properties Name Type Description Notes dkimVerdict kotlin.String Verdict of DomainKeys Identified …

  • EmailContentMatchResult

    EmailContentMatchResult Properties Name Type Description Notes matches …

  • EmailControllerApi

    EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • EmailLinksResult

    EmailLinksResult Properties Name Type Description Notes body kotlin.String links …

  • EmailPreview

    EmailPreview Properties Name Type Description Notes attachments kotlin.collections.List<kotlin.String> List …

  • EmailProjection

    EmailProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id java.util.UUID …

  • EmailRecipients

    EmailRecipients Properties Name Type Description Notes bcc kotlin.collections.List [optional] cc …

  • EmailTextLinesResult

    EmailTextLinesResult Properties Name Type Description Notes body kotlin.String lines …

  • EmailVerificationResult

    EmailVerificationResult Properties Name Type Description Notes domainName kotlin.String emailAddress …

  • ExpirationDefaults

    ExpirationDefaults Properties Name Type Description Notes canPermanentInbox kotlin.Boolean …

  • ExpiredControllerApi

    ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExpiredInboxDto

    ExpiredInboxDto Properties Name Type Description Notes emailAddress kotlin.String id java.util.UUID …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime …

  • ExportControllerApi

    ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExportLink

    ExportLink Properties Name Type Description Notes downloadLink kotlin.String

  • ExportOptions

    ExportOptions Properties Name Type Description Notes outputFormat inline excludePreviouslyExported …

  • FlushExpiredInboxesResult

    FlushExpiredInboxesResult Properties Name Type Description Notes expireBefore java.time.OffsetDateTime …

  • FormControllerApi

    FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description submitForm …

  • ForwardEmailOptions

    ForwardEmailOptions Properties Name Type Description Notes bcc kotlin.collections.List<kotlin.String> …

  • GravatarUrl

    GravatarUrl Properties Name Type Description Notes hash kotlin.String url kotlin.String

  • GroupContactsDto

    GroupContactsDto Properties Name Type Description Notes contacts kotlin.collections.List group GroupDto

  • GroupControllerApi

    GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • GroupDto

    GroupDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime id java.util.UUID name …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id java.util.UUID …

  • HTMLValidationResult

    HTMLValidationResult Properties Name Type Description Notes errors kotlin.collections.List Optional errors …

  • Inbox

    Inbox Properties Name Type Description Notes createdAt java.time.OffsetDateTime When the inbox was created. Time …

  • InboxControllerApi

    InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description createInbox …

  • InboxExistsDto

    InboxExistsDto Properties Name Type Description Notes exists kotlin.Boolean

  • InboxForwarderControllerApi

    InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime field inline …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes testValue kotlin.String

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes doesMatch kotlin.Boolean matches …

  • InboxPreview

    InboxPreview Properties Name Type Description Notes createdAt java.time.OffsetDateTime When the inbox was …

  • InboxRulesetControllerApi

    InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes action inline createdAt java.time.OffsetDateTime …

  • InboxRulesetTestOptions

    InboxRulesetTestOptions Properties Name Type Description Notes testTarget kotlin.String

  • InboxRulesetTestResult

    InboxRulesetTestResult Properties Name Type Description Notes matches kotlin.Boolean rulesetMatches …

  • IPAddressResult

    IPAddressResult Properties Name Type Description Notes address kotlin.String hostname kotlin.String

  • JSONSchemaDto

    JSONSchemaDto Properties Name Type Description Notes value kotlin.String

  • MailServerControllerApi

    MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MatchOption

    MatchOption Properties Name Type Description Notes field inline The email property to match on. One of SUBJECT, …

  • MatchOptions

    MatchOptions Properties Name Type Description Notes conditions kotlin.collections.List Zero or more conditions …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes attachmentCount kotlin.Int bcc …

  • MissedEmailControllerApi

    MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MissedEmailProjection

    MissedEmailProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id …

  • NameServerRecord

    NameServerRecord Properties Name Type Description Notes priority kotlin.String raw kotlin.String …

  • OrganizationInboxProjection

    OrganizationInboxProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime When the …

  • Pageable

    Pageable Properties Name Type Description Notes offset kotlin.Long [optional] pageNumber kotlin.Int …

  • PageAlias

    PageAlias Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageAttachmentEntity

    PageAttachmentEntity Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageBouncedEmail

    PageBouncedEmail Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageBouncedRecipients

    PageBouncedRecipients Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageContactProjection

    PageContactProjection Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageEmailPreview

    PageEmailPreview Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageEmailProjection

    PageEmailProjection Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageExpiredInboxRecordProjecti …

    PageExpiredInboxRecordProjection Properties Name Type Description Notes content kotlin.collections.List …

  • PageGroupProjection

    PageGroupProjection Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageInboxForwarderDto

    PageInboxForwarderDto Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageInboxProjection

    PageInboxProjection Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageInboxRulesetDto

    PageInboxRulesetDto Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageMissedEmailProjection

    PageMissedEmailProjection Properties Name Type Description Notes content kotlin.collections.List [optional] …

  • PageOrganizationInboxProjectio …

    PageOrganizationInboxProjection Properties Name Type Description Notes content kotlin.collections.List …

  • PageSentEmailProjection

    PageSentEmailProjection Properties Name Type Description Notes content kotlin.collections.List Collection of …

  • PageTemplateProjection

    PageTemplateProjection Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageThreadProjection

    PageThreadProjection Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Properties Name Type Description Notes content kotlin.collections.List [optional] …

  • PageUnknownMissedEmailProjecti …

    PageUnknownMissedEmailProjection Properties Name Type Description Notes content kotlin.collections.List …

  • PageWebhookProjection

    PageWebhookProjection Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • PageWebhookResult

    PageWebhookResult Properties Name Type Description Notes content kotlin.collections.List [optional] empty …

  • RawEmailJson

    RawEmailJson Properties Name Type Description Notes content kotlin.String

  • Recipient

    Recipient Properties Name Type Description Notes emailAddress kotlin.String rawValue kotlin.String name …

  • ReplyToAliasEmailOptions

    ReplyToAliasEmailOptions Properties Name Type Description Notes attachments …

  • ReplyToEmailOptions

    ReplyToEmailOptions Properties Name Type Description Notes attachments …

  • SendEmailOptions

    SendEmailOptions Properties Name Type Description Notes addTrackingPixel kotlin.Boolean Add tracking pixel to …

  • Sender

    Sender Properties Name Type Description Notes emailAddress kotlin.String rawValue kotlin.String name …

  • SentEmailDto

    SentEmailDto Properties Name Type Description Notes sentAt java.time.OffsetDateTime attachments …

  • SentEmailProjection

    SentEmailProjection Properties Name Type Description Notes attachments …

  • SentEmailsControllerApi

    SentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • SetInboxFavouritedOptions

    SetInboxFavouritedOptions Properties Name Type Description Notes state kotlin.Boolean Is the inbox a favorite. …

  • SimpleSendEmailOptions

    SimpleSendEmailOptions Properties Name Type Description Notes body kotlin.String Body of the email message. …

  • Sort

    Sort Properties Name Type Description Notes empty kotlin.Boolean [optional] sorted kotlin.Boolean [optional] …

  • TemplateControllerApi

    TemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TemplateDto

    TemplateDto Properties Name Type Description Notes content kotlin.String createdAt java.time.OffsetDateTime …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id …

  • TemplateVariable

    TemplateVariable Properties Name Type Description Notes name kotlin.String variableType inline Enum: …

  • TestNewInboxForwarderOptions

    TestNewInboxForwarderOptions Properties Name Type Description Notes inboxForwarderTestOptions …

  • TestNewInboxRulesetOptions

    TestNewInboxRulesetOptions Properties Name Type Description Notes inboxRulesetTestOptions InboxRulesetTestOptions …

  • ThreadProjection

    ThreadProjection Properties Name Type Description Notes aliasId java.util.UUID createdAt …

  • TrackingControllerApi

    TrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime html kotlin.String …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes count kotlin.Long

  • UnseenErrorCountDto

    UnseenErrorCountDto Properties Name Type Description Notes count kotlin.Long

  • UpdateAliasOptions

    UpdateAliasOptions Properties Name Type Description Notes name kotlin.String Optional name for alias [optional] …

  • UpdateDomainOptions

    UpdateDomainOptions Properties Name Type Description Notes catchAllInboxId java.util.UUID [optional]

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes contactIds …

  • UpdateInboxOptions

    UpdateInboxOptions Properties Name Type Description Notes description kotlin.String Description of an inbox for …

  • UploadAttachmentOptions

    UploadAttachmentOptions Properties Name Type Description Notes base64Contents kotlin.String Base64 encoded string …

  • ValidationDto

    ValidationDto Properties Name Type Description Notes emailId java.util.UUID ID of the email validated [optional] …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes lineNumber kotlin.Int message kotlin.String …

  • VerifyEmailAddressOptions

    VerifyEmailAddressOptions Properties Name Type Description Notes emailAddress kotlin.String mailServerDomain …

  • WaitForConditions

    WaitForConditions Properties Name Type Description Notes inboxId java.util.UUID ID of inbox to search within and …

  • WaitForControllerApi

    WaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description waitFor …

  • WebhookControllerApi

    WebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WebhookDto

    WebhookDto Properties Name Type Description Notes updatedAt java.time.OffsetDateTime basicAuth kotlin.Boolean …

  • WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload Properties Name Type Description Notes createdAt java.time.OffsetDateTime Date time of …

  • WebhookEmailReadPayload

    WebhookEmailReadPayload Properties Name Type Description Notes createdAt java.time.OffsetDateTime Date time of …

  • WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload Properties Name Type Description Notes attachmentId kotlin.String ID of attachment. …

  • WebhookNewContactPayload

    WebhookNewContactPayload Properties Name Type Description Notes contactId java.util.UUID createdAt …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload Properties Name Type Description Notes attachmentMetaDatas kotlin.collections.List List of …

  • WebhookProjection

    WebhookProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime id java.util.UUID …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes success kotlin.Boolean webhookResultId …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes createdAt java.time.OffsetDateTime httpMethod inline …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes headers kotlin.collections.Map<kotlin.String, …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes message kotlin.String [optional] statusCode …

  • WebhookTestResult

    WebhookTestResult Properties Name Type Description Notes request WebhookTestRequest response …

  • Docs

    Index OAI OAIAbstractWebhookPayload OAIAliasControllerApi OAIAliasDto OAIAliasProjection OAIAttachmentMetaData …

  • OAI

    OAI MailSlurp OAI is a general prefix in MailSlurp’s objective C code.

  • OAIAbstractWebhookPayload

    OAIAbstractWebhookPayload Properties Name Type Description Notes eventName NSString* messageId NSString* …

  • OAIAliasControllerApi

    OAIAliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIAliasDto

    OAIAliasDto Properties Name Type Description Notes createdAt NSDate* [optional] emailAddress NSString* The …

  • OAIAliasProjection

    OAIAliasProjection Properties Name Type Description Notes createdAt NSDate* emailAddress NSString* _id …

  • OAIAttachmentControllerApi

    OAIAttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIAttachmentEntity

    OAIAttachmentEntity Properties Name Type Description Notes attachmentId NSString* contentLength NSNumber* …

  • OAIAttachmentMetaData

    OAIAttachmentMetaData Properties Name Type Description Notes contentLength NSNumber* Size of attachment in bytes …

  • OAIAttachmentProjection

    OAIAttachmentProjection Properties Name Type Description Notes attachmentId NSString* Attachment ID [optional] …

  • OAIBasicAuthOptions

    OAIBasicAuthOptions Properties Name Type Description Notes username NSString* password NSString* [Back …

  • OAIBounceControllerApi

    OAIBounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIBouncedEmailDto

    OAIBouncedEmailDto Properties Name Type Description Notes bounceMta NSString* [optional] bounceRecipients …

  • OAIBouncedRecipientDto

    OAIBouncedRecipientDto Properties Name Type Description Notes createdAt NSDate* _id NSString* [optional] …

  • OAIBounceProjection

    OAIBounceProjection Properties Name Type Description Notes createdAt NSDate* _id NSString* [optional] …

  • OAIBounceRecipient

    OAIBounceRecipient Properties Name Type Description Notes createdAt NSDate* _id NSString* [optional] …

  • OAIBulkActionsControllerApi

    OAIBulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIBulkSendEmailOptions

    OAIBulkSendEmailOptions Properties Name Type Description Notes inboxIds NSArray<NSString>** Inboxes to send …

  • OAICommonActionsControllerApi

    OAICommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIConditionOption

    OAIConditionOption Properties Name Type Description Notes condition NSString* The condition to evaluate against …

  • OAIContactControllerApi

    OAIContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIContactDto

    OAIContactDto Properties Name Type Description Notes company NSString* [optional] createdAt NSDate* …

  • OAIContactProjection

    OAIContactProjection Properties Name Type Description Notes company NSString* [optional] createdAt NSDate* …

  • OAIContentMatchOptions

    OAIContentMatchOptions Properties Name Type Description Notes pattern NSString* Java style regex pattern. Do not …

  • OAICountDto

    OAICountDto Properties Name Type Description Notes totalElements NSNumber* [Back to Model list] [Back to API …

  • OAICreateAliasOptions

    OAICreateAliasOptions Properties Name Type Description Notes emailAddress NSString* Email address to be hidden …

  • OAICreateContactOptions

    OAICreateContactOptions Properties Name Type Description Notes emailAddresses NSArray<NSString>** Set of …

  • OAICreateDomainOptions

    OAICreateDomainOptions Properties Name Type Description Notes createdCatchAllInbox NSNumber* Whether to create a …

  • OAICreateGroupOptions

    OAICreateGroupOptions Properties Name Type Description Notes name NSString* _description NSString* …

  • OAICreateInboxDto

    OAICreateInboxDto Properties Name Type Description Notes allowTeamAccess NSNumber* DEPRECATED (team access is …

  • OAICreateInboxForwarderOptions

    OAICreateInboxForwarderOptions Properties Name Type Description Notes field NSString* Field to match against to …

  • OAICreateInboxRulesetOptions

    OAICreateInboxRulesetOptions Properties Name Type Description Notes action NSString* Action to be taken when the …

  • OAICreateTemplateOptions

    OAICreateTemplateOptions Properties Name Type Description Notes name NSString* content NSString* [Back …

  • OAICreateTrackingPixelOptions

    OAICreateTrackingPixelOptions Properties Name Type Description Notes name NSString* [optional] recipient …

  • OAICreateWebhookOptions

    OAICreateWebhookOptions Properties Name Type Description Notes basicAuth OAIBasicAuthOptions* [optional] …

  • OAIDescribeDomainOptions

    OAIDescribeDomainOptions Properties Name Type Description Notes domain NSString* [Back to Model list] [Back …

  • OAIDescribeMailServerDomainRes …

    OAIDescribeMailServerDomainResult Properties Name Type Description Notes domain NSString* message NSString* …

  • OAIDNSLookupOptions

    OAIDNSLookupOptions Properties Name Type Description Notes hostname NSString* List of record types you wish to …

  • OAIDNSLookupResult

    OAIDNSLookupResult Properties Name Type Description Notes name NSString* recordEntries …

  • OAIDNSLookupResults

    OAIDNSLookupResults Properties Name Type Description Notes results NSArray* [Back to Model list] [Back to …

  • OAIDomainControllerApi

    OAIDomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIDomainDto

    OAIDomainDto Properties Name Type Description Notes catchAllInboxId NSString* The optional catch all inbox that …

  • OAIDomainNameRecord

    OAIDomainNameRecord Properties Name Type Description Notes name NSString* recordEntries …

  • OAIDomainPreview

    OAIDomainPreview Properties Name Type Description Notes catchAllInboxId NSString* [optional] createdAt NSDate* …

  • OAIDownloadAttachmentDto

    OAIDownloadAttachmentDto Properties Name Type Description Notes base64FileContents NSString* Base64 encoded …

  • OAIEmail

    OAIEmail Properties Name Type Description Notes analysis OAIEmailAnalysis* [optional] attachments …

  • OAIEmailAnalysis

    OAIEmailAnalysis Properties Name Type Description Notes dkimVerdict NSString* Verdict of DomainKeys Identified …

  • OAIEmailContentMatchResult

    OAIEmailContentMatchResult Properties Name Type Description Notes matches NSArray<NSString>** pattern …

  • OAIEmailControllerApi

    OAIEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIEmailLinksResult

    OAIEmailLinksResult Properties Name Type Description Notes body NSString* links NSArray<NSString>** …

  • OAIEmailPreview

    OAIEmailPreview Properties Name Type Description Notes attachments NSArray<NSString>** List of IDs of …

  • OAIEmailProjection

    OAIEmailProjection Properties Name Type Description Notes attachments NSArray<NSString>** [optional] bcc …

  • OAIEmailRecipients

    OAIEmailRecipients Properties Name Type Description Notes bcc NSArray* [optional] cc NSArray* [optional] to …

  • OAIEmailTextLinesResult

    OAIEmailTextLinesResult Properties Name Type Description Notes body NSString* lines NSArray<NSString>** …

  • OAIEmailVerificationResult

    OAIEmailVerificationResult Properties Name Type Description Notes domainName NSString* emailAddress NSString* …

  • OAIExpirationDefaults

    OAIExpirationDefaults Properties Name Type Description Notes canPermanentInbox NSNumber* …

  • OAIExpiredControllerApi

    OAIExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIExpiredInboxDto

    OAIExpiredInboxDto Properties Name Type Description Notes emailAddress NSString* _id NSString* inboxId …

  • OAIExpiredInboxRecordProjectio …

    OAIExpiredInboxRecordProjection Properties Name Type Description Notes createdAt NSDate* emailAddress …

  • OAIExportControllerApi

    OAIExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIExportLink

    OAIExportLink Properties Name Type Description Notes downloadLink NSString* [Back to Model list] [Back to …

  • OAIExportOptions

    OAIExportOptions Properties Name Type Description Notes outputFormat NSString* excludePreviouslyExported …

  • OAIFlushExpiredInboxesResult

    OAIFlushExpiredInboxesResult Properties Name Type Description Notes expireBefore NSDate* inboxIds …

  • OAIFormControllerApi

    OAIFormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIForwardEmailOptions

    OAIForwardEmailOptions Properties Name Type Description Notes bcc NSArray<NSString>** Optional bcc …

  • OAIGravatarUrl

    OAIGravatarUrl Properties Name Type Description Notes hash NSString* url NSString* [Back to Model list] …

  • OAIGroupContactsDto

    OAIGroupContactsDto Properties Name Type Description Notes contacts NSArray* group OAIGroupDto* [Back to …

  • OAIGroupControllerApi

    OAIGroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIGroupDto

    OAIGroupDto Properties Name Type Description Notes createdAt NSDate* _description NSString* [optional] _id …

  • OAIGroupProjection

    OAIGroupProjection Properties Name Type Description Notes createdAt NSDate* _description NSString* …

  • OAIHTMLValidationResult

    OAIHTMLValidationResult Properties Name Type Description Notes errors NSArray* Optional errors resulting from …

  • OAIInbox

    OAIInbox Properties Name Type Description Notes createdAt NSDate* When the inbox was created. Time stamps are in …

  • OAIInboxControllerApi

    OAIInboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIInboxExistsDto

    OAIInboxExistsDto Properties Name Type Description Notes exists NSNumber* [Back to Model list] [Back to API …

  • OAIInboxForwarderControllerApi

    OAIInboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIInboxForwarderDto

    OAIInboxForwarderDto Properties Name Type Description Notes createdAt NSDate* field NSString* …

  • OAIInboxForwarderTestOptions

    OAIInboxForwarderTestOptions Properties Name Type Description Notes testValue NSString* [Back to Model list] …

  • OAIInboxForwarderTestResult

    OAIInboxForwarderTestResult Properties Name Type Description Notes doesMatch NSNumber* matches …

  • OAIInboxPreview

    OAIInboxPreview Properties Name Type Description Notes createdAt NSDate* When the inbox was created. Time stamps …

  • OAIInboxRulesetControllerApi

    OAIInboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIInboxRulesetDto

    OAIInboxRulesetDto Properties Name Type Description Notes action NSString* createdAt NSDate* handler …

  • OAIInboxRulesetTestOptions

    OAIInboxRulesetTestOptions Properties Name Type Description Notes testTarget NSString* [Back to Model list] …

  • OAIInboxRulesetTestResult

    OAIInboxRulesetTestResult Properties Name Type Description Notes matches NSNumber* rulesetMatches …

  • OAIIPAddressResult

    OAIIPAddressResult Properties Name Type Description Notes address NSString* hostname NSString* [Back to …

  • OAIJSONSchemaDto

    OAIJSONSchemaDto Properties Name Type Description Notes value NSString* [Back to Model list] [Back to API …

  • OAIMailServerControllerApi

    OAIMailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIMatchOption

    OAIMatchOption Properties Name Type Description Notes field NSString* The email property to match on. One of …

  • OAIMatchOptions

    OAIMatchOptions Properties Name Type Description Notes conditions NSArray* Zero or more conditions such as { …

  • OAIMissedEmail

    OAIMissedEmail Properties Name Type Description Notes attachmentCount NSNumber* bcc NSArray<NSString>** …

  • OAIMissedEmailControllerApi

    OAIMissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIMissedEmailProjection

    OAIMissedEmailProjection Properties Name Type Description Notes createdAt NSDate* from NSString* [optional] …

  • OAINameServerRecord

    OAINameServerRecord Properties Name Type Description Notes priority NSString* raw NSString* recordType …

  • OAIOrganizationInboxProjection

    OAIOrganizationInboxProjection Properties Name Type Description Notes createdAt NSDate* When the inbox was …

  • OAIPageable

    OAIPageable Properties Name Type Description Notes offset NSNumber* [optional] pageNumber NSNumber* …

  • OAIPageAlias

    OAIPageAlias Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* [optional] …

  • OAIPageAttachmentEntity

    OAIPageAttachmentEntity Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageBouncedEmail

    OAIPageBouncedEmail Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageBouncedRecipients

    OAIPageBouncedRecipients Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageContactProjection

    OAIPageContactProjection Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageEmailPreview

    OAIPageEmailPreview Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageEmailProjection

    OAIPageEmailProjection Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageExpiredInboxRecordProje …

    OAIPageExpiredInboxRecordProjection Properties Name Type Description Notes content NSArray* [optional] empty …

  • OAIPageGroupProjection

    OAIPageGroupProjection Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageInboxForwarderDto

    OAIPageInboxForwarderDto Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageInboxProjection

    OAIPageInboxProjection Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageInboxRulesetDto

    OAIPageInboxRulesetDto Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageMissedEmailProjection

    OAIPageMissedEmailProjection Properties Name Type Description Notes content NSArray* [optional] empty …

  • OAIPageOrganizationInboxProjec …

    OAIPageOrganizationInboxProjection Properties Name Type Description Notes content NSArray* [optional] empty …

  • OAIPageSentEmailProjection

    OAIPageSentEmailProjection Properties Name Type Description Notes content NSArray* Collection of items [optional] …

  • OAIPageTemplateProjection

    OAIPageTemplateProjection Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageThreadProjection

    OAIPageThreadProjection Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageTrackingPixelProjection

    OAIPageTrackingPixelProjection Properties Name Type Description Notes content NSArray* [optional] empty …

  • OAIPageUnknownMissedEmailProje …

    OAIPageUnknownMissedEmailProjection Properties Name Type Description Notes content NSArray* [optional] empty …

  • OAIPageWebhookProjection

    OAIPageWebhookProjection Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIPageWebhookResult

    OAIPageWebhookResult Properties Name Type Description Notes content NSArray* [optional] empty NSNumber* …

  • OAIRawEmailJson

    OAIRawEmailJson Properties Name Type Description Notes content NSString* [Back to Model list] [Back to API …

  • OAIRecipient

    OAIRecipient Properties Name Type Description Notes emailAddress NSString* name NSString* [optional] …

  • OAIReplyToAliasEmailOptions

    OAIReplyToAliasEmailOptions Properties Name Type Description Notes attachments NSArray<NSString>** List of …

  • OAIReplyToEmailOptions

    OAIReplyToEmailOptions Properties Name Type Description Notes attachments NSArray<NSString>** List of …

  • OAISendEmailOptions

    OAISendEmailOptions Properties Name Type Description Notes addTrackingPixel NSNumber* Add tracking pixel to email …

  • OAISender

    OAISender Properties Name Type Description Notes emailAddress NSString* name NSString* [optional] rawValue …

  • OAISentEmailDto

    OAISentEmailDto Properties Name Type Description Notes attachments NSArray<NSString>** Array of IDs of …

  • OAISentEmailProjection

    OAISentEmailProjection Properties Name Type Description Notes attachments NSArray<NSString>** bcc …

  • OAISentEmailsControllerApi

    OAISentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAISetInboxFavouritedOptions

    OAISetInboxFavouritedOptions Properties Name Type Description Notes state NSNumber* Is the inbox a favorite. …

  • OAISimpleSendEmailOptions

    OAISimpleSendEmailOptions Properties Name Type Description Notes body NSString* Body of the email message. …

  • OAISort

    OAISort Properties Name Type Description Notes empty NSNumber* [optional] sorted NSNumber* [optional] …

  • OAITemplateControllerApi

    OAITemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAITemplateDto

    OAITemplateDto Properties Name Type Description Notes content NSString* createdAt NSDate* _id NSString* …

  • OAITemplateProjection

    OAITemplateProjection Properties Name Type Description Notes createdAt NSDate* _id NSString* name …

  • OAITemplateVariable

    OAITemplateVariable Properties Name Type Description Notes name NSString* variableType NSString* [Back …

  • OAITestNewInboxForwarderOption …

    OAITestNewInboxForwarderOptions Properties Name Type Description Notes inboxForwarderTestOptions …

  • OAITestNewInboxRulesetOptions

    OAITestNewInboxRulesetOptions Properties Name Type Description Notes inboxRulesetTestOptions …

  • OAIThreadProjection

    OAIThreadProjection Properties Name Type Description Notes aliasId NSString* bcc NSArray<NSString>** …

  • OAITrackingControllerApi

    OAITrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAITrackingPixelDto

    OAITrackingPixelDto Properties Name Type Description Notes createdAt NSDate* html NSString* _id NSString* …

  • OAITrackingPixelProjection

    OAITrackingPixelProjection Properties Name Type Description Notes createdAt NSDate* _id NSString* inboxId …

  • OAIUnknownMissedEmailProjectio …

    OAIUnknownMissedEmailProjection Properties Name Type Description Notes createdAt NSDate* from NSString* …

  • OAIUnreadCount

    OAIUnreadCount Properties Name Type Description Notes count NSNumber* [Back to Model list] [Back to API …

  • OAIUnseenErrorCountDto

    OAIUnseenErrorCountDto Properties Name Type Description Notes count NSNumber* [Back to Model list] [Back to …

  • OAIUpdateAliasOptions

    OAIUpdateAliasOptions Properties Name Type Description Notes name NSString* Optional name for alias [optional] …

  • OAIUpdateDomainOptions

    OAIUpdateDomainOptions Properties Name Type Description Notes catchAllInboxId NSString* [optional] [Back to …

  • OAIUpdateGroupContacts

    OAIUpdateGroupContacts Properties Name Type Description Notes contactIds NSArray<NSString>** [Back to …

  • OAIUpdateInboxOptions

    OAIUpdateInboxOptions Properties Name Type Description Notes _description NSString* Description of an inbox for …

  • OAIUploadAttachmentOptions

    OAIUploadAttachmentOptions Properties Name Type Description Notes base64Contents NSString* Base64 encoded string …

  • OAIValidationDto

    OAIValidationDto Properties Name Type Description Notes emailId NSString* ID of the email validated [optional] …

  • OAIValidationMessage

    OAIValidationMessage Properties Name Type Description Notes lineNumber NSNumber* message NSString* …

  • OAIVerifyEmailAddressOptions

    OAIVerifyEmailAddressOptions Properties Name Type Description Notes mailServerDomain NSString* [optional] …

  • OAIWaitForConditions

    OAIWaitForConditions Properties Name Type Description Notes before NSDate* ISO Date Time latest time of email to …

  • OAIWaitForControllerApi

    OAIWaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIWebhookControllerApi

    OAIWebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • OAIWebhookDto

    OAIWebhookDto Properties Name Type Description Notes basicAuth NSNumber* Does webhook expect basic …

  • OAIWebhookEmailOpenedPayload

    OAIWebhookEmailOpenedPayload Properties Name Type Description Notes createdAt NSDate* Date time of event creation …

  • OAIWebhookEmailReadPayload

    OAIWebhookEmailReadPayload Properties Name Type Description Notes createdAt NSDate* Date time of event creation …

  • OAIWebhookNewAttachmentPayload

    OAIWebhookNewAttachmentPayload Properties Name Type Description Notes attachmentId NSString* ID of attachment. …

  • OAIWebhookNewContactPayload

    OAIWebhookNewContactPayload Properties Name Type Description Notes company NSString* [optional] contactId …

  • OAIWebhookNewEmailPayload

    OAIWebhookNewEmailPayload Properties Name Type Description Notes attachmentMetaDatas NSArray* List of attachment …

  • OAIWebhookProjection

    OAIWebhookProjection Properties Name Type Description Notes createdAt NSDate* eventName NSString* [optional] …

  • OAIWebhookRedriveResult

    OAIWebhookRedriveResult Properties Name Type Description Notes message NSString* [optional] success NSNumber* …

  • OAIWebhookResultDto

    OAIWebhookResultDto Properties Name Type Description Notes createdAt NSDate* httpMethod NSString* _id …

  • OAIWebhookTestRequest

    OAIWebhookTestRequest Properties Name Type Description Notes headers NSDictionary<NSString, NSString>*** …

  • OAIWebhookTestResponse

    OAIWebhookTestResponse Properties Name Type Description Notes message NSString* [optional] statusCode …

  • OAIWebhookTestResult

    OAIWebhookTestResult Properties Name Type Description Notes message NSString* [optional] request …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    MailSlurp::Object::AbstractWebhookPayload Load the model package use MailSlurp::Object::AbstractWebhookPayload; …

  • AliasControllerApi

    MailSlurp::AliasControllerApi Load the API package use MailSlurp::Object::AliasControllerApi; All URIs are relative to …

  • AliasDto

    MailSlurp::Object::AliasDto Load the model package use MailSlurp::Object::AliasDto; Properties Name Type Description …

  • AliasProjection

    MailSlurp::Object::AliasProjection Load the model package use MailSlurp::Object::AliasProjection; Properties Name …

  • AttachmentControllerApi

    MailSlurp::AttachmentControllerApi Load the API package use MailSlurp::Object::AttachmentControllerApi; All URIs are …

  • AttachmentEntity

    MailSlurp::Object::AttachmentEntity Load the model package use MailSlurp::Object::AttachmentEntity; Properties Name …

  • AttachmentMetaData

    MailSlurp::Object::AttachmentMetaData Load the model package use MailSlurp::Object::AttachmentMetaData; Properties …

  • AttachmentProjection

    MailSlurp::Object::AttachmentProjection Load the model package use MailSlurp::Object::AttachmentProjection; Properties …

  • BasicAuthOptions

    MailSlurp::Object::BasicAuthOptions Load the model package use MailSlurp::Object::BasicAuthOptions; Properties Name …

  • BounceControllerApi

    MailSlurp::BounceControllerApi Load the API package use MailSlurp::Object::BounceControllerApi; All URIs are relative to …

  • BouncedEmailDto

    MailSlurp::Object::BouncedEmailDto Load the model package use MailSlurp::Object::BouncedEmailDto; Properties Name …

  • BouncedRecipientDto

    MailSlurp::Object::BouncedRecipientDto Load the model package use MailSlurp::Object::BouncedRecipientDto; Properties …

  • BounceProjection

    MailSlurp::Object::BounceProjection Load the model package use MailSlurp::Object::BounceProjection; Properties Name …

  • BounceRecipient

    MailSlurp::Object::BounceRecipient Load the model package use MailSlurp::Object::BounceRecipient; Properties Name …

  • BulkActionsControllerApi

    MailSlurp::BulkActionsControllerApi Load the API package use MailSlurp::Object::BulkActionsControllerApi; All URIs are …

  • BulkSendEmailOptions

    MailSlurp::Object::BulkSendEmailOptions Load the model package use MailSlurp::Object::BulkSendEmailOptions; Properties …

  • CommonActionsControllerApi

    MailSlurp::CommonActionsControllerApi Load the API package use MailSlurp::Object::CommonActionsControllerApi; All URIs …

  • ConditionOption

    MailSlurp::Object::ConditionOption Load the model package use MailSlurp::Object::ConditionOption; Properties Name …

  • ContactControllerApi

    MailSlurp::ContactControllerApi Load the API package use MailSlurp::Object::ContactControllerApi; All URIs are relative …

  • ContactDto

    MailSlurp::Object::ContactDto Load the model package use MailSlurp::Object::ContactDto; Properties Name Type …

  • ContactProjection

    MailSlurp::Object::ContactProjection Load the model package use MailSlurp::Object::ContactProjection; Properties Name …

  • ContentMatchOptions

    MailSlurp::Object::ContentMatchOptions Load the model package use MailSlurp::Object::ContentMatchOptions; Properties …

  • CountDto

    MailSlurp::Object::CountDto Load the model package use MailSlurp::Object::CountDto; Properties Name Type Description …

  • CreateAliasOptions

    MailSlurp::Object::CreateAliasOptions Load the model package use MailSlurp::Object::CreateAliasOptions; Properties …

  • CreateContactOptions

    MailSlurp::Object::CreateContactOptions Load the model package use MailSlurp::Object::CreateContactOptions; Properties …

  • CreateDomainOptions

    MailSlurp::Object::CreateDomainOptions Load the model package use MailSlurp::Object::CreateDomainOptions; Properties …

  • CreateGroupOptions

    MailSlurp::Object::CreateGroupOptions Load the model package use MailSlurp::Object::CreateGroupOptions; Properties …

  • CreateInboxDto

    MailSlurp::Object::CreateInboxDto Load the model package use MailSlurp::Object::CreateInboxDto; Properties Name Type …

  • CreateInboxForwarderOptions

    MailSlurp::Object::CreateInboxForwarderOptions Load the model package use …

  • CreateInboxRulesetOptions

    MailSlurp::Object::CreateInboxRulesetOptions Load the model package use MailSlurp::Object::CreateInboxRulesetOptions; …

  • CreateTemplateOptions

    MailSlurp::Object::CreateTemplateOptions Load the model package use MailSlurp::Object::CreateTemplateOptions; Properties …

  • CreateTrackingPixelOptions

    MailSlurp::Object::CreateTrackingPixelOptions Load the model package use MailSlurp::Object::CreateTrackingPixelOptions; …

  • CreateWebhookOptions

    MailSlurp::Object::CreateWebhookOptions Load the model package use MailSlurp::Object::CreateWebhookOptions; Properties …

  • DescribeDomainOptions

    MailSlurp::Object::DescribeDomainOptions Load the model package use MailSlurp::Object::DescribeDomainOptions; Properties …

  • DescribeMailServerDomainResult

    MailSlurp::Object::DescribeMailServerDomainResult Load the model package use …

  • DNSLookupOptions

    MailSlurp::Object::DNSLookupOptions Load the model package use MailSlurp::Object::DNSLookupOptions; Properties Name …

  • DNSLookupResult

    MailSlurp::Object::DNSLookupResult Load the model package use MailSlurp::Object::DNSLookupResult; Properties Name …

  • DNSLookupResults

    MailSlurp::Object::DNSLookupResults Load the model package use MailSlurp::Object::DNSLookupResults; Properties Name …

  • DomainControllerApi

    MailSlurp::DomainControllerApi Load the API package use MailSlurp::Object::DomainControllerApi; All URIs are relative to …

  • DomainDto

    MailSlurp::Object::DomainDto Load the model package use MailSlurp::Object::DomainDto; Properties Name Type …

  • DomainNameRecord

    MailSlurp::Object::DomainNameRecord Load the model package use MailSlurp::Object::DomainNameRecord; Properties Name …

  • DomainPreview

    MailSlurp::Object::DomainPreview Load the model package use MailSlurp::Object::DomainPreview; Properties Name Type …

  • DownloadAttachmentDto

    MailSlurp::Object::DownloadAttachmentDto Load the model package use MailSlurp::Object::DownloadAttachmentDto; Properties …

  • Email

    MailSlurp::Object::Email Load the model package use MailSlurp::Object::Email; Properties Name Type Description Notes …

  • EmailAnalysis

    MailSlurp::Object::EmailAnalysis Load the model package use MailSlurp::Object::EmailAnalysis; Properties Name Type …

  • EmailContentMatchResult

    MailSlurp::Object::EmailContentMatchResult Load the model package use MailSlurp::Object::EmailContentMatchResult; …

  • EmailControllerApi

    MailSlurp::EmailControllerApi Load the API package use MailSlurp::Object::EmailControllerApi; All URIs are relative to …

  • EmailLinksResult

    MailSlurp::Object::EmailLinksResult Load the model package use MailSlurp::Object::EmailLinksResult; Properties Name …

  • EmailPreview

    MailSlurp::Object::EmailPreview Load the model package use MailSlurp::Object::EmailPreview; Properties Name Type …

  • EmailProjection

    MailSlurp::Object::EmailProjection Load the model package use MailSlurp::Object::EmailProjection; Properties Name …

  • EmailRecipients

    MailSlurp::Object::EmailRecipients Load the model package use MailSlurp::Object::EmailRecipients; Properties Name …

  • EmailTextLinesResult

    MailSlurp::Object::EmailTextLinesResult Load the model package use MailSlurp::Object::EmailTextLinesResult; Properties …

  • EmailVerificationResult

    MailSlurp::Object::EmailVerificationResult Load the model package use MailSlurp::Object::EmailVerificationResult; …

  • ExpirationDefaults

    MailSlurp::Object::ExpirationDefaults Load the model package use MailSlurp::Object::ExpirationDefaults; Properties …

  • ExpiredControllerApi

    MailSlurp::ExpiredControllerApi Load the API package use MailSlurp::Object::ExpiredControllerApi; All URIs are relative …

  • ExpiredInboxDto

    MailSlurp::Object::ExpiredInboxDto Load the model package use MailSlurp::Object::ExpiredInboxDto; Properties Name …

  • ExpiredInboxRecordProjection

    MailSlurp::Object::ExpiredInboxRecordProjection Load the model package use …

  • ExportControllerApi

    MailSlurp::ExportControllerApi Load the API package use MailSlurp::Object::ExportControllerApi; All URIs are relative to …

  • ExportLink

    MailSlurp::Object::ExportLink Load the model package use MailSlurp::Object::ExportLink; Properties Name Type …

  • ExportOptions

    MailSlurp::Object::ExportOptions Load the model package use MailSlurp::Object::ExportOptions; Properties Name Type …

  • FlushExpiredInboxesResult

    MailSlurp::Object::FlushExpiredInboxesResult Load the model package use MailSlurp::Object::FlushExpiredInboxesResult; …

  • FormControllerApi

    MailSlurp::FormControllerApi Load the API package use MailSlurp::Object::FormControllerApi; All URIs are relative to …

  • ForwardEmailOptions

    MailSlurp::Object::ForwardEmailOptions Load the model package use MailSlurp::Object::ForwardEmailOptions; Properties …

  • GravatarUrl

    MailSlurp::Object::GravatarUrl Load the model package use MailSlurp::Object::GravatarUrl; Properties Name Type …

  • GroupContactsDto

    MailSlurp::Object::GroupContactsDto Load the model package use MailSlurp::Object::GroupContactsDto; Properties Name …

  • GroupControllerApi

    MailSlurp::GroupControllerApi Load the API package use MailSlurp::Object::GroupControllerApi; All URIs are relative to …

  • GroupDto

    MailSlurp::Object::GroupDto Load the model package use MailSlurp::Object::GroupDto; Properties Name Type Description …

  • GroupProjection

    MailSlurp::Object::GroupProjection Load the model package use MailSlurp::Object::GroupProjection; Properties Name …

  • HTMLValidationResult

    MailSlurp::Object::HTMLValidationResult Load the model package use MailSlurp::Object::HTMLValidationResult; Properties …

  • Inbox

    MailSlurp::Object::Inbox Load the model package use MailSlurp::Object::Inbox; Properties Name Type Description Notes …

  • InboxControllerApi

    MailSlurp::InboxControllerApi Load the API package use MailSlurp::Object::InboxControllerApi; All URIs are relative to …

  • InboxExistsDto

    MailSlurp::Object::InboxExistsDto Load the model package use MailSlurp::Object::InboxExistsDto; Properties Name Type …

  • InboxForwarderControllerApi

    MailSlurp::InboxForwarderControllerApi Load the API package use MailSlurp::Object::InboxForwarderControllerApi; All URIs …

  • InboxForwarderDto

    MailSlurp::Object::InboxForwarderDto Load the model package use MailSlurp::Object::InboxForwarderDto; Properties Name …

  • InboxForwarderTestOptions

    MailSlurp::Object::InboxForwarderTestOptions Load the model package use MailSlurp::Object::InboxForwarderTestOptions; …

  • InboxForwarderTestResult

    MailSlurp::Object::InboxForwarderTestResult Load the model package use MailSlurp::Object::InboxForwarderTestResult; …

  • InboxPreview

    MailSlurp::Object::InboxPreview Load the model package use MailSlurp::Object::InboxPreview; Properties Name Type …

  • InboxRulesetControllerApi

    MailSlurp::InboxRulesetControllerApi Load the API package use MailSlurp::Object::InboxRulesetControllerApi; All URIs are …

  • InboxRulesetDto

    MailSlurp::Object::InboxRulesetDto Load the model package use MailSlurp::Object::InboxRulesetDto; Properties Name …

  • InboxRulesetTestOptions

    MailSlurp::Object::InboxRulesetTestOptions Load the model package use MailSlurp::Object::InboxRulesetTestOptions; …

  • InboxRulesetTestResult

    MailSlurp::Object::InboxRulesetTestResult Load the model package use MailSlurp::Object::InboxRulesetTestResult; …

  • IPAddressResult

    MailSlurp::Object::IPAddressResult Load the model package use MailSlurp::Object::IPAddressResult; Properties Name …

  • JSONSchemaDto

    MailSlurp::Object::JSONSchemaDto Load the model package use MailSlurp::Object::JSONSchemaDto; Properties Name Type …

  • MailServerControllerApi

    MailSlurp::MailServerControllerApi Load the API package use MailSlurp::Object::MailServerControllerApi; All URIs are …

  • MatchOption

    MailSlurp::Object::MatchOption Load the model package use MailSlurp::Object::MatchOption; Properties Name Type …

  • MatchOptions

    MailSlurp::Object::MatchOptions Load the model package use MailSlurp::Object::MatchOptions; Properties Name Type …

  • MissedEmail

    MailSlurp::Object::MissedEmail Load the model package use MailSlurp::Object::MissedEmail; Properties Name Type …

  • MissedEmailControllerApi

    MailSlurp::MissedEmailControllerApi Load the API package use MailSlurp::Object::MissedEmailControllerApi; All URIs are …

  • MissedEmailProjection

    MailSlurp::Object::MissedEmailProjection Load the model package use MailSlurp::Object::MissedEmailProjection; Properties …

  • NameServerRecord

    MailSlurp::Object::NameServerRecord Load the model package use MailSlurp::Object::NameServerRecord; Properties Name …

  • OrganizationInboxProjection

    MailSlurp::Object::OrganizationInboxProjection Load the model package use …

  • Pageable

    MailSlurp::Object::Pageable Load the model package use MailSlurp::Object::Pageable; Properties Name Type Description …

  • PageAlias

    MailSlurp::Object::PageAlias Load the model package use MailSlurp::Object::PageAlias; Properties Name Type …

  • PageAttachmentEntity

    MailSlurp::Object::PageAttachmentEntity Load the model package use MailSlurp::Object::PageAttachmentEntity; Properties …

  • PageBouncedEmail

    MailSlurp::Object::PageBouncedEmail Load the model package use MailSlurp::Object::PageBouncedEmail; Properties Name …

  • PageBouncedRecipients

    MailSlurp::Object::PageBouncedRecipients Load the model package use MailSlurp::Object::PageBouncedRecipients; Properties …

  • PageContactProjection

    MailSlurp::Object::PageContactProjection Load the model package use MailSlurp::Object::PageContactProjection; Properties …

  • PageEmailPreview

    MailSlurp::Object::PageEmailPreview Load the model package use MailSlurp::Object::PageEmailPreview; Properties Name …

  • PageEmailProjection

    MailSlurp::Object::PageEmailProjection Load the model package use MailSlurp::Object::PageEmailProjection; Properties …

  • PageExpiredInboxRecordProjecti …

    MailSlurp::Object::PageExpiredInboxRecordProjection Load the model package use …

  • PageGroupProjection

    MailSlurp::Object::PageGroupProjection Load the model package use MailSlurp::Object::PageGroupProjection; Properties …

  • PageInboxForwarderDto

    MailSlurp::Object::PageInboxForwarderDto Load the model package use MailSlurp::Object::PageInboxForwarderDto; Properties …

  • PageInboxProjection

    MailSlurp::Object::PageInboxProjection Load the model package use MailSlurp::Object::PageInboxProjection; Properties …

  • PageInboxRulesetDto

    MailSlurp::Object::PageInboxRulesetDto Load the model package use MailSlurp::Object::PageInboxRulesetDto; Properties …

  • PageMissedEmailProjection

    MailSlurp::Object::PageMissedEmailProjection Load the model package use MailSlurp::Object::PageMissedEmailProjection; …

  • PageOrganizationInboxProjectio …

    MailSlurp::Object::PageOrganizationInboxProjection Load the model package use …

  • PageSentEmailProjection

    MailSlurp::Object::PageSentEmailProjection Load the model package use MailSlurp::Object::PageSentEmailProjection; …

  • PageTemplateProjection

    MailSlurp::Object::PageTemplateProjection Load the model package use MailSlurp::Object::PageTemplateProjection; …

  • PageThreadProjection

    MailSlurp::Object::PageThreadProjection Load the model package use MailSlurp::Object::PageThreadProjection; Properties …

  • PageTrackingPixelProjection

    MailSlurp::Object::PageTrackingPixelProjection Load the model package use …

  • PageUnknownMissedEmailProjecti …

    MailSlurp::Object::PageUnknownMissedEmailProjection Load the model package use …

  • PageWebhookProjection

    MailSlurp::Object::PageWebhookProjection Load the model package use MailSlurp::Object::PageWebhookProjection; Properties …

  • PageWebhookResult

    MailSlurp::Object::PageWebhookResult Load the model package use MailSlurp::Object::PageWebhookResult; Properties Name …

  • RawEmailJson

    MailSlurp::Object::RawEmailJson Load the model package use MailSlurp::Object::RawEmailJson; Properties Name Type …

  • Recipient

    MailSlurp::Object::Recipient Load the model package use MailSlurp::Object::Recipient; Properties Name Type …

  • ReplyToAliasEmailOptions

    MailSlurp::Object::ReplyToAliasEmailOptions Load the model package use MailSlurp::Object::ReplyToAliasEmailOptions; …

  • ReplyToEmailOptions

    MailSlurp::Object::ReplyToEmailOptions Load the model package use MailSlurp::Object::ReplyToEmailOptions; Properties …

  • SendEmailOptions

    MailSlurp::Object::SendEmailOptions Load the model package use MailSlurp::Object::SendEmailOptions; Properties Name …

  • Sender

    MailSlurp::Object::Sender Load the model package use MailSlurp::Object::Sender; Properties Name Type Description …

  • SentEmailDto

    MailSlurp::Object::SentEmailDto Load the model package use MailSlurp::Object::SentEmailDto; Properties Name Type …

  • SentEmailProjection

    MailSlurp::Object::SentEmailProjection Load the model package use MailSlurp::Object::SentEmailProjection; Properties …

  • SentEmailsControllerApi

    MailSlurp::SentEmailsControllerApi Load the API package use MailSlurp::Object::SentEmailsControllerApi; All URIs are …

  • SetInboxFavouritedOptions

    MailSlurp::Object::SetInboxFavouritedOptions Load the model package use MailSlurp::Object::SetInboxFavouritedOptions; …

  • SimpleSendEmailOptions

    MailSlurp::Object::SimpleSendEmailOptions Load the model package use MailSlurp::Object::SimpleSendEmailOptions; …

  • Sort

    MailSlurp::Object::Sort Load the model package use MailSlurp::Object::Sort; Properties Name Type Description Notes …

  • TemplateControllerApi

    MailSlurp::TemplateControllerApi Load the API package use MailSlurp::Object::TemplateControllerApi; All URIs are …

  • TemplateDto

    MailSlurp::Object::TemplateDto Load the model package use MailSlurp::Object::TemplateDto; Properties Name Type …

  • TemplateProjection

    MailSlurp::Object::TemplateProjection Load the model package use MailSlurp::Object::TemplateProjection; Properties …

  • TemplateVariable

    MailSlurp::Object::TemplateVariable Load the model package use MailSlurp::Object::TemplateVariable; Properties Name …

  • TestNewInboxForwarderOptions

    MailSlurp::Object::TestNewInboxForwarderOptions Load the model package use …

  • TestNewInboxRulesetOptions

    MailSlurp::Object::TestNewInboxRulesetOptions Load the model package use MailSlurp::Object::TestNewInboxRulesetOptions; …

  • ThreadProjection

    MailSlurp::Object::ThreadProjection Load the model package use MailSlurp::Object::ThreadProjection; Properties Name …

  • TrackingControllerApi

    MailSlurp::TrackingControllerApi Load the API package use MailSlurp::Object::TrackingControllerApi; All URIs are …

  • TrackingPixelDto

    MailSlurp::Object::TrackingPixelDto Load the model package use MailSlurp::Object::TrackingPixelDto; Properties Name …

  • TrackingPixelProjection

    MailSlurp::Object::TrackingPixelProjection Load the model package use MailSlurp::Object::TrackingPixelProjection; …

  • UnknownMissedEmailProjection

    MailSlurp::Object::UnknownMissedEmailProjection Load the model package use …

  • UnreadCount

    MailSlurp::Object::UnreadCount Load the model package use MailSlurp::Object::UnreadCount; Properties Name Type …

  • UnseenErrorCountDto

    MailSlurp::Object::UnseenErrorCountDto Load the model package use MailSlurp::Object::UnseenErrorCountDto; Properties …

  • UpdateAliasOptions

    MailSlurp::Object::UpdateAliasOptions Load the model package use MailSlurp::Object::UpdateAliasOptions; Properties …

  • UpdateDomainOptions

    MailSlurp::Object::UpdateDomainOptions Load the model package use MailSlurp::Object::UpdateDomainOptions; Properties …

  • UpdateGroupContacts

    MailSlurp::Object::UpdateGroupContacts Load the model package use MailSlurp::Object::UpdateGroupContacts; Properties …

  • UpdateInboxOptions

    MailSlurp::Object::UpdateInboxOptions Load the model package use MailSlurp::Object::UpdateInboxOptions; Properties …

  • UploadAttachmentOptions

    MailSlurp::Object::UploadAttachmentOptions Load the model package use MailSlurp::Object::UploadAttachmentOptions; …

  • ValidationDto

    MailSlurp::Object::ValidationDto Load the model package use MailSlurp::Object::ValidationDto; Properties Name Type …

  • ValidationMessage

    MailSlurp::Object::ValidationMessage Load the model package use MailSlurp::Object::ValidationMessage; Properties Name …

  • VerifyEmailAddressOptions

    MailSlurp::Object::VerifyEmailAddressOptions Load the model package use MailSlurp::Object::VerifyEmailAddressOptions; …

  • WaitForConditions

    MailSlurp::Object::WaitForConditions Load the model package use MailSlurp::Object::WaitForConditions; Properties Name …

  • WaitForControllerApi

    MailSlurp::WaitForControllerApi Load the API package use MailSlurp::Object::WaitForControllerApi; All URIs are relative …

  • WebhookControllerApi

    MailSlurp::WebhookControllerApi Load the API package use MailSlurp::Object::WebhookControllerApi; All URIs are relative …

  • WebhookDto

    MailSlurp::Object::WebhookDto Load the model package use MailSlurp::Object::WebhookDto; Properties Name Type …

  • WebhookEmailOpenedPayload

    MailSlurp::Object::WebhookEmailOpenedPayload Load the model package use MailSlurp::Object::WebhookEmailOpenedPayload; …

  • WebhookEmailReadPayload

    MailSlurp::Object::WebhookEmailReadPayload Load the model package use MailSlurp::Object::WebhookEmailReadPayload; …

  • WebhookNewAttachmentPayload

    MailSlurp::Object::WebhookNewAttachmentPayload Load the model package use …

  • WebhookNewContactPayload

    MailSlurp::Object::WebhookNewContactPayload Load the model package use MailSlurp::Object::WebhookNewContactPayload; …

  • WebhookNewEmailPayload

    MailSlurp::Object::WebhookNewEmailPayload Load the model package use MailSlurp::Object::WebhookNewEmailPayload; …

  • WebhookProjection

    MailSlurp::Object::WebhookProjection Load the model package use MailSlurp::Object::WebhookProjection; Properties Name …

  • WebhookRedriveResult

    MailSlurp::Object::WebhookRedriveResult Load the model package use MailSlurp::Object::WebhookRedriveResult; Properties …

  • WebhookResultDto

    MailSlurp::Object::WebhookResultDto Load the model package use MailSlurp::Object::WebhookResultDto; Properties Name …

  • WebhookTestRequest

    MailSlurp::Object::WebhookTestRequest Load the model package use MailSlurp::Object::WebhookTestRequest; Properties …

  • WebhookTestResponse

    MailSlurp::Object::WebhookTestResponse Load the model package use MailSlurp::Object::WebhookTestResponse; Properties …

  • WebhookTestResult

    MailSlurp::Object::WebhookTestResult Load the model package use MailSlurp::Object::WebhookTestResult; Properties Name …

  • Docs

    Index More links For more help and documentation see the MailSlurp developer portal.

  • API

    Index AliasControllerApi AttachmentControllerApi BounceControllerApi BulkActionsControllerApi …

  • AliasControllerApi

    MailSlurpAliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AttachmentControllerApi

    MailSlurpAttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BounceControllerApi

    MailSlurpBounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BulkActionsControllerApi

    MailSlurpBulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • CommonActionsControllerApi

    MailSlurpCommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ContactControllerApi

    MailSlurpContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • DomainControllerApi

    MailSlurpDomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • EmailControllerApi

    MailSlurpEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExpiredControllerApi

    MailSlurpExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExportControllerApi

    MailSlurpExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • FormControllerApi

    MailSlurpFormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • GroupControllerApi

    MailSlurpGroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxControllerApi

    MailSlurpInboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxForwarderControllerApi

    MailSlurpInboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxRulesetControllerApi

    MailSlurpInboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MailServerControllerApi

    MailSlurpMailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MissedEmailControllerApi

    MailSlurpMissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • SentEmailsControllerApi

    MailSlurpSentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TemplateControllerApi

    MailSlurpTemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • TrackingControllerApi

    MailSlurpTrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WaitForControllerApi

    MailSlurpWaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • WebhookControllerApi

    MailSlurpWebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • Model

    Index AbstractWebhookPayload AliasDto AliasProjection AttachmentEntity AttachmentMetaData AttachmentProjection …

  • AbstractWebhookPayload

    # AbstractWebhookPayload Properties Name Type Description Notes event_name string message_id string …

  • AliasDto

    # AliasDto Properties Name Type Description Notes created_at DateTime [optional] email_address string The …

  • AliasProjection

    # AliasProjection Properties Name Type Description Notes created_at DateTime email_address string id …

  • AttachmentEntity

    # AttachmentEntity Properties Name Type Description Notes attachment_id string content_length int [optional] …

  • AttachmentMetaData

    # AttachmentMetaData Properties Name Type Description Notes content_length int Size of attachment in bytes …

  • AttachmentProjection

    # AttachmentProjection Properties Name Type Description Notes attachment_id string Attachment ID [optional] …

  • BasicAuthOptions

    # BasicAuthOptions Properties Name Type Description Notes username string password string [Back to Model …

  • BouncedEmailDto

    # BouncedEmailDto Properties Name Type Description Notes bounce_mta string [optional] bounce_recipients …

  • BouncedRecipientDto

    # BouncedRecipientDto Properties Name Type Description Notes created_at DateTime id string [optional] …

  • BounceProjection

    # BounceProjection Properties Name Type Description Notes created_at DateTime id string [optional] sender …

  • BounceRecipient

    # BounceRecipient Properties Name Type Description Notes created_at DateTime id string [optional] …

  • BulkSendEmailOptions

    # BulkSendEmailOptions Properties Name Type Description Notes inbox_ids string[] Inboxes to send the email from …

  • ConditionOption

    # ConditionOption Properties Name Type Description Notes condition string The condition to evaluate against the …

  • ContactDto

    # ContactDto Properties Name Type Description Notes company string [optional] created_at DateTime …

  • ContactProjection

    # ContactProjection Properties Name Type Description Notes company string [optional] created_at DateTime …

  • ContentMatchOptions

    # ContentMatchOptions Properties Name Type Description Notes pattern string Java style regex pattern. Do not …

  • CountDto

    # CountDto Properties Name Type Description Notes total_elements int [Back to Model list] [Back to API list] …

  • CreateAliasOptions

    # CreateAliasOptions Properties Name Type Description Notes email_address string Email address to be hidden …

  • CreateContactOptions

    # CreateContactOptions Properties Name Type Description Notes email_addresses string[] Set of email addresses …

  • CreateDomainOptions

    # CreateDomainOptions Properties Name Type Description Notes created_catch_all_inbox bool Whether to create a …

  • CreateGroupOptions

    # CreateGroupOptions Properties Name Type Description Notes name string description string [optional] …

  • CreateInboxDto

    # CreateInboxDto Properties Name Type Description Notes allow_team_access bool DEPRECATED (team access is always …

  • CreateInboxForwarderOptions

    # CreateInboxForwarderOptions Properties Name Type Description Notes field string Field to match against to …

  • CreateInboxRulesetOptions

    # CreateInboxRulesetOptions Properties Name Type Description Notes action string Action to be taken when the …

  • CreateTemplateOptions

    # CreateTemplateOptions Properties Name Type Description Notes name string content string [Back to Model …

  • CreateTrackingPixelOptions

    # CreateTrackingPixelOptions Properties Name Type Description Notes name string [optional] recipient string …

  • CreateWebhookOptions

    # CreateWebhookOptions Properties Name Type Description Notes basic_auth MailSlurpModelsBasicAuthOptions …

  • DescribeDomainOptions

    # DescribeDomainOptions Properties Name Type Description Notes domain string [Back to Model list] [Back to …

  • DescribeMailServerDomainResult

    # DescribeMailServerDomainResult Properties Name Type Description Notes domain string message string …

  • DNSLookupOptions

    # DNSLookupOptions Properties Name Type Description Notes hostname string List of record types you wish to query …

  • DNSLookupResult

    # DNSLookupResult Properties Name Type Description Notes name string record_entries string[] record_type …

  • DNSLookupResults

    # DNSLookupResults Properties Name Type Description Notes results **MailSlurpModelsDNSLookupResult[]** [Back …

  • DomainDto

    # DomainDto Properties Name Type Description Notes catch_all_inbox_id string The optional catch all inbox that …

  • DomainNameRecord

    # DomainNameRecord Properties Name Type Description Notes name string record_entries string[] record_type …

  • DomainPreview

    # DomainPreview Properties Name Type Description Notes catch_all_inbox_id string [optional] created_at …

  • DownloadAttachmentDto

    # DownloadAttachmentDto Properties Name Type Description Notes base64_file_contents string Base64 encoded string …

  • Email

    # Email Properties Name Type Description Notes analysis MailSlurpModelsEmailAnalysis [optional] attachments …

  • EmailAnalysis

    # EmailAnalysis Properties Name Type Description Notes dkim_verdict string Verdict of DomainKeys Identified Mail …

  • EmailContentMatchResult

    # EmailContentMatchResult Properties Name Type Description Notes matches string[] pattern string [Back …

  • EmailLinksResult

    # EmailLinksResult Properties Name Type Description Notes body string links string[] [Back to Model …

  • EmailPreview

    # EmailPreview Properties Name Type Description Notes attachments string[] List of IDs of attachments found in …

  • EmailProjection

    # EmailProjection Properties Name Type Description Notes attachments string[] [optional] bcc string[] …

  • EmailRecipients

    # EmailRecipients Properties Name Type Description Notes bcc **MailSlurpModelsRecipient[]** [optional] cc …

  • EmailTextLinesResult

    # EmailTextLinesResult Properties Name Type Description Notes body string lines string[] [Back to Model …

  • EmailVerificationResult

    # EmailVerificationResult Properties Name Type Description Notes domain_name string email_address string …

  • ExpirationDefaults

    # ExpirationDefaults Properties Name Type Description Notes can_permanent_inbox bool …

  • ExpiredInboxDto

    # ExpiredInboxDto Properties Name Type Description Notes email_address string id string inbox_id string …

  • ExpiredInboxRecordProjection

    # ExpiredInboxRecordProjection Properties Name Type Description Notes created_at DateTime email_address …

  • ExportLink

    # ExportLink Properties Name Type Description Notes download_link string [Back to Model list] [Back to API …

  • ExportOptions

    # ExportOptions Properties Name Type Description Notes output_format string exclude_previously_exported bool …

  • FlushExpiredInboxesResult

    # FlushExpiredInboxesResult Properties Name Type Description Notes expire_before DateTime inbox_ids string[] …

  • ForwardEmailOptions

    # ForwardEmailOptions Properties Name Type Description Notes bcc string[] Optional bcc recipients [optional] cc …

  • GravatarUrl

    # GravatarUrl Properties Name Type Description Notes hash string url string [Back to Model list] [Back …

  • GroupContactsDto

    # GroupContactsDto Properties Name Type Description Notes contacts **MailSlurpModelsContactDto[]** group …

  • GroupDto

    # GroupDto Properties Name Type Description Notes created_at DateTime description string [optional] id …

  • GroupProjection

    # GroupProjection Properties Name Type Description Notes created_at DateTime description string [optional] …

  • HTMLValidationResult

    # HTMLValidationResult Properties Name Type Description Notes errors **MailSlurpModelsValidationMessage[]** …

  • Inbox

    # Inbox Properties Name Type Description Notes created_at DateTime When the inbox was created. Time stamps are in …

  • InboxExistsDto

    # InboxExistsDto Properties Name Type Description Notes exists bool [Back to Model list] [Back to API list] …

  • InboxForwarderDto

    # InboxForwarderDto Properties Name Type Description Notes created_at DateTime field string …

  • InboxForwarderTestOptions

    # InboxForwarderTestOptions Properties Name Type Description Notes test_value string [Back to Model list] …

  • InboxForwarderTestResult

    # InboxForwarderTestResult Properties Name Type Description Notes does_match bool matches map[string,bool] …

  • InboxPreview

    # InboxPreview Properties Name Type Description Notes created_at DateTime When the inbox was created. Time stamps …

  • InboxRulesetDto

    # InboxRulesetDto Properties Name Type Description Notes action string created_at DateTime handler string …

  • InboxRulesetTestOptions

    # InboxRulesetTestOptions Properties Name Type Description Notes test_target string [Back to Model list] …

  • InboxRulesetTestResult

    # InboxRulesetTestResult Properties Name Type Description Notes matches bool ruleset_matches map[string,bool] …

  • IPAddressResult

    # IPAddressResult Properties Name Type Description Notes address string hostname string [Back to Model …

  • JSONSchemaDto

    # JSONSchemaDto Properties Name Type Description Notes value string [Back to Model list] [Back to API list] …

  • MatchOption

    # MatchOption Properties Name Type Description Notes field string The email property to match on. One of SUBJECT, …

  • MatchOptions

    # MatchOptions Properties Name Type Description Notes conditions **MailSlurpModelsConditionOption[]** Zero or …

  • MissedEmail

    # MissedEmail Properties Name Type Description Notes attachment_count int bcc string[] body_excerpt …

  • MissedEmailProjection

    # MissedEmailProjection Properties Name Type Description Notes created_at DateTime from string [optional] …

  • NameServerRecord

    # NameServerRecord Properties Name Type Description Notes priority string raw string record_type string …

  • OrganizationInboxProjection

    # OrganizationInboxProjection Properties Name Type Description Notes created_at DateTime When the inbox was …

  • Pageable

    # Pageable Properties Name Type Description Notes offset int [optional] page_number int [optional] …

  • PageAlias

    # PageAlias Properties Name Type Description Notes content **MailSlurpModelsAliasProjection[]** [optional] …

  • PageAttachmentEntity

    # PageAttachmentEntity Properties Name Type Description Notes content **MailSlurpModelsAttachmentProjection[]** …

  • PageBouncedEmail

    # PageBouncedEmail Properties Name Type Description Notes content **MailSlurpModelsBounceProjection[]** …

  • PageBouncedRecipients

    # PageBouncedRecipients Properties Name Type Description Notes content **MailSlurpModelsBounceRecipient[]** …

  • PageContactProjection

    # PageContactProjection Properties Name Type Description Notes content **MailSlurpModelsContactProjection[]** …

  • PageEmailPreview

    # PageEmailPreview Properties Name Type Description Notes content **MailSlurpModelsEmailPreview[]** [optional] …

  • PageEmailProjection

    # PageEmailProjection Properties Name Type Description Notes content **MailSlurpModelsEmailProjection[]** …

  • PageExpiredInboxRecordProjecti …

    # PageExpiredInboxRecordProjection Properties Name Type Description Notes content …

  • PageGroupProjection

    # PageGroupProjection Properties Name Type Description Notes content **MailSlurpModelsGroupProjection[]** …

  • PageInboxForwarderDto

    # PageInboxForwarderDto Properties Name Type Description Notes content **MailSlurpModelsInboxForwarderDto[]** …

  • PageInboxProjection

    # PageInboxProjection Properties Name Type Description Notes content **MailSlurpModelsInboxPreview[]** …

  • PageInboxRulesetDto

    # PageInboxRulesetDto Properties Name Type Description Notes content **MailSlurpModelsInboxRulesetDto[]** …

  • PageMissedEmailProjection

    # PageMissedEmailProjection Properties Name Type Description Notes content …

  • PageOrganizationInboxProjectio …

    # PageOrganizationInboxProjection Properties Name Type Description Notes content …

  • PageSentEmailProjection

    # PageSentEmailProjection Properties Name Type Description Notes content **MailSlurpModelsSentEmailProjection[]** …

  • PageTemplateProjection

    # PageTemplateProjection Properties Name Type Description Notes content **MailSlurpModelsTemplateProjection[]** …

  • PageThreadProjection

    # PageThreadProjection Properties Name Type Description Notes content **MailSlurpModelsThreadProjection[]** …

  • PageTrackingPixelProjection

    # PageTrackingPixelProjection Properties Name Type Description Notes content …

  • PageUnknownMissedEmailProjecti …

    # PageUnknownMissedEmailProjection Properties Name Type Description Notes content …

  • PageWebhookProjection

    # PageWebhookProjection Properties Name Type Description Notes content **MailSlurpModelsWebhookProjection[]** …

  • PageWebhookResult

    # PageWebhookResult Properties Name Type Description Notes content **MailSlurpModelsWebhookResultDto[]** …

  • RawEmailJson

    # RawEmailJson Properties Name Type Description Notes content string [Back to Model list] [Back to API list] …

  • Recipient

    # Recipient Properties Name Type Description Notes email_address string name string [optional] raw_value …

  • ReplyToAliasEmailOptions

    # ReplyToAliasEmailOptions Properties Name Type Description Notes attachments string[] List of uploaded …

  • ReplyToEmailOptions

    # ReplyToEmailOptions Properties Name Type Description Notes attachments string[] List of uploaded attachments to …

  • SendEmailOptions

    # SendEmailOptions Properties Name Type Description Notes add_tracking_pixel bool Add tracking pixel to email …

  • Sender

    # Sender Properties Name Type Description Notes email_address string name string [optional] raw_value …

  • SentEmailDto

    # SentEmailDto Properties Name Type Description Notes attachments string[] Array of IDs of attachments that were …

  • SentEmailProjection

    # SentEmailProjection Properties Name Type Description Notes attachments string[] bcc string[] …

  • SetInboxFavouritedOptions

    # SetInboxFavouritedOptions Properties Name Type Description Notes state bool Is the inbox a favorite. Marking an …

  • SimpleSendEmailOptions

    # SimpleSendEmailOptions Properties Name Type Description Notes body string Body of the email message. Supports …

  • Sort

    # Sort Properties Name Type Description Notes empty bool [optional] sorted bool [optional] unsorted bool …

  • TemplateDto

    # TemplateDto Properties Name Type Description Notes content string created_at DateTime id string …

  • TemplateProjection

    # TemplateProjection Properties Name Type Description Notes created_at DateTime id string name string …

  • TemplateVariable

    # TemplateVariable Properties Name Type Description Notes name string variable_type string [Back to …

  • TestNewInboxForwarderOptions

    # TestNewInboxForwarderOptions Properties Name Type Description Notes inbox_forwarder_test_options …

  • TestNewInboxRulesetOptions

    # TestNewInboxRulesetOptions Properties Name Type Description Notes inbox_ruleset_test_options …

  • ThreadProjection

    # ThreadProjection Properties Name Type Description Notes alias_id string bcc string[] [optional] cc …

  • TrackingPixelDto

    # TrackingPixelDto Properties Name Type Description Notes created_at DateTime html string id string …

  • TrackingPixelProjection

    # TrackingPixelProjection Properties Name Type Description Notes created_at DateTime id string inbox_id …

  • UnknownMissedEmailProjection

    # UnknownMissedEmailProjection Properties Name Type Description Notes created_at DateTime from string …

  • UnreadCount

    # UnreadCount Properties Name Type Description Notes count int [Back to Model list] [Back to API list] [Back …

  • UnseenErrorCountDto

    # UnseenErrorCountDto Properties Name Type Description Notes count int [Back to Model list] [Back to API …

  • UpdateAliasOptions

    # UpdateAliasOptions Properties Name Type Description Notes name string Optional name for alias [optional] …

  • UpdateDomainOptions

    # UpdateDomainOptions Properties Name Type Description Notes catch_all_inbox_id string [optional] [Back to …

  • UpdateGroupContacts

    # UpdateGroupContacts Properties Name Type Description Notes contact_ids string[] [Back to Model list] [Back …

  • UpdateInboxOptions

    # UpdateInboxOptions Properties Name Type Description Notes description string Description of an inbox for …

  • UploadAttachmentOptions

    # UploadAttachmentOptions Properties Name Type Description Notes base64_contents string Base64 encoded string of …

  • ValidationDto

    # ValidationDto Properties Name Type Description Notes email_id string ID of the email validated [optional] …

  • ValidationMessage

    # ValidationMessage Properties Name Type Description Notes line_number int message string [optional] …

  • VerifyEmailAddressOptions

    # VerifyEmailAddressOptions Properties Name Type Description Notes mail_server_domain string [optional] …

  • WaitForConditions

    # WaitForConditions Properties Name Type Description Notes before DateTime ISO Date Time latest time of email to …

  • WebhookDto

    # WebhookDto Properties Name Type Description Notes basic_auth bool Does webhook expect basic authentication? If …

  • WebhookEmailOpenedPayload

    # WebhookEmailOpenedPayload Properties Name Type Description Notes created_at DateTime Date time of event …

  • WebhookEmailReadPayload

    # WebhookEmailReadPayload Properties Name Type Description Notes created_at DateTime Date time of event creation …

  • WebhookNewAttachmentPayload

    # WebhookNewAttachmentPayload Properties Name Type Description Notes attachment_id string ID of attachment. Use …

  • WebhookNewContactPayload

    # WebhookNewContactPayload Properties Name Type Description Notes company string [optional] contact_id string …

  • WebhookNewEmailPayload

    # WebhookNewEmailPayload Properties Name Type Description Notes attachment_meta_datas …

  • WebhookProjection

    # WebhookProjection Properties Name Type Description Notes created_at DateTime event_name string [optional] …

  • WebhookRedriveResult

    # WebhookRedriveResult Properties Name Type Description Notes message string [optional] success bool …

  • WebhookResultDto

    # WebhookResultDto Properties Name Type Description Notes created_at DateTime http_method string id …

  • WebhookTestRequest

    # WebhookTestRequest Properties Name Type Description Notes headers map[string,string] method string …

  • WebhookTestResponse

    # WebhookTestResponse Properties Name Type Description Notes message string [optional] status_code int …

  • WebhookTestResult

    # WebhookTestResult Properties Name Type Description Notes message string [optional] request …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    AbstractWebhookPayload Properties Name Type Description Notes EventName String MessageId String WebhookId …

  • AliasControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.AliasControllerApi All URIs are relative to …

  • AliasDto

    AliasDto Properties Name Type Description Notes CreatedAt System.DateTime [optional] EmailAddress String The …

  • AliasProjection

    AliasProjection Properties Name Type Description Notes CreatedAt System.DateTime EmailAddress String Id …

  • AttachmentControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.AttachmentControllerApi All URIs are relative to …

  • AttachmentEntity

    AttachmentEntity Properties Name Type Description Notes AttachmentId String ContentLength Int64 [optional] …

  • AttachmentMetaData

    AttachmentMetaData Properties Name Type Description Notes ContentLength Int64 Size of attachment in bytes …

  • AttachmentProjection

    AttachmentProjection Properties Name Type Description Notes AttachmentId String Attachment ID [optional] …

  • BasicAuthOptions

    BasicAuthOptions Properties Name Type Description Notes Username String Password String Examples …

  • BounceControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.BounceControllerApi All URIs are relative to …

  • BouncedEmailDto

    BouncedEmailDto Properties Name Type Description Notes BounceMta String [optional] BounceRecipients String[] …

  • BouncedRecipientDto

    BouncedRecipientDto Properties Name Type Description Notes CreatedAt System.DateTime Id String [optional] …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes CreatedAt System.DateTime Id String [optional] …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes CreatedAt System.DateTime Id String [optional] …

  • BulkActionsControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.BulkActionsControllerApi All URIs are relative to …

  • BulkSendEmailOptions

    BulkSendEmailOptions Properties Name Type Description Notes InboxIds String[] Inboxes to send the email from …

  • CommonActionsControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.CommonActionsControllerApi All URIs are relative to …

  • ConditionOption

    ConditionOption Properties Name Type Description Notes Condition String The condition to evaluate against the …

  • ContactControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.ContactControllerApi All URIs are relative to …

  • ContactDto

    ContactDto Properties Name Type Description Notes Company String [optional] CreatedAt System.DateTime …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes Company String [optional] CreatedAt System.DateTime …

  • ContentMatchOptions

    ContentMatchOptions Properties Name Type Description Notes Pattern String Java style regex pattern. Do not …

  • CountDto

    CountDto Properties Name Type Description Notes TotalElements Int64 Examples Prepare the resource …

  • CreateAliasOptions

    CreateAliasOptions Properties Name Type Description Notes EmailAddress String Email address to be hidden behind …

  • CreateContactOptions

    CreateContactOptions Properties Name Type Description Notes EmailAddresses String[] Set of email addresses …

  • CreateDomainOptions

    CreateDomainOptions Properties Name Type Description Notes CreatedCatchAllInbox Boolean Whether to create a catch …

  • CreateGroupOptions

    CreateGroupOptions Properties Name Type Description Notes Name String Description String [optional] …

  • CreateInboxDto

    CreateInboxDto Properties Name Type Description Notes AllowTeamAccess Boolean DEPRECATED (team access is always …

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Properties Name Type Description Notes Field String Field to match against to trigger …

  • CreateInboxRulesetOptions

    CreateInboxRulesetOptions Properties Name Type Description Notes Action String Action to be taken when the …

  • CreateTemplateOptions

    CreateTemplateOptions Properties Name Type Description Notes Name String Content String Examples …

  • CreateTrackingPixelOptions

    CreateTrackingPixelOptions Properties Name Type Description Notes Name String [optional] Recipient String …

  • CreateWebhookOptions

    CreateWebhookOptions Properties Name Type Description Notes BasicAuth BasicAuthOptions [optional] EventName …

  • DescribeDomainOptions

    DescribeDomainOptions Properties Name Type Description Notes Domain String Examples Prepare the resource …

  • DescribeMailServerDomainResult

    DescribeMailServerDomainResult Properties Name Type Description Notes Domain String Message String …

  • DNSLookupOptions

    DNSLookupOptions Properties Name Type Description Notes Hostname String List of record types you wish to query …

  • DNSLookupResult

    DNSLookupResult Properties Name Type Description Notes Name String RecordEntries String[] RecordType …

  • DNSLookupResults

    DNSLookupResults Properties Name Type Description Notes Results **DNSLookupResult[]** Examples Prepare the …

  • DomainControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.DomainControllerApi All URIs are relative to …

  • DomainDto

    DomainDto Properties Name Type Description Notes CatchAllInboxId String The optional catch all inbox that will …

  • DomainNameRecord

    DomainNameRecord Properties Name Type Description Notes Name String RecordEntries String[] RecordType …

  • DomainPreview

    DomainPreview Properties Name Type Description Notes CatchAllInboxId String [optional] CreatedAt …

  • DownloadAttachmentDto

    DownloadAttachmentDto Properties Name Type Description Notes Base64FileContents String Base64 encoded string of …

  • Email

    Email Properties Name Type Description Notes Analysis EmailAnalysis [optional] Attachments String[] List of …

  • EmailAnalysis

    EmailAnalysis Properties Name Type Description Notes DkimVerdict String Verdict of DomainKeys Identified Mail …

  • EmailContentMatchResult

    EmailContentMatchResult Properties Name Type Description Notes VarMatches String[] Pattern String …

  • EmailControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.EmailControllerApi All URIs are relative to …

  • EmailLinksResult

    EmailLinksResult Properties Name Type Description Notes Body String Links String[] Examples Prepare the …

  • EmailPreview

    EmailPreview Properties Name Type Description Notes Attachments String[] List of IDs of attachments found in the …

  • EmailProjection

    EmailProjection Properties Name Type Description Notes Attachments String[] [optional] Bcc String[] …

  • EmailRecipients

    EmailRecipients Properties Name Type Description Notes Bcc **Recipient[]** [optional] Cc **Recipient[]** …

  • EmailTextLinesResult

    EmailTextLinesResult Properties Name Type Description Notes Body String Lines String[] Examples Prepare …

  • EmailVerificationResult

    EmailVerificationResult Properties Name Type Description Notes DomainName String EmailAddress String …

  • ExpirationDefaults

    ExpirationDefaults Properties Name Type Description Notes CanPermanentInbox Boolean DefaultExpirationMillis …

  • ExpiredControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.ExpiredControllerApi All URIs are relative to …

  • ExpiredInboxDto

    ExpiredInboxDto Properties Name Type Description Notes EmailAddress String Id String InboxId String …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes CreatedAt System.DateTime EmailAddress …

  • ExportControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.ExportControllerApi All URIs are relative to …

  • ExportLink

    ExportLink Properties Name Type Description Notes DownloadLink String Examples Prepare the resource …

  • ExportOptions

    ExportOptions Properties Name Type Description Notes OutputFormat String ExcludePreviouslyExported Boolean …

  • FlushExpiredInboxesResult

    FlushExpiredInboxesResult Properties Name Type Description Notes ExpireBefore System.DateTime InboxIds …

  • FormControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.FormControllerApi All URIs are relative to …

  • ForwardEmailOptions

    ForwardEmailOptions Properties Name Type Description Notes Bcc String[] Optional bcc recipients [optional] Cc …

  • GravatarUrl

    GravatarUrl Properties Name Type Description Notes Hash String Url String Examples Prepare the resource …

  • GroupContactsDto

    GroupContactsDto Properties Name Type Description Notes Contacts **ContactDto[]** Group GroupDto …

  • GroupControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.GroupControllerApi All URIs are relative to …

  • GroupDto

    GroupDto Properties Name Type Description Notes CreatedAt System.DateTime Description String [optional] Id …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes CreatedAt System.DateTime Description String …

  • HTMLValidationResult

    HTMLValidationResult Properties Name Type Description Notes Errors **ValidationMessage[]** Optional errors …

  • Inbox

    Inbox Properties Name Type Description Notes CreatedAt System.DateTime When the inbox was created. Time stamps …

  • InboxControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.InboxControllerApi All URIs are relative to …

  • InboxExistsDto

    InboxExistsDto Properties Name Type Description Notes Exists Boolean Examples Prepare the resource …

  • InboxForwarderControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.InboxForwarderControllerApi All URIs are relative to …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes CreatedAt System.DateTime Field String …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes TestValue String Examples Prepare the …

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes DoesMatch Boolean VarMatches …

  • InboxPreview

    InboxPreview Properties Name Type Description Notes CreatedAt System.DateTime When the inbox was created. Time …

  • InboxRulesetControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.InboxRulesetControllerApi All URIs are relative to …

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes Action String CreatedAt System.DateTime Handler …

  • InboxRulesetTestOptions

    InboxRulesetTestOptions Properties Name Type Description Notes TestTarget String Examples Prepare the …

  • InboxRulesetTestResult

    InboxRulesetTestResult Properties Name Type Description Notes VarMatches Boolean RulesetMatches …

  • IPAddressResult

    IPAddressResult Properties Name Type Description Notes Address String Hostname String Examples Prepare …

  • JSONSchemaDto

    JSONSchemaDto Properties Name Type Description Notes Value String Examples Prepare the resource …

  • MailServerControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.MailServerControllerApi All URIs are relative to …

  • MatchOption

    MatchOption Properties Name Type Description Notes Field String The email property to match on. One of SUBJECT, …

  • MatchOptions

    MatchOptions Properties Name Type Description Notes Conditions **ConditionOption[]** Zero or more conditions such …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes AttachmentCount Int32 Bcc String[] BodyExcerpt String …

  • MissedEmailControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.MissedEmailControllerApi All URIs are relative to …

  • MissedEmailProjection

    MissedEmailProjection Properties Name Type Description Notes CreatedAt System.DateTime VarFrom String …

  • NameServerRecord

    NameServerRecord Properties Name Type Description Notes Priority String Raw String RecordType String …

  • OrganizationInboxProjection

    OrganizationInboxProjection Properties Name Type Description Notes CreatedAt System.DateTime When the inbox was …

  • Pageable

    Pageable Properties Name Type Description Notes Offset Int64 [optional] PageNumber Int32 [optional] …

  • PageAlias

    PageAlias Properties Name Type Description Notes Content **AliasProjection[]** [optional] Empty Boolean …

  • PageAttachmentEntity

    PageAttachmentEntity Properties Name Type Description Notes Content **AttachmentProjection[]** [optional] …

  • PageBouncedEmail

    PageBouncedEmail Properties Name Type Description Notes Content **BounceProjection[]** [optional] Empty …

  • PageBouncedRecipients

    PageBouncedRecipients Properties Name Type Description Notes Content **BounceRecipient[]** [optional] Empty …

  • PageContactProjection

    PageContactProjection Properties Name Type Description Notes Content **ContactProjection[]** [optional] Empty …

  • PageEmailPreview

    PageEmailPreview Properties Name Type Description Notes Content **EmailPreview[]** [optional] Empty Boolean …

  • PageEmailProjection

    PageEmailProjection Properties Name Type Description Notes Content **EmailProjection[]** [optional] Empty …

  • PageExpiredInboxRecordProjecti …

    PageExpiredInboxRecordProjection Properties Name Type Description Notes Content …

  • PageGroupProjection

    PageGroupProjection Properties Name Type Description Notes Content **GroupProjection[]** [optional] Empty …

  • PageInboxForwarderDto

    PageInboxForwarderDto Properties Name Type Description Notes Content **InboxForwarderDto[]** [optional] Empty …

  • PageInboxProjection

    PageInboxProjection Properties Name Type Description Notes Content **InboxPreview[]** [optional] Empty Boolean …

  • PageInboxRulesetDto

    PageInboxRulesetDto Properties Name Type Description Notes Content **InboxRulesetDto[]** [optional] Empty …

  • PageMissedEmailProjection

    PageMissedEmailProjection Properties Name Type Description Notes Content **MissedEmailProjection[]** [optional] …

  • PageOrganizationInboxProjectio …

    PageOrganizationInboxProjection Properties Name Type Description Notes Content **OrganizationInboxProjection[]** …

  • PageSentEmailProjection

    PageSentEmailProjection Properties Name Type Description Notes Content **SentEmailProjection[]** Collection of …

  • PageTemplateProjection

    PageTemplateProjection Properties Name Type Description Notes Content **TemplateProjection[]** [optional] …

  • PageThreadProjection

    PageThreadProjection Properties Name Type Description Notes Content **ThreadProjection[]** [optional] Empty …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Properties Name Type Description Notes Content **TrackingPixelProjection[]** …

  • PageUnknownMissedEmailProjecti …

    PageUnknownMissedEmailProjection Properties Name Type Description Notes Content …

  • PageWebhookProjection

    PageWebhookProjection Properties Name Type Description Notes Content **WebhookProjection[]** [optional] Empty …

  • PageWebhookResult

    PageWebhookResult Properties Name Type Description Notes Content **WebhookResultDto[]** [optional] Empty …

  • RawEmailJson

    RawEmailJson Properties Name Type Description Notes Content String Examples Prepare the resource …

  • Recipient

    Recipient Properties Name Type Description Notes EmailAddress String Name String [optional] RawValue …

  • ReplyToAliasEmailOptions

    ReplyToAliasEmailOptions Properties Name Type Description Notes Attachments String[] List of uploaded attachments …

  • ReplyToEmailOptions

    ReplyToEmailOptions Properties Name Type Description Notes Attachments String[] List of uploaded attachments to …

  • SendEmailOptions

    SendEmailOptions Properties Name Type Description Notes AddTrackingPixel Boolean Add tracking pixel to email …

  • Sender

    ModelSender Properties Name Type Description Notes EmailAddress String Name String [optional] RawValue …

  • SentEmailDto

    SentEmailDto Properties Name Type Description Notes Attachments String[] Array of IDs of attachments that were …

  • SentEmailProjection

    SentEmailProjection Properties Name Type Description Notes Attachments String[] Bcc String[] BodyMD5Hash …

  • SentEmailsControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.SentEmailsControllerApi All URIs are relative to …

  • SetInboxFavouritedOptions

    SetInboxFavouritedOptions Properties Name Type Description Notes State Boolean Is the inbox a favorite. Marking …

  • SimpleSendEmailOptions

    SimpleSendEmailOptions Properties Name Type Description Notes Body String Body of the email message. Supports …

  • Sort

    Sort Properties Name Type Description Notes Empty Boolean [optional] Sorted Boolean [optional] Unsorted …

  • TemplateControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.TemplateControllerApi All URIs are relative to …

  • TemplateDto

    TemplateDto Properties Name Type Description Notes Content String CreatedAt System.DateTime Id String …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes CreatedAt System.DateTime Id String Name String …

  • TemplateVariable

    TemplateVariable Properties Name Type Description Notes Name String VariableType String Examples …

  • TestNewInboxForwarderOptions

    TestNewInboxForwarderOptions Properties Name Type Description Notes InboxForwarderTestOptions …

  • TestNewInboxRulesetOptions

    TestNewInboxRulesetOptions Properties Name Type Description Notes InboxRulesetTestOptions InboxRulesetTestOptions …

  • ThreadProjection

    ThreadProjection Properties Name Type Description Notes AliasId String Bcc String[] [optional] Cc String[] …

  • TrackingControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.TrackingControllerApi All URIs are relative to …

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes CreatedAt System.DateTime Html String Id String …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes CreatedAt System.DateTime Id String …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes CreatedAt System.DateTime VarFrom String …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes Count Int64 Examples Prepare the resource $UnreadCount …

  • UnseenErrorCountDto

    UnseenErrorCountDto Properties Name Type Description Notes Count Int64 Examples Prepare the resource …

  • UpdateAliasOptions

    UpdateAliasOptions Properties Name Type Description Notes Name String Optional name for alias [optional] …

  • UpdateDomainOptions

    UpdateDomainOptions Properties Name Type Description Notes CatchAllInboxId String [optional] Examples …

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes ContactIds String[] Examples Prepare the …

  • UpdateInboxOptions

    UpdateInboxOptions Properties Name Type Description Notes Description String Description of an inbox for …

  • UploadAttachmentOptions

    UploadAttachmentOptions Properties Name Type Description Notes Base64Contents String Base64 encoded string of …

  • ValidationDto

    ValidationDto Properties Name Type Description Notes EmailId String ID of the email validated [optional] Html …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes LineNumber Int32 Message String [optional] …

  • VerifyEmailAddressOptions

    VerifyEmailAddressOptions Properties Name Type Description Notes MailServerDomain String [optional] …

  • WaitForConditions

    WaitForConditions Properties Name Type Description Notes Before System.DateTime ISO Date Time latest time of …

  • WaitForControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.WaitForControllerApi All URIs are relative to …

  • WebhookControllerApi

    maislurp-client-powershell.maislurp-client-powershell/Api.WebhookControllerApi All URIs are relative to …

  • WebhookDto

    WebhookDto Properties Name Type Description Notes BasicAuth Boolean Does webhook expect basic authentication? If …

  • WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload Properties Name Type Description Notes CreatedAt System.DateTime Date time of event …

  • WebhookEmailReadPayload

    WebhookEmailReadPayload Properties Name Type Description Notes CreatedAt System.DateTime Date time of event …

  • WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload Properties Name Type Description Notes AttachmentId String ID of attachment. Use the …

  • WebhookNewContactPayload

    WebhookNewContactPayload Properties Name Type Description Notes Company String [optional] ContactId String …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload Properties Name Type Description Notes AttachmentMetaDatas **AttachmentMetaData[]** List …

  • WebhookProjection

    WebhookProjection Properties Name Type Description Notes CreatedAt System.DateTime EventName String …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes Message String [optional] Success Boolean …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes CreatedAt System.DateTime HttpMethod String Id …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes Headers System.Collections.Hashtable Method String …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes Message String [optional] StatusCode Int32 …

  • WebhookTestResult

    WebhookTestResult Properties Name Type Description Notes Message String [optional] Request WebhookTestRequest …

  • Docs

    MailSlurp Email API Protobuf definitions Protobuf definitions / schemas for the MailSlurp REST email API. See github for …

  • Docs

    Index AbstractWebhookPayload AliasDto AliasProjection AliasControllerApi AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    AbstractWebhookPayload Abstract webhook payload. Use the correct payload type for your webhook event type in order to …

  • AliasControllerApi

    mailslurp_client.AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • AliasDto

    AliasDto Email alias representation Properties Name Type Description Notes created_at datetime [optional] …

  • AliasProjection

    AliasProjection Representation of a alias Properties Name Type Description Notes created_at datetime …

  • AttachmentControllerApi

    mailslurp_client.AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • AttachmentEntity

    AttachmentEntity Properties Name Type Description Notes attachment_id str content_length int [optional] …

  • AttachmentMetaData

    AttachmentMetaData Meta data associated with an attachment. Attachments are stored as byte blobs so the meta data is …

  • AttachmentProjection

    AttachmentProjection Properties Name Type Description Notes attachment_id str Attachment ID [optional] …

  • BasicAuthOptions

    BasicAuthOptions Basic Authentication options for webhooks. Will be used is present when calling webhook endpoints. …

  • BounceControllerApi

    mailslurp_client.BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • BouncedEmailDto

    BouncedEmailDto Bounced email Properties Name Type Description Notes bounce_mta str [optional] …

  • BouncedRecipientDto

    BouncedRecipientDto Bounced recipient Properties Name Type Description Notes created_at datetime id str …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes created_at datetime id str [optional] sender str …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes created_at datetime id str [optional] recipient str …

  • BulkActionsControllerApi

    mailslurp_client.BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • BulkSendEmailOptions

    BulkSendEmailOptions Options for bulk sending an email from multiple addresses. See regular sendEmail methods for more …

  • CommonActionsControllerApi

    mailslurp_client.CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ConditionOption

    ConditionOption Options for matching emails in an inbox based on a condition such as HAS_ATTACHMENTS=TRUE Properties …

  • ContactControllerApi

    mailslurp_client.ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ContactDto

    ContactDto Properties Name Type Description Notes company str [optional] created_at datetime …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes company str [optional] created_at datetime …

  • ContentMatchOptions

    ContentMatchOptions Options for matching content using regex patterns based on Java Pattern syntax Properties Name …

  • CountDto

    CountDto Properties Name Type Description Notes total_elements int [Back to Model list] [Back to API list] …

  • CreateAliasOptions

    CreateAliasOptions Create email alias options. Email aliases can be used to mask real email addresses behind an ID. You …

  • CreateContactOptions

    CreateContactOptions Properties Name Type Description Notes email_addresses list[str] Set of email addresses …

  • CreateDomainOptions

    CreateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to this domain …

  • CreateGroupOptions

    CreateGroupOptions Properties Name Type Description Notes name str description str [optional] [Back to …

  • CreateInboxDto

    CreateInboxDto Options for creating an inbox. An inbox has a real email address that can send and receive emails. …

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Options for creating an inbox forwarder Properties Name Type Description Notes field …

  • CreateInboxRulesetOptions

    CreateInboxRulesetOptions Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or …

  • CreateTemplateOptions

    CreateTemplateOptions Properties Name Type Description Notes name str content str [Back to Model list] …

  • CreateTrackingPixelOptions

    CreateTrackingPixelOptions Properties Name Type Description Notes name str [optional] recipient str …

  • CreateWebhookOptions

    CreateWebhookOptions Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a …

  • DescribeDomainOptions

    DescribeDomainOptions Properties Name Type Description Notes domain str [Back to Model list] [Back to API …

  • DescribeMailServerDomainResult

    DescribeMailServerDomainResult Name Server lookup result Properties Name Type Description Notes domain str …

  • DNSLookupOptions

    DNSLookupOptions Options for DNS query. Properties Name Type Description Notes hostname str List of record types …

  • DNSLookupResult

    DNSLookupResult DNS lookup result. Includes record type, time to live, raw response, and name value for the name server …

  • DNSLookupResults

    DNSLookupResults Results of query on domain name servers Properties Name Type Description Notes results …

  • DomainControllerApi

    mailslurp_client.DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • DomainDto

    DomainDto Domain plus verification records and status Properties Name Type Description Notes catch_all_inbox_id …

  • DomainNameRecord

    DomainNameRecord DNS Record required for verification of a domain. Record vary depending on domain type. Properties …

  • DomainPreview

    DomainPreview Preview object for domain entity Properties Name Type Description Notes catch_all_inbox_id str …

  • DownloadAttachmentDto

    DownloadAttachmentDto Content of attachment Properties Name Type Description Notes base64_file_contents str …

  • Email

    Email Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body …

  • EmailAnalysis

    EmailAnalysis Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic error message …

  • EmailContentMatchResult

    EmailContentMatchResult Matches for the given pattern Properties Name Type Description Notes matches list[str] …

  • EmailControllerApi

    mailslurp_client.EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • EmailLinksResult

    EmailLinksResult Links found in HTML Properties Name Type Description Notes body str links list[str] …

  • EmailPreview

    EmailPreview Preview of an email message. For full message (including body and attachments) call the getEmail or other …

  • EmailProjection

    EmailProjection A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and …

  • EmailRecipients

    EmailRecipients Properties Name Type Description Notes bcc **list[Recipient]** [optional] cc …

  • EmailTextLinesResult

    EmailTextLinesResult Parsed text of an email Properties Name Type Description Notes body str lines list[str] …

  • EmailVerificationResult

    EmailVerificationResult Email verification result. Valid means email address exists according to response from mail …

  • ExpirationDefaults

    ExpirationDefaults Expiration defaults for your account Properties Name Type Description Notes …

  • ExpiredControllerApi

    mailslurp_client.ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ExpiredInboxDto

    ExpiredInboxDto Expired inbox Properties Name Type Description Notes email_address str id str inbox_id …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes created_at datetime email_address str …

  • ExportControllerApi

    mailslurp_client.ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ExportLink

    ExportLink Export download link Properties Name Type Description Notes download_link str [Back to Model …

  • ExportOptions

    ExportOptions Options for exporting user data Properties Name Type Description Notes output_format str …

  • FlushExpiredInboxesResult

    FlushExpiredInboxesResult Properties Name Type Description Notes expire_before datetime inbox_ids list[str] …

  • FormControllerApi

    mailslurp_client.FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ForwardEmailOptions

    ForwardEmailOptions Options for forwarding an email Properties Name Type Description Notes bcc list[str] Optional …

  • GravatarUrl

    GravatarUrl Properties Name Type Description Notes hash str url str [Back to Model list] [Back to API …

  • GroupContactsDto

    GroupContactsDto Properties Name Type Description Notes contacts **list[ContactDto]** group GroupDto …

  • GroupControllerApi

    mailslurp_client.GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • GroupDto

    GroupDto Properties Name Type Description Notes created_at datetime description str [optional] id str …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes created_at datetime description str [optional] id …

  • HTMLValidationResult

    HTMLValidationResult HTML Validation Results Properties Name Type Description Notes errors …

  • Inbox

    Inbox Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from …

  • InboxControllerApi

    mailslurp_client.InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxExistsDto

    InboxExistsDto Properties Name Type Description Notes exists bool [Back to Model list] [Back to API list] …

  • InboxForwarderControllerApi

    mailslurp_client.InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes created_at datetime field str …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes test_value str [Back to Model list] [Back …

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes does_match bool matches dict(str, bool) …

  • InboxPreview

    InboxPreview Properties Name Type Description Notes created_at datetime When the inbox was created. Time stamps …

  • InboxRulesetControllerApi

    mailslurp_client.InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes action str created_at datetime handler str id …

  • InboxRulesetTestOptions

    InboxRulesetTestOptions Properties Name Type Description Notes test_target str [Back to Model list] [Back to …

  • InboxRulesetTestResult

    InboxRulesetTestResult Properties Name Type Description Notes matches bool ruleset_matches dict(str, bool) …

  • IPAddressResult

    IPAddressResult IP Address look up result for a given domain / hostname Properties Name Type Description Notes …

  • JSONSchemaDto

    JSONSchemaDto Properties Name Type Description Notes value str [Back to Model list] [Back to API list] [Back …

  • MailServerControllerApi

    mailslurp_client.MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • MatchOption

    MatchOption Options for matching emails in an inbox. Each match option object contains a field, should and value …

  • MatchOptions

    MatchOptions Optional filter for matching emails based on fields. For instance filter results to only include emails …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes attachment_count int bcc list[str] body_excerpt str …

  • MissedEmailControllerApi

    mailslurp_client.MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • MissedEmailProjection

    MissedEmailProjection Properties Name Type Description Notes created_at datetime _from str [optional] id …

  • NameServerRecord

    NameServerRecord Name Server Record Properties Name Type Description Notes priority str raw str …

  • OrganizationInboxProjection

    OrganizationInboxProjection Properties Name Type Description Notes created_at datetime When the inbox was …

  • Pageable

    Pageable Properties Name Type Description Notes offset int [optional] page_number int [optional] page_size …

  • PageAlias

    PageAlias Paginated email alias results. Page starts at zero. Projection results may omit larger entity fields. For …

  • PageAttachmentEntity

    PageAttachmentEntity Paginated attachment entity results. Page starts at zero. Projection results may omit larger entity …

  • PageBouncedEmail

    PageBouncedEmail Paginated bounced email. Page starts at zero. Projection results may omit larger entity fields. For …

  • PageBouncedRecipients

    PageBouncedRecipients Paginated bounced recipients. Page starts at zero. Projection results may omit larger entity …

  • PageContactProjection

    PageContactProjection Paginated contact results. Page starts at zero. Projection results may omit larger entity fields. …

  • PageEmailPreview

    PageEmailPreview Paginated email preview results. EmailProjections and EmailPreviews are essentially the same but have …

  • PageEmailProjection

    PageEmailProjection Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but …

  • PageExpiredInboxRecordProjecti …

    PageExpiredInboxRecordProjection Paginated expired inbox results. Page starts at zero. Projection results may omit …

  • PageGroupProjection

    PageGroupProjection Paginated missed email results. Page starts at zero. Projection results may omit larger entity …

  • PageInboxForwarderDto

    PageInboxForwarderDto Paginated inbox forwarder results. Page starts at zero. Projection results may omit larger entity …

  • PageInboxProjection

    PageInboxProjection Paginated inbox results. Page starts at zero. Projection results may omit larger entity fields. For …

  • PageInboxRulesetDto

    PageInboxRulesetDto Paginated inbox ruleset results. Page starts at zero. Projection results may omit larger entity …

  • PageMissedEmailProjection

    PageMissedEmailProjection Paginated MissedEmail results. Page starts at zero. Projection results may omit larger entity …

  • PageOrganizationInboxProjectio …

    PageOrganizationInboxProjection Paginated organization inbox results. Page starts at zero. Projection results may omit …

  • PageSentEmailProjection

    PageSentEmailProjection Paginated sent email results. Page starts at zero. Projection results may omit larger entity …

  • PageTemplateProjection

    PageTemplateProjection Paginated email template results. Page starts at zero. Projection results may omit larger entity …

  • PageThreadProjection

    PageThreadProjection Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Paginated TrackingPixel results. Page starts at zero. Projection results may omit larger …

  • PageUnknownMissedEmailProjecti …

    PageUnknownMissedEmailProjection Paginated unknown MissedEmail results. Unknown missed emails are emails that were sent …

  • PageWebhookProjection

    PageWebhookProjection Paginated webhook entity. Page starts at zero. Projection results may omit larger entity fields. …

  • PageWebhookResult

    PageWebhookResult Paginated webhook results. Page starts at zero. Projection results may omit larger entity fields. For …

  • RawEmailJson

    RawEmailJson Content in raw format Properties Name Type Description Notes content str [Back to Model list] …

  • Recipient

    Recipient Properties Name Type Description Notes email_address str name str [optional] raw_value str …

  • ReplyToAliasEmailOptions

    ReplyToAliasEmailOptions Options for replying to an alias email using the alias inbox Properties Name Type …

  • ReplyToEmailOptions

    ReplyToEmailOptions Options for replying to email with API Properties Name Type Description Notes attachments …

  • SendEmailOptions

    SendEmailOptions Options for sending an email message from an inbox. You must provide one of: to, toGroup, or toContacts …

  • Sender

    Sender Properties Name Type Description Notes email_address str name str [optional] raw_value str …

  • SentEmailDto

    SentEmailDto Sent email details Properties Name Type Description Notes attachments list[str] Array of IDs of …

  • SentEmailProjection

    SentEmailProjection Properties Name Type Description Notes attachments list[str] bcc list[str] …

  • SentEmailsControllerApi

    mailslurp_client.SentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • SetInboxFavouritedOptions

    SetInboxFavouritedOptions Options for setting inbox favourite state Properties Name Type Description Notes state …

  • SimpleSendEmailOptions

    SimpleSendEmailOptions Properties Name Type Description Notes body str Body of the email message. Supports HTML …

  • Sort

    Sort Properties Name Type Description Notes empty bool [optional] sorted bool [optional] unsorted bool …

  • TemplateControllerApi

    mailslurp_client.TemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • TemplateDto

    TemplateDto Properties Name Type Description Notes content str created_at datetime id str name str …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes created_at datetime id str name str …

  • TemplateVariable

    TemplateVariable Properties Name Type Description Notes name str variable_type str [Back to Model list] …

  • TestNewInboxForwarderOptions

    TestNewInboxForwarderOptions Properties Name Type Description Notes inbox_forwarder_test_options …

  • TestNewInboxRulesetOptions

    TestNewInboxRulesetOptions Properties Name Type Description Notes inbox_ruleset_test_options …

  • ThreadProjection

    ThreadProjection A thread is a message thread created for a message received by an alias Properties Name Type …

  • TrackingControllerApi

    mailslurp_client.TrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes created_at datetime html str id str inbox_id …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes created_at datetime id str inbox_id str …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes created_at datetime _from str [optional] …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes count int [Back to Model list] [Back to API list] [Back …

  • UnseenErrorCountDto

    UnseenErrorCountDto Properties Name Type Description Notes count int [Back to Model list] [Back to API list] …

  • UpdateAliasOptions

    UpdateAliasOptions Update an email alias Properties Name Type Description Notes name str Optional name for alias …

  • UpdateDomainOptions

    UpdateDomainOptions Options for creating a domain to use with MailSlurp. You must have ownership access to this domain …

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes contact_ids list[str] [Back to Model list] [Back …

  • UpdateInboxOptions

    UpdateInboxOptions Options for updating inbox properties Properties Name Type Description Notes description str …

  • UploadAttachmentOptions

    UploadAttachmentOptions Options for uploading files for attachments. When sending emails with the API that require …

  • ValidationDto

    ValidationDto Response object for email validation operation Properties Name Type Description Notes email_id str …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes line_number int message str [optional] [Back to …

  • VerifyEmailAddressOptions

    VerifyEmailAddressOptions Options for verifying that an email address exists at a remote mail server. Properties Name …

  • WaitForConditions

    WaitForConditions Conditions that a waitForXEmails endpoint operates on. The methods wait until given conditions are met …

  • WaitForControllerApi

    mailslurp_client.WaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • WebhookControllerApi

    mailslurp_client.WebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • WebhookDto

    WebhookDto Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is …

  • WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email …

  • WebhookEmailReadPayload

    WebhookEmailReadPayload EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is …

  • WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an …

  • WebhookNewContactPayload

    WebhookNewContactPayload NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is …

  • WebhookProjection

    WebhookProjection Representation of a webhook Properties Name Type Description Notes created_at datetime …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes message str [optional] success bool …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes created_at datetime http_method str id str …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes headers dict(str, str) method str payload str …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes message str [optional] status_code int [optional] …

  • WebhookTestResult

    WebhookTestResult Results of testing a webhook Properties Name Type Description Notes message str [optional] …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    MailSlurpClient::AbstractWebhookPayload Properties Name Type Description Notes event_name String message_id …

  • AliasControllerApi

    MailSlurpClient::AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • AliasDto

    MailSlurpClient::AliasDto Properties Name Type Description Notes created_at DateTime [optional] email_address …

  • AliasProjection

    MailSlurpClient::AliasProjection Properties Name Type Description Notes created_at DateTime email_address …

  • AttachmentControllerApi

    MailSlurpClient::AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • AttachmentEntity

    MailSlurpClient::AttachmentEntity Properties Name Type Description Notes attachment_id String content_length …

  • AttachmentMetaData

    MailSlurpClient::AttachmentMetaData Properties Name Type Description Notes content_length Integer Size of …

  • AttachmentProjection

    MailSlurpClient::AttachmentProjection Properties Name Type Description Notes attachment_id String Attachment ID …

  • BasicAuthOptions

    MailSlurpClient::BasicAuthOptions Properties Name Type Description Notes username String password String …

  • BounceControllerApi

    MailSlurpClient::BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • BouncedEmailDto

    MailSlurpClient::BouncedEmailDto Properties Name Type Description Notes bounce_mta String [optional] …

  • BouncedRecipientDto

    MailSlurpClient::BouncedRecipientDto Properties Name Type Description Notes created_at DateTime id String …

  • BounceProjection

    MailSlurpClient::BounceProjection Properties Name Type Description Notes created_at DateTime id String …

  • BounceRecipient

    MailSlurpClient::BounceRecipient Properties Name Type Description Notes created_at DateTime id String …

  • BulkActionsControllerApi

    MailSlurpClient::BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • BulkSendEmailOptions

    MailSlurpClient::BulkSendEmailOptions Properties Name Type Description Notes inbox_ids Array Inboxes to send the …

  • CommonActionsControllerApi

    MailSlurpClient::CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ConditionOption

    MailSlurpClient::ConditionOption Properties Name Type Description Notes condition String The condition to …

  • ContactControllerApi

    MailSlurpClient::ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ContactDto

    MailSlurpClient::ContactDto Properties Name Type Description Notes company String [optional] created_at …

  • ContactProjection

    MailSlurpClient::ContactProjection Properties Name Type Description Notes company String [optional] created_at …

  • ContentMatchOptions

    MailSlurpClient::ContentMatchOptions Properties Name Type Description Notes pattern String Java style regex …

  • CountDto

    MailSlurpClient::CountDto Properties Name Type Description Notes total_elements Integer Code Sample require …

  • CreateAliasOptions

    MailSlurpClient::CreateAliasOptions Properties Name Type Description Notes email_address String Email address to …

  • CreateContactOptions

    MailSlurpClient::CreateContactOptions Properties Name Type Description Notes email_addresses Array Set of email …

  • CreateDomainOptions

    MailSlurpClient::CreateDomainOptions Properties Name Type Description Notes created_catch_all_inbox Boolean …

  • CreateGroupOptions

    MailSlurpClient::CreateGroupOptions Properties Name Type Description Notes name String description String …

  • CreateInboxDto

    MailSlurpClient::CreateInboxDto Properties Name Type Description Notes allow_team_access Boolean DEPRECATED (team …

  • CreateInboxForwarderOptions

    MailSlurpClient::CreateInboxForwarderOptions Properties Name Type Description Notes field String Field to match …

  • CreateInboxRulesetOptions

    MailSlurpClient::CreateInboxRulesetOptions Properties Name Type Description Notes action String Action to be …

  • CreateTemplateOptions

    MailSlurpClient::CreateTemplateOptions Properties Name Type Description Notes name String content String …

  • CreateTrackingPixelOptions

    MailSlurpClient::CreateTrackingPixelOptions Properties Name Type Description Notes name String [optional] …

  • CreateWebhookOptions

    MailSlurpClient::CreateWebhookOptions Properties Name Type Description Notes basic_auth BasicAuthOptions …

  • DescribeDomainOptions

    MailSlurpClient::DescribeDomainOptions Properties Name Type Description Notes domain String Code Sample …

  • DescribeMailServerDomainResult

    MailSlurpClient::DescribeMailServerDomainResult Properties Name Type Description Notes domain String message …

  • DNSLookupOptions

    MailSlurpClient::DNSLookupOptions Properties Name Type Description Notes hostname String List of record types you …

  • DNSLookupResult

    MailSlurpClient::DNSLookupResult Properties Name Type Description Notes name String record_entries Array …

  • DNSLookupResults

    MailSlurpClient::DNSLookupResults Properties Name Type Description Notes results Array Code Sample require …

  • DomainControllerApi

    MailSlurpClient::DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • DomainDto

    MailSlurpClient::DomainDto Properties Name Type Description Notes catch_all_inbox_id String The optional catch …

  • DomainNameRecord

    MailSlurpClient::DomainNameRecord Properties Name Type Description Notes name String record_entries Array …

  • DomainPreview

    MailSlurpClient::DomainPreview Properties Name Type Description Notes catch_all_inbox_id String [optional] …

  • DownloadAttachmentDto

    MailSlurpClient::DownloadAttachmentDto Properties Name Type Description Notes base64_file_contents String Base64 …

  • Email

    MailSlurpClient::Email Properties Name Type Description Notes analysis EmailAnalysis [optional] attachments …

  • EmailAnalysis

    MailSlurpClient::EmailAnalysis Properties Name Type Description Notes dkim_verdict String Verdict of DomainKeys …

  • EmailContentMatchResult

    MailSlurpClient::EmailContentMatchResult Properties Name Type Description Notes matches Array pattern String …

  • EmailControllerApi

    MailSlurpClient::EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • EmailLinksResult

    MailSlurpClient::EmailLinksResult Properties Name Type Description Notes body String links Array Code …

  • EmailPreview

    MailSlurpClient::EmailPreview Properties Name Type Description Notes attachments Array List of IDs of attachments …

  • EmailProjection

    MailSlurpClient::EmailProjection Properties Name Type Description Notes attachments Array [optional] bcc Array …

  • EmailRecipients

    MailSlurpClient::EmailRecipients Properties Name Type Description Notes bcc Array [optional] cc Array …

  • EmailTextLinesResult

    MailSlurpClient::EmailTextLinesResult Properties Name Type Description Notes body String lines Array …

  • EmailVerificationResult

    MailSlurpClient::EmailVerificationResult Properties Name Type Description Notes domain_name String …

  • ExpirationDefaults

    MailSlurpClient::ExpirationDefaults Properties Name Type Description Notes can_permanent_inbox Boolean …

  • ExpiredControllerApi

    MailSlurpClient::ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ExpiredInboxDto

    MailSlurpClient::ExpiredInboxDto Properties Name Type Description Notes email_address String id String …

  • ExpiredInboxRecordProjection

    MailSlurpClient::ExpiredInboxRecordProjection Properties Name Type Description Notes created_at DateTime …

  • ExportControllerApi

    MailSlurpClient::ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • ExportLink

    MailSlurpClient::ExportLink Properties Name Type Description Notes download_link String Code Sample require …

  • ExportOptions

    MailSlurpClient::ExportOptions Properties Name Type Description Notes output_format String …

  • FlushExpiredInboxesResult

    MailSlurpClient::FlushExpiredInboxesResult Properties Name Type Description Notes expire_before DateTime …

  • FormControllerApi

    MailSlurpClient::FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ForwardEmailOptions

    MailSlurpClient::ForwardEmailOptions Properties Name Type Description Notes bcc Array Optional bcc recipients …

  • GravatarUrl

    MailSlurpClient::GravatarUrl Properties Name Type Description Notes hash String url String Code Sample …

  • GroupContactsDto

    MailSlurpClient::GroupContactsDto Properties Name Type Description Notes contacts Array group GroupDto …

  • GroupControllerApi

    MailSlurpClient::GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • GroupDto

    MailSlurpClient::GroupDto Properties Name Type Description Notes created_at DateTime description String …

  • GroupProjection

    MailSlurpClient::GroupProjection Properties Name Type Description Notes created_at DateTime description …

  • HTMLValidationResult

    MailSlurpClient::HTMLValidationResult Properties Name Type Description Notes errors Array Optional errors …

  • Inbox

    MailSlurpClient::Inbox Properties Name Type Description Notes created_at DateTime When the inbox was created. …

  • InboxControllerApi

    MailSlurpClient::InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxExistsDto

    MailSlurpClient::InboxExistsDto Properties Name Type Description Notes exists Boolean Code Sample require …

  • InboxForwarderControllerApi

    MailSlurpClient::InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxForwarderDto

    MailSlurpClient::InboxForwarderDto Properties Name Type Description Notes created_at DateTime field String …

  • InboxForwarderTestOptions

    MailSlurpClient::InboxForwarderTestOptions Properties Name Type Description Notes test_value String Code …

  • InboxForwarderTestResult

    MailSlurpClient::InboxForwarderTestResult Properties Name Type Description Notes does_match Boolean matches …

  • InboxPreview

    MailSlurpClient::InboxPreview Properties Name Type Description Notes created_at DateTime When the inbox was …

  • InboxRulesetControllerApi

    MailSlurpClient::InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • InboxRulesetDto

    MailSlurpClient::InboxRulesetDto Properties Name Type Description Notes action String created_at DateTime …

  • InboxRulesetTestOptions

    MailSlurpClient::InboxRulesetTestOptions Properties Name Type Description Notes test_target String Code …

  • InboxRulesetTestResult

    MailSlurpClient::InboxRulesetTestResult Properties Name Type Description Notes matches Boolean …

  • IPAddressResult

    MailSlurpClient::IPAddressResult Properties Name Type Description Notes address String hostname String …

  • JSONSchemaDto

    MailSlurpClient::JSONSchemaDto Properties Name Type Description Notes value String Code Sample require …

  • MailServerControllerApi

    MailSlurpClient::MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • MatchOption

    MailSlurpClient::MatchOption Properties Name Type Description Notes field String The email property to match on. …

  • MatchOptions

    MailSlurpClient::MatchOptions Properties Name Type Description Notes conditions Array Zero or more conditions …

  • MissedEmail

    MailSlurpClient::MissedEmail Properties Name Type Description Notes attachment_count Integer bcc Array …

  • MissedEmailControllerApi

    MailSlurpClient::MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • MissedEmailProjection

    MailSlurpClient::MissedEmailProjection Properties Name Type Description Notes created_at DateTime from String …

  • NameServerRecord

    MailSlurpClient::NameServerRecord Properties Name Type Description Notes priority String raw String …

  • OrganizationInboxProjection

    MailSlurpClient::OrganizationInboxProjection Properties Name Type Description Notes created_at DateTime When the …

  • Pageable

    MailSlurpClient::Pageable Properties Name Type Description Notes offset Integer [optional] page_number Integer …

  • PageAlias

    MailSlurpClient::PageAlias Properties Name Type Description Notes content Array [optional] empty Boolean …

  • PageAttachmentEntity

    MailSlurpClient::PageAttachmentEntity Properties Name Type Description Notes content Array [optional] empty …

  • PageBouncedEmail

    MailSlurpClient::PageBouncedEmail Properties Name Type Description Notes content Array [optional] empty …

  • PageBouncedRecipients

    MailSlurpClient::PageBouncedRecipients Properties Name Type Description Notes content Array [optional] empty …

  • PageContactProjection

    MailSlurpClient::PageContactProjection Properties Name Type Description Notes content Array [optional] empty …

  • PageEmailPreview

    MailSlurpClient::PageEmailPreview Properties Name Type Description Notes content Array [optional] empty …

  • PageEmailProjection

    MailSlurpClient::PageEmailProjection Properties Name Type Description Notes content Array [optional] empty …

  • PageExpiredInboxRecordProjecti …

    MailSlurpClient::PageExpiredInboxRecordProjection Properties Name Type Description Notes content Array …

  • PageGroupProjection

    MailSlurpClient::PageGroupProjection Properties Name Type Description Notes content Array [optional] empty …

  • PageInboxForwarderDto

    MailSlurpClient::PageInboxForwarderDto Properties Name Type Description Notes content Array [optional] empty …

  • PageInboxProjection

    MailSlurpClient::PageInboxProjection Properties Name Type Description Notes content Array [optional] empty …

  • PageInboxRulesetDto

    MailSlurpClient::PageInboxRulesetDto Properties Name Type Description Notes content Array [optional] empty …

  • PageMissedEmailProjection

    MailSlurpClient::PageMissedEmailProjection Properties Name Type Description Notes content Array [optional] …

  • PageOrganizationInboxProjectio …

    MailSlurpClient::PageOrganizationInboxProjection Properties Name Type Description Notes content Array [optional] …

  • PageSentEmailProjection

    MailSlurpClient::PageSentEmailProjection Properties Name Type Description Notes content Array Collection of items …

  • PageTemplateProjection

    MailSlurpClient::PageTemplateProjection Properties Name Type Description Notes content Array [optional] empty …

  • PageThreadProjection

    MailSlurpClient::PageThreadProjection Properties Name Type Description Notes content Array [optional] empty …

  • PageTrackingPixelProjection

    MailSlurpClient::PageTrackingPixelProjection Properties Name Type Description Notes content Array [optional] …

  • PageUnknownMissedEmailProjecti …

    MailSlurpClient::PageUnknownMissedEmailProjection Properties Name Type Description Notes content Array …

  • PageWebhookProjection

    MailSlurpClient::PageWebhookProjection Properties Name Type Description Notes content Array [optional] empty …

  • PageWebhookResult

    MailSlurpClient::PageWebhookResult Properties Name Type Description Notes content Array [optional] empty …

  • RawEmailJson

    MailSlurpClient::RawEmailJson Properties Name Type Description Notes content String Code Sample require …

  • Recipient

    MailSlurpClient::Recipient Properties Name Type Description Notes email_address String name String …

  • ReplyToAliasEmailOptions

    MailSlurpClient::ReplyToAliasEmailOptions Properties Name Type Description Notes attachments Array List of …

  • ReplyToEmailOptions

    MailSlurpClient::ReplyToEmailOptions Properties Name Type Description Notes attachments Array List of uploaded …

  • SendEmailOptions

    MailSlurpClient::SendEmailOptions Properties Name Type Description Notes add_tracking_pixel Boolean Add tracking …

  • Sender

    MailSlurpClient::Sender Properties Name Type Description Notes email_address String name String [optional] …

  • SentEmailDto

    MailSlurpClient::SentEmailDto Properties Name Type Description Notes attachments Array Array of IDs of …

  • SentEmailProjection

    MailSlurpClient::SentEmailProjection Properties Name Type Description Notes attachments Array bcc Array …

  • SentEmailsControllerApi

    MailSlurpClient::SentEmailsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • SetInboxFavouritedOptions

    MailSlurpClient::SetInboxFavouritedOptions Properties Name Type Description Notes state Boolean Is the inbox a …

  • SimpleSendEmailOptions

    MailSlurpClient::SimpleSendEmailOptions Properties Name Type Description Notes body String Body of the email …

  • Sort

    MailSlurpClient::Sort Properties Name Type Description Notes empty Boolean [optional] sorted Boolean …

  • TemplateControllerApi

    MailSlurpClient::TemplateControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • TemplateDto

    MailSlurpClient::TemplateDto Properties Name Type Description Notes content String created_at DateTime id …

  • TemplateProjection

    MailSlurpClient::TemplateProjection Properties Name Type Description Notes created_at DateTime id String …

  • TemplateVariable

    MailSlurpClient::TemplateVariable Properties Name Type Description Notes name String variable_type String …

  • TestNewInboxForwarderOptions

    MailSlurpClient::TestNewInboxForwarderOptions Properties Name Type Description Notes inbox_forwarder_test_options …

  • TestNewInboxRulesetOptions

    MailSlurpClient::TestNewInboxRulesetOptions Properties Name Type Description Notes inbox_ruleset_test_options …

  • ThreadProjection

    MailSlurpClient::ThreadProjection Properties Name Type Description Notes alias_id String bcc Array …

  • TrackingControllerApi

    MailSlurpClient::TrackingControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • TrackingPixelDto

    MailSlurpClient::TrackingPixelDto Properties Name Type Description Notes created_at DateTime html String …

  • TrackingPixelProjection

    MailSlurpClient::TrackingPixelProjection Properties Name Type Description Notes created_at DateTime id String …

  • UnknownMissedEmailProjection

    MailSlurpClient::UnknownMissedEmailProjection Properties Name Type Description Notes created_at DateTime from …

  • UnreadCount

    MailSlurpClient::UnreadCount Properties Name Type Description Notes count Integer Code Sample require …

  • UnseenErrorCountDto

    MailSlurpClient::UnseenErrorCountDto Properties Name Type Description Notes count Integer Code Sample …

  • UpdateAliasOptions

    MailSlurpClient::UpdateAliasOptions Properties Name Type Description Notes name String Optional name for alias …

  • UpdateDomainOptions

    MailSlurpClient::UpdateDomainOptions Properties Name Type Description Notes catch_all_inbox_id String [optional] …

  • UpdateGroupContacts

    MailSlurpClient::UpdateGroupContacts Properties Name Type Description Notes contact_ids Array Code Sample …

  • UpdateInboxOptions

    MailSlurpClient::UpdateInboxOptions Properties Name Type Description Notes description String Description of an …

  • UploadAttachmentOptions

    MailSlurpClient::UploadAttachmentOptions Properties Name Type Description Notes base64_contents String Base64 …

  • ValidationDto

    MailSlurpClient::ValidationDto Properties Name Type Description Notes email_id String ID of the email validated …

  • ValidationMessage

    MailSlurpClient::ValidationMessage Properties Name Type Description Notes line_number Integer message String …

  • VerifyEmailAddressOptions

    MailSlurpClient::VerifyEmailAddressOptions Properties Name Type Description Notes mail_server_domain String …

  • WaitForConditions

    MailSlurpClient::WaitForConditions Properties Name Type Description Notes before DateTime ISO Date Time latest …

  • WaitForControllerApi

    MailSlurpClient::WaitForControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • WebhookControllerApi

    MailSlurpClient::WebhookControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request …

  • WebhookDto

    MailSlurpClient::WebhookDto Properties Name Type Description Notes basic_auth Boolean Does webhook expect basic …

  • WebhookEmailOpenedPayload

    MailSlurpClient::WebhookEmailOpenedPayload Properties Name Type Description Notes created_at DateTime Date time …

  • WebhookEmailReadPayload

    MailSlurpClient::WebhookEmailReadPayload Properties Name Type Description Notes created_at DateTime Date time of …

  • WebhookNewAttachmentPayload

    MailSlurpClient::WebhookNewAttachmentPayload Properties Name Type Description Notes attachment_id String ID of …

  • WebhookNewContactPayload

    MailSlurpClient::WebhookNewContactPayload Properties Name Type Description Notes company String [optional] …

  • WebhookNewEmailPayload

    MailSlurpClient::WebhookNewEmailPayload Properties Name Type Description Notes attachment_meta_datas Array List …

  • WebhookProjection

    MailSlurpClient::WebhookProjection Properties Name Type Description Notes created_at DateTime event_name …

  • WebhookRedriveResult

    MailSlurpClient::WebhookRedriveResult Properties Name Type Description Notes message String [optional] success …

  • WebhookResultDto

    MailSlurpClient::WebhookResultDto Properties Name Type Description Notes created_at DateTime http_method …

  • WebhookTestRequest

    MailSlurpClient::WebhookTestRequest Properties Name Type Description Notes headers Hash<String, String> …

  • WebhookTestResponse

    MailSlurpClient::WebhookTestResponse Properties Name Type Description Notes message String [optional] …

  • WebhookTestResult

    MailSlurpClient::WebhookTestResult Properties Name Type Description Notes message String [optional] request …

  • Docs

    Index AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentEntity …

  • AbstractWebhookPayload

    AbstractWebhookPayload Properties Name Type Description Notes event_name String message_id String …

  • AliasControllerApi

    AliasControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AliasDto

    AliasDto Properties Name Type Description Notes created_at Option<String> [optional] email_address …

  • AliasProjection

    AliasProjection Properties Name Type Description Notes created_at String email_address String id String …

  • AttachmentControllerApi

    AttachmentControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • AttachmentEntity

    AttachmentEntity Properties Name Type Description Notes attachment_id String content_length Option<i64> …

  • AttachmentMetaData

    AttachmentMetaData Properties Name Type Description Notes content_length Option<i64> Size of attachment in …

  • AttachmentProjection

    AttachmentProjection Properties Name Type Description Notes attachment_id Option<String> Attachment ID …

  • BasicAuthOptions

    BasicAuthOptions Properties Name Type Description Notes username String password String [Back to Model …

  • BounceControllerApi

    BounceControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BouncedEmailDto

    BouncedEmailDto Properties Name Type Description Notes bounce_mta Option<String> [optional] …

  • BouncedRecipientDto

    BouncedRecipientDto Properties Name Type Description Notes created_at String id Option<String> …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes created_at String id Option<String> [optional] …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes created_at String id Option<String> [optional] …

  • BulkActionsControllerApi

    BulkActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • BulkSendEmailOptions

    BulkSendEmailOptions Properties Name Type Description Notes inbox_ids Option<Vec> Inboxes to send the email …

  • CommonActionsControllerApi

    CommonActionsControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ConditionOption

    ConditionOption Properties Name Type Description Notes condition Option<String> The condition to evaluate …

  • ContactControllerApi

    ContactControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ContactDto

    ContactDto Properties Name Type Description Notes company Option<String> [optional] created_at String …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes company Option<String> [optional] created_at …

  • ContentMatchOptions

    ContentMatchOptions Properties Name Type Description Notes pattern Option<String> Java style regex pattern. …

  • CountDto

    CountDto Properties Name Type Description Notes total_elements i64 [Back to Model list] [Back to API list] …

  • CreateAliasOptions

    CreateAliasOptions Properties Name Type Description Notes email_address Option<String> Email address to be …

  • CreateContactOptions

    CreateContactOptions Properties Name Type Description Notes email_addresses Option<Vec> Set of email …

  • CreateDomainOptions

    CreateDomainOptions Properties Name Type Description Notes created_catch_all_inbox Option<bool> Whether to …

  • CreateGroupOptions

    CreateGroupOptions Properties Name Type Description Notes name String description Option<String> …

  • CreateInboxDto

    CreateInboxDto Properties Name Type Description Notes allow_team_access Option<bool> DEPRECATED (team …

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Properties Name Type Description Notes field Option<String> Field to match …

  • CreateInboxRulesetOptions

    CreateInboxRulesetOptions Properties Name Type Description Notes action Option<String> Action to be taken …

  • CreateTemplateOptions

    CreateTemplateOptions Properties Name Type Description Notes name String content String [Back to Model …

  • CreateTrackingPixelOptions

    CreateTrackingPixelOptions Properties Name Type Description Notes name Option<String> [optional] …

  • CreateWebhookOptions

    CreateWebhookOptions Properties Name Type Description Notes basic_auth …

  • DescribeDomainOptions

    DescribeDomainOptions Properties Name Type Description Notes domain String [Back to Model list] [Back to API …

  • DescribeMailServerDomainResult

    DescribeMailServerDomainResult Properties Name Type Description Notes domain String message …

  • DnsLookupOptions

    DnsLookupOptions Properties Name Type Description Notes hostname Option<String> List of record types you …

  • DnsLookupResult

    DnsLookupResult Properties Name Type Description Notes name String record_entries Vec record_type String …

  • DnsLookupResults

    DnsLookupResults Properties Name Type Description Notes results Veccrate::models::DnsLookupResult [Back to …

  • DomainControllerApi

    DomainControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • DomainDto

    DomainDto Properties Name Type Description Notes catch_all_inbox_id Option<String> The optional catch all …

  • DomainNameRecord

    DomainNameRecord Properties Name Type Description Notes name String record_entries Vec record_type String …

  • DomainPreview

    DomainPreview Properties Name Type Description Notes catch_all_inbox_id Option<String> [optional] …

  • DownloadAttachmentDto

    DownloadAttachmentDto Properties Name Type Description Notes base64_file_contents Option<String> Base64 …

  • Email

    Email Properties Name Type Description Notes analysis Option<crate::models::EmailAnalysis> [optional] …

  • EmailAnalysis

    EmailAnalysis Properties Name Type Description Notes dkim_verdict Option<String> Verdict of DomainKeys …

  • EmailContentMatchResult

    EmailContentMatchResult Properties Name Type Description Notes matches Vec pattern String [Back to Model …

  • EmailControllerApi

    EmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • EmailLinksResult

    EmailLinksResult Properties Name Type Description Notes body String links Vec [Back to Model list] [Back …

  • EmailPreview

    EmailPreview Properties Name Type Description Notes attachments Option<Vec> List of IDs of attachments …

  • EmailProjection

    EmailProjection Properties Name Type Description Notes attachments Option<Vec> [optional] bcc …

  • EmailRecipients

    EmailRecipients Properties Name Type Description Notes bcc Option<Veccrate::models::Recipient> [optional] …

  • EmailTextLinesResult

    EmailTextLinesResult Properties Name Type Description Notes body String lines Vec [Back to Model list] …

  • EmailVerificationResult

    EmailVerificationResult Properties Name Type Description Notes domain_name String email_address String …

  • ExpirationDefaults

    ExpirationDefaults Properties Name Type Description Notes can_permanent_inbox bool default_expiration_millis …

  • ExpiredControllerApi

    ExpiredControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExpiredInboxDto

    ExpiredInboxDto Properties Name Type Description Notes email_address String id String inbox_id String …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes created_at String email_address String …

  • ExportControllerApi

    ExportControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • ExportLink

    ExportLink Properties Name Type Description Notes download_link String [Back to Model list] [Back to API …

  • ExportOptions

    ExportOptions Properties Name Type Description Notes output_format String exclude_previously_exported …

  • FlushExpiredInboxesResult

    FlushExpiredInboxesResult Properties Name Type Description Notes expire_before String inbox_ids Vec …

  • FormControllerApi

    FormControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description submit_form …

  • ForwardEmailOptions

    ForwardEmailOptions Properties Name Type Description Notes bcc Option<Vec> Optional bcc recipients …

  • GravatarUrl

    GravatarUrl Properties Name Type Description Notes hash String url String [Back to Model list] [Back to …

  • GroupContactsDto

    GroupContactsDto Properties Name Type Description Notes contacts Veccrate::models::ContactDto group …

  • GroupControllerApi

    GroupControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • GroupDto

    GroupDto Properties Name Type Description Notes created_at String description Option<String> …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes created_at String description Option<String> …

  • HtmlValidationResult

    HtmlValidationResult Properties Name Type Description Notes errors …

  • Inbox

    Inbox Properties Name Type Description Notes created_at Option<String> When the inbox was created. Time …

  • InboxControllerApi

    InboxControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxExistsDto

    InboxExistsDto Properties Name Type Description Notes exists bool [Back to Model list] [Back to API list] …

  • InboxForwarderControllerApi

    InboxForwarderControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes created_at String field String …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes test_value String [Back to Model list] …

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes does_match bool matches …

  • InboxPreview

    InboxPreview Properties Name Type Description Notes created_at Option<String> When the inbox was created. …

  • InboxRulesetControllerApi

    InboxRulesetControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes action String created_at String handler String …

  • InboxRulesetTestOptions

    InboxRulesetTestOptions Properties Name Type Description Notes test_target String [Back to Model list] [Back …

  • InboxRulesetTestResult

    InboxRulesetTestResult Properties Name Type Description Notes matches bool ruleset_matches …

  • IpAddressResult

    IpAddressResult Properties Name Type Description Notes address String hostname String [Back to Model …

  • JsonSchemaDto

    JsonSchemaDto Properties Name Type Description Notes value String [Back to Model list] [Back to API list] …

  • MailServerControllerApi

    MailServerControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MatchOption

    MatchOption Properties Name Type Description Notes field Option<String> The email property to match on. One …

  • MatchOptions

    MatchOptions Properties Name Type Description Notes conditions Option<Veccrate::models::ConditionOption> …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes attachment_count i32 bcc Vec body_excerpt …

  • MissedEmailControllerApi

    MissedEmailControllerApi All URIs are relative to https://api.mailslurp.com Method HTTP request Description …

  • MissedEmailProjection

    MissedEmailProjection Properties Name Type Description Notes created_at String from Option<String> …

  • NameServerRecord

    NameServerRecord Properties Name Type Description Notes priority String raw String record_type String …

  • OrganizationInboxProjection

    OrganizationInboxProjection Properties Name Type Description Notes created_at Option<String> When the inbox …

  • Pageable

    Pageable Properties Name Type Description Notes offset Option<i64> [optional] page_number …

  • PageAlias

    PageAlias Properties Name Type Description Notes content Option<Veccrate::models::AliasProjection> …

  • PageAttachmentEntity

    PageAttachmentEntity Properties Name Type Description Notes content …

  • PageBouncedEmail

    PageBouncedEmail Properties Name Type Description Notes content Option<Veccrate::models::BounceProjection> …

  • PageBouncedRecipients

    PageBouncedRecipients Properties Name Type Description Notes cont