No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.swagger-codegen
docs
lib
spec
.gitignore
.rspec
.rubocop.yml
.swagger-codegen-ignore
Gemfile
Mailslurp Swagger SDK.gemspec
README.md
Rakefile
git_push.sh

README.md

Mailslurp Swagger SDK

MailSlurpClient - the Ruby gem for the MailSlurp API

Documentation for MailSlurp's public REST API. ### About MailSlurp is a SAAS API for sending and receiving emails from ephemeral email inboxes. These inboxes can be created on the fly and each has a unique email address. ### Why MailSlurp was built for testing software or processes that interact with email in some way. For more information see the homepage. ### Links - Get API Key - API Documentation - Official SDK Libraries - Support / Issues - Swagger JSON ### Use You can call the MailSlurp API from any HTTP client in any language. Or you use one of the official generated SDK Libraries. - Official Typescript SDK - Official Python SDK - Official C# SDK - Official Java SDK - Official Swift SDK - Official Golang SDK - Official Javascript SDK - Official PHP SDK - Official Ruby SDK You can also compile your own library with SwaggerCodegen and the Swagger Spec. Lastly, there is an interactive GUI available at demo.mailslurp.com for testing requests. ### Auth An API Key must be passed as a header in all requests. To get an API Key sign up and log in to the MailSlurp Dashboard web app. ### Terms - Inbox - A unique email address - Unlimited in number - Can send and receive emails - Email - Belongs to an inbox - Contains summary and body - Raw content stored on S3 ### Issues If you encounter issues please contact the developers or open a ticket in GitHub.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.0.1-alpha
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://www.mailslurp.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build Mailslurp Swagger SDK.gemspec

Then either install the gem locally:

gem install ./Mailslurp Swagger SDK-1.0.0.gem

(for development, run gem install --dev ./Mailslurp Swagger SDK-1.0.0.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 Swagger SDK', '~> 1.0.0'

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 Swagger SDK', :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 Swagger SDK'

# 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::EmailControllerApi.new

id = 'id_example' # String | id


begin
  #Delete Email
  api_instance.delete_message_using_delete(id)
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling EmailControllerApi->delete_message_using_delete: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
MailSlurpClient::EmailControllerApi delete_message_using_delete DELETE /emails/{id} Delete Email
MailSlurpClient::EmailControllerApi get_message_analytics_using_get GET /emails/{id}/analytics Get Email Analytics
MailSlurpClient::EmailControllerApi get_message_using_get GET /emails/{id} Get Email Content
MailSlurpClient::InboxControllerApi create_inbox_using_post POST /inboxes Create Inbox
MailSlurpClient::InboxControllerApi delete_inbox_using_delete DELETE /inboxes/{id} Delete Inbox
MailSlurpClient::InboxControllerApi get_inbox_using_get GET /inboxes/{id} Get Inbox
MailSlurpClient::InboxControllerApi get_inboxes_using_get GET /inboxes List Inboxes
MailSlurpClient::InboxControllerApi get_messages_using_get GET /inboxes/{id}/messages List Inbox's Emails
MailSlurpClient::InboxControllerApi send_message_using_post POST /inboxes/{id} Send Email
MailSlurpClient::ManageEntitiesApi delete_inbox_using_delete DELETE /inboxes/{id} Delete Inbox
MailSlurpClient::ManageEntitiesApi delete_message_using_delete DELETE /emails/{id} Delete Email
MailSlurpClient::ManageEntitiesApi get_inbox_using_get GET /inboxes/{id} Get Inbox
MailSlurpClient::ManageEntitiesApi get_inboxes_using_get GET /inboxes List Inboxes
MailSlurpClient::ReceiveEmailsApi create_inbox_using_post POST /inboxes Create Inbox
MailSlurpClient::ReceiveEmailsApi get_message_analytics_using_get GET /emails/{id}/analytics Get Email Analytics
MailSlurpClient::ReceiveEmailsApi get_message_using_get GET /emails/{id} Get Email Content
MailSlurpClient::ReceiveEmailsApi get_messages_using_get GET /inboxes/{id}/messages List Inbox's Emails
MailSlurpClient::SendEmailsApi create_inbox_using_post POST /inboxes Create Inbox
MailSlurpClient::SendEmailsApi send_message_using_post POST /inboxes/{id} Send Email

Documentation for Models

Documentation for Authorization

API_KEY

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