MailSlurpClient::MissedEmailControllerApi

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

MethodHTTP requestDescription
get_all_missed_emailsGET /missed-emailsGet all MissedEmails in paginated format
get_missed_emailGET /missed-emails/{MissedEmailId}Get MissedEmail

get_all_missed_emails

PageMissedEmailProjection get_all_missed_emails(opts)

Get all MissedEmails in paginated format

Example

# 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::MissedEmailControllerApi.new
opts = {
  page: 0, # Integer | Optional page  in inbox list pagination
  search_filter: 'search_filter_example', # String | Optional search filter
  size: 20, # Integer | Optional page size in inbox list pagination
  sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
}

begin
  #Get all MissedEmails in paginated format
  result = api_instance.get_all_missed_emails(opts)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling MissedEmailControllerApi->get_all_missed_emails: #{e}"
end

Parameters

NameTypeDescriptionNotes
pageIntegerOptional page in inbox list pagination[optional] [default to 0]
search_filterStringOptional search filter[optional]
sizeIntegerOptional page size in inbox list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageMissedEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_missed_email

MissedEmail get_missed_email(missed_email_id)

Get MissedEmail

Example

# 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::MissedEmailControllerApi.new
missed_email_id = 'missed_email_id_example' # String | MissedEmailId

begin
  #Get MissedEmail
  result = api_instance.get_missed_email(missed_email_id)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling MissedEmailControllerApi->get_missed_email: #{e}"
end

Parameters

NameTypeDescriptionNotes
missed_email_idStringMissedEmailId

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json