class MailinatorClient::Messages
Class containing all the actions for the Messages
Resource
Public Class Methods
# File lib/mailinator_client/messages.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Deletes ALL messages from a Private Domain. Caution: This action is irreversible.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
Responses:
-
Status and count of removed messages (manybrain.github.io/m8rdocs/#delete-all-messages-by-domain)
# File lib/mailinator_client/messages.rb, line 253 def delete_all_domain_messages(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) path = "/domains/#{params[:domain]}/inboxes" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Deletes ALL messages from a specific private inbox.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
Responses:
-
Status and count of removed messages (manybrain.github.io/m8rdocs/#delete-all-messages-by-inbox)
# File lib/mailinator_client/messages.rb, line 283 def delete_all_inbox_messages(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Deletes a specific messages.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{string} messageId - The Message id
Responses:
-
Status and count of removed messages (manybrain.github.io/m8rdocs/#delete-a-message)
# File lib/mailinator_client/messages.rb, line 315 def delete_message(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) raise ArgumentError.new("message id is required") unless params.has_key?(:messageId) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Retrieves a specific attachment.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{string} messageId - The Message id
-
{string} attachmentId - The Attachment id
Responses:
-
Attachment (manybrain.github.io/m8rdocs/#fetch-attachment)
# File lib/mailinator_client/messages.rb, line 188 def fetch_attachment(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) raise ArgumentError.new("message id is required") unless params.has_key?(:messageId) raise ArgumentError.new("attachment id is required") unless params.has_key?(:attachmentId) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}/attachments/#{params[:attachmentId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves a list of attachments for a message. Note attachments are expected to be in Email format.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{string} messageId - The Message id
Responses:
-
Collection of attachments (manybrain.github.io/m8rdocs/#fetch-list-of-attachments)
# File lib/mailinator_client/messages.rb, line 153 def fetch_attachments(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) raise ArgumentError.new("message id is required") unless params.has_key?(:messageId) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}/attachments" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves a list of messages summaries. You can retreive a list by inbox, inboxes, or entire domain.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{number} skip - Skip this many emails in your Private Domain
-
{number} limit - Number of emails to fetch from your Private Domain
-
{string} sort - Sort results by ascending or descending
-
{boolean} decodeSubject - true: decode encoded subjects
Responses:
-
Collection of messages (manybrain.github.io/m8rdocs/#fetch-inbox-aka-fetch-message-summaries)
# File lib/mailinator_client/messages.rb, line 50 def fetch_inbox(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { skip: 0, limit: 50, sort: "ascending", decodeSubject: false } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) query_params[:skip] = params[:skip] if params.has_key?(:skip) query_params[:limit] = params[:limit] if params.has_key?(:limit) query_params[:sort] = params[:sort] if params.has_key?(:sort) query_params[:decodeSubject] = params[:decodeSubject] if params.has_key?(:decodeSubject) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves a specific message by id.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{string} messageId - The Message id
Responses:
# File lib/mailinator_client/messages.rb, line 87 def fetch_message(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) raise ArgumentError.new("message id is required") unless params.has_key?(:messageId) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves all links found within a given email.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{string} messageId - The Message id
Responses:
-
Collection of links (manybrain.github.io/m8rdocs/#fetch-links)
# File lib/mailinator_client/messages.rb, line 222 def fetch_message_links(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) raise ArgumentError.new("message id is required") unless params.has_key?(:messageId) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages/#{params[:messageId]}/links" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves a specific SMS message by sms number.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{string} teamSmsNumber - The Team sms number
Responses:
-
Collection of messages (manybrain.github.io/m8rdocs/#fetch-an-sms-messages)
# File lib/mailinator_client/messages.rb, line 120 def fetch_sms_message(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) raise ArgumentError.new("team sms number is required") unless params.has_key?(:teamSmsNumber) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/#{params[:teamSmsNumber]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Deliver a JSON message into your private domain.
Authentication: The client must be configured with a valid api access token to call this action.
Parameters:
-
{string} domainId - The Domain name or the Domain id
-
{string} inbox - The Inbox name
-
{string} messageToPost - The Message object (manybrain.github.io/m8rdocs/#inject-a-message-http-post-messages)
Responses:
-
Status, Id and RulesToFired info (manybrain.github.io/m8rdocs/#fetch-an-sms-messages)
# File lib/mailinator_client/messages.rb, line 348 def inject_message(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { } headers = {} body = nil raise ArgumentError.new("domain is required") unless params.has_key?(:domain) raise ArgumentError.new("inbox is required") unless params.has_key?(:inbox) raise ArgumentError.new("messageToPost is required") unless params.has_key?(:messageToPost) body = params[:messageToPost] if params.has_key?(:messageToPost) path = "/domains/#{params[:domain]}/inboxes/#{params[:inbox]}/messages" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end