Namespace mailslurp.Model

Classes

AIMappingMatchOption

Options for matching when an AI transform mapping should trigger. Each match option object contains a field, should and value property. Together they form logical conditions such as SUBJECT should CONTAIN value.

AIMappingMatchOptions

Optional filter for matching emails based on fields. For instance filter results to only include emails whose SUBJECT value does CONTAIN given match value. An example payload would be { matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }. You can also pass conditions such as HAS_ATTACHMENT. If you wish to extract regex matches inside the email content see the getEmailContentMatch method in the EmailController.

AITransformCreateOptions

AITransformDto

AITransformMappingDto

AITransformMappingMatchResult

AITransformMappingProjection

AITransformProjection

AITransformResultDto

AITransformResultProjectionDto

AbstractOpenAPISchema

Abstract base class for oneOf, anyOf schemas in the OpenAPI specification

AbstractWebhookPayload

Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the NEW_EMAIL,NEW_CONTACT, NEW_ATTACHMENT and EMAIL_OPENED payloads for the properties available for those events.

AccountBounceBlockDto

AliasDto

Email alias representation

AliasProjection

Representation of a alias

AliasThreadProjection

A thread is a message thread created for a message received by an alias

AttachmentEntityDto

DTO representation of an attachment.

AttachmentMetaData

Meta data associated with an attachment. Attachments are stored as byte blobs so the meta data is stored separately.

AttachmentProjection

Email attachment data

AuditLogEventDto

AuditLogPageDto

AuditLogSearchOptions

BasicAuthOptions

Basic Authentication options for webhooks. Will be used is present when calling webhook endpoints.

BounceProjection

Bounced email event

BounceRecipientProjection

Bounced recipient

BouncedEmailDto

Bounced email

BouncedRecipientDto

Bounced recipient

BulkSendEmailOptions

Options for bulk sending an email from multiple addresses. See regular sendEmail methods for more information.

CampaignProbeDto

CampaignProbeInsightsDto

CampaignProbeRunDto

CampaignProbeRunDueResult

CampaignProbeRunNowResult

CampaignProbeSeriesDto

CampaignProbeSeriesPointDto

CanSendEmailResults

CancelDevicePreviewRunOptions

CancelDevicePreviewRunResult

CheckEmailBodyFeatureSupportResults

CheckEmailBodyResults

CheckEmailClientSupportOptions

Options for the email to be validated

CheckEmailClientSupportResults

CheckEmailFeaturesClientSupportOptions

CheckEmailFeaturesClientSupportResults

CodeCandidate

Candidate verification code extracted from content

Complaint

ConditionOption

Options for matching emails in an inbox based on a condition such as HAS_ATTACHMENTS=TRUE

ConditionalStructuredContentResult

ConnectorDto

ConnectorEventDto

ConnectorEventProjection

ConnectorImapConnectionDto

ConnectorImapConnectionTestResult

ConnectorProjection

Connector

ConnectorProviderSettingsDto

ConnectorSmtpConnectionDto

ConnectorSmtpConnectionTestResult

ConnectorSyncRequestResult

ConnectorSyncResult

ConnectorSyncSettingsDto

ConsentStatusDto

ContactDto

Contact object. For saving a user in contact book.

ContactProjection

Email contact for address book

ContentMatchOptions

Options for matching content using regex patterns based on Java Pattern syntax

CountDto

Number of elements

CreateAITransformerMappingOptions

CreateAliasOptions

Create email alias options. Email aliases can be used to mask real email addresses behind an ID. You can also attach an inbox to an alias so that any email received by the inbox email address if forwarded to the alias email address.

CreateCampaignProbeOptions

Create options for a campaign probe

CreateCampaignProbeRunOptions

Direct invoke options for campaign probe analysis

CreateConnectorImapConnectionOptions

Options for IMAP connection to external email inbox. Allows syncing emails via IMAP.

CreateConnectorOptions

Options for creating an inbox connection with an external mail provider

CreateConnectorSmtpConnectionOptions

