MailerSend Ruby SDK

Installation
- Setup
Usage
- Email
  - Send an email
  - Add CC, BCC recipients
  - Send a template-based email
  - Personalization
- Bulk Email
  - Send bulk email
  - Get bulk email status
- Tokens
  - Create a token
  - Update a token
  - Delete a token
  - Send email with attachment
- Activity
  - Get a list of activities
- Analytics
  - Activity data by date
  - Opens by country
  - Opens by user-agent name
  - Opens by reading environment
- Inbound Routes
  - Get a list of inbound routes
  - Get a single inbound route
  - Add an inbound route
  - Update an inbound route
  - Delete an inbound route
- Domains
  - Get a list of domains
  - Get a single domain
  - Add a domain
  - Delete a domain
  - Get recipients for a domain
  - Update domain settings
  - Get DNS Records
  - Get verification status
- Sender Identities
  - Get a list of sender identities
  - Get a single sender identity
  - Get a single sender identity by email
  - Add a sender identity
  - Update a sender identity
  - Update a sender identity by email
  - Delete a sender identity
  - Delete a sender identity by email
- Messages
  - Get a list of messages
  - Get info for a single message
- Scheduled Messages
  - Get a list of scheduled messages
  - Get a single scheduled message
  - Delete a scheduled message
- Recipients
  - Get recipients
  - Get a single recipient
  - Delete a recipient
- Suppressions
  - Get recipients from a suppression list
  - Add recipients to a suppression list
  - Delete recipients from a suppression list
- Webhooks
  - List webhooks
  - Get a webhook
  - Create a webhook
  - Update a webhook
  - Delete a webhook
- Templates
  - Get templates
  - Get a single template
  - Delete template
- Email Verification
  - Verify an email
  - Get all email verification lists
  - Get an email verification list
  - Create an email verification list
  - Verify an email list
  - Get email verification list results
- SMS
- SMS Messages
  - Get a list of SMS messages
  - Get info on an SMS message
- SMS Activity
  - Get a list of sms activities
- SMS Phone Numbers
  - Get a list of SMS phone numbers
  - Get an SMS phone number
  - Update a single SMS phone number
  - Delete an SMS phone number
- SMS Recipients
  - Get a list of SMS recipients
  - Get an SMS recipient
  - Update a single SMS recipient
- SMS Inbounds
  - Get a list of SMS inbound routes
  - Get a single SMS inbound route
  - Create an SMS inbound route
  - Update an SMS inbound route
  - Delete an SMS inbound route
- SMS Webhooks
  - Get a list of SMS webhooks
  - Get an SMS webhook
  - Create an SMS webhook
  - Update an SMS webhook
  - Delete an SMS webhook
- Other endpoints
  - Get API quota
Support and Feedback
License

Installation

Setup

gem install mailersend-ruby

You will have to initalize it in your Ruby file with require "mailersend-ruby".

Email

Send an email

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the email class
ms_email = Mailersend::Email.new(ms_client)

# Add parameters
ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
ms_email.add_recipients("email" => "leslie@parksandrec.com", "name" => "Leslie")
ms_email.add_from("email" => "april@parksandrec.com", "name" => "April")
ms_email.add_subject("Time")
ms_email.add_text("Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.")
ms_email.add_html("<b>Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>")

# Send the email
ms_email.send

Add CC, BCC recipients

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the email class
ms_email = Mailersend::Email.new(ms_client)

# Add parameters
ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
ms_email.add_recipients("email" => "leslie@parksandrec.com", "name" => "Leslie")
ms_email.add_cc("email" => "chris@parksandrec.com", "name" => "Chris")
ms_email.add_bcc("email" => "andy@parksandrec.com", "name" => "Andy")
ms_email.add_from("email" => "april@parksandrec.com", "name" => "April")
ms_email.add_subject("Time")
ms_email.add_text("Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.")
ms_email.add_html("<b>Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>")

# Send the email
ms_email.send

Send a template-based email

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the email class
ms_email = Mailersend::Email.new(ms_client)

# Add parameters
ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
ms_email.add_recipients("email" => "leslie@parksandrec.com", "name" => "Leslie")
ms_email.add_from("email" => "april@parksandrec.com", "name" => "April")
ms_email.add_subject("Time")
ms_email.add_template_id(12415125)

# Send the email
ms_email.send

