MailSlurpClient::SentEmailsControllerApi

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

MethodHTTP requestDescription
get_all_sent_tracking_pixelsGET /sent/tracking-pixelsGet all sent email tracking pixels in paginated form
get_sent_emailGET /sent/{id}Get sent email receipt
get_sent_email_tracking_pixelsGET /sent/{id}/tracking-pixelsGet all tracking pixels for a sent email in paginated form
get_sent_emailsGET /sentGet all sent emails in paginated form
get_sent_organization_emailsGET /sent/organizationGet all sent organization emails in paginated form

get_all_sent_tracking_pixels

PageTrackingPixelProjection get_all_sent_tracking_pixels(opts)

Get all sent email tracking pixels in paginated form

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

begin
  #Get all sent email tracking pixels in paginated form
  result = api_instance.get_all_sent_tracking_pixels(opts)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling SentEmailsControllerApi->get_all_sent_tracking_pixels: #{e}"
end

Parameters

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

Return type

PageTrackingPixelProjection

Authorization

API_KEY

HTTP request headers

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

get_sent_email

SentEmailDto get_sent_email(id)

Get sent email receipt

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::SentEmailsControllerApi.new
id = 'id_example' # String | id

begin
  #Get sent email receipt
  result = api_instance.get_sent_email(id)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling SentEmailsControllerApi->get_sent_email: #{e}"
end

Parameters

NameTypeDescriptionNotes
idStringid

Return type

SentEmailDto

Authorization

API_KEY

HTTP request headers

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

get_sent_email_tracking_pixels

PageTrackingPixelProjection get_sent_email_tracking_pixels(id, opts)

Get all tracking pixels for a sent email in paginated form

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

begin
  #Get all tracking pixels for a sent email in paginated form
  result = api_instance.get_sent_email_tracking_pixels(id, opts)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling SentEmailsControllerApi->get_sent_email_tracking_pixels: #{e}"
end

Parameters

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

Return type

PageTrackingPixelProjection

Authorization

API_KEY

HTTP request headers

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

get_sent_emails

PageSentEmailProjection get_sent_emails(opts)

Get all sent emails in paginated form

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::SentEmailsControllerApi.new
opts = {
  inbox_id: 'inbox_id_example', # String | Optional inboxId to filter sender of sent emails by
  page: 0, # Integer | Optional page  in inbox sent email list pagination
  search_filter: 'search_filter_example', # String | Optional search filter
  size: 20, # Integer | Optional page size in inbox sent email list pagination
  sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
}

begin
  #Get all sent emails in paginated form
  result = api_instance.get_sent_emails(opts)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling SentEmailsControllerApi->get_sent_emails: #{e}"
end

Parameters

NameTypeDescriptionNotes
inbox_idStringOptional inboxId to filter sender of sent emails by[optional]
pageIntegerOptional page in inbox sent email list pagination[optional] [default to 0]
search_filterStringOptional search filter[optional]
sizeIntegerOptional page size in inbox sent email list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageSentEmailProjection

Authorization

API_KEY

HTTP request headers

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

get_sent_organization_emails

PageSentEmailProjection get_sent_organization_emails(opts)

Get all sent organization emails in paginated form

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::SentEmailsControllerApi.new
opts = {
  inbox_id: 'inbox_id_example', # String | Optional inboxId to filter sender of sent emails by
  page: 0, # Integer | Optional page  in sent email list pagination
  search_filter: 'search_filter_example', # String | Optional search filter
  size: 20, # Integer | Optional page size in sent email list pagination
  sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
}

begin
  #Get all sent organization emails in paginated form
  result = api_instance.get_sent_organization_emails(opts)
  p result
rescue MailSlurpClient::ApiError => e
  puts "Exception when calling SentEmailsControllerApi->get_sent_organization_emails: #{e}"
end

Parameters

NameTypeDescriptionNotes
inbox_idStringOptional inboxId to filter sender of sent emails by[optional]
pageIntegerOptional page in sent email list pagination[optional] [default to 0]
search_filterStringOptional search filter[optional]
sizeIntegerOptional page size in sent email list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageSentEmailProjection

Authorization

API_KEY

HTTP request headers

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