Skip to content

MailSlurpClient::MissedEmailControllerApi

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

Method HTTP request Description
get_all_missed_emails GET /missed-emails Get all MissedEmails in paginated format
get_all_unknown_missed_emails GET /missed-emails/unknown Get all unknown missed emails in paginated format
get_missed_email GET /missed-emails/{missedEmailId} Get MissedEmail
restore_missed_emails POST /missed-emails/restore Restore missed emails
wait_for_nth_missed_email GET /missed-emails/waitForNthMissedEmail Wait for Nth missed email

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 list pagination
  size: 20, # Integer | Optional page size in list pagination
  sort: 'ASC', # String | Optional createdAt sort direction ASC or DESC
  search_filter: 'search_filter_example', # String | Optional search filter
  since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter by created at after the given timestamp
  before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter by created at before the given timestamp
  inbox_id: 'inbox_id_example' # String | Optional inbox ID filter
}

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

Name Type Description Notes
page Integer Optional page in list pagination [optional] [default to 0]
size Integer Optional page size in list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to 'ASC']
search_filter String Optional search filter [optional]
since DateTime Filter by created at after the given timestamp [optional]
before DateTime Filter by created at before the given timestamp [optional]
inbox_id String Optional inbox ID filter [optional]

Return type

PageMissedEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

get_all_unknown_missed_emails

PageUnknownMissedEmailProjection get_all_unknown_missed_emails(opts)

Get all unknown missed emails in paginated format

Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

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 list pagination
  size: 20, # Integer | Optional page size in list pagination
  sort: 'ASC', # String | Optional createdAt sort direction ASC or DESC
  search_filter: 'search_filter_example', # String | Optional search filter
  since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter by created at after the given timestamp
  before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter by created at before the given timestamp
  inbox_id: 'inbox_id_example' # String | Optional inbox ID filter
}

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

Parameters

Name Type Description Notes
page Integer Optional page in list pagination [optional] [default to 0]
size Integer Optional page size in list pagination [optional] [default to 20]
sort String Optional createdAt sort direction ASC or DESC [optional] [default to 'ASC']
search_filter String Optional search filter [optional]
since DateTime Filter by created at after the given timestamp [optional]
before DateTime Filter by created at before the given timestamp [optional]
inbox_id String Optional inbox ID filter [optional]

Return type

PageUnknownMissedEmailProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

get_missed_email

MissedEmail get_missed_email(missed_email_id)

Get MissedEmail

List emails that were missed due to plan limits.

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 | 

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

Name Type Description Notes
missed_email_id String

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

restore_missed_emails

restore_missed_emails

Restore missed emails

If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

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

begin
  #Restore missed emails
  api_instance.restore_missed_emails
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling MissedEmailControllerApi->restore_missed_emails: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

nil (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

wait_for_nth_missed_email

MissedEmail wait_for_nth_missed_email(, opts)

Wait for Nth missed email

Wait for 0 based missed email

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
 = 56 # Integer | Zero based  of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
opts = {
  inbox_id: 'inbox_id_example', # String | Optional inbox ID filter
  timeout: 56, # Integer | Optional timeout milliseconds
  since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter by created at after the given timestamp
  before: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter by created at before the given timestamp
}

begin
  #Wait for Nth missed email
  result = api_instance.wait_for_nth_missed_email(, opts)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling MissedEmailControllerApi->wait_for_nth_missed_email: #{e}"
end

Parameters

Name Type Description Notes
**** Integer Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
inbox_id String Optional inbox ID filter [optional]
timeout Integer Optional timeout milliseconds [optional]
since DateTime Filter by created at after the given timestamp [optional]
before DateTime Filter by created at before the given timestamp [optional]

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /