API Reference mailslurp v11.6.13

Modules

API calls for all endpoints tagged AliasController.

API calls for all endpoints tagged AttachmentController.

API calls for all endpoints tagged BulkActionsController.

API calls for all endpoints tagged CommonActionsController.

API calls for all endpoints tagged ContactController.

API calls for all endpoints tagged DomainController.

API calls for all endpoints tagged EmailController.

API calls for all endpoints tagged ExpiredController.

API calls for all endpoints tagged FormController.

API calls for all endpoints tagged GroupController.

API calls for all endpoints tagged InboxController.

API calls for all endpoints tagged MailServerController.

API calls for all endpoints tagged SentEmailsController.

API calls for all endpoints tagged TemplateController.

API calls for all endpoints tagged WaitForController.

API calls for all endpoints tagged WebhookController.

Handle Tesla connections for MailSlurpAPI.

Helper functions for deserializing responses into models

Email alias representation

Representation of a alias

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

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

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

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

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.

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.

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. They can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or if `useDomainPool` is enabled then ending in a similar domains such as `mailslurp.xyz` (selected at random).

Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the inbox receives an email. Webhooks are great for processing many inbound emails.

Options for DNS query.

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

Results of query on domain name servers

Domain plus verification records and status

DNS Record required for verification of a domain

Preview object for domain entity

Email model (also referred to as EmailDto). Represents an email that was received by an inbox. If you want the original SMTP message see the `getRawEmail` endpoint.

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

Matches for the given pattern

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

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.

Parsed text of an email

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

Expiration defaults for your account

Options for forwarding an email

HTML Validation Results

Representation of an inbox with an email address. Emails can be sent to or from this email address.

IP Address look up result for a given domain / hostname

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.

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' }] }`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.

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

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

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.

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.

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

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

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

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

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.

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

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.

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

Content in raw format

Options for replying to an alias email using the alias inbox

Options for replying to email with API

Options for sending an email message from an inbox. You must provide one of: `to`, `toGroup`, or `toContacts` to send an email. All other parameters are optional.

Sent email details

Options for setting inbox favourite state

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

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.

Options for updating inbox properties

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.

Response object for email validation operation

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

Conditions that a `waitForXEmails` endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately.

Representation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox.

Representation of a webhook

Results of testing a webhook

Helper functions for building Tesla requests