CreateConnectorSyncSettingsOptions

Options for creating automatic syncing between an inbox connection and an external mail provider

CreateConnectorWithOptions

Options for creating an inbox connection with an external mail provider including extra settings

CreateContactOptions

Options for creating an email contact in address book

CreateDeliverabilitySimulationJobOptions

Create a simulation job for a deliverability test

CreateDeliverabilityTestOptions

Create a new deliverability/load test

CreateDevicePreviewFeedbackOptions

CreateDevicePreviewOptions

CreateDevicePreviewRunResult

CreateDomainMonitorAlertSinkOptions

CreateDomainMonitorOptions

Create options for a domain monitor

CreateDomainOptions

Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either HTTP or SMTP type. The type of domain determines which inboxes can be used with it. SMTP inboxes use a mail server running mxslurp.click while HTTP inboxes are handled by AWS SES.

CreateEmergencyAddressOptions

CreateGroupOptions

Create contact group options

CreateInboxDto

Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either SMTP or HTTP mailboxes. SMTP inboxes are processed by a mail server running at mailslurp.mx while HTTP inboxes are processed by AWS SES backed mailservers. An inbox email address is randomly assigned by default ending in either mailslurp.com or (if useDomainPool is enabled) ending in a similar domain such as mailslurp.xyz (selected at random). To specify an address use a custom domain: either pass the emailAddress options with <your-recipient>@<your-domain>. To create a randomized address for your domain set the domainName to the domain you have verified or pass the domainId. Virtual inboxes prevent outbound sending and instead trap mail.

CreateInboxForwarderOptions

Options for creating an inbox forwarder

CreateInboxReplierOptions

Options for creating an inbox replier. Repliers can be attached to inboxes and send automated responses when an inbound email matches given criteria.

CreateInboxRetentionPolicyForAccountOptions

CreatePhoneNumberOptions

CreatePortalOptions

CreatePortalUserOptions

CreateRulesetOptions

Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or forward emails when sending or receiving using the inbox.

CreateTemplateOptions

Create template options

CreateTotpDeviceBase32SecretKeyOptions

CreateTotpDeviceCustomOptions

CreateTotpDeviceOtpAuthUrlOptions

CreateTrackingPixelOptions

Options for creating a tracking pixel for email open tracking

CreateWebhookOptions

Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the webhook's event is triggered. Webhooks are great for processing many inbound emails and responding to other events at scale. Customize the payload sent to your endpoint by setting the requestBodyTemplate property to a string with moustache style variables. Property names from the standard payload model for the given event are available as variables.

DNSLookupOptions

Options for DNS query.

DNSLookupResult

DNS lookup result. Includes record type, time to live, raw response, and name value for the name server response.

DNSLookupResults

Results of query on domain name servers

DNSLookupsOptions

Options for multiple DNS queries

DeleteDevicePreviewRunResult

DeleteResult

DeliverabilityAnalyticsRunDto

Run-level metrics for analytics tables

DeliverabilityAnalyticsSeriesDto

Deliverability analytics response for time-range comparison

DeliverabilityAnalyticsSeriesPointDto

Bucketed deliverability analytics point for charts/tables

DeliverabilityAnalyticsSummaryDto

Aggregated deliverability metrics for a given set of runs

DeliverabilityEntityResultDto

Entity-level deliverability result

DeliverabilityEntityResultPageDto

Paged entity results for a deliverability test

DeliverabilityExpectation

Single expectation to evaluate against each selected entity

DeliverabilityExpectationResultDto

Expectation evaluation result for a single entity

DeliverabilityFailureEntityHotspotDto

Most common failing entity across deliverability runs

DeliverabilityFailureHotspotsDto

Deliverability failure hotspot response for range comparisons

DeliverabilityFailurePhoneDimensionHotspotDto

Most common failing phone country/variant dimensions

DeliverabilityPollStatusResultDto

Polling response for deliverability test progress

DeliverabilitySelectorOptions

How entities are selected for a deliverability test

DeliverabilitySimulationEmailOptions

