Other Libraries

  • Email API

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

  • Email API

    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.

  • Email API

    Send and receive emails in Erlang

  • Email API

    Javascript email library with GraphQL types for MailSlurp API.

  • Email API

    Send and receive emails in Haskell

  • Email API

    Send and receive emails in OCaml

  • Email API

    Send and receive emails in Powershell

  • Email API

    MailSlurp API Protobuf definitions

Basics

Sections

Pages

More

  • Docs

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

  • Apis

    Index AliasControllerApi CommonActionsControllerApi AttachmentControllerApi BulkActionsControllerApi …

  • 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 AliasDto AbstractWebhookPayload AttachmentEntity AliasProjection AttachmentMetaData 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 …

  • 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 [default to null] match String …

  • 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] …

  • 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 …

  • 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 …

  • InboxProjection

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

  • 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 …

  • PageExpiredInboxRecordProjection

    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] …

  • PageOrganizationInboxProjection

    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] …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AttachmentControllerApi AliasProjection 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 …

  • 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 Properties Name Type Description Notes Field string …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

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

  • 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 …

  • PageExpiredInboxRecordProjection

    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 …

  • PageOrganizationInboxProjection

    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. …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AliasControllerApi AbstractWebhookPayload AliasProjection AliasDto 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 …

  • 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 Properties Name Type Description Notes Field string Match string …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

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

  • 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 …

  • PageExpiredInboxRecordProjection

    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 …

  • PageOrganizationInboxProjection

    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 …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AbstractWebhookPayload AliasControllerApi AliasDto AliasProjection AttachmentControllerApi AttachmentMetaData …

  • 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 …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

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

  • 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 …

  • PageExpiredInboxRecordProjection

    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 …

  • PageOrganizationInboxProjection

    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'; …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AliasProjection AttachmentControllerApi 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 …

  • 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 Match string …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

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

  • 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 …

  • PageExpiredInboxRecordProjection

    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 **[]InboxProjection** [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] …

  • PageOrganizationInboxProjection

    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** …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AttachmentEntity AttachmentMetaData AliasProjection …

  • 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 …

  • 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 Properties Name Type Description Notes field FieldEnum match String …

  • 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 …

  • 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 …

  • 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, …

  • InboxProjection

    InboxProjection Properties Name Type Description Notes createdAt OffsetDateTime emailAddress String …

  • 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 …

  • PageExpiredInboxRecordProjection

    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 …

  • PageOrganizationInboxProjection

    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 …

  • PageUnknownMissedEmailProjection

    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

  • 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 MailSlurp JS Table of contents References default Namespaces AbstractWebhookPayload ConditionOption …

  • Classes

    Index AttachmentControllerApi AliasControllerApi BaseAPI BounceControllerApi BulkActionsControllerApi …

  • AliasControllerApi

    MailSlurp JS / AliasControllerApi Class: AliasControllerApi AliasControllerApi - object-oriented interface export …

  • AttachmentControllerApi

    MailSlurp JS / AttachmentControllerApi Class: AttachmentControllerApi AttachmentControllerApi - object-oriented …

  • BaseAPI

    MailSlurp JS / BaseAPI Class: BaseAPI export Hierarchy BaseAPI ↳ AliasControllerApi ↳ AttachmentControllerApi ↳ …

  • BounceControllerApi

    MailSlurp JS / BounceControllerApi Class: BounceControllerApi BounceControllerApi - object-oriented interface export …

  • BulkActionsControllerApi

    MailSlurp JS / BulkActionsControllerApi Class: BulkActionsControllerApi BulkActionsControllerApi - object-oriented …

  • CommonActionsControllerApi

    MailSlurp JS / CommonActionsControllerApi Class: CommonActionsControllerApi CommonActionsControllerApi - object-oriented …

  • Configuration

    MailSlurp JS / Configuration Class: Configuration Table of contents Constructors constructor Properties accessToken …

  • ContactControllerApi

    MailSlurp JS / ContactControllerApi Class: ContactControllerApi ContactControllerApi - object-oriented interface export …

  • DomainControllerApi

    MailSlurp JS / DomainControllerApi Class: DomainControllerApi DomainControllerApi - object-oriented interface export …

  • EmailControllerApi

    MailSlurp JS / EmailControllerApi Class: EmailControllerApi EmailControllerApi - object-oriented interface export …

  • ExpiredControllerApi

    MailSlurp JS / ExpiredControllerApi Class: ExpiredControllerApi ExpiredControllerApi - object-oriented interface export …

  • ExportControllerApi

    MailSlurp JS / ExportControllerApi Class: ExportControllerApi ExportControllerApi - object-oriented interface export …

  • FormControllerApi

    MailSlurp JS / FormControllerApi Class: FormControllerApi FormControllerApi - object-oriented interface export Hierarchy …

  • GroupControllerApi

    MailSlurp JS / GroupControllerApi Class: GroupControllerApi GroupControllerApi - object-oriented interface export …

  • InboxControllerApi

    MailSlurp JS / InboxControllerApi Class: InboxControllerApi InboxControllerApi - object-oriented interface export …

  • InboxForwarderControllerApi

    MailSlurp JS / InboxForwarderControllerApi Class: InboxForwarderControllerApi InboxForwarderControllerApi - …

  • InboxRulesetControllerApi

    MailSlurp JS / InboxRulesetControllerApi Class: InboxRulesetControllerApi InboxRulesetControllerApi - object-oriented …

  • MailServerControllerApi

    MailSlurp JS / MailServerControllerApi Class: MailServerControllerApi MailServerControllerApi - object-oriented …

  • MailSlurp

    MailSlurp JS / MailSlurp Class: MailSlurp The official MailSlurp Javascript library. A wrapper around the MailSlurp REST …

  • MissedEmailControllerApi

    MailSlurp JS / MissedEmailControllerApi Class: MissedEmailControllerApi MissedEmailControllerApi - object-oriented …

  • RequiredError

    MailSlurp JS / RequiredError Class: RequiredError export Hierarchy Error ↳ RequiredError Table of contents …

  • SentEmailsControllerApi

    MailSlurp JS / SentEmailsControllerApi Class: SentEmailsControllerApi SentEmailsControllerApi - object-oriented …

  • TemplateControllerApi

    MailSlurp JS / TemplateControllerApi Class: TemplateControllerApi TemplateControllerApi - object-oriented interface …

  • TrackingControllerApi

    MailSlurp JS / TrackingControllerApi Class: TrackingControllerApi TrackingControllerApi - object-oriented interface …

  • WaitForControllerApi

    MailSlurp JS / WaitForControllerApi Class: WaitForControllerApi WaitForControllerApi - object-oriented interface export …

  • WebhookControllerApi

    MailSlurp JS / WebhookControllerApi Class: WebhookControllerApi WebhookControllerApi - object-oriented interface export …

  • Enums

    Index AbstractWebhookPayload.EventNameEnum ConditionOption.ConditionEnum CreateDomainOptions.DomainTypeEnum …

  • AbstractWebhookPayload.EventNameEnum

    MailSlurp JS / AbstractWebhookPayload / EventNameEnum Enumeration: EventNameEnum AbstractWebhookPayload.EventNameEnum …

  • ConditionOption.ConditionEnum

    MailSlurp JS / ConditionOption / ConditionEnum Enumeration: ConditionEnum ConditionOption.ConditionEnum export Table of …

  • ConditionOption.ValueEnum

    MailSlurp JS / ConditionOption / ValueEnum Enumeration: ValueEnum ConditionOption.ValueEnum export Table of contents …

  • CreateDomainOptions.DomainTypeEnum

    MailSlurp JS / CreateDomainOptions / DomainTypeEnum Enumeration: DomainTypeEnum CreateDomainOptions.DomainTypeEnum …

  • CreateInboxDto.InboxTypeEnum

    MailSlurp JS / CreateInboxDto / InboxTypeEnum Enumeration: InboxTypeEnum CreateInboxDto.InboxTypeEnum export Table of …

  • CreateInboxForwarderOptions.FieldEnum

    MailSlurp JS / CreateInboxForwarderOptions / FieldEnum Enumeration: FieldEnum CreateInboxForwarderOptions.FieldEnum …

  • CreateInboxRulesetOptions.ActionEnum

    MailSlurp JS / CreateInboxRulesetOptions / ActionEnum Enumeration: ActionEnum CreateInboxRulesetOptions.ActionEnum …

  • CreateInboxRulesetOptions.ScopeEnum

    MailSlurp JS / CreateInboxRulesetOptions / ScopeEnum Enumeration: ScopeEnum CreateInboxRulesetOptions.ScopeEnum export …

  • CreateWebhookOptions.EventNameEnum

    MailSlurp JS / CreateWebhookOptions / EventNameEnum Enumeration: EventNameEnum CreateWebhookOptions.EventNameEnum export …

  • DNSLookupOptions.RecordTypesEnum

    MailSlurp JS / DNSLookupOptions / RecordTypesEnum Enumeration: RecordTypesEnum DNSLookupOptions.RecordTypesEnum export …

  • DNSLookupResult.RecordTypeEnum

    MailSlurp JS / DNSLookupResult / RecordTypeEnum Enumeration: RecordTypeEnum DNSLookupResult.RecordTypeEnum export Table …

  • DomainDto.DomainTypeEnum

    MailSlurp JS / DomainDto / DomainTypeEnum Enumeration: DomainTypeEnum DomainDto.DomainTypeEnum export Table of contents …

  • DomainNameRecord.RecordTypeEnum

    MailSlurp JS / DomainNameRecord / RecordTypeEnum Enumeration: RecordTypeEnum DomainNameRecord.RecordTypeEnum export …

  • DomainPreview.DomainTypeEnum

    MailSlurp JS / DomainPreview / DomainTypeEnum Enumeration: DomainTypeEnum DomainPreview.DomainTypeEnum export Table of …

  • ExportOptions.OutputFormatEnum

    MailSlurp JS / ExportOptions / OutputFormatEnum Enumeration: OutputFormatEnum ExportOptions.OutputFormatEnum export …

  • Inbox.InboxTypeEnum

    MailSlurp JS / Inbox / InboxTypeEnum Enumeration: InboxTypeEnum Inbox.InboxTypeEnum export Table of contents Enumeration …

  • InboxForwarderDto.FieldEnum

    MailSlurp JS / InboxForwarderDto / FieldEnum Enumeration: FieldEnum InboxForwarderDto.FieldEnum export Table of contents …

  • InboxProjection.InboxTypeEnum

    MailSlurp JS / InboxProjection / InboxTypeEnum Enumeration: InboxTypeEnum InboxProjection.InboxTypeEnum export Table of …

  • InboxRulesetDto.ActionEnum

    MailSlurp JS / InboxRulesetDto / ActionEnum Enumeration: ActionEnum InboxRulesetDto.ActionEnum export Table of contents …

  • InboxRulesetDto.HandlerEnum

    MailSlurp JS / InboxRulesetDto / HandlerEnum Enumeration: HandlerEnum InboxRulesetDto.HandlerEnum export Table of …

  • InboxRulesetDto.ScopeEnum

    MailSlurp JS / InboxRulesetDto / ScopeEnum Enumeration: ScopeEnum InboxRulesetDto.ScopeEnum export Table of contents …

  • MatchOption.FieldEnum

    MailSlurp JS / MatchOption / FieldEnum Enumeration: FieldEnum MatchOption.FieldEnum export Table of contents Enumeration …

  • MatchOption.ShouldEnum

    MailSlurp JS / MatchOption / ShouldEnum Enumeration: ShouldEnum MatchOption.ShouldEnum export Table of contents …

  • OrganizationInboxProjection.InboxTypeEnum

    MailSlurp JS / OrganizationInboxProjection / InboxTypeEnum Enumeration: InboxTypeEnum …

  • ReplyToAliasEmailOptions.SendStrategyEnum

    MailSlurp JS / ReplyToAliasEmailOptions / SendStrategyEnum Enumeration: SendStrategyEnum …

  • ReplyToEmailOptions.SendStrategyEnum

    MailSlurp JS / ReplyToEmailOptions / SendStrategyEnum Enumeration: SendStrategyEnum ReplyToEmailOptions.SendStrategyEnum …

  • SendEmailOptions.SendStrategyEnum

    MailSlurp JS / SendEmailOptions / SendStrategyEnum Enumeration: SendStrategyEnum SendEmailOptions.SendStrategyEnum …

  • TemplateVariable.VariableTypeEnum

    MailSlurp JS / TemplateVariable / VariableTypeEnum Enumeration: VariableTypeEnum TemplateVariable.VariableTypeEnum …

  • WaitForConditions.CountTypeEnum

    MailSlurp JS / WaitForConditions / CountTypeEnum Enumeration: CountTypeEnum WaitForConditions.CountTypeEnum export Table …

  • WaitForConditions.SortDirectionEnum

    MailSlurp JS / WaitForConditions / SortDirectionEnum Enumeration: SortDirectionEnum WaitForConditions.SortDirectionEnum …

  • WebhookDto.EventNameEnum

    MailSlurp JS / WebhookDto / EventNameEnum Enumeration: EventNameEnum WebhookDto.EventNameEnum export Table of contents …

  • WebhookDto.MethodEnum

    MailSlurp JS / WebhookDto / MethodEnum Enumeration: MethodEnum WebhookDto.MethodEnum export Table of contents …

  • WebhookEmailOpenedPayload.EventNameEnum

    MailSlurp JS / WebhookEmailOpenedPayload / EventNameEnum Enumeration: EventNameEnum …

  • WebhookEmailReadPayload.EventNameEnum

    MailSlurp JS / WebhookEmailReadPayload / EventNameEnum Enumeration: EventNameEnum WebhookEmailReadPayload.EventNameEnum …

  • WebhookNewAttachmentPayload.EventNameEnum

    MailSlurp JS / WebhookNewAttachmentPayload / EventNameEnum Enumeration: EventNameEnum …

  • WebhookNewContactPayload.EventNameEnum

    MailSlurp JS / WebhookNewContactPayload / EventNameEnum Enumeration: EventNameEnum …

  • WebhookNewEmailPayload.EventNameEnum

    MailSlurp JS / WebhookNewEmailPayload / EventNameEnum Enumeration: EventNameEnum WebhookNewEmailPayload.EventNameEnum …

  • WebhookProjection.EventNameEnum

    MailSlurp JS / WebhookProjection / EventNameEnum Enumeration: EventNameEnum WebhookProjection.EventNameEnum export Table …

  • WebhookResultDto.HttpMethodEnum

    MailSlurp JS / WebhookResultDto / HttpMethodEnum Enumeration: HttpMethodEnum WebhookResultDto.HttpMethodEnum export …

  • WebhookResultDto.ResultTypeEnum

    MailSlurp JS / WebhookResultDto / ResultTypeEnum Enumeration: ResultTypeEnum WebhookResultDto.ResultTypeEnum export …

  • WebhookResultDto.WebhookEventEnum

    MailSlurp JS / WebhookResultDto / WebhookEventEnum Enumeration: WebhookEventEnum WebhookResultDto.WebhookEventEnum …

  • WebhookTestRequest.MethodEnum

    MailSlurp JS / WebhookTestRequest / MethodEnum Enumeration: MethodEnum WebhookTestRequest.MethodEnum export Table of …

  • Interfaces

    Index AbstractWebhookPayload AliasDto AliasProjection AttachmentEntity AttachmentMetaData AttachmentProjection …

  • AbstractWebhookPayload

    MailSlurp JS / AbstractWebhookPayload Interface: AbstractWebhookPayload Abstract webhook payload. Use the correct …

  • AliasDto

    MailSlurp JS / AliasDto Interface: AliasDto Email alias representation export interface AliasDto Table of contents …

  • AliasProjection

    MailSlurp JS / AliasProjection Interface: AliasProjection Representation of a alias export interface AliasProjection …

  • AttachmentEntity

    MailSlurp JS / AttachmentEntity Interface: AttachmentEntity export interface AttachmentEntity Table of contents …

  • AttachmentMetaData

    MailSlurp JS / AttachmentMetaData Interface: AttachmentMetaData Meta data associated with an attachment. Attachments are …

  • AttachmentProjection

    MailSlurp JS / AttachmentProjection Interface: AttachmentProjection export interface AttachmentProjection Table of …

  • BasicAuthOptions

    MailSlurp JS / BasicAuthOptions Interface: BasicAuthOptions Basic Authentication options for webhooks. Will be used is …

  • BouncedEmailDto

    MailSlurp JS / BouncedEmailDto Interface: BouncedEmailDto Bounced email export interface BouncedEmailDto Table of …

  • BouncedRecipientDto

    MailSlurp JS / BouncedRecipientDto Interface: BouncedRecipientDto Bounced recipient export interface BouncedRecipientDto …

  • BounceProjection

    MailSlurp JS / BounceProjection Interface: BounceProjection export interface BounceProjection Table of contents …

  • BounceRecipient

    MailSlurp JS / BounceRecipient Interface: BounceRecipient export interface BounceRecipient Table of contents Properties …

  • BulkSendEmailOptions

    MailSlurp JS / BulkSendEmailOptions Interface: BulkSendEmailOptions Options for bulk sending an email from multiple …

  • Character

    MailSlurp JS / Character Interface: Character export interface Character

  • ConditionOption

    MailSlurp JS / ConditionOption Interface: ConditionOption Options for matching emails in an inbox based on a condition …

  • ConfigurationParameters

    MailSlurp JS / ConfigurationParameters Interface: ConfigurationParameters MailSlurp API MailSlurp is an API for sending …

  • ContactDto

    MailSlurp JS / ContactDto Interface: ContactDto export interface ContactDto Table of contents Properties company …

  • ContactProjection

    MailSlurp JS / ContactProjection Interface: ContactProjection export interface ContactProjection Table of contents …

  • ContentMatchOptions

    MailSlurp JS / ContentMatchOptions Interface: ContentMatchOptions Options for matching content using regex patterns …

  • CreateAliasOptions

    MailSlurp JS / CreateAliasOptions Interface: CreateAliasOptions Create email alias options. Email aliases can be used to …

  • CreateContactOptions

    MailSlurp JS / CreateContactOptions Interface: CreateContactOptions export interface CreateContactOptions Table of …

  • CreateDomainOptions

    MailSlurp JS / CreateDomainOptions Interface: CreateDomainOptions Options for creating a domain to use with MailSlurp. …

  • CreateGroupOptions

    MailSlurp JS / CreateGroupOptions Interface: CreateGroupOptions export interface CreateGroupOptions Table of contents …

  • CreateInboxDto

    MailSlurp JS / CreateInboxDto Interface: CreateInboxDto Options for creating an inbox. An inbox has a real email address …

  • CreateInboxForwarderOptions

    MailSlurp JS / CreateInboxForwarderOptions Interface: CreateInboxForwarderOptions export interface …

  • CreateInboxRulesetOptions

    MailSlurp JS / CreateInboxRulesetOptions Interface: CreateInboxRulesetOptions Options for creating inbox rulesets. Inbox …

  • CreateTemplateOptions

    MailSlurp JS / CreateTemplateOptions Interface: CreateTemplateOptions export interface CreateTemplateOptions Table of …

  • CreateTrackingPixelOptions

    MailSlurp JS / CreateTrackingPixelOptions Interface: CreateTrackingPixelOptions export interface …

  • CreateWebhookOptions

    MailSlurp JS / CreateWebhookOptions Interface: CreateWebhookOptions Options for creating a webhook. Webhooks can be …

  • DescribeDomainOptions

    MailSlurp JS / DescribeDomainOptions Interface: DescribeDomainOptions export interface DescribeDomainOptions Table of …

  • DescribeMailServerDomainResult

    MailSlurp JS / DescribeMailServerDomainResult Interface: DescribeMailServerDomainResult Name Server lookup result export …

  • DNSLookupOptions

    MailSlurp JS / DNSLookupOptions Interface: DNSLookupOptions Options for DNS query. export interface DNSLookupOptions …

  • DNSLookupResult

    MailSlurp JS / DNSLookupResult Interface: DNSLookupResult DNS lookup result. Includes record type, time to live, raw …

  • DNSLookupResults

    MailSlurp JS / DNSLookupResults Interface: DNSLookupResults Results of query on domain name servers export interface …

  • DomainDto

    MailSlurp JS / DomainDto Interface: DomainDto Domain plus verification records and status export interface DomainDto …

  • DomainNameRecord

    MailSlurp JS / DomainNameRecord Interface: DomainNameRecord DNS Record required for verification of a domain. Record …

  • DomainPreview

    MailSlurp JS / DomainPreview Interface: DomainPreview Preview object for domain entity export interface DomainPreview …

  • DownloadAttachmentDto

    MailSlurp JS / DownloadAttachmentDto Interface: DownloadAttachmentDto Content of attachment export interface …

  • Email

    MailSlurp JS / Email Interface: Email Email entity (also known as EmailDto). When an SMTP email message is received by …

  • EmailAnalysis

    MailSlurp JS / EmailAnalysis Interface: EmailAnalysis Analysis result for email. Each verdict property is a string …

  • EmailContentMatchResult

    MailSlurp JS / EmailContentMatchResult Interface: EmailContentMatchResult Matches for the given pattern export interface …

  • EmailLinksResult

    MailSlurp JS / EmailLinksResult Interface: EmailLinksResult Links found in HTML export interface EmailLinksResult Table …

  • EmailPreview

    MailSlurp JS / EmailPreview Interface: EmailPreview Preview of an email message. For full message (including body and …

  • EmailProjection

    MailSlurp JS / EmailProjection Interface: EmailProjection A compact representation of a full email. Used in list …

  • EmailRecipients

    MailSlurp JS / EmailRecipients Interface: EmailRecipients export interface EmailRecipients Table of contents Properties …

  • EmailTextLinesResult

    MailSlurp JS / EmailTextLinesResult Interface: EmailTextLinesResult Parsed text of an email export interface …

  • EmailVerificationResult

    MailSlurp JS / EmailVerificationResult Interface: EmailVerificationResult Email verification result. Valid means email …

  • ExpirationDefaults

    MailSlurp JS / ExpirationDefaults Interface: ExpirationDefaults Expiration defaults for your account export interface …

  • ExpiredInboxDto

    MailSlurp JS / ExpiredInboxDto Interface: ExpiredInboxDto Expired inbox export interface ExpiredInboxDto Table of …

  • ExpiredInboxRecordProjection

    MailSlurp JS / ExpiredInboxRecordProjection Interface: ExpiredInboxRecordProjection export interface …

  • ExportLink

    MailSlurp JS / ExportLink Interface: ExportLink Export download link export interface ExportLink Table of contents …

  • ExportOptions

    MailSlurp JS / ExportOptions Interface: ExportOptions Options for exporting user data export interface ExportOptions …

  • FetchAPI

    MailSlurp JS / FetchAPI Interface: FetchAPI Callable FetchAPI ▸ FetchAPI(url, init?): Promise<Response> Parameters …

  • FetchArgs

    MailSlurp JS / FetchArgs Interface: FetchArgs export interface FetchArgs Table of contents Properties options url …

  • ForwardEmailOptions

    MailSlurp JS / ForwardEmailOptions Interface: ForwardEmailOptions Options for forwarding an email export interface …

  • GravatarUrl

    MailSlurp JS / GravatarUrl Interface: GravatarUrl export interface GravatarUrl Table of contents Properties hash url …

  • GroupContactsDto

    MailSlurp JS / GroupContactsDto Interface: GroupContactsDto export interface GroupContactsDto Table of contents …

  • GroupDto

    MailSlurp JS / GroupDto Interface: GroupDto export interface GroupDto Table of contents Properties createdAt …

  • GroupProjection

    MailSlurp JS / GroupProjection Interface: GroupProjection export interface GroupProjection Table of contents Properties …

  • HTMLValidationResult

    MailSlurp JS / HTMLValidationResult Interface: HTMLValidationResult HTML Validation Results export interface …

  • Inbox

    MailSlurp JS / Inbox Interface: Inbox Representation of a MailSlurp inbox. An inbox has an ID and a real email address. …

  • InboxForwarderDto

    MailSlurp JS / InboxForwarderDto Interface: InboxForwarderDto export interface InboxForwarderDto Table of contents …

  • InboxForwarderTestOptions

    MailSlurp JS / InboxForwarderTestOptions Interface: InboxForwarderTestOptions export interface InboxForwarderTestOptions …

  • InboxForwarderTestResult

    MailSlurp JS / InboxForwarderTestResult Interface: InboxForwarderTestResult export interface InboxForwarderTestResult …

  • InboxProjection

    MailSlurp JS / InboxProjection Interface: InboxProjection export interface InboxProjection Table of contents Properties …

  • InboxRulesetDto

    MailSlurp JS / InboxRulesetDto Interface: InboxRulesetDto export interface InboxRulesetDto Table of contents Properties …

  • InboxRulesetTestOptions

    MailSlurp JS / InboxRulesetTestOptions Interface: InboxRulesetTestOptions export interface InboxRulesetTestOptions Table …

  • InboxRulesetTestResult

    MailSlurp JS / InboxRulesetTestResult Interface: InboxRulesetTestResult export interface InboxRulesetTestResult Table of …

  • IPAddressResult

    MailSlurp JS / IPAddressResult Interface: IPAddressResult IP Address look up result for a given domain / hostname export …

  • JsonNode

    MailSlurp JS / JsonNode Interface: JsonNode export interface JsonNode

  • JSONSchemaDto

    MailSlurp JS / JSONSchemaDto Interface: JSONSchemaDto export interface JSONSchemaDto Table of contents Properties value …

  • MatchOption

    MailSlurp JS / MatchOption Interface: MatchOption Options for matching emails in an inbox. Each match option object …

  • MatchOptions

    MailSlurp JS / MatchOptions Interface: MatchOptions Optional filter for matching emails based on fields. For instance …

  • MissedEmail

    MailSlurp JS / MissedEmail Interface: MissedEmail export interface MissedEmail Table of contents Properties …

  • MissedEmailProjection

    MailSlurp JS / MissedEmailProjection Interface: MissedEmailProjection export interface MissedEmailProjection Table of …

  • NameServerRecord

    MailSlurp JS / NameServerRecord Interface: NameServerRecord Name Server Record export interface NameServerRecord Table …

  • OrganizationInboxProjection

    MailSlurp JS / OrganizationInboxProjection Interface: OrganizationInboxProjection export interface …

  • Pageable

    MailSlurp JS / Pageable Interface: Pageable export interface Pageable Table of contents Properties offset pageNumber …

  • PageAlias

    MailSlurp JS / PageAlias Interface: PageAlias Paginated email alias results. Page starts at zero. Projection results may …

  • PageAttachmentEntity

    MailSlurp JS / PageAttachmentEntity Interface: PageAttachmentEntity Paginated attachment entity results. Page starts at …

  • PageBouncedEmail

    MailSlurp JS / PageBouncedEmail Interface: PageBouncedEmail Paginated bounced email. Page starts at zero. Projection …

  • PageBouncedRecipients

    MailSlurp JS / PageBouncedRecipients Interface: PageBouncedRecipients Paginated bounced recipients. Page starts at zero. …

  • PageContactProjection

    MailSlurp JS / PageContactProjection Interface: PageContactProjection Paginated contact results. Page starts at zero. …

  • PageEmailPreview

    MailSlurp JS / PageEmailPreview Interface: PageEmailPreview Paginated email preview results. EmailProjections and …

  • PageEmailProjection

    MailSlurp JS / PageEmailProjection Interface: PageEmailProjection Paginated email projection results. EmailProjections …

  • PageExpiredInboxRecordProjection

    MailSlurp JS / PageExpiredInboxRecordProjection Interface: PageExpiredInboxRecordProjection Paginated expired inbox …

  • PageGroupProjection

    MailSlurp JS / PageGroupProjection Interface: PageGroupProjection Paginated missed email results. Page starts at zero. …

  • PageInboxForwarderDto

    MailSlurp JS / PageInboxForwarderDto Interface: PageInboxForwarderDto Paginated inbox forwarder results. Page starts at …

  • PageInboxProjection

    MailSlurp JS / PageInboxProjection Interface: PageInboxProjection Paginated inbox results. Page starts at zero. …

  • PageInboxRulesetDto

    MailSlurp JS / PageInboxRulesetDto Interface: PageInboxRulesetDto Paginated inbox ruleset results. Page starts at zero. …

  • PageMissedEmailProjection

    MailSlurp JS / PageMissedEmailProjection Interface: PageMissedEmailProjection Paginated MissedEmail results. Page starts …

  • PageOrganizationInboxProjection

    MailSlurp JS / PageOrganizationInboxProjection Interface: PageOrganizationInboxProjection Paginated organization inbox …

  • PageSentEmailProjection

    MailSlurp JS / PageSentEmailProjection Interface: PageSentEmailProjection Paginated sent email results. Page starts at …

  • PageTemplateProjection

    MailSlurp JS / PageTemplateProjection Interface: PageTemplateProjection Paginated email template results. Page starts at …

  • PageThreadProjection

    MailSlurp JS / PageThreadProjection Interface: PageThreadProjection Paginated email projection results. EmailProjections …

  • PageTrackingPixelProjection

    MailSlurp JS / PageTrackingPixelProjection Interface: PageTrackingPixelProjection Paginated TrackingPixel results. Page …

  • PageUnknownMissedEmailProjection

    MailSlurp JS / PageUnknownMissedEmailProjection Interface: PageUnknownMissedEmailProjection Paginated unknown …

  • PageWebhookProjection

    MailSlurp JS / PageWebhookProjection Interface: PageWebhookProjection Paginated webhook entity. Page starts at zero. …

  • PageWebhookResult

    MailSlurp JS / PageWebhookResult Interface: PageWebhookResult Paginated webhook results. Page starts at zero. Projection …

  • RawEmailJson

    MailSlurp JS / RawEmailJson Interface: RawEmailJson Content in raw format export interface RawEmailJson Table of …

  • Recipient

    MailSlurp JS / Recipient Interface: Recipient export interface Recipient Table of contents Properties emailAddress name …

  • ReplyToAliasEmailOptions

    MailSlurp JS / ReplyToAliasEmailOptions Interface: ReplyToAliasEmailOptions Options for replying to an alias email using …

  • ReplyToEmailOptions

    MailSlurp JS / ReplyToEmailOptions Interface: ReplyToEmailOptions Options for replying to email with API export …

  • Result

    MailSlurp JS / Result Interface: Result Type parameters Name T Table of contents Properties content error …

  • SendEmailOptions

    MailSlurp JS / SendEmailOptions Interface: SendEmailOptions Options for sending an email message from an inbox. You must …

  • Sender

    MailSlurp JS / Sender Interface: Sender export interface Sender Table of contents Properties emailAddress name rawValue …

  • SentEmailDto

    MailSlurp JS / SentEmailDto Interface: SentEmailDto Sent email details export interface SentEmailDto Table of contents …

  • SentEmailProjection

    MailSlurp JS / SentEmailProjection Interface: SentEmailProjection export interface SentEmailProjection Table of contents …

  • SetInboxFavouritedOptions

    MailSlurp JS / SetInboxFavouritedOptions Interface: SetInboxFavouritedOptions Options for setting inbox favourite state …

  • SimpleSendEmailOptions

    MailSlurp JS / SimpleSendEmailOptions Interface: SimpleSendEmailOptions export interface SimpleSendEmailOptions Table of …

  • Sort

    MailSlurp JS / Sort Interface: Sort export interface Sort Table of contents Properties empty sorted unsorted …

  • TemplateDto

    MailSlurp JS / TemplateDto Interface: TemplateDto export interface TemplateDto Table of contents Properties content …

  • TemplateProjection

    MailSlurp JS / TemplateProjection Interface: TemplateProjection export interface TemplateProjection Table of contents …

  • TemplateVariable

    MailSlurp JS / TemplateVariable Interface: TemplateVariable export interface TemplateVariable Table of contents …

  • TestNewInboxForwarderOptions

    MailSlurp JS / TestNewInboxForwarderOptions Interface: TestNewInboxForwarderOptions export interface …

  • TestNewInboxRulesetOptions

    MailSlurp JS / TestNewInboxRulesetOptions Interface: TestNewInboxRulesetOptions export interface …

  • ThreadProjection

    MailSlurp JS / ThreadProjection Interface: ThreadProjection A thread is a message thread created for a message received …

  • TrackingPixelDto

    MailSlurp JS / TrackingPixelDto Interface: TrackingPixelDto export interface TrackingPixelDto Table of contents …

  • TrackingPixelProjection

    MailSlurp JS / TrackingPixelProjection Interface: TrackingPixelProjection export interface TrackingPixelProjection Table …

  • UnknownMissedEmailProjection

    MailSlurp JS / UnknownMissedEmailProjection Interface: UnknownMissedEmailProjection export interface …

  • UnreadCount

    MailSlurp JS / UnreadCount Interface: UnreadCount export interface UnreadCount Table of contents Properties count …

  • UpdateAliasOptions

    MailSlurp JS / UpdateAliasOptions Interface: UpdateAliasOptions Update an email alias export interface …

  • UpdateDomainOptions

    MailSlurp JS / UpdateDomainOptions Interface: UpdateDomainOptions Options for creating a domain to use with MailSlurp. …

  • UpdateGroupContacts

    MailSlurp JS / UpdateGroupContacts Interface: UpdateGroupContacts export interface UpdateGroupContacts Table of contents …

  • UpdateInboxOptions

    MailSlurp JS / UpdateInboxOptions Interface: UpdateInboxOptions Options for updating inbox properties export interface …

  • UploadAttachmentOptions

    MailSlurp JS / UploadAttachmentOptions Interface: UploadAttachmentOptions Options for uploading files for attachments. …

  • ValidationDto

    MailSlurp JS / ValidationDto Interface: ValidationDto Response object for email validation operation export interface …

  • ValidationMessage

    MailSlurp JS / ValidationMessage Interface: ValidationMessage export interface ValidationMessage Table of contents …

  • VerifyEmailAddressOptions

    MailSlurp JS / VerifyEmailAddressOptions Interface: VerifyEmailAddressOptions Options for verifying that an email …

  • WaitForConditions

    MailSlurp JS / WaitForConditions Interface: WaitForConditions Conditions that a waitForXEmails endpoint operates on. The …

  • WebhookDto

    MailSlurp JS / WebhookDto Interface: WebhookDto Representation of a webhook for an inbox. The URL specified will be …

  • WebhookEmailOpenedPayload

    MailSlurp JS / WebhookEmailOpenedPayload Interface: WebhookEmailOpenedPayload EMAIL_OPENED webhook payload. Sent to your …

  • WebhookEmailReadPayload

    MailSlurp JS / WebhookEmailReadPayload Interface: WebhookEmailReadPayload EMAIL_READ webhook payload. Sent to your …

  • WebhookNewAttachmentPayload

    MailSlurp JS / WebhookNewAttachmentPayload Interface: WebhookNewAttachmentPayload NEW_ATTACHMENT webhook payload. Sent …

  • WebhookNewContactPayload

    MailSlurp JS / WebhookNewContactPayload Interface: WebhookNewContactPayload NEW_CONTACT webhook payload. Sent to your …

  • WebhookNewEmailPayload

    MailSlurp JS / WebhookNewEmailPayload Interface: WebhookNewEmailPayload NEW_EMAIL webhook payload. Sent to your webhook …

  • WebhookProjection

    MailSlurp JS / WebhookProjection Interface: WebhookProjection Representation of a webhook export interface …

  • WebhookRedriveResult

    MailSlurp JS / WebhookRedriveResult Interface: WebhookRedriveResult export interface WebhookRedriveResult Table of …

  • WebhookResultDto

    MailSlurp JS / WebhookResultDto Interface: WebhookResultDto export interface WebhookResultDto Table of contents …

  • WebhookTestRequest

    MailSlurp JS / WebhookTestRequest Interface: WebhookTestRequest export interface WebhookTestRequest Table of contents …

  • WebhookTestResponse

    MailSlurp JS / WebhookTestResponse Interface: WebhookTestResponse export interface WebhookTestResponse Table of contents …

  • WebhookTestResult

    MailSlurp JS / WebhookTestResult Interface: WebhookTestResult Results of testing a webhook export interface …

  • Modules

    Index AbstractWebhookPayload ConditionOption CreateDomainOptions CreateInboxDto CreateInboxForwarderOptions …

  • AbstractWebhookPayload

    MailSlurp JS / AbstractWebhookPayload Namespace: AbstractWebhookPayload export namespace AbstractWebhookPayload Table of …

  • ConditionOption

    MailSlurp JS / ConditionOption Namespace: ConditionOption export namespace ConditionOption Table of contents …

  • CreateDomainOptions

    MailSlurp JS / CreateDomainOptions Namespace: CreateDomainOptions export namespace CreateDomainOptions Table of contents …

  • CreateInboxDto

    MailSlurp JS / CreateInboxDto Namespace: CreateInboxDto export namespace CreateInboxDto Table of contents Enumerations …

  • CreateInboxForwarderOptions

    MailSlurp JS / CreateInboxForwarderOptions Namespace: CreateInboxForwarderOptions export namespace …

  • CreateInboxRulesetOptions

    MailSlurp JS / CreateInboxRulesetOptions Namespace: CreateInboxRulesetOptions export namespace CreateInboxRulesetOptions …

  • CreateWebhookOptions

    MailSlurp JS / CreateWebhookOptions Namespace: CreateWebhookOptions export namespace CreateWebhookOptions Table of …

  • DNSLookupOptions

    MailSlurp JS / DNSLookupOptions Namespace: DNSLookupOptions export namespace DNSLookupOptions Table of contents …

  • DNSLookupResult

    MailSlurp JS / DNSLookupResult Namespace: DNSLookupResult export namespace DNSLookupResult Table of contents …

  • DomainDto

    MailSlurp JS / DomainDto Namespace: DomainDto export namespace DomainDto Table of contents Enumerations DomainTypeEnum …

  • DomainNameRecord

    MailSlurp JS / DomainNameRecord Namespace: DomainNameRecord export namespace DomainNameRecord Table of contents …

  • DomainPreview

    MailSlurp JS / DomainPreview Namespace: DomainPreview export namespace DomainPreview Table of contents Enumerations …

  • ExportOptions

    MailSlurp JS / ExportOptions Namespace: ExportOptions export namespace ExportOptions Table of contents Enumerations …

  • Inbox

    MailSlurp JS / Inbox Namespace: Inbox export namespace Inbox Table of contents Enumerations InboxTypeEnum

  • InboxForwarderDto

    MailSlurp JS / InboxForwarderDto Namespace: InboxForwarderDto export namespace InboxForwarderDto Table of contents …

  • InboxProjection

    MailSlurp JS / InboxProjection Namespace: InboxProjection export namespace InboxProjection Table of contents …

  • InboxRulesetDto

    MailSlurp JS / InboxRulesetDto Namespace: InboxRulesetDto export namespace InboxRulesetDto Table of contents …

  • MatchOption

    MailSlurp JS / MatchOption Namespace: MatchOption export namespace MatchOption Table of contents Enumerations FieldEnum …

  • OrganizationInboxProjection

    MailSlurp JS / OrganizationInboxProjection Namespace: OrganizationInboxProjection export namespace …

  • ReplyToAliasEmailOptions

    MailSlurp JS / ReplyToAliasEmailOptions Namespace: ReplyToAliasEmailOptions export namespace ReplyToAliasEmailOptions …

  • ReplyToEmailOptions

    MailSlurp JS / ReplyToEmailOptions Namespace: ReplyToEmailOptions export namespace ReplyToEmailOptions Table of contents …

  • SendEmailOptions

    MailSlurp JS / SendEmailOptions Namespace: SendEmailOptions export namespace SendEmailOptions Table of contents …

  • TemplateVariable

    MailSlurp JS / TemplateVariable Namespace: TemplateVariable export namespace TemplateVariable Table of contents …

  • WaitForConditions

    MailSlurp JS / WaitForConditions Namespace: WaitForConditions export namespace WaitForConditions Table of contents …

  • WebhookDto

    MailSlurp JS / WebhookDto Namespace: WebhookDto export namespace WebhookDto Table of contents Enumerations …

  • WebhookEmailOpenedPayload

    MailSlurp JS / WebhookEmailOpenedPayload Namespace: WebhookEmailOpenedPayload export namespace WebhookEmailOpenedPayload …

  • WebhookEmailReadPayload

    MailSlurp JS / WebhookEmailReadPayload Namespace: WebhookEmailReadPayload export namespace WebhookEmailReadPayload Table …

  • WebhookNewAttachmentPayload

    MailSlurp JS / WebhookNewAttachmentPayload Namespace: WebhookNewAttachmentPayload export namespace …

  • WebhookNewContactPayload

    MailSlurp JS / WebhookNewContactPayload Namespace: WebhookNewContactPayload export namespace WebhookNewContactPayload …

  • WebhookNewEmailPayload

    MailSlurp JS / WebhookNewEmailPayload Namespace: WebhookNewEmailPayload export namespace WebhookNewEmailPayload Table of …

  • WebhookProjection

    MailSlurp JS / WebhookProjection Namespace: WebhookProjection export namespace WebhookProjection Table of contents …

  • WebhookResultDto

    MailSlurp JS / WebhookResultDto Namespace: WebhookResultDto export namespace WebhookResultDto Table of contents …

  • WebhookTestRequest

    MailSlurp JS / WebhookTestRequest Namespace: WebhookTestRequest export namespace WebhookTestRequest Table of contents …

  • 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 …

  • 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 match kotlin.String …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

    InboxProjection Properties Name Type Description Notes createdAt java.time.OffsetDateTime favourite …

  • 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 …

  • PageExpiredInboxRecordProjection

    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] …

  • PageOrganizationInboxProjection

    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] …

  • PageUnknownMissedEmailProjection

    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

  • 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 OAIAttachmentControllerApi …

  • 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 …

  • 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* match NSString* …

  • 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 …

  • OAIDescribeMailServerDomainResult

    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 …

  • OAIExpiredInboxRecordProjection

    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 …

  • 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 …

  • 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 …

  • OAIInboxProjection

    OAIInboxProjection Properties Name Type Description Notes createdAt NSDate* emailAddress NSString* …

  • 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* …

  • OAIPageExpiredInboxRecordProjection

    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 …

  • OAIPageOrganizationInboxProjection

    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 …

  • OAIPageUnknownMissedEmailProjection

    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 …

  • OAITestNewInboxForwarderOptions

    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 …

  • OAIUnknownMissedEmailProjection

    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 …

  • 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 …

  • 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 …

  • 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 …

  • 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; …

  • InboxProjection

    MailSlurp::Object::InboxProjection Load the model package use MailSlurp::Object::InboxProjection; Properties Name …

  • 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 …

  • PageExpiredInboxRecordProjection

    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; …

  • PageOrganizationInboxProjection

    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 …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AliasDto AbstractWebhookPayload AttachmentEntity AttachmentMetaData AliasProjection 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 …

  • 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 match string …

  • 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 …

  • 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 …

  • 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] …

  • InboxProjection

    # InboxProjection Properties Name Type Description Notes created_at DateTime email_address string [optional] …

  • 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[]** …

  • PageExpiredInboxRecordProjection

    # 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 **MailSlurpModelsInboxProjection[]** …

  • PageInboxRulesetDto

    # PageInboxRulesetDto Properties Name Type Description Notes content **MailSlurpModelsInboxRulesetDto[]** …

  • PageMissedEmailProjection

    # PageMissedEmailProjection Properties Name Type Description Notes content …

  • PageOrganizationInboxProjection

    # 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 …

  • PageUnknownMissedEmailProjection

    # 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 …

  • 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 AttachmentControllerApi AttachmentEntity AttachmentProjection …

  • 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 …

  • 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 Match String …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

    InboxProjection Properties Name Type Description Notes CreatedAt System.DateTime EmailAddress String …

  • 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 …

  • PageExpiredInboxRecordProjection

    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 **InboxProjection[]** [optional] Empty …

  • PageInboxRulesetDto

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

  • PageMissedEmailProjection

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

  • PageOrganizationInboxProjection

    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[]** …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AliasControllerApi AliasProjection 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 …

  • 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 Properties Name Type Description Notes field str match str …

  • 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 …

  • 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 …

  • 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) …

  • InboxProjection

    InboxProjection Properties Name Type Description Notes created_at datetime email_address str [optional] …

  • 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 …

  • PageExpiredInboxRecordProjection

    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 …

  • PageOrganizationInboxProjection

    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 …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AttachmentControllerApi AliasProjection 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 …

  • 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 match String …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

    MailSlurpClient::InboxProjection Properties Name Type Description Notes created_at DateTime email_address …

  • 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 …

  • PageExpiredInboxRecordProjection

    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] …

  • PageOrganizationInboxProjection

    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] …

  • PageUnknownMissedEmailProjection

    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 …

  • 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 AliasDto AliasControllerApi AbstractWebhookPayload 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. …

  • 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 String _match String …

  • 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 …

  • 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 …

  • 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 …

  • InboxProjection

    InboxProjection Properties Name Type Description Notes created_at String email_address Option<String> …

  • 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 content …

  • PageContactProjection

    PageContactProjection Properties Name Type Description Notes content …

  • PageEmailPreview

    PageEmailPreview Properties Name Type Description Notes content Option<Veccrate::models::EmailPreview> …

  • PageEmailProjection

    PageEmailProjection Properties Name Type Description Notes content …

  • PageExpiredInboxRecordProjection

    PageExpiredInboxRecordProjection Properties Name Type Description Notes content …

  • PageGroupProjection

    PageGroupProjection Properties Name Type Description Notes content …

  • PageInboxForwarderDto

    PageInboxForwarderDto Properties Name Type Description Notes content …

  • PageInboxProjection

    PageInboxProjection Properties Name Type Description Notes content …

  • PageInboxRulesetDto

    PageInboxRulesetDto Properties Name Type Description Notes content …

  • PageMissedEmailProjection

    PageMissedEmailProjection Properties Name Type Description Notes content …

  • PageOrganizationInboxProjection

    PageOrganizationInboxProjection Properties Name Type Description Notes content …

  • PageSentEmailProjection

    PageSentEmailProjection Properties Name Type Description Notes content …

  • PageTemplateProjection

    PageTemplateProjection Properties Name Type Description Notes content …

  • PageThreadProjection

    PageThreadProjection Properties Name Type Description Notes content …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Properties Name Type Description Notes content …

  • PageUnknownMissedEmailProjection

    PageUnknownMissedEmailProjection Properties Name Type Description Notes content …

  • PageWebhookProjection

    PageWebhookProjection Properties Name Type Description Notes content …

  • PageWebhookResult

    PageWebhookResult Properties Name Type Description Notes content Option<Veccrate::models::WebhookResultDto> …

  • 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 Option<String> [optional] …

  • ReplyToAliasEmailOptions

    ReplyToAliasEmailOptions Properties Name Type Description Notes attachments Option<Vec> List of uploaded …

  • ReplyToEmailOptions

    ReplyToEmailOptions Properties Name Type Description Notes attachments Option<Vec> List of uploaded …

  • SendEmailOptions

    SendEmailOptions Properties Name Type Description Notes add_tracking_pixel Option<bool> Add tracking pixel …

  • Sender

    Sender Properties Name Type Description Notes email_address String name Option<String> [optional] …

  • SentEmailDto

    SentEmailDto Properties Name Type Description Notes attachments Option<Vec> Array of IDs of attachments …

  • SentEmailProjection

    SentEmailProjection Properties Name Type Description Notes attachments Vec bcc Vec body_md5_hash …

  • SentEmailsControllerApi

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

  • SetInboxFavouritedOptions

    SetInboxFavouritedOptions Properties Name Type Description Notes state Option<bool> Is the inbox a …

  • SimpleSendEmailOptions

    SimpleSendEmailOptions Properties Name Type Description Notes body Option<String> Body of the email …

  • Sort

    Sort Properties Name Type Description Notes empty Option<bool> [optional] sorted Option<bool> …

  • TemplateControllerApi

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

  • TemplateDto

    TemplateDto Properties Name Type Description Notes content String created_at String id String name …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes created_at String id String name String …

  • TemplateVariable

    TemplateVariable Properties Name Type Description Notes name String variable_type String [Back to Model …

  • 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 Option<Vec> [optional] …

  • TrackingControllerApi

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

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes created_at String html String id String …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes created_at String id String inbox_id …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes created_at String from …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes count i64 [Back to Model list] [Back to API list] [Back …

  • UpdateAliasOptions

    UpdateAliasOptions Properties Name Type Description Notes name Option<String> Optional name for alias …

  • UpdateDomainOptions

    UpdateDomainOptions Properties Name Type Description Notes catch_all_inbox_id Option<String> [optional] …

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes contact_ids Vec [Back to Model list] [Back to API …

  • UpdateInboxOptions

    UpdateInboxOptions Properties Name Type Description Notes description Option<String> Description of an …

  • UploadAttachmentOptions

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

  • ValidationDto

    ValidationDto Properties Name Type Description Notes email_id Option<String> ID of the email validated …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes line_number i32 message Option<String> …

  • VerifyEmailAddressOptions

    VerifyEmailAddressOptions Properties Name Type Description Notes mail_server_domain Option<String> …

  • WaitForConditions

    WaitForConditions Properties Name Type Description Notes before Option<String> ISO Date Time latest time of …

  • WaitForControllerApi

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

  • WebhookControllerApi

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

  • WebhookDto

    WebhookDto Properties Name Type Description Notes basic_auth Option<bool> Does webhook expect basic …

  • WebhookEmailOpenedPayload

    WebhookEmailOpenedPayload Properties Name Type Description Notes created_at Option<String> Date time of …

  • WebhookEmailReadPayload

    WebhookEmailReadPayload Properties Name Type Description Notes created_at Option<String> Date time of event …

  • WebhookNewAttachmentPayload

    WebhookNewAttachmentPayload Properties Name Type Description Notes attachment_id Option<String> ID of …

  • WebhookNewContactPayload

    WebhookNewContactPayload Properties Name Type Description Notes company Option<String> [optional] …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload Properties Name Type Description Notes attachment_meta_datas …

  • WebhookProjection

    WebhookProjection Properties Name Type Description Notes created_at String event_name Option<String> …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes message Option<String> [optional] success …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes created_at String http_method String id …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes headers ::std::collections::HashMap<String, …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes message Option<String> [optional] status_code …

  • WebhookTestResult

    WebhookTestResult Properties Name Type Description Notes message Option<String> [optional] request …

  • Docs

    Index AliasControllerAPI AbstractWebhookPayload AliasDto AliasProjection AttachmentControllerAPI AttachmentEntity …

  • AbstractWebhookPayload

    AbstractWebhookPayload Properties Name Type Description Notes eventName String messageId String webhookId …

  • AliasControllerAPI

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

  • AliasDto

    AliasDto Properties Name Type Description Notes createdAt Date [optional] emailAddress String The …

  • AliasProjection

    AliasProjection Properties Name Type Description Notes createdAt Date emailAddress String _id UUID …

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

    BounceControllerAPI 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 Date _id UUID [optional] recipient …

  • BounceProjection

    BounceProjection Properties Name Type Description Notes createdAt Date _id UUID [optional] sender String …

  • BounceRecipient

    BounceRecipient Properties Name Type Description Notes createdAt Date _id UUID [optional] recipient String …

  • BulkActionsControllerAPI

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

  • BulkSendEmailOptions

    BulkSendEmailOptions Properties Name Type Description Notes inboxIds [UUID] Inboxes to send the email from …

  • CommonActionsControllerAPI

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

  • ConditionOption

    ConditionOption Properties Name Type Description Notes condition String 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 company String [optional] createdAt Date emailAddresses …

  • ContactProjection

    ContactProjection Properties Name Type Description Notes company String [optional] createdAt Date …

  • ContentMatchOptions

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

  • 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] …

  • CreateInboxDto

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

  • CreateInboxForwarderOptions

    CreateInboxForwarderOptions Properties Name Type Description Notes field String match String …

  • 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] [Back …

  • DomainControllerAPI

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

  • 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 recordEntries [String] recordType …

  • DomainPreview

    DomainPreview Properties Name Type Description Notes catchAllInboxId UUID [optional] createdAt Date domain …

  • 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

    EmailControllerAPI 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] [optional] …

  • 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

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

  • ExpiredInboxDto

    ExpiredInboxDto Properties Name Type Description Notes emailAddress String _id UUID inboxId UUID …

  • ExpiredInboxRecordProjection

    ExpiredInboxRecordProjection Properties Name Type Description Notes createdAt Date emailAddress String …

  • ExportControllerAPI

    ExportControllerAPI 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 …

  • FormControllerAPI

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

  • 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 to …

  • GroupControllerAPI

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

  • GroupDto

    GroupDto Properties Name Type Description Notes createdAt Date _description String [optional] _id UUID …

  • GroupProjection

    GroupProjection Properties Name Type Description Notes createdAt Date _description String [optional] _id …

  • HTMLValidationResult

    HTMLValidationResult Properties Name Type Description Notes errors [ValidationMessage] Optional errors resulting …

  • Inbox

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

  • 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 …

  • InboxForwarderDto

    InboxForwarderDto Properties Name Type Description Notes createdAt Date field String forwardToRecipients …

  • InboxForwarderTestOptions

    InboxForwarderTestOptions Properties Name Type Description Notes testValue String [Back to Model list] [Back …

  • InboxForwarderTestResult

    InboxForwarderTestResult Properties Name Type Description Notes doesMatch Bool matches [String: Bool] …

  • InboxProjection

    InboxProjection Properties Name Type Description Notes createdAt Date emailAddress String [optional] …

  • InboxRulesetControllerAPI

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

  • InboxRulesetDto

    InboxRulesetDto Properties Name Type Description Notes action String createdAt Date 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 [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

    MailServerControllerAPI 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 as …

  • MissedEmail

    MissedEmail Properties Name Type Description Notes attachmentCount Int bcc [String] 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 Date 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 Date When the inbox was created. …

  • Pageable

    Pageable Properties Name Type Description Notes offset Int64 [optional] pageNumber Int [optional] pageSize …

  • PageAlias

    PageAlias Properties Name Type Description Notes content [AliasProjection] [optional] empty Bool [optional] …

  • PageAttachmentEntity

    PageAttachmentEntity Properties Name Type Description Notes content [AttachmentProjection] [optional] empty …

  • PageBouncedEmail

    PageBouncedEmail Properties Name Type Description Notes content [BounceProjection] [optional] empty Bool …

  • PageBouncedRecipients

    PageBouncedRecipients Properties Name Type Description Notes content [BounceRecipient] [optional] empty Bool …

  • PageContactProjection

    PageContactProjection Properties Name Type Description Notes content [ContactProjection] [optional] empty Bool …

  • PageEmailPreview

    PageEmailPreview Properties Name Type Description Notes content [EmailPreview] [optional] empty Bool …

  • PageEmailProjection

    PageEmailProjection Properties Name Type Description Notes content [EmailProjection] [optional] empty Bool …

  • PageExpiredInboxRecordProjection

    PageExpiredInboxRecordProjection Properties Name Type Description Notes content [ExpiredInboxRecordProjection] …

  • PageGroupProjection

    PageGroupProjection Properties Name Type Description Notes content [GroupProjection] [optional] empty Bool …

  • PageInboxForwarderDto

    PageInboxForwarderDto Properties Name Type Description Notes content [InboxForwarderDto] [optional] empty Bool …

  • PageInboxProjection

    PageInboxProjection Properties Name Type Description Notes content [InboxProjection] [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] …

  • PageOrganizationInboxProjection

    PageOrganizationInboxProjection Properties Name Type Description Notes content [OrganizationInboxProjection] …

  • PageSentEmailProjection

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

  • PageTemplateProjection

    PageTemplateProjection Properties Name Type Description Notes content [TemplateProjection] [optional] empty …

  • PageThreadProjection

    PageThreadProjection Properties Name Type Description Notes content [ThreadProjection] [optional] empty Bool …

  • PageTrackingPixelProjection

    PageTrackingPixelProjection Properties Name Type Description Notes content [TrackingPixelProjection] [optional] …

  • PageUnknownMissedEmailProjection

    PageUnknownMissedEmailProjection Properties Name Type Description Notes content [UnknownMissedEmailProjection] …

  • PageWebhookProjection

    PageWebhookProjection Properties Name Type Description Notes content [WebhookProjection] [optional] empty Bool …

  • 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

    SentEmailsControllerAPI 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

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

  • TemplateDto

    TemplateDto Properties Name Type Description Notes content String createdAt Date _id UUID name String …

  • TemplateProjection

    TemplateProjection Properties Name Type Description Notes createdAt Date _id UUID 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 UUID bcc [String] [optional] cc [String] …

  • TrackingControllerAPI

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

  • TrackingPixelDto

    TrackingPixelDto Properties Name Type Description Notes createdAt Date html String _id UUID inboxId …

  • TrackingPixelProjection

    TrackingPixelProjection Properties Name Type Description Notes createdAt Date _id UUID inboxId UUID …

  • UnknownMissedEmailProjection

    UnknownMissedEmailProjection Properties Name Type Description Notes createdAt Date from String [optional] …

  • UnreadCount

    UnreadCount Properties Name Type Description Notes count Int64 [Back to Model list] [Back to API list] [Back …

  • UpdateAliasOptions

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

  • UpdateDomainOptions

    UpdateDomainOptions Properties Name Type Description Notes catchAllInboxId UUID [optional] [Back to Model …

  • UpdateGroupContacts

    UpdateGroupContacts Properties Name Type Description Notes contactIds [UUID] [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 UUID ID of the email validated [optional] html …

  • ValidationMessage

    ValidationMessage Properties Name Type Description Notes lineNumber Int message String [optional] [Back …

  • VerifyEmailAddressOptions

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

  • WaitForConditions

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

  • 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 basicAuth Bool 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] contactId UUID …

  • WebhookNewEmailPayload

    WebhookNewEmailPayload Properties Name Type Description Notes attachmentMetaDatas [AttachmentMetaData] List of …

  • WebhookProjection

    WebhookProjection Properties Name Type Description Notes createdAt Date eventName String [optional] _id …

  • WebhookRedriveResult

    WebhookRedriveResult Properties Name Type Description Notes message String [optional] success Bool …

  • WebhookResultDto

    WebhookResultDto Properties Name Type Description Notes createdAt Date httpMethod String _id UUID …

  • WebhookTestRequest

    WebhookTestRequest Properties Name Type Description Notes headers [String: String] method String payload …

  • WebhookTestResponse

    WebhookTestResponse Properties Name Type Description Notes message String [optional] statusCode Int …

  • WebhookTestResult

    WebhookTestResult Properties Name Type Description Notes message String [optional] request WebhookTestRequest …

  • Docs

    MailSlurp Typescript Fetch Client A generated client for the MailSlurp email API. Used by the official MailSlurp Client. …

  • email-generator

  • inbox

  • socket-timeout-exception-502

    Socket Timeout Exceptions - how to fix connection timeouts or 502 exceptions. MailSlurp uses ‘Keep-Alive’ …

  • Avoiding Spam Filters

    Avoiding Spam Filters When sending emails for marketing, no one wants their emails to go to the spam folder. The target …

  • Cancel plan or delete account

    You can manage your account in the MailSlurp dashboard

  • CC and BCC in SMTP

    CC and BCC in SMTP Numerous questions arise from people asking, what is Bcc in email, and how does it work? They also …

  • Change MailSlurp account email address

    Manage account email address MailSlurp accounts are mapped to email addresses. To change the email address for your …

  • Compared to

    MailSlurp alternatives for Mailinator, Mailosaur, MailTrap and others. Email API service with fake email accounts.

  • Configuring DNS Records

    How to enable custom domains with DNS Records in your hosting provider

  • Contact

    Contact Contact MailSlurp at the addresses.

  • Contact

    Please reach out to us any time.

  • Dashboard

    Dashboard guides The dashboard guides have moved.

  • Dealing with SendGrid 550 and 530 errors

    SendGrid uses a shared pool of IP addresses between all users. This means spamming users of SendGrid can ruin the …

  • Deploy Redash to AWS with Terraform

    Easily deploy a self-hosted Redash instance to an AWS EC2 machine using Terraform.

  • Developer guide

    How to get starting with MailSlurp

  • Fetch nameserver records

    Use MailSlurp to fetch name server records. These are useful for verifying domains and querying mail servers.

  • Do you really need MailChimp? (transactional emails with AWS SES, Terraform and Lambda)

    Sending transactional emails with AWS is more powerful than other API providers but comes with some downsides.

  • Documentation

    Developer documentation for Javascript Client, REST API, and other SDKs. For an introduction see the [getting started …

  • Email Account API

    Use MailSlurp to create real email addresses on demand. Generate test email accounts or create permanent user email …

  • Email account custom domain pool

    Using the domain pool with MailSlurp email API

  • Email API accounts. Create inboxes on demand and send and receive emails in code and tests.

    Generate inbox email addresses in code or using visual dashboard. Programmatic email API with REST API and team access.

  • Email APIs for Developers & QA

    Build powerful applications and test suites using real email addresses in code. Create inboxes on demand then send and …

  • About

    Powerful email APIs and solutions for Developers, QA Teams, and Marketers. Unlimited, on-demand private email addresses …

  • Email for testing

    Email for testing One of the laborious things in QA professional life is testing email workflow. It involves a lot of …

  • Email for testing (test email accounts)

    Use dummy test email accounts to test email end-to-end.

  • Email internationalization and i18n localization

    Email encoding with MailSlurp API MailSlurp supports email sending and receiving in multiple languages. The SMTP …

  • Email on Rails

    Testing user sign-up with real email addresses in Ruby

  • Email proxies and aliases on demand.

    Free email masking API. Hide your email address behind randomly generated email proxy accounts. Inbound emails are …

  • Email Web Interface

    Use MailSlurp's free frontend for email sending, receiving, and analysing. Test email account generator and team email …

  • Code examples

    See MailSlurp in action with code examples or interactive demo app.

  • Expired Inboxes

    How inbox expiration works

  • Expired inboxes

    Manage payment, access, and usage limits.

  • F.A.Q.s

    Frequently asked questions about MailSlurp.

  • Feedback

    Let us know what you think.

  • Fetching emails in code

    Fetching email content Some email receiving methods return lists of email previews. This is to keep response sizes low. …

  • Form submit emails

    Submit forms directly to email. No code or sign-up required.

  • GDPR Email Requirements

    How do GDPR laws affect email usage and business that send, receive, or manage emails? Email APIs and dashboards for …

  • Generate email addresses for testing

    Use MailSlurp to create email addresses to send and receive emails during tests.

  • Generate test email accounts

    Test applications with real emails. MailSlurp is like a fake email account.

  • GitHub CLI Auth with token from environment variable

    How to set GitHub CLI token in termal without a file

  • Guides

    Learn how MailSlurp works and how you can use it to achieve email related tasks using the official Javascript client. …

  • Help

    We are always here to support you.

  • How to send emails with MailJet

    Using MailJet to send emails (and how to test it).

  • How to use Mailto Links

    Tutorial mailto links in HTML emails

  • IMAP vs POP3 in SMTP

    IMAP vs POP3 in SMTP There are multiple technologies associated with the retrieval of emails to your email inbox. It …

  • Introducing MailSlurp 2.0

    MailSlurp has been totally rewritten. More functionality, more scale and more support. Plus sustainable pricing.

  • Mailinator email testing usage guide

    Tutorial for Mailinator email testing and alternatives.

  • MailSlurp Blog

    MailSlurp technical blog from the developers. Posts about email API testing and features added to the platform and new …

  • About

    Legal information about MailSlurp.

  • MailSlurp Documentation

    Official MailSlurp documentation Find the developer portal and documentation here.

  • Examples

    Integrate MailSlurp into your application or test. Try an example project to learn how. For reference documentation see …

  • MailSlurp Integrations

    Integrations This page has moved. Example Create inbox Can list inboxes Send emails Receive emails Attachments Sent …

  • MailSlurp Login

    Login to MailSlurp Go to https://app.mailslurp.com/login/ to login to MailSlurp or see the dashboard guide for more …

  • MailSlurp SMTP POP3 IMAP Ports

    How to test SMTP, POP3, and IMAP inboxes using MailSlurp.

  • Mailto link use in HTML

    Mailto link use in HTML HTML is the most prominent technology used behind emails. If you want to become an expert in …

  • Manage billing information and invoices

    Change account billing details for invoices To update your account billing information sign in to the MailSlurp app and …

  • NBSP HTML Entities

    NBSP HTML Entities All emails that you send out are formatted through HTML. This is why you should have a strong …

  • NBSP in HTML emails

    NBSP in HTML emails Of the easiest thing to use on the keyboard, it is the space bar. You can even do it while your eyes …

  • PHP Mail Tutorial (3 ways to send emails)

    How to send and receive emails in PHP

  • Pricing

  • Privacy Policy for Pettman OU

    MailSlurp privacy policy

  • Products

  • Query IP addresses

    Free IP Address API. Query IP address for domains and urls.

  • Receive emails in code and tests

    Read email in code or tests For full documentation please see the receiving email guide.

  • Receive emails in code.

    Use MailSlurp to fetch, receive, or respond in real-time to inbound emails and attachments. Accessible via SDK, API, or …

  • Receive emails with email API using Wait For methods

    Fetch emails and attachments in code waiting for new emails to arrive using MailSlurp

  • Receiving Email

    How to receive emails in application, tests, or the MailSlurp dashboard.

  • Receiving emails in tests

    Generate email accounts for testing

  • Reset API Key

    How to refresh your account API Key

  • Secure Email

    How MailSlurp secures your emails and what security features are available.

  • Send Emails Programmatically

    Use MailSlurp to send transactional emails and attachments using Javascript, PHP, Ruby, Python, and more. Generate email …

  • Sending emails in Javascript (3 ways to send and test emails with Node).

    Sending emails in NodeJS with Sengrid, SES, or custom SMTP servers.

  • Sending Emails with MailSlurp

    How to send emails using the Dashboard, API, or SDK clients.

  • Show latest package version NPM

    How to show latest package version in NPM NodeJS’s package manager NPM has a handy feature for listing outdated …

  • Sign up for MailSlurp

    Create email accounts for team access and use email APIs to send and receive emails in code and tests.

  • Smoke-test your app with CircleCI and NodeJS (catching bugs quickly)

    Avoid embarrassing bug reports by catching bugs in production early with Smoke Tests. It's a simple way to deploy with …

  • SMTP Port Guide

    SMTP Port Guide Everyone wants a successful delivery of their email. What stands between desire and real success is the …

  • SMTP vs HTTP MailSlurp inboxes

    The difference between HTTP and SMTP inboxes and domains in MailSlurp.

  • Spam email and virus detection

    Analyse emails for vulnerabilities and viruses. Get DMARC, SPF, and DKIM verdicts for emails with MailSlurp.

  • Support

    Your MailSlurp account can be managed at https://app.mailslurp.com. MailSlurp support, help, and documentation can be …

  • Terms and Conditions

    MailSlurp terms and conditions of use.

  • Test REST APIs with Kotlin, Retrofit, and JUnit5

    Fast, strongly typed end-to-end testing

  • Test user sign up with NodeJS and Jest (testing email verification codes)

    How to use test email accounts with Jest and NodeJS

  • Test with real email addresses

    Use MailSlurp to test critical application functions (like user sign-up and account confirmation) with real email …

  • Testing User Sign-Up and Email Confirmation

    A tutorial on testing email dependant actions using MailSlurp test email accounts. Intercept inbound emails in tests and …

  • The Difference between POP3 Vs. IMAP Emails

    The Difference between POP3 Vs. IMAP Emails When it comes to retrieving email messages, you have to do it right. To …

  • The fastest way to start a typescript project (in 30 seconds)

    Modern typescript tooling has come a long way. See how to setup a new project with TS-Node, TSC, and typeconfig.json.

  • The Recommended Email size

    The Recommended Email size Do you know what the email attachment size limit is to the content you put in your email? …

  • User Sign-Up Playground

    Use MailSlurp's Playground to test ideas or integrations with a real user sign-up, verification, and login process.

  • Using test email accounts to test user sign up (using CypressJS)

    Generate real email addresses in tests

  • App basics

    An interactive web app for sending, receiving, and managing emails online

  • Validate frontmatter markdown SEO metadata in Javascript

    How to parse and validate markdown with YAML headers and assert for required meta data lengths.

  • Wait for email API

    Wait for email API MailSlurp has many functions for receiving emails. One popular method is the WaitForController wait …

  • Web Interface

    MailSlurp has a powerful online interface that lets you generate email addresses, compose templated messages, download …

  • What are DKIM records

    What are DKIM records We all receive dozens of spam emails to our spam boxes daily. These spam emails are usually sent …

  • What is an SMTP server

    What is an SMTP server Sending an email to someone is something that you can do within few seconds. This is one of the …

  • What is an SMTP Server?

    What is an SMTP Server? If you ask anyone whether they can send an email, a good percentage of them will answer in the …

  • What is transaction email (and how to send it)

    Why sending emails via API services is simpler than deploying your own SMTP server

Related

  • Office Puppy

    Office Puppy Behold the MailSlurp office puppy Wusi. She is a chihuahau/mini-pinscher mix and she keeps everyone …

  • The Recommended Email size

    The Recommended Email size Do you know what the email attachment size limit is to the content you put in your email? …

  • The Difference between POP3 Vs. IMAP Emails

    The Difference between POP3 Vs. IMAP Emails When it comes to retrieving email messages, you have to do it right. To …

  • SMTP Port Guide

    SMTP Port Guide Everyone wants a successful delivery of their email. What stands between desire and real success is the …

  • What is an SMTP Server?

    What is an SMTP Server? If you ask anyone whether they can send an email, a good percentage of them will answer in the …

  • NBSP in HTML emails

    NBSP in HTML emails Of the easiest thing to use on the keyboard, it is the space bar. You can even do it while your eyes …

  • Email for testing

    Email for testing One of the laborious things in QA professional life is testing email workflow. It involves a lot of …

  • CC and BCC in SMTP

    CC and BCC in SMTP Numerous questions arise from people asking, what is Bcc in email, and how does it work? They also …

  • Avoiding Spam Filters

    Avoiding Spam Filters When sending emails for marketing, no one wants their emails to go to the spam folder. The target …

  • EmailRecipients

    # EmailRecipients Properties Name Type Description Notes bcc **MailSlurpModelsRecipient[]** [optional] cc …