Personalization

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the email class
ms_email = Mailersend::Email.new(ms_client)

# Add parameters
ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
ms_email.add_from("email" => "april@parksandrec.com", "name" => "April")
ms_email.add_subject("Time {{ test }}")
ms_email.add_text("{{ test }}Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.")
ms_email.add_html("<b>{{ test }}Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>")

personalization = {
  email: 'ron@parksandrec.com',
  data: {
    test: 'Test Value'
  }
}

ms_email.add_personalization(personalization)

ms_email.send

Bulk Email

Send bulk email

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_bulk_email = Mailersend::BulkEmail.new(ms_client)

ms_bulk_email.messages = [
    {
        'from' => {"email" => "april@parksandrec.com", "name" => "April"},
        'to' => [{"email" => "ron@parksandrec.com", "name" => "Ron"}],
        'subject' => "Time",
        'text' => "Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.",
        'html' => "<b>Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>",
      },
      {
        'from' => {"email" => "april@parksandrec.com", "name" => "April"},
        'to' => [{"email" => "leslie@parksandrec.com", "name" => "Leslie"}],
        'subject' => "Lorem Ipsum",
        'text' => "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
        'html' => "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
      }
]

ms_bulk_email.send

Get bulk email status

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_bulk_email = Mailersend::BulkEmail.new(ms_client)
ms_bulk_email.get_bulk_status(bulk_email_id: 'yourbulkemailid')

Tokens

Create a token

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_tokens = Mailersend::Tokens.new(ms_client)
ms_tokens.create(name: "Very nice token", scopes: %w[ email_full domains_read ], domain_id: "yourdomainid")

Update a token

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_tokens = Mailersend::Tokens.new(ms_client)
ms_tokens.update(token_id: "d2220fx04", status: "paused")

Delete a token

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_tokens = Mailersend::Tokens.new(ms_client)
ms_tokens.delete(token_id: "d2220fx04")

Send email with attachment

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the email class
ms_email = Mailersend::Email.new(ms_client)

# Add parameters
ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
ms_email.add_recipients("email" => "leslie@parksandrec.com", "name" => "Leslie")
ms_email.add_cc("email" => "chris@parksandrec.com", "name" => "Chris")
ms_email.add_bcc("email" => "andy@parksandrec.com", "name" => "Andy")
ms_email.add_from("email" => "april@parksandrec.com", "name" => "April")
ms_email.add_subject("Time")
ms_email.add_text("Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.")
ms_email.add_html("<b>Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>")

# You can add one or multiple attachments
ms.add_attachment(content: "/Users/Jerry/Desktop/doc.pdf", filename: "doc.pdf", disposition: "attachment")
ms.add_attachment(content: "/Users/Jerry/Desktop/pic.png", filename: "pic.png", disposition: "attachment")

ms_email.send

Activity

Get a list of activities

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_activity = Mailersend::Activity.new(ms_client)
ms_activity.get(domain_id: "xxx2241ll", page: 3, limit: 5, date_from: 1620643567, date_to: 1623321967)

Analytics

Activity data by date

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_analytics = Mailersend::Analytics.new(ms_client)
ms_analytics.date(date_from: 1620643567, date_to: 1623321967, events: %w[sent queued])

Opens by country

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_analytics = Mailersend::Analytics.new(ms_client)
ms_analytics.country(date_from: 1620643567, date_to: 1623321967)

Opens by user-agent name

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_analytics = Mailersend::Analytics.new(ms_client)
ms_analytics.ua_name(date_from: 1620643567, date_to: 1623321967)

Opens by reading environment

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_analytics = Mailersend::Analytics.new(ms_client)
ms_analytics.ua_type(date_from: 1620643567, date_to: 1623321967)

Inbound Routes

Get a list of inbound routes

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
ms_inbound_routes.get_inbound_routes

Get a single inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
ms_inbound_routes.get_single_route(inbound_id: 'idofroute12412')

Add an inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
ms_inbound_routes.settings =
  {
    'domain_id' => 'yourdomainid',
    'name' => 'inbound_name',
    'domain_enabled' => false,
    'match_filter' => { 'type' => 'match_all' },
    'forwards' => [{ 'type' => 'webhook', 'value' => 'https://example.com' }]
  }
puts ms_inbound_routes.add_inbound_route