Simulation options for email deliverability tests

DeliverabilitySimulationJobConfigDto

Simulation job configuration snapshot

DeliverabilitySimulationJobDto

Deliverability simulation job status

DeliverabilitySimulationJobErrorSummaryDto

Simulation error summary

DeliverabilitySimulationJobEventDto

Single event for a deliverability simulation job

DeliverabilitySimulationJobEventPageDto

Paged simulation events

DeliverabilitySimulationJobTopErrorDto

Top simulation error summary item

DeliverabilitySimulationSmsOptions

Simulation options for SMS deliverability tests

DeliverabilityTestDto

Deliverability test configuration and progress summary

DeliverabilityTestPageDto

Paged list of deliverability tests

DeliveryStatusDto

DescribeDomainOptions

Domain record description

DescribeMailServerDomainResult

Name Server lookup result

DevicePreviewFeedbackDto

DevicePreviewFeedbackListDto

DevicePreviewProviderProgressDto

DevicePreviewRunDto

DevicePreviewRunResultsDto

DevicePreviewScreenshotDto

DevicePreviewTargetDto

DomainDto

Domain plus verification records and status

DomainGroup

DomainGroupsDto

DomainInformation

DomainIssuesDto

DomainMonitorAlertSinkDto

DomainMonitorDto

DomainMonitorInsightsDto

DomainMonitorRunDto

DomainMonitorRunDueResult

DomainMonitorRunNowResult

DomainMonitorSeriesDto

DomainMonitorSeriesPointDto

DomainNameRecord

DNS Record required for verification of a domain. Record vary depending on domain type.

DomainPreview

Preview object for domain entity

DomainRegionGroup

DomainRegionGroupsDto

Grouped available domains including account-region policy status.

DomainRegionInformation

DownloadAttachmentDto

Content of attachment

Email

Email entity (also known as EmailDto). When an SMTP email message is received by MailSlurp it is parsed. The body and attachments are written to disk and the fields such as to, from, subject etc are stored in a database. The body contains the email content. If you want the original SMTP message see the getRawEmail endpoints. The attachments can be fetched using the AttachmentController

EmailAnalysis

Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic error message

EmailAvailableResult

EmailContentMatchResult

Matches for the given pattern

EmailContentPartResult

EmailFeatureCategoryName

EmailFeatureFamilyName

EmailFeatureFamilyStatistics

EmailFeatureNames

EmailFeatureOverview

EmailFeaturePlatformName

EmailFeaturePlatformStatistics

EmailFeatureSupportFlags

EmailFeatureSupportResult

EmailFeatureSupportStatusPercentage

EmailFeatureVersionStatistics

EmailHtmlDto

EmailLinksResult

Links found in HTML

EmailPreview

Preview of an email message. For full message (including body and attachments) call the getEmail or other email endpoints with the provided email ID.

EmailPreviewUrls

URLs for email body

EmailProjection

A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the getEmail method with the email projection's ID. See EmailDto for documentation on projection properties.

EmailRecipients

The To,CC,BCC recipients stored in object form with email address and name accessible.

EmailRecipientsProjection

Recipients of original email in thread

EmailScreenshotResult

EmailSignature

Parsed signature block detected in an email

EmailSignatureParseResult

Result of attempting to parse an email signature

EmailTextLinesResult

Parsed text of an email

EmailThreadDto

EmailThreadItem

EmailThreadItemsDto

EmailThreadProjection

An email thread is a message thread created for a email based on Message-ID, In-Reply-To, and References headers

EmailValidationRequestDto

Email validation request

EmailVerificationResult

Email verification result. Valid means email address exists according to response from mail server running at the domain and port given.

EmergencyAddress

EmergencyAddressDto

EmptyResponseDto

EntityAutomationItemProjection

EntityEventItemProjection

EntityFavouriteItemProjection

ExpirationDefaults

Expiration defaults for your account

ExpiredInboxDto

Expired inbox

ExpiredInboxRecordProjection

Record of inbox expiration

ExportLink

Export download link

ExportOptions

