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_all_unknown_missed_emailsGET /missed-emails/unknownGet all unknown missed emails in paginated format
get_missed_emailGET /missed-emails/{missedEmailId}Get MissedEmail
wait_for_nth_missed_emailGET /missed-emails/waitForNthMissedEmailWait 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 = {
  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
  page: 0, # Integer | Optional page  in list pagination
  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
  size: 20, # Integer | Optional page size in 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
beforeDateTimeFilter by created at before the given timestamp[optional]
inbox_idStringOptional inbox ID filter[optional]
pageIntegerOptional page in list pagination[optional] [default to 0]
search_filterStringOptional search filter[optional]
sinceDateTimeFilter by created at after the given timestamp[optional]
sizeIntegerOptional page size in 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_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 = {
  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
  page: 0, # Integer | Optional page  in list pagination
  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
  size: 20, # Integer | Optional page size in list pagination
  sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
}

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

NameTypeDescriptionNotes
beforeDateTimeFilter by created at before the given timestamp[optional]
inbox_idStringOptional inbox ID filter[optional]
pageIntegerOptional page in list pagination[optional] [default to 0]
search_filterStringOptional search filter[optional]
sinceDateTimeFilter by created at after the given timestamp[optional]
sizeIntegerOptional page size in list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageUnknownMissedEmailProjection

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

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
opts = {
  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
  : 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
  since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter by created at after the given timestamp
  timeout: 56 # Integer | Optional timeout milliseconds
}

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

NameTypeDescriptionNotes
beforeDateTimeFilter by created at before the given timestamp[optional]
inbox_idStringOptional inbox ID filter[optional]
****IntegerZero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1[optional]
sinceDateTimeFilter by created at after the given timestamp[optional]
timeoutIntegerOptional timeout milliseconds[optional]

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

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