Update an inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
ms_inbound_routes.settings =
  {
    'domain_id' => 'yourdomainid',
    'name' => 'inbound_updated',
    'domain_enabled' => false,
    'match_filter' => { 'type' => 'match_all' },
    'forwards' => [{ 'type' => 'webhook', 'value' => 'https://example.com' }]
  }
puts ms_inbound_routes.update_inbound_route(inbound_id: 'idofroute12412')

Delete an inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
ms_inbound_routes.delete_route(inbound_id: 'idofroute12412')

Domains

Get a list of domains

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.list

Get a single domain

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.single(domain_id: "idofdomain12412")

Add a domain

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.add(name: 'yourdomain')

Delete a domain

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.delete(domain_id: "idofdomain12412")

Get recipients for a domain

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.recipients(domain_id: "idofdomain12412")

Update domain settings

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.settings(domain_id: "idofdomain12412", track_clicks: true, track_unsubscribe: false)

Get DNS Records

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.dns(domain_id: "idofdomain12412")

Get verification status

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_domains = Mailersend::Domains.new(ms_client)
ms_domains.verify(domain_id: "idofdomain12412")

Sender Identities

Get a list of sender identities

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.list

Get a single sender identity

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.single(identity_id: 'idofidentity123')

Get a single sender identity by email

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.single_by_email(email: 'example@email.com')

Add a sender identity

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.add(domain_id: 'idofdomain12412', name: 'yourname', email: 'youremail')

Update a sender identity

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.update(identity_id: 'idofidentity123', reply_to_email: 'replyemail', reply_to_name: 'replyname')

Update a sender identity by email

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.update_by_email(email: 'example@email.com', reply_to_email: 'replyemail', reply_to_name: 'replyname')

Delete a sender identity

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.delete(identity_id: 'idofidentity123')

Delete a sender identity by email

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
ms_sender_identity.delete_by_email(email: 'example@email.com')

Messages

Get a list of messages

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_messages = Mailersend::Messages.new(ms_client)
ms_messages.list(page: 1, limit: 10)

Get info for a single message

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_messages = Mailersend::Messages.new(ms_client)
ms_messages.single(message_id: "mess11454")

Scheduled Messages

Get a list of scheduled messages

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_scheduled_messages = Mailersend::ScheduledMessages.new(ms_client)
ms_scheduled_messages.get_list

Get a single scheduled message

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_scheduled_messages = Mailersend::ScheduledMessages.new(ms_client)
ms_scheduled_messages.get_single(message_id: 'mess11454')

Delete a scheduled message

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_scheduled_messages = Mailersend::ScheduledMessages.new(ms_client)
ms_scheduled_messages.delete(message_id: 'mess11454')

Recipients

Get recipients

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_recipients = Mailersend::Recipients.new(ms_client)
ms_recipients.list(page: 1, limit: 10)

Get a single recipient

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_recipients = Mailersend::Recipients.new(ms_client)
ms_recipients.single(recipient_id: "id124")

Delete a recipient

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_recipients = Mailersend::Recipients.new(ms_client)
ms_recipients.delete(recipient_id: "id124")

Suppressions

Get recipients from a suppression list

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_suppressions = Mailersend::Suppressions.new(ms_client)

// List from Blocklist 
ms_suppressions.get_from_blocklist(domain_id: "xxx2241ll")

// List from Hard Bounces
ms_suppressions.get_hard_bounces(domain_id: "xxx2241ll")

// List from Spam Complaints
ms_suppressions.get_spam_complaints(domain_id: "xxx2241ll")

// List from Unsubscribers
ms_suppressions.get_unsubscribes(domain_id: "xxx2241ll")

Add recipients to a suppression list

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_suppressions = Mailersend::Suppressions.new(ms_client)

// Add Recipient to Block List using recipients
ms_suppressions.add_to_blocklist(domain_id: "xxx2241ll", recipients: ["blocked@client.com"])

// Add Recipient to Block List using patterns
ms_suppressions.add_to_blocklist(domain_id: "xxx2241ll", patterns: ["*@client.com"])

// Add Recipient to Hard Bounces
ms_suppressions.add_to_hard_bounces(domain_id: "xxx2241ll", recipients: ["bounced@client.com"])

// Add Recipient to Spam Complaints
ms_suppressions.add_to_spam_complaints(domain_id: "xxx2241ll", recipients: ["bounced@client.com"])