Options for exporting user data

ExportTransformerOptions

ExportTransformerResponse

ExportTransformerResultJobDto

ExtractAttachmentTextOptions

Options for extracting text from an attachment. Choose a method and whether fallback is allowed.

ExtractAttachmentTextResult

Extracted text result for an attachment

ExtractCodesOptions

Options for extracting verification codes from email or SMS content. Use method to control extraction strategy and allowFallback to control strictness.

ExtractCodesResult

Result of extracting verification codes from message content

FakeEmailDto

FakeEmailPreview

FakeEmailResult

FilterBouncedRecipientsOptions

Options for filtering bounced email recipients

FilterBouncedRecipientsResult

Remaining recipients that were filtered to remove bounced recipients

FlushExpiredInboxesResult

Result from calling expire on any inboxes that have applicable expiration dates given current time.

ForwardEmailOptions

Options for forwarding an email

GenerateBimiRecordOptions

GenerateBimiRecordResults

GenerateDmarcRecordOptions

GenerateDmarcRecordResults

GenerateMtaStsRecordOptions

GenerateMtaStsRecordResults

GenerateStructuredContentAttachmentOptions

Options for generating structured content output from an attachment

GenerateStructuredContentEmailOptions

Options for generating structured content output from an email

GenerateStructuredContentSmsOptions

Options for generating structured content output from an SMS

GenerateTlsReportingRecordOptions

GenerateTlsReportingRecordResults

GetEmailScreenshotOptions

Options taking a screenshot capture of a rendered email

GravatarUrl

User image

GroupContactsDto

Describes contacts attached to a contact group

GroupDto

Contact group data

GroupProjection

Data for contact group

GuestPortalDto

GuestPortalUserCreateDto

GuestPortalUserDto

GuestPortalUserProjection

Representation of a guest portal user

HTMLValidationResult

HTML Validation Results

IPAddressResult

IP Address look up result for a given domain / hostname

ImageIssue

ImapAccessDetails

Access details for inbox using IMAP

ImapEmailProjection

ImapFlagOperationOptions

IMAP operation flags

ImapMailboxStatus

ImapServerFetchItem

IMAP fetch content in raw format

ImapServerFetchResult

IMAP fetch email result

ImapServerGetResult

ImapServerListOptions

ImapServerListResult

ImapServerMailboxResult

ImapServerSearchOptions

IMAP server search options

ImapServerSearchResult

ImapServerStatusOptions

ImapServerStatusResult

ImapSmtpAccessDetails

Access details for inbox using SMTP or IMAP

ImapSmtpAccessServers

IMAP and SMTP server endpoints for MailSlurp

ImapUpdateFlagsOptions

InboxByEmailAddressResult

Result of search for inbox by email address

InboxByNameResult

Result of search for inbox by name

InboxDto

Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either SMTP or HTTP mailboxes. The default, HTTP inboxes, use AWS SES to process emails and are best suited as test email accounts and do not support IMAP or POP3. SMTP inboxes use a custom mail server at mxslurp.click and support SMTP login, IMAP and POP3. Use the EmailController or the InboxController methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching.

InboxExistsDto

Result of email exists query

InboxForwarderDto

Inbox forwarder. Describes how an inbox will forward matching emails to designated recipients.

InboxForwarderEventDto

Inbox forwarder event. Describes how an email was handled by an inbox forwarder.

InboxForwarderEventProjection

Inbox forwarder event

InboxForwarderTestOptions

Options for testing an inbox forwarder against a value

InboxForwarderTestResult

Results of inbox forwarder test

InboxIdItem

Inbox ID and email address pair

InboxIdsResult

List of inbox IDs and email addresses

InboxPreview

Inbox data preview element.

InboxReplierDto

Inbox replier. Will automatically reply to inbound emails that match given field for an inbox.

InboxReplierEventProjection

Inbox replier event

InboxRetentionPolicyDto

InboxRetentionPolicyOptionalDto

InboxRulesetTestResult

Result of test of inbox ruleset

