Skip to main content

MailSlurp API

Project description

MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Overview #### Inboxes Inboxes have real email addresses that can send and receive emails. You can create inboxes with specific email addresses (using custom domains). You can also use randomly assigned MailSlurp addresses as unique, disposable test addresses. See the InboxController or [inbox and email address guide](https://www.mailslurp.com/guides/) for more information. #### Receive Emails You can receive emails in a number of ways. You can fetch emails and attachments directly from an inbox. Or you can use `waitFor` endpoints to hold a connection open until an email is received that matches given criteria (such as subject or body content). You can also use webhooks to have emails from multiple inboxes forwarded to your server via HTTP POST. InboxController methods with `waitFor` in the name have a long timeout period and instruct MailSlurp to wait until an expected email is received. You can set conditions on email counts, subject or body matches, and more. Most receive methods only return an email ID and not the full email (to keep response sizes low). To fetch the full body or attachments for an email use the email's ID with EmailController endpoints. See the InboxController or [receiving emails guide](https://www.mailslurp.com/guides/) for more information. #### Send Emails You can send templated HTML emails in several ways. You must first create an inbox to send an email. An inbox can have a specific address or a randomly assigned one. You can send emails from an inbox using `to`, `cc`, and `bcc` recipient lists or with contacts and contact groups. Emails can contain plain-text or HTML bodies. You can also use email templates that support [moustache](https://mustache.github.io/) template variables. You can send attachments by first posting files to the AttachmentController and then using the returned IDs in the `attachments` field of the send options. See the InboxController or [sending emails guide](https://www.mailslurp.com/guides/) for more information. ## Templates MailSlurp emails support templates. You can create templates in the dashboard or API that contain [moustache](https://mustache.github.io/) style variables: for instance `Hello {{name}}`. Then when sending emails you can pass a map of variables names and values to be used. Additionally, when sending emails with contact groups you can use properties of the contact in your templates like `{{firstName}}` and `{{lastName}}``. ## Explore # noqa: E501

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mailslurp-client-7.0.4.tar.gz (80.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mailslurp_client-7.0.4-py3-none-any.whl (198.5 kB view details)

Uploaded Python 3

File details

Details for the file mailslurp-client-7.0.4.tar.gz.

File metadata

  • Download URL: mailslurp-client-7.0.4.tar.gz
  • Upload date:
  • Size: 80.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.5.2

File hashes

Hashes for mailslurp-client-7.0.4.tar.gz
Algorithm Hash digest
SHA256 aee8f2cd6d86f3032a64e8504ee4d4ed3d4a30ad432a38fb24e8c08ad5f330fe
MD5 b79ee447438ffacdfb0ae3e308895220
BLAKE2b-256 c5143860654ee32951ceff47009e62bc1e140e6ccbffd22e604765a5e457f0fe

See more details on using hashes here.

File details

Details for the file mailslurp_client-7.0.4-py3-none-any.whl.

File metadata

  • Download URL: mailslurp_client-7.0.4-py3-none-any.whl
  • Upload date:
  • Size: 198.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.9.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.5.2

File hashes

Hashes for mailslurp_client-7.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5d9dcf4f4798830c358e4ba3c95df292275d526b2d1d8662a6710f307f8e0139
MD5 c3167d1a56d5cef8490532a41b3abd61
BLAKE2b-256 ac45dfb917d394a96a99525e9aa05f1e834a36aed352a38603ab51631de9196b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page