mimepost

Mimepost - the Ruby gem for the mimepost

MimePost API for sending email. You can find out more about MimePost at https://mimepost.com. For this sample, you can use the api key special-key to test the authorization filters.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Via RubyGems

gem install mimepost

Usage

Example on how to send an simple email:

# Load the gem
require 'mimepost'

# Setup authorization
Mimepost.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['X-Auth-Token'] = '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-Auth-Token'] = 'Bearer'
end

api_instance = Mimepost::EmailsApi.new

body = Mimepost::Email.new
body.html           = '<p>Email send using MimePost ruby sdk</p>'
body.subject        = 'Email send using MimePost ruby sdk'
body.from_email     = '[email protected]'
body.from_name      = 'Mail Sender'

to                  = Mimepost::EmailTo.new
to.email            = '[email protected]'

body.to             = [to]


begin
  #Get account profile details
  result = api_instance.send_email(body)
  p result
rescue Mimepost::ApiError => e
  puts "Exception when calling EmailsApi->send_email: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.mimepost.com/v1/

Class	Method	HTTP request	Description
Mimepost::AccountsApi	account_profile_get	GET /account/profile/	Get account profile details
Mimepost::AccountsApi	account_profile_post	POST /account/profile/	Update account profile details
Mimepost::AccountsApi	settings_get	GET /settings/	Get all the settings
Mimepost::AccountsApi	settings_post	POST /settings/	Set a setting
Mimepost::DomainsApi	domains_get	GET /domains/	Get a list of all the domains
Mimepost::DomainsApi	domains_id_approve_post	POST /domains/{id}/approve/	Submit request for the approval of a verified domain
Mimepost::DomainsApi	domains_id_delete	DELETE /domains/{id}	Remove a single domain
Mimepost::DomainsApi	domains_id_get	GET /domains/{id}	Get the details of a single domain
Mimepost::DomainsApi	domains_id_verify_dkim_post	POST /domains/{id}/verify_dkim/	Request for the verification of DKIM record for a single domain
Mimepost::DomainsApi	domains_id_verify_spf_post	POST /domains/{id}/verify_spf/	Request for the verification of SPF record for a single domain
Mimepost::DomainsApi	domains_id_verify_tracking_post	POST /domains/{id}/verify_tracking/	Request for the verification of tracking record for a single domain
Mimepost::DomainsApi	domains_post	POST /domains/	Add single domain
Mimepost::EmailsApi	send_email	POST /emails/	Send email
Mimepost::StatsApi	emaillogs_get	GET /emaillogs/	Get the logs of a particular date
Mimepost::StatsApi	stats_get	GET /stats/	Get the summary of stats for a range of dates
Mimepost::WebhooksApi	webhooks_get	GET /webhooks/	Get the list of all the webhooks
Mimepost::WebhooksApi	webhooks_id_delete	DELETE /webhooks/{id}	Remove a single webhook
Mimepost::WebhooksApi	webhooks_id_get	GET /webhooks/{id}	Get the details of a single webhook
Mimepost::WebhooksApi	webhooks_id_put	PUT /webhooks/{id}	Update the details of a single webhook
Mimepost::WebhooksApi	webhooks_post	POST /webhooks/	Add single webhook

Documentation for Models

• Mimepost::AccountProfile
• Mimepost::AccountProfileResponse
• Mimepost::AccountSettings
• Mimepost::ApiResponse
• Mimepost::ApiResponseAllWebhooks
• Mimepost::ApiResponseAllWebhooksData
• Mimepost::ApiResponseDomainsList
• Mimepost::ApiResponseDomainsListData
• Mimepost::ApiResponseEmaillogs
• Mimepost::ApiResponseEmaillogsData
• Mimepost::ApiResponseSingleWebhooks
• Mimepost::ApiResponseStats
• Mimepost::ApiResponseStatsData
• Mimepost::ApiResponseStatsDataDatewiseSummary
• Mimepost::ApiResponseStatsDataGraphSummary
• Mimepost::ApiResponseStatsDataTotalSummary
• Mimepost::ApiResponseStatsDataTotalSummaryStatus
• Mimepost::ApiResponseWebhooks
• Mimepost::ApiResponseWebhooksData
• Mimepost::Domain
• Mimepost::Email
• Mimepost::EmailAttachments
• Mimepost::EmailGlobalMergeVars
• Mimepost::EmailMergeVars
• Mimepost::EmailTo
• Mimepost::Webhook
• Mimepost::Webhook1

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: X-Auth-Token
• Location: HTTP header