InvokeTransformerOptions

JSONSchemaDto

JSONSchema for payload

LinkIssue

ListUnsubscribeRecipientProjection

List unsubscribe recipient

LookupBimiDomainOptions

LookupBimiDomainResults

LookupDmarcDomainOptions

LookupDmarcDomainResults

LookupMtaStsDomainOptions

LookupMtaStsDomainResults

LookupMxRecordsOptions

LookupMxRecordsResults

LookupTlsReportingDomainOptions

LookupTlsReportingDomainResults

MatchOption

Options for matching emails in an inbox. Each match option object contains a field, should and value property. Together they form logical conditions such as SUBJECT should CONTAIN value.

MatchOptions

MissedEmailDto

Missed email

MissedEmailProjection

Missed email data

MissedSmsDto

Missed SMS

MissedSmsProjection

Missed SMS projection

NameServerRecord

Name Server Record

NewFakeEmailAddressResult

OptInConsentOptions

OptInConsentSendResult

OptInIdentityProjection

OptInSendingConsentDto

OptionalConnectorDto

OptionalConnectorImapConnectionDto

OptionalConnectorSmtpConnectionDto

OptionalConnectorSyncSettingsDto

OrganizationInboxProjection

Organization team inbox

PageAITransformMappingProjection

Paginated AI Transform mapping entities. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageAITransformProjection

Paginated AI Transform entity. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageAITransformResultProjection

Paginated AI Transform result entities. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageAlias

Paginated email alias results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageAliasThreadProjection

Paginated alias thread projection results.

PageAttachmentEntity

Paginated attachment entity results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageBouncedEmail

Paginated bounced email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageBouncedRecipients

Paginated bounced recipients. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageComplaint

Paginated complaint email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageConnector

Paginated inbox connectors. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageConnectorEvents

Paginated inbox connector events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageContactProjection

Paginated contact results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageDeliveryStatus

Paginated delivery status results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageDevicePreviewRunProjection

Paginated device preview run results. Page index starts at zero. Use runId for detailed status, provider progress, and screenshots.

PageEmailPreview

Paginated email preview results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments.

PageEmailProjection

Paginated email projection results. EmailProjections and EmailPreviews are essentially the same but have legacy naming issues. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full email entity use the projection ID with individual method calls. For emails there are several methods for fetching message bodies and attachments.

PageEmailThreadProjection

Paginated email thread projection results.

PageEmailValidationRequest

Paginated email validation request records. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageEntityAutomationItems

Paginated automation items like auto-repliers, forwarders, and rulesets. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageEntityEventItems

Paginated event items like webhook events and forwarding. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageEntityFavouriteItems

Paginated favourite items like inboxes, phones, sms, emails. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageExpiredInboxRecordProjection

Paginated expired inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageGroupProjection

Paginated missed email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageGuestPortalUsers

Paginated guest portal users

PageInboxForwarderDto

Paginated inbox forwarder results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageInboxForwarderEvents

Paginated inbox forwarder events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageInboxProjection

Paginated inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageInboxReplierDto

Paginated inbox replier results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageInboxReplierEvents

Paginated inbox replier events. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageInboxTags

Paginated inbox tags. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageListUnsubscribeRecipients

Paginated list unsubscribe recipients. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageMissedEmailProjection

Paginated MissedEmail results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageMissedSmsProjection

Paginated missed SMS messages. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageOptInIdentityProjection

Paginated opt in identity projections reflecting users who have verified double-opt in consent to receive emails from your account.

PageOrganizationInboxProjection

Paginated organization inbox results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PagePhoneMessageThreadItemProjection

Paginated phone message thread items. These are messages in a phone thread. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PagePhoneMessageThreadProjection

Paginated phone message threads. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PagePhoneNumberProjection

Paginated phone numbers. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PagePhoneNumberReleaseProjection

Paginated released phone numbers. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PagePlusAddressProjection

Paginated inbox plus addresses. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageReputationItems

Paginated reputation items like complaints and bounces. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageRulesetDto

Paginated ruleset results to deny or permit inbound or outbound SMS and email. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageScheduledJobs

Paginated scheduled jobs results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageSentEmailProjection

Paginated sent email results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls.

PageSentEmailWithQueueProjection

Paginated sent email results for emails sent with queue. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full sent email entity use the projection ID with individual method calls.

PageSentSmsProjection

Paginated sent SMS messages. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageSmsProjection

Paginated SMS messages. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageTableData

PageTemplateProjection

Paginated email template results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageTrackingPixelProjection

Paginated TrackingPixel results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageUnknownMissedEmailProjection

Paginated unknown MissedEmail results. Unknown missed emails are emails that were sent to MailSlurp /Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageWebhookEndpointProjection

Paginated webhook endpoint with latest health status. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageWebhookProjection

Paginated webhook entity. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageWebhookResult

Paginated webhook results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

PageableObject

Pagination

PhoneMessageThreadItemProjection

PhoneMessageThreadProjection

PhoneNumberDto

PhoneNumberProjection

Phone number projection

PhoneNumberReleaseProjection

Released phone number projection

PhoneNumberValidationDto

PhonePlanAvailability

PhonePlanAvailabilityItem

PhonePlanDto

PhoneSummaryCountryDto

PhoneSummaryDto

PlanSummaryDto

PlusAddressDto

PlusAddressProjection

ProviderSettings

RawEmailJson

Content in raw format

Recipient

Email recipient

RecipientProjection

ReplyForSms

ReplyToAliasEmailOptions

Options for replying to an alias email using the alias inbox

ReplyToEmailOptions

Options for replying to email with API

ReputationItemProjection

RulesetDto

Rules for an inbox or phone number. Rulesets can be used to block, allow, filter, or bounce emails or SMS when sending or receiving.

RulesetTestOptions

Test options for inbox ruleset

ScheduledJob

ScheduledJobDto

SearchEmailsOptions

SearchInboxesOptions

SendEmailBodyPart

Email body content parts for multipart mime message. Will override body.

SendEmailOptions

Options for the email to be sent

SendOptInConsentEmailOptions

SendSMTPEnvelopeOptions

Options for the email envelope

SendWithQueueResult

Sender

Sender object containing from email address and from personal name if provided in address

SenderProjection

Last sender object

SentEmailDto

Sent email details

SentEmailProjection

SentSmsDto

SentSmsProjection

Sent SMS projection

ServerEndpoints

SetInboxFavouritedOptions

Options for setting inbox favourite state

SetPhoneFavouritedOptions

Options for setting phone favourite state

SimpleSendEmailOptions

Simplified send email options

SmsDto

SmsMatchOption

Options for matching SMS messages in a phone number. Each match option object contains a field, should and value property. Together they form logical conditions such as BODY should CONTAIN value.

SmsPreview

SmsProjection

SMS projection

SmsReplyOptions

SmsSendOptions

SmtpAccessDetails

Access details for inbox using SMTP

SortObject

SpellingIssue

StructuredContentResultDto

StructuredOutputSchema

JSON output schema for structured content repsonses. This schema dictates the format that an AI should use when responding to your instructions.

StructuredOutputSchemaValidation

TemplateDto

Email template

TemplatePreview

TemplateProjection

Email template data

TemplateVariable

Variable for use with email template

TenantReputationFindingDto

TenantReputationFindingsDto

TenantReputationStatusRowDto

TenantReputationStatusSummaryDto

TestInboxRulesetSendingOptions

Test options for ruleset sending test

TestNewInboxForwarderOptions

Options for testing new inbox forwarder rules

TestNewInboxRulesetOptions

Test inbox ruleset options

TestPhoneNumberOptions

TestRulesetReceivingOptions

Test options for inbox ruleset receiving test or phone number receiving test

TestRulesetReceivingResult

TestRulesetSendingResult

TotpDeviceCodeDto

TotpDeviceDto

TotpDeviceOptionalDto

