Namespace mailslurp.Model
Classes
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
AccountBounceBlockDto
AliasDto
Email alias representation
AliasProjection
Representation of a alias
AttachmentEntity
AttachmentEntity
AttachmentMetaData
Meta data associated with an attachment. Attachments are stored as byte blobs so the meta data is stored separately.
AttachmentProjection
Email attachment data
BasicAuthOptions
Basic Authentication options for webhooks. Will be used is present when calling webhook endpoints.
BouncedEmailDto
Bounced email
BouncedRecipientDto
Bounced recipient
BounceProjection
Bounced email event
BounceRecipientProjection
Bounced recipient
BulkSendEmailOptions
Options for bulk sending an email from multiple addresses. See regular sendEmail
methods for more information.
CanSendEmailResults
CanSendEmailResults
CheckEmailBodyFeatureSupportResults
CheckEmailBodyFeatureSupportResults
CheckEmailBodyResults
CheckEmailBodyResults
CheckEmailClientSupportOptions
Options for the email to be validated
CheckEmailClientSupportResults
CheckEmailClientSupportResults
CheckEmailFeaturesClientSupportOptions
CheckEmailFeaturesClientSupportOptions
CheckEmailFeaturesClientSupportResults
CheckEmailFeaturesClientSupportResults
Complaint
Complaint
ConditionOption
Options for matching emails in an inbox based on a condition such as HAS_ATTACHMENTS=TRUE
ConnectorDto
ConnectorDto
ConnectorImapConnectionDto
ConnectorImapConnectionDto
ConnectorProjection
Connector
ConnectorSmtpConnectionDto
ConnectorSmtpConnectionDto
ConnectorSyncEventDto
ConnectorSyncEventDto
ConnectorSyncEventProjection
ConnectorSyncEventProjection
ConnectorSyncRequestResult
ConnectorSyncRequestResult
ConnectorSyncRequestResultException
ConnectorSyncRequestResultException
ConnectorSyncRequestResultExceptionCause
ConnectorSyncRequestResultExceptionCause
ConnectorSyncRequestResultExceptionCauseStackTraceInner
ConnectorSyncRequestResultExceptionCauseStackTraceInner
ConnectorSyncResult
ConnectorSyncResult
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
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.
CreateConnectorImapConnectionOptions
Options for IMAP connection to external email inbox. Allows syncing emails iva IMAP.
CreateConnectorOptions
Options for creating an inbox connection with an external mail provider
CreateConnectorSmtpConnectionOptions
CreateConnectorSmtpConnectionOptions
CreateContactOptions
Options for creating an email contact in address book
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
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.
CreateInboxRulesetOptions
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
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.
DeliveryStatusDto
DeliveryStatusDto
DescribeDomainOptions
Domain record description
DescribeMailServerDomainResult
Name Server lookup result
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
DomainDto
Domain plus verification records and status
DomainGroup
DomainGroup
DomainGroupsDto
DomainGroupsDto
DomainInformation
DomainInformation
DomainIssuesDto
DomainIssuesDto
DomainNameRecord
DNS Record required for verification of a domain. Record vary depending on domain type.
DomainPreview
Preview object for domain entity
DownloadAttachmentDto
Content of attachment
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
EmailAvailableResult
EmailContentMatchResult
Matches for the given pattern
EmailContentPartResult
EmailContentPartResult
EmailFeatureCategoryName
EmailFeatureCategoryName
EmailFeatureFamilyName
EmailFeatureFamilyName
EmailFeatureFamilyStatistics
EmailFeatureFamilyStatistics
EmailFeatureNames
EmailFeatureNames
EmailFeatureOverview
EmailFeatureOverview
EmailFeaturePlatformName
EmailFeaturePlatformName
EmailFeaturePlatformStatistics
EmailFeaturePlatformStatistics
EmailFeatureSupportFlags
EmailFeatureSupportFlags
EmailFeatureSupportResult
EmailFeatureSupportResult
EmailFeatureSupportStatusPercentage
EmailFeatureSupportStatusPercentage
EmailFeatureVersionStatistics
EmailFeatureVersionStatistics
EmailHtmlDto
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.
EmailScreenshotResult
EmailScreenshotResult
EmailTextLinesResult
Parsed text of an email
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
EmergencyAddress
EmergencyAddressDto
EmergencyAddressDto
EmptyResponseDto
EmptyResponseDto
ExpirationDefaults
Expiration defaults for your account
ExpiredInboxDto
Expired inbox
ExpiredInboxRecordProjection
Record of inbox expiration
ExportLink
Export download link
ExportOptions
Options for exporting user data
FakeEmailDto
FakeEmailDto
FakeEmailPreview
FakeEmailPreview
FakeEmailResult
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
GenerateBimiRecordOptions
GenerateBimiRecordResults
GenerateBimiRecordResults
GenerateDmarcRecordOptions
GenerateDmarcRecordOptions
GenerateDmarcRecordResults
GenerateDmarcRecordResults
GenerateMtaStsRecordOptions
GenerateMtaStsRecordOptions
GenerateMtaStsRecordResults
GenerateMtaStsRecordResults
GenerateTlsReportingRecordOptions
GenerateTlsReportingRecordOptions
GenerateTlsReportingRecordResults
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
HTMLValidationResult
HTML Validation Results
ImageIssue
ImageIssue
ImapAccessDetails
Access details for inbox using IMAP
ImapEmailProjection
ImapEmailProjection
ImapFlagOperationOptions
IMAP operation flags
ImapMailboxStatus
ImapMailboxStatus
ImapServerFetchItem
IMAP fetch content in raw format
ImapServerFetchResult
IMAP fetch email result
ImapServerGetResult
ImapServerGetResult
ImapServerListOptions
ImapServerListOptions
ImapServerListResult
ImapServerListResult
ImapServerMailboxResult
ImapServerMailboxResult
ImapServerSearchOptions
IMAP server search options
ImapServerSearchResult
ImapServerSearchResult
ImapServerStatusOptions
ImapServerStatusOptions
ImapServerStatusResult
ImapServerStatusResult
ImapSmtpAccessDetails
Access details for inbox using SMTP or IMAP
ImapSmtpAccessServers
IMAP and SMTP server endpoints for MailSlurp
ImapUpdateFlagsOptions
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
InboxRulesetDto
Rules for inbox
InboxRulesetTestOptions
Test options for inbox ruleset
InboxRulesetTestResult
Result of test of inbox ruleset
IPAddressResult
IP Address look up result for a given domain / hostname
JSONSchemaDto
JSONSchema for payload
LinkIssue
LinkIssue
ListUnsubscribeRecipientProjection
List unsubscribe recipient
LookupBimiDomainOptions
LookupBimiDomainOptions
LookupBimiDomainResults
LookupBimiDomainResults
LookupDmarcDomainOptions
LookupDmarcDomainOptions
LookupDmarcDomainResults
LookupDmarcDomainResults
LookupMtaStsDomainOptions
LookupMtaStsDomainOptions
LookupMtaStsDomainResults
LookupMtaStsDomainResults
LookupTlsReportingDomainOptions
LookupTlsReportingDomainOptions
LookupTlsReportingDomainResults
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
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.
MissedEmailDto
Missed email
MissedEmailProjection
Missed email data
NameServerRecord
Name Server Record
NewFakeEmailAddressResult
NewFakeEmailAddressResult
OrganizationInboxProjection
Organization team inbox
PageableObject
PageableObject
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.
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.
PageConnectorSyncEvents
Paginated inbox connector sync 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.
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.
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.
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.
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.
PageInboxRulesetDto
Paginated inbox ruleset 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.
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.
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.
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.
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.
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.
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.
PageThreadProjection
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.
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.
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.
PhoneNumberDto
PhoneNumberDto
PhoneNumberProjection
Phone number projection
PhonePlanDto
PhonePlanDto
RawEmailJson
Content in raw format
Recipient
Email recipient
ReplyForSms
ReplyForSms
ReplyToAliasEmailOptions
Options for replying to an alias email using the alias inbox
ReplyToEmailOptions
Options for replying to email with API
ScheduledJob
ScheduledJob
ScheduledJobDto
ScheduledJobDto
SearchEmailsOptions
SearchEmailsOptions
SearchInboxesOptions
SearchInboxesOptions
SendEmailBodyPart
Email body content parts for multipart mime message. Will override body.
SendEmailOptions
Options for the email to be sent
Sender
Sender object containing from email address and from personal name if provided in address
SendSMTPEnvelopeOptions
Options for the email envelope
SendWithQueueResult
SendWithQueueResult
SentEmailDto
Sent email details
SentEmailProjection
SentEmailProjection
SentSmsDto
SentSmsDto
ServerEndpoints
ServerEndpoints
SetInboxFavouritedOptions
Options for setting inbox favourite state
SimpleSendEmailOptions
Simplified send email options
SmsDto
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
SmsPreview
SmsProjection
SMS projection
SmsReplyOptions
SmsReplyOptions
SmtpAccessDetails
Access details for inbox using SMTP
SortObject
SortObject
SpellingIssue
SpellingIssue
TemplateDto
Email template
TemplatePreview
TemplatePreview
TemplateProjection
Email template data
TemplateVariable
Variable for use with email template
TestInboxRulesetReceivingOptions
Test options for inbox ruleset receiving test
TestInboxRulesetReceivingResult
TestInboxRulesetReceivingResult
TestInboxRulesetSendingOptions
Test options for inbox ruleset sending test
TestInboxRulesetSendingResult
TestInboxRulesetSendingResult
TestNewInboxForwarderOptions
Options for testing new inbox forwarder rules
TestNewInboxRulesetOptions
Test inbox ruleset options
TestPhoneNumberOptions
TestPhoneNumberOptions
ThreadProjection
A thread is a message thread created for a message received by an alias
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
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
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
UploadMultipartFormRequest
UserInfoDto
UserInfoDto
ValidateEmailAddressListOptions
Options for validating a list of email addresses
ValidateEmailAddressListResult
Result of validating a list of email addresses
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
VerifyWebhookSignatureOptions
VerifyWebhookSignatureResults
VerifyWebhookSignatureResults
WaitForConditions
Conditions to apply to emails that you are waiting for
WaitForSingleSmsOptions
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.
WebhookHeaderNameValue
Name value pair for webhook header
WebhookHeaders
Webhook HTTP headers to include with each request from MailSlurp to your server
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
AbstractWebhookPayload.EventNameEnum
Defines EventName
ConditionOption.ConditionEnum
Condition of an email object that can be used to filter results
ConditionOption.ValueEnum
Expected condition value
ConnectorDto.SyncScheduleTypeEnum
Defines SyncScheduleType
ConnectorProjection.SyncScheduleTypeEnum
Defines SyncScheduleType
ConnectorSyncEventDto.SyncStatusEnum
Defines SyncStatus
ConnectorSyncEventProjection.SyncStatusEnum
Defines SyncStatus
CreateConnectorOptions.SyncScheduleTypeEnum
Sync schedule 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
CreateInboxRulesetOptions.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.
CreateInboxRulesetOptions.ScopeEnum
What type of emails actions to apply ruleset to. Either SENDING_EMAILS
or RECEIVING_EMAILS
will apply action and target to any sending or receiving of emails respectively.
CreateWebhookOptions.EventNameEnum
Optional webhook event name. Default is EMAIL_RECEIVED
and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name.
DNSLookupOptions.RecordTypesEnum
Domain Name Server Record Types
DNSLookupResult.RecordTypeEnum
Domain Name Server Record Types
DomainDto.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.
DomainGroup.LabelEnum
Defines Label
DomainInformation.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.
DomainNameRecord.LabelEnum
Domain Name Server Record Label
DomainNameRecord.RecordTypeEnum
Domain Name Server Record Types
DomainPreview.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.
EmailFeatureCategoryName.SlugEnum
Defines Slug
EmailFeatureFamilyName.SlugEnum
Defines Slug
EmailFeatureFamilyStatistics.FamilyEnum
Defines Family
EmailFeatureFamilyStatistics.FeatureEnum
Defines Feature
EmailFeatureOverview.CategoryEnum
Defines Category
EmailFeatureOverview.FeatureEnum
Defines Feature
EmailFeatureOverview.StatusesEnum
Defines Statuses
EmailFeaturePlatformName.SlugEnum
Defines Slug
EmailFeaturePlatformStatistics.PlatformEnum
Defines Platform
EmailFeatureSupportFlags.StatusEnum
Defines Status
EmailFeatureSupportResult.DetectedFeaturesEnum
Defines DetectedFeatures
EmailFeatureSupportStatusPercentage.StatusEnum
Defines Status
EmergencyAddress.PhoneCountryEnum
Defines PhoneCountry
EmergencyAddressDto.PhoneCountryEnum
Defines PhoneCountry
ExportOptions.OutputFormatEnum
Defines OutputFormat
GenerateBimiRecordOptions.VersionEnum
Defines _Version
GenerateBimiRecordResults.TypeEnum
Domain Name Server Record Types
GenerateDmarcRecordOptions.AdkimEnum
Defines Adkim
GenerateDmarcRecordOptions.AspfEnum
Defines Aspf
GenerateDmarcRecordOptions.FoEnum
Defines Fo
GenerateDmarcRecordOptions.PolicyEnum
Defines Policy
GenerateDmarcRecordOptions.ReportFormatEnum
Defines ReportFormat
GenerateDmarcRecordOptions.SubdomainPolicyEnum
Defines SubdomainPolicy
GenerateDmarcRecordOptions.VersionEnum
Defines _Version
GenerateDmarcRecordResults.TypeEnum
Domain Name Server Record Types
GenerateMtaStsRecordOptions.ModeEnum
Defines Mode
GenerateMtaStsRecordOptions.VersionEnum
Defines _Version
GenerateMtaStsRecordResults.TypeEnum
Domain Name Server Record Types
GenerateTlsReportingRecordOptions.VersionEnum
Defines _Version
GenerateTlsReportingRecordResults.TypeEnum
Domain Name Server Record Types
ImageIssue.SeverityEnum
Defines Severity
ImapFlagOperationOptions.FlagOperationEnum
Defines FlagOperation
ImapServerStatusOptions.StatusItemsEnum
Defines StatusItems
InboxDto.FunctionsAsEnum
Inbox function if used as a primitive for another system.
InboxDto.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).
InboxForwarderDto.FieldEnum
Which field to match against
InboxForwarderEventDto.StatusEnum
Defines Status
InboxForwarderEventProjection.StatusEnum
Defines Status
InboxPreview.FunctionsAsEnum
Inbox function if used as a primitive for another system.
InboxPreview.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).
InboxReplierDto.FieldEnum
Defines Field
InboxReplierEventProjection.StatusEnum
Defines Status
InboxRulesetDto.ActionEnum
Defines Action
InboxRulesetDto.HandlerEnum
Defines Handler
InboxRulesetDto.ScopeEnum
Defines Scope
LinkIssue.SeverityEnum
Defines Severity
MatchOption.FieldEnum
Fields of an email object that can be used to filter results
MatchOption.ShouldEnum
How the value of the email field specified should be compared to the value given in the match options.
OrganizationInboxProjection.FunctionsAsEnum
Inbox function if used as a primitive for another system.
OrganizationInboxProjection.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).
PhoneNumberDto.PhoneCountryEnum
Defines PhoneCountry
PhoneNumberProjection.PhoneCountryEnum
Defines PhoneCountry
PhonePlanDto.PhoneCountryEnum
Defines PhoneCountry
ReplyToAliasEmailOptions.SendStrategyEnum
How an email should be sent based on its recipients
ReplyToEmailOptions.SendStrategyEnum
How an email should be sent based on its recipients
ScheduledJob.StatusEnum
Defines Status
ScheduledJobDto.StatusEnum
Defines Status
SearchEmailsOptions.SortDirectionEnum
Optional createdAt sort direction ASC or DESC
SearchInboxesOptions.InboxFunctionEnum
Optional filter by inbox function
SearchInboxesOptions.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).
SearchInboxesOptions.SortDirectionEnum
Optional createdAt sort direction ASC or DESC
SendEmailOptions.SendStrategyEnum
How an email should be sent based on its recipients
SendEmailOptions.ValidateEmailAddressesEnum
Validate recipient email addresses before sending
SmsMatchOption.FieldEnum
Fields of an SMS object that can be used to filter results
SmsMatchOption.ShouldEnum
How the value of the email field specified should be compared to the value given in the match options.
SpellingIssue.SeverityEnum
Defines Severity
TemplateVariable.VariableTypeEnum
The type of variable
UpdateInboxReplierOptions.FieldEnum
Field to match against to trigger inbox replier for inbound email
UserInfoDto.AccountStateEnum
Defines AccountState
UserInfoDto.AccountTypeEnum
Defines AccountType
UserInfoDto.SubscriptionTypeEnum
Defines SubscriptionType
WaitForConditions.CountTypeEnum
How result size should be compared with the expected size. Exactly or at-least matching result?
WaitForConditions.SortDirectionEnum
Direction to sort matching emails by created time
WaitForSingleSmsOptions.SortDirectionEnum
Defines SortDirection
WaitForSmsConditions.CountTypeEnum
How result size should be compared with the expected size. Exactly or at-least matching result?
WaitForSmsConditions.SortDirectionEnum
Direction to sort matching SMSs by created time
WebhookBouncePayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookBounceRecipientPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookDeliveryStatusPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookDto.EventNameEnum
Webhook trigger event name
WebhookDto.MethodEnum
HTTP method that your server endpoint must listen for
WebhookEmailOpenedPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookEmailReadPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewAttachmentPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewContactPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewEmailPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookNewSmsPayload.EventNameEnum
Name of the event type webhook is being triggered for.
WebhookProjection.EventNameEnum
Defines EventName
WebhookResultDto.HttpMethodEnum
Defines HttpMethod
WebhookResultDto.ResultTypeEnum
Defines ResultType
WebhookResultDto.WebhookEventEnum
Defines WebhookEvent
WebhookTestRequest.MethodEnum
Defines Method