mailslurp_client

MailSlurpClient - the Ruby gem for the MailSlurp API

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.

Resources

• Homepage
• Get an API KEY
• Generated SDK Clients
• Examples repository

This SDK is automatically generated by the OpenAPI Generator project:

• API version: d1659dc1567a5b62f65d0612107a50aace03e085
• Package version: 7.0.8
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build mailslurp_client.gemspec

Then either install the gem locally:

gem install ./mailslurp_client-7.0.8.gem

(for development, run gem install --dev ./mailslurp_client-7.0.8.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'mailslurp_client', '~> 7.0.8'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'mailslurp_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'mailslurp_client'

# Setup authorization
MailSlurpClient.configure do |config|
  # Configure API key authorization: API_KEY
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = MailSlurpClient::AliasControllerApi.new
create_owned_alias_options = MailSlurpClient::CreateOwnedAliasOptions.new # CreateOwnedAliasOptions | createOwnedAliasOptions

begin
  #Create an email alias
  api_instance.create_alias(create_owned_alias_options)
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling AliasControllerApi->create_alias: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.mailslurp.com

Class	Method	HTTP request	Description
MailSlurpClient::AliasControllerApi	create_alias	POST /aliases	Create an email alias
MailSlurpClient::AliasControllerApi	create_anonymous_alias	POST /aliases/anonymous	Create an anonymous email alias
MailSlurpClient::AliasControllerApi	delete_alias	DELETE /aliases/aliasId	Delete an owned alias
MailSlurpClient::AliasControllerApi	get_alias	GET /aliases/aliasId	Get an email alias
MailSlurpClient::AliasControllerApi	get_aliases	GET /aliases	Get all email aliases
MailSlurpClient::AliasControllerApi	update_alias	PUT /aliases/aliasId	Update an owned alias
MailSlurpClient::AttachmentControllerApi	upload_attachment	POST /attachments	Upload an attachment for sending
MailSlurpClient::AttachmentControllerApi	upload_multipart_form	POST /attachments/multipart	Upload an attachment for sending using Multipart Form
MailSlurpClient::BulkActionsControllerApi	bulk_create_inboxes	POST /bulk/inboxes	Bulk create Inboxes (email addresses)
MailSlurpClient::BulkActionsControllerApi	bulk_delete_inboxes	DELETE /bulk/inboxes	Bulk Delete Inboxes
MailSlurpClient::BulkActionsControllerApi	bulk_send_emails	POST /bulk/send	Bulk Send Emails
MailSlurpClient::CommonActionsControllerApi	create_new_email_address	POST /createInbox	Create new random inbox
MailSlurpClient::CommonActionsControllerApi	create_new_email_address1	POST /newEmailAddress	Create new random inbox
MailSlurpClient::CommonActionsControllerApi	empty_inbox	DELETE /emptyInbox	Delete all emails in an inbox
MailSlurpClient::CommonActionsControllerApi	send_email_simple	POST /sendEmail	Send an email
MailSlurpClient::ContactControllerApi	create_contact	POST /contacts	Create a contact
MailSlurpClient::ContactControllerApi	delete_contact	DELETE /contacts/contactId	Delete contact
MailSlurpClient::ContactControllerApi	get_all_contacts	GET /contacts/paginated	Get all contacts
MailSlurpClient::ContactControllerApi	get_contact	GET /contacts/contactId	Get contact
MailSlurpClient::ContactControllerApi	get_contacts	GET /contacts	Get all contacts
MailSlurpClient::DomainControllerApi	create_domain	POST /domains	Create Domain
MailSlurpClient::DomainControllerApi	delete_domain	DELETE /domains/id	Delete a domain
MailSlurpClient::DomainControllerApi	get_domain	GET /domains/id	Get a domain
MailSlurpClient::DomainControllerApi	get_domains	GET /domains	Get domains
MailSlurpClient::EmailControllerApi	delete_all_emails	DELETE /emails	Delete all emails
MailSlurpClient::EmailControllerApi	delete_email	DELETE /emails/emailId	Delete an email
MailSlurpClient::EmailControllerApi	download_attachment	GET /emails/emailId/attachments/attachmentId	Get email attachment bytes
MailSlurpClient::EmailControllerApi	forward_email	POST /emails/emailId/forward	Forward email
MailSlurpClient::EmailControllerApi	get_attachment_meta_data	GET /emails/emailId/attachments/attachmentId/metadata	Get email attachment metadata
MailSlurpClient::EmailControllerApi	get_attachments	GET /emails/emailId/attachments	Get all email attachment metadata
MailSlurpClient::EmailControllerApi	get_email	GET /emails/emailId	Get email content
MailSlurpClient::EmailControllerApi	get_email_html	GET /emails/emailId/html	Get email content as HTML
MailSlurpClient::EmailControllerApi	get_emails_paginated	GET /emails	Get all emails
MailSlurpClient::EmailControllerApi	get_raw_email_contents	GET /emails/emailId/raw	Get raw email string
MailSlurpClient::EmailControllerApi	get_raw_email_json	GET /emails/emailId/raw/json	Get raw email in JSON
MailSlurpClient::EmailControllerApi	get_unread_email_count	GET /emails/unreadCount	Get unread email count
MailSlurpClient::EmailControllerApi	validate_email	POST /emails/emailId/validate	Validate email
MailSlurpClient::FormControllerApi	submit_form	POST /forms	Submit a form to be parsed and sent as an email to an address determined by the form fields
MailSlurpClient::GroupControllerApi	add_contacts_to_group	PUT /groups/groupId/contacts	Add contacts to a group
MailSlurpClient::GroupControllerApi	create_group	POST /groups	Create a group
MailSlurpClient::GroupControllerApi	delete_group	DELETE /groups/groupId	Delete group
MailSlurpClient::GroupControllerApi	get_all_groups	GET /groups/paginated	Get all Contact Groups in paginated format
MailSlurpClient::GroupControllerApi	get_group	GET /groups/groupId	Get group
MailSlurpClient::GroupControllerApi	get_group_with_contacts	GET /groups/groupId/contacts	Get group and contacts belonging to it
MailSlurpClient::GroupControllerApi	get_groups	GET /groups	Get all groups
MailSlurpClient::GroupControllerApi	remove_contacts_from_group	DELETE /groups/groupId/contacts	Remove contacts from a group
MailSlurpClient::InboxControllerApi	create_inbox	POST /inboxes	Create an Inbox (email address)
MailSlurpClient::InboxControllerApi	delete_all_inboxes	DELETE /inboxes	Delete all inboxes
MailSlurpClient::InboxControllerApi	delete_inbox	DELETE /inboxes/inboxId	Delete inbox
MailSlurpClient::InboxControllerApi	get_all_inboxes	GET /inboxes/paginated	List Inboxes Paginated
MailSlurpClient::InboxControllerApi	get_emails	GET /inboxes/inboxId/emails	Get emails in an Inbox
MailSlurpClient::InboxControllerApi	get_inbox	GET /inboxes/inboxId	Get Inbox
MailSlurpClient::InboxControllerApi	get_inbox_emails_paginated	GET /inboxes/inboxId/emails/paginated	Get inbox emails paginated
MailSlurpClient::InboxControllerApi	get_inbox_tags	GET /inboxes/tags	Get inbox tags
MailSlurpClient::InboxControllerApi	get_inboxes	GET /inboxes	List Inboxes / Email Addresses
MailSlurpClient::InboxControllerApi	send_email	POST /inboxes/inboxId	Send Email
MailSlurpClient::InboxControllerApi	set_inbox_favourited	PUT /inboxes/inboxId/favourite	Set inbox favourited state
MailSlurpClient::InboxControllerApi	update_inbox	PATCH /inboxes/inboxId	Update Inbox
MailSlurpClient::TemplateControllerApi	create_template	POST /templates	Create a Template
MailSlurpClient::TemplateControllerApi	delete_template	DELETE /templates/TemplateId	Delete Template
MailSlurpClient::TemplateControllerApi	get_all_templates	GET /templates/paginated	Get all Templates in paginated format
MailSlurpClient::TemplateControllerApi	get_template	GET /templates/TemplateId	Get Template
MailSlurpClient::TemplateControllerApi	get_templates	GET /templates	Get all Templates
MailSlurpClient::WaitForControllerApi	wait_for	POST /waitFor	Wait for conditions to be met
MailSlurpClient::WaitForControllerApi	wait_for_email_count	GET /waitForEmailCount	Wait for and return count number of emails
MailSlurpClient::WaitForControllerApi	wait_for_latest_email	GET /waitForLatestEmail	Fetch inbox's latest email or if empty wait for an email to arrive
MailSlurpClient::WaitForControllerApi	wait_for_matching_email	POST /waitForMatchingEmails	Wait or return list of emails that match simple matching patterns
MailSlurpClient::WaitForControllerApi	wait_for_nth_email	GET /waitForNthEmail	Wait for or fetch the email with a given index in the inbox specified
MailSlurpClient::WebhookControllerApi	create_webhook	POST /inboxes/inboxId/webhooks	Attach a WebHook URL to an inbox
MailSlurpClient::WebhookControllerApi	delete_webhook	DELETE /inboxes/inboxId/webhooks/webhookId	Delete and disable a Webhook for an Inbox
MailSlurpClient::WebhookControllerApi	get_all_webhooks	GET /webhooks/paginated	List Webhooks Paginated
MailSlurpClient::WebhookControllerApi	get_webhook	GET /webhooks/webhookId	Get a webhook for an Inbox
MailSlurpClient::WebhookControllerApi	get_webhooks	GET /inboxes/inboxId/webhooks	Get all Webhooks for an Inbox
MailSlurpClient::WebhookControllerApi	send_test_data	POST /webhooks/webhookId/test	Send webhook test data

Documentation for Models

• MailSlurpClient::AttachmentMetaData
• MailSlurpClient::BasicAuthOptions
• MailSlurpClient::BulkSendEmailOptions
• MailSlurpClient::ContactDto
• MailSlurpClient::ContactProjection
• MailSlurpClient::CreateAnonymousAliasOptions
• MailSlurpClient::CreateContactOptions
• MailSlurpClient::CreateDomainOptions
• MailSlurpClient::CreateGroupOptions
• MailSlurpClient::CreateOwnedAliasOptions
• MailSlurpClient::CreateTemplateOptions
• MailSlurpClient::CreateWebhookOptions
• MailSlurpClient::DomainDto
• MailSlurpClient::DomainPreview
• MailSlurpClient::Email
• MailSlurpClient::EmailAnalysis
• MailSlurpClient::EmailPreview
• MailSlurpClient::EmailProjection
• MailSlurpClient::ForwardEmailOptions
• MailSlurpClient::GroupContactsDto
• MailSlurpClient::GroupDto
• MailSlurpClient::GroupProjection
• MailSlurpClient::HTMLValidationResult
• MailSlurpClient::Inbox
• MailSlurpClient::InboxProjection
• MailSlurpClient::JsonNode
• MailSlurpClient::MatchOption
• MailSlurpClient::MatchOptions
• MailSlurpClient::ModelAlias
• MailSlurpClient::PageAlias
• MailSlurpClient::PageContactProjection
• MailSlurpClient::PageEmailPreview
• MailSlurpClient::PageEmailProjection
• MailSlurpClient::PageGroupProjection
• MailSlurpClient::PageInboxProjection
• MailSlurpClient::PageTemplateProjection
• MailSlurpClient::PageWebhookProjection
• MailSlurpClient::Pageable
• MailSlurpClient::RawEmailJson
• MailSlurpClient::SendEmailOptions
• MailSlurpClient::SetInboxFavouritedOptions
• MailSlurpClient::SimpleSendEmailOptions
• MailSlurpClient::Sort
• MailSlurpClient::TemplateDto
• MailSlurpClient::TemplateProjection
• MailSlurpClient::TemplateVariable
• MailSlurpClient::UnreadCount
• MailSlurpClient::UpdateGroupContacts
• MailSlurpClient::UpdateInboxOptions
• MailSlurpClient::UploadAttachmentOptions
• MailSlurpClient::ValidationDto
• MailSlurpClient::ValidationMessage
• MailSlurpClient::WaitForConditions
• MailSlurpClient::WebhookDto
• MailSlurpClient::WebhookProjection
• MailSlurpClient::WebhookTestRequest
• MailSlurpClient::WebhookTestResponse
• MailSlurpClient::WebhookTestResult

Documentation for Authorization

API_KEY

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header