TrackingPixelDto

Tracking pixel

TrackingPixelProjection

Tracking pixel data

UnknownMissedEmailProjection

Unknown missed email projection

UnreadCount

Number of unread entities

UnseenErrorCountDto

Number of unseen errors

UpdateAliasOptions

Update an email alias

UpdateCampaignProbeOptions

Update options for a campaign probe

UpdateDeliverabilityTestOptions

Update a deliverability/load test

UpdateDevicePreviewFeedbackOptions

UpdateDomainMonitorOptions

Update options for a domain monitor

UpdateDomainOptions

Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not functionally currently until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help.

UpdateGroupContacts

Update group contacts options. Pass a list of contact ids to replace existing group contacts.

UpdateImapAccessOptions

Edit access details for inbox using IMAP

UpdateInboxOptions

Options for updating inbox properties

UpdateInboxReplierOptions

Options for updating an inbox replier

UpdatePhoneNumberOptions

UpdateSmtpAccessOptions

Edit access details for inbox using SMTP

UploadAttachmentOptions

Options for uploading files for attachments. When sending emails with the API that require attachments first upload each attachment. Then use the returned attachment ID in your SendEmailOptions when sending an email. This way you can use attachments multiple times once they have been uploaded.

UploadMultipartFormRequest

UserInfoDto

ValidateEmailAddressListOptions

Options for validating a list of email addresses

ValidateEmailAddressListResult

Result of validating a list of email addresses

ValidatePhoneNumberOptions

ValidationDto

Response object for email validation operation

ValidationMessage

Optional warnings resulting from HTML validation

VerifyEmailAddressOptions

Options for verifying that an email address exists at a remote mail server.

VerifyWebhookSignatureOptions

VerifyWebhookSignatureResults

WaitForConditions

Conditions to apply to emails that you are waiting for

WaitForSingleSmsOptions

WaitForSmsConditions

Conditions to apply to emails that you are waiting for

WebhookBouncePayload

BOUNCE webhook payload. Sent to your webhook url endpoint via HTTP POST when an email bounced or was rejected by a recipient. Save the recipients to a ban list on your server and avoid emailing them again. It is recommended you also listen to the BOUNCE_RECIPIENT payload.

WebhookBounceRecipientPayload

BOUNCE_RECIPIENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email caused a bounce to occur for a recipient. Save the recipient to a ban list of your server and avoid email them again.

WebhookDeliveryStatusPayload

DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure.

WebhookDto

Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://csharp.api.mailslurp.com/schemas/webhook-payload for the payload schema.

WebhookEmailOpenedPayload

EMAIL_OPENED webhook payload. Sent to your webhook url endpoint via HTTP POST when an email containing a tracking pixel is opened and the pixel image is loaded by a reader.

WebhookEmailReadPayload

EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard.

WebhookEndpointProjection

WebhookHeaderNameValue

Name value pair for webhook header

WebhookHeaders

Webhook HTTP headers to include with each request from MailSlurp to your server

WebhookNewAITransformResultPayload

NEW_AI_TRANSFORM_RESULT webhook payload. Sent to your webhook url endpoint via HTTP POST when a structured data result is generated by the AI Transformer that your webhook is attached to. Use the AI Transform Result ID to fetch the full details.

WebhookNewAttachmentPayload

NEW_ATTACHMENT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains an attachment. You can use the attachmentId to download the attachment.

WebhookNewContactPayload

NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains a recipient that has not been saved as a contact.

WebhookNewEmailPayload

NEW_EMAIL webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to. Use the email ID to fetch the full email body or attachments.

WebhookNewSmsPayload

NEW_SMS webhook payload. Sent to your webhook url endpoint via HTTP POST when an sms is received by the phone number that your webhook is attached to. Use the SMS ID to fetch the full SMS details.

WebhookProjection

Representation of a webhook

WebhookRedriveAllResult

Result of retrying all failed webhook

WebhookRedriveResult

Result of retrying webhook

WebhookResultDto

Result of a webhook notification