// Add Recipient to Unsubscribes
ms_suppressions.add_to_unsubscribers(domain_id: "xxx2241ll", recipients: ["bounced@client.com"])

Delete recipients from a suppression list

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_suppressions = Mailersend::Suppressions.new(ms_client)

// Delete from Block List
ms_suppressions.delete_from_blocklist(domain_id: 'yourdomainid', ids: ["xxx2241ll"])

// Delete from Hard Bounces
ms_suppressions.delete_from_hard_bounces(domain_id: 'yourdomainid', ids: ["xxx2241ll"])

// Delete from Spam Complaints
ms_suppressions.delete_from_spam_complaints(domain_id: 'yourdomainid', ids: ["xxx2241ll"])

// Delete from Unsubscribes
ms_suppressions.delete_from_unsubscribers(domain_id: 'yourdomainid', ids: ["xxx2241ll"])

Webhooks

List webhooks

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_webhooks = Mailersend::Webhooks.new(ms_client)
ms_webhooks.list(domain_id: "xxx2241ll")

Get a webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_webhooks = Mailersend::Webhooks.new(ms_client)
ms_webhooks.single(webhook_id: "zzz2241ll")

Create a webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_webhooks = Mailersend::Webhooks.new(ms_client)
ms_webhooks.create(domain_id: "xxx2241ll", url: "https://domain.com/hook", name: "Webhook", events: ["activity.sent", "activity.delivered"], enabled: true)

Update a webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_webhooks = Mailersend::Webhooks.new(ms_client)
ms_webhooks.update(webhook_id: "zzz2241ll", enabled: false)

Delete a webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_webhooks = Mailersend::Webhooks.new(ms_client)
ms_webhooks.delete(webhook_id: "zzz2241ll")

Templates

Get templates

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_templates = Mailersend::Templates.new(ms_client)
ms_templates.list(domain_id: "aax455lll", page: 1, limit: 10)

Get a single template

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_templates = Mailersend::Templates.new(ms_client)
ms_templates.single(template_id: "id124")

Delete template

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_templates = Mailersend::Templates.new(ms_client)
ms_templates.delete(template_id: "id124")

Email Verification

Verify an email

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_email_verification = Mailersend::EmailVerification.new(ms_client)
ms_email_verification.verify_an_email(email: 'example@email.com')

Get all email verification lists

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_email_verification = Mailersend::EmailVerification.new(ms_client)
ms_email_verification.list(page: 1, limit: 10)

Get an email verification list

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_email_verification = Mailersend::EmailVerification.new(ms_client)
ms_email_verification.get_single_list(email_verification_id: 'your-email-verification-id')

Create an email verification list

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_email_verification = Mailersend::EmailVerification.new(ms_client)
ms_email_verification.create_a_list(name: "name-your-list", emails: ["example@email.com"])

Verify an email list

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_email_verification = Mailersend::EmailVerification.new(ms_client)
ms_email_verification.verify_a_list(email_verification_id: 'your-email-verification-id')

Get email verification list results

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

ms_email_verification = Mailersend::EmailVerification.new(ms_client)
ms_email_verification.get_list_results(email_verification_id: 'your-email-verification-id')

SMS

Send an SMS

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS class
ms_sms = Mailersend::SMS.new(ms_client)

# Add parameters
ms_sms.add_from('your-number')
ms_sms.add_to('client-number')
ms_sms.add_text('This is the message content')
personalization = {
  phone_number: 'client-number',
  data: {
    test: 'Test Value'
  }
}
ms_sms.add_personalization(personalization)

# Send the SMS
ms_sms.send

SMS Messages

Get a list of SMS messages

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Messages class
ms_sms_messages = Mailersend::SMSMessages.new(ms_client)

# Add parameters
ms_sms_messages.list(page: 1, limit: 10)

Get info on an SMS message

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Messages class
ms_sms_messages = Mailersend::SMSMessages.new(ms_client)

# Add parameters
ms_sms_messages.get_single_route(sms_message_id: 'your-sms-message-id')

SMS Activity

Get a list of sms activities

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_activity = Mailersend::SMSActivity.new(ms_client)

# Add parameters
ms_sms_activity.list(page: 1, limit: 10)

SMS phone numbers

Get a list of SMS phone numbers

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_number = Mailersend::SMSNumber.new(ms_client)

# Add parameters
ms_sms_number.list(page: 1, limit: 10)

Get an SMS phone number

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_number = Mailersend::SMSNumber.new(ms_client)

# Add parameters
ms_sms_number.get(sms_number_id: 'your-sms-number-id')

Update a single SMS phone number

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_number = Mailersend::SMSNumber.new(ms_client)

# Add parameters
ms_sms_number.update(sms_number_id: 'your-sms-number-id', paused: false)

Delete an SMS phone number

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_number = Mailersend::SMSNumber.new(ms_client)

# Add parameters
ms_sms_number.delete(sms_number_id: 'your-sms-number-id')

SMS recipients

Get a list of SMS recipients

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_recipient = Mailersend::SMSRecipient.new(ms_client)

# Add parameters
ms_sms_recipient.list(page: 1, limit: 10)

Get an SMS recipient

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_recipient = Mailersend::SMSRecipient.new(ms_client)

# Add parameters
ms_sms_recipient.get(sms_recipient_id: 'your-sms-recipient-id')

Update a single SMS recipient

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Recipient class
ms_sms_recipient = Mailersend::SMSRecipient.new(ms_client)

# Add parameters
ms_sms_recipient.update(sms_recipient_id: 'your-sms-recipient-id', status: 'opt_out')

SMS Inbounds

Get a list of SMS inbound routes

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Inbounds class
ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)

ms_sms_inbounds.list

Get a single SMS inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Inbounds class
ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)

# Add parameters
ms_sms_inbounds.get_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')

Create an SMS inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Inbounds class
ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)

# Add parameters
ms_sms_inbounds.settings =
  {
    'forward_url' => 'https://your-forward-url',
    'name' => 'name',
    'events' => ['sms.sent', 'sms.delivered'],
    'sms_number_id' => 'your-sms-number-id'
  }
puts ms_sms_inbounds.add_sms_inbound_route

Update an SMS inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Inbounds class
ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)

# Add parameters
ms_sms_inbounds.settings =
  {
    'forward_url' => 'https://your-forward-url',
    'name' => 'name',
    'events' => ['sms.sent', 'sms.delivered'],
    'sms_number_id' => 'your-sms-number-id'
  }
puts ms_sms_inbounds.update_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')

Delete an SMS inbound route

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Inbounds class
ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)

# Add parameters
ms_sms_inbounds.delete_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')

SMS Webhooks

Get a list of SMS webhooks

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Webhooks class
ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)

# Add parameters
ms_sms_webhooks.list(sms_number_id: 'your-sms-number-id')

Get an SMS webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Webhooks class
ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)

# Add parameters
ms_sms_webhooks.get_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')

Create an SMS webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Webhooks class
ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)

# Add parameters
ms_sms_webhooks.settings =
  {
    'sms_number_id' => 'your-sms-number-id',
    'name' => 'your-name',
    'url' => 'https://your-url.com',
    'events' => ['sms.sent', 'sms.delivered']
  }
puts ms_sms_webhooks.add_sms_webhook_route

Update an SMS webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Webhooks class
ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)

# Add parameters
ms_sms_webhooks.settings =
  {
    'sms_number_id' => 'your-sms-number-id',
    'name' => 'your-name',
    'url' => 'https://your-url.com',
    'events' => ['sms.sent', 'sms.delivered']
  }
puts ms_sms_webhooks.update_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')

Delete an SMS webhook

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the SMS Webhooks class
ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)

# Add parameters
ms_sms_webhooks.delete_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')

Other endpoints

Get API quota

require "mailersend-ruby"

ms_client = Mailersend::Client.new('your_mailersend_token')

# Intialize the API Quota class
ms_api_quota = Mailersend::APIQuota.new(ms_client)

# Add parameters
ms_api_quota.get_api_quota

Testing

bundle i
bundle exec rspec spec/*_rspec.rb

To run tests you would need to install gems using bundle and then run rspec via bundle to run all tests. The fixtures for the test have been recorded using vcr and are available in the ./fixtures directory.

Support and Feedback

In case you find any bugs, submit an issue directly here in GitHub.

You are welcome to create SDK for any other programming language.

If you have any troubles using our API or SDK free to contact our support by email info@mailersend.com

The official documentation is at https://developers.mailersend.com

License

The MIT License (MIT)

mailersend-ruby

Runtime