WebhookTestRequest

Result of webhook test request

WebhookTestResponse

Response from webhook test request

WebhookTestResult

Results of testing a webhook

Enums

AIMappingMatchOption.FieldEnum

Fields of an email, sms, or attachment object that can be used to filter results

AIMappingMatchOption.ShouldEnum

How the value of the field specified should be compared to the value given in the match options.

AITransformMappingDto.EntityTypeEnum

Defines EntityType

AITransformMappingProjection.ContentSelectorEnum

Defines ContentSelector

AITransformMappingProjection.EntityTypeEnum

Defines EntityType

AITransformMappingProjection.TriggerSelectorEnum

Defines TriggerSelector

AITransformResultDto.EntityTypeEnum

Defines EntityType

AITransformResultProjectionDto.EntityTypeEnum

Defines EntityType

AbstractWebhookPayload.EventNameEnum

Defines EventName

CampaignProbeDto.LastRunStatusEnum

Defines LastRunStatus

CampaignProbeRunDto.SourceEnum

Defines Source

CampaignProbeRunDto.StatusEnum

Defines Status

CampaignProbeRunDueResult.TriggerSourceEnum

Defines TriggerSource

CampaignProbeSeriesDto.BucketEnum

Defines Bucket

CodeCandidate.MethodEnum

Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.

ConditionOption.ConditionEnum

Condition of an email object that can be used to filter results

ConditionOption.ValueEnum

Expected condition value

ConnectorEventDto.EventTypeEnum

Defines EventType

ConnectorEventDto.StatusEnum

Defines Status

ConnectorEventProjection.EventTypeEnum

Defines EventType

ConnectorEventProjection.StatusEnum

Defines Status

ConnectorSyncSettingsDto.SyncScheduleTypeEnum

Defines SyncScheduleType

CreateAITransformerMappingOptions.ContentSelectorEnum

Defines ContentSelector

CreateAITransformerMappingOptions.EntityTypeEnum

Defines EntityType

CreateAITransformerMappingOptions.TriggerSelectorEnum

Defines TriggerSelector

CreateConnectorSyncSettingsOptions.SyncScheduleTypeEnum

Sync schedule type

CreateDeliverabilityTestOptions.ScopeEnum

Entity scope to evaluate

CreateDevicePreviewFeedbackOptions.CategoryEnum

Defines Category

CreateDevicePreviewFeedbackOptions.ProviderEnum

Defines Provider

CreateDevicePreviewFeedbackOptions.SourceEnum

Defines Source

CreateDevicePreviewFeedbackOptions.StatusEnum

Defines Status

CreateDevicePreviewOptions.ProvidersEnum

Optional providers to request for rendering. Defaults to ESP_DEFAULT_PROVIDERS when set, otherwise GMAIL and OUTLOOK.

CreateDomainMonitorAlertSinkOptions.SeverityThresholdEnum

Defines SeverityThreshold

CreateDomainMonitorAlertSinkOptions.TypeEnum

Defines Type

CreateDomainOptions.DomainTypeEnum

Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.

CreateEmergencyAddressOptions.IsoCountryCodeEnum

Defines IsoCountryCode

CreateInboxDto.InboxTypeEnum

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

CreateInboxForwarderOptions.FieldEnum

Field to match against to trigger inbox forwarding for inbound email

CreateInboxReplierOptions.FieldEnum

Field to match against to trigger inbox replier for inbound email

CreatePhoneNumberOptions.PhoneCountryEnum

Defines PhoneCountry

CreatePhoneNumberOptions.PhoneNumberVariantEnum

Defines PhoneNumberVariant

CreatePhoneNumberOptions.ScheduleEnum

Defines Schedule

CreateRulesetOptions.ActionEnum

Action to be taken when the ruleset matches an email for the given scope. For example: BLOCK action with target * and scope SENDING_EMAILS blocks sending to all recipients. Note ALLOW takes precedent over BLOCK. FILTER_REMOVE is like block but will remove offending email addresses during a send or receive event instead of blocking the action.