MailSlurpClient::EmailControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
apply_imap_flag_operation | POST /emails/{emailId}/imap-flag-operation | Set IMAP flags associated with a message. Only supports 'Seen' flag. |
delete_all_emails | DELETE /emails | Delete all emails in all inboxes. |
delete_email | DELETE /emails/{emailId} | Delete an email |
download_attachment | GET /emails/{emailId}/attachments/{attachmentId} | Get email attachment bytes. Returned as octet-stream with content type header. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints and convert the base 64 encoded content to a file or string. |
download_attachment_base64 | GET /emails/{emailId}/attachments/{attachmentId}/base64 | Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents as a utf-8 encoded string or array of bytes depending on the contentType . |
download_body | GET /emails/{emailId}/body | Get email body as string. Returned as plain/text with content type header. |
download_body_bytes | GET /emails/{emailId}/body-bytes | Get email body in bytes. Returned as octet-stream with content type header. |
forward_email | POST /emails/{emailId}/forward | Forward email to recipients |
get_attachment_meta_data | GET /emails/{emailId}/attachments/{attachmentId}/metadata | Get email attachment metadata. This is the contentType and contentLength of an attachment. To get the individual attachments use the downloadAttachment methods. |
get_email | GET /emails/{emailId} | Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController. |
get_email_attachments | GET /emails/{emailId}/attachments | Get all email attachment metadata. Metadata includes name and size of attachments. |
get_email_content_match | POST /emails/{emailId}/contentMatch | Get email content regex pattern match results. Runs regex against email body and returns match groups. |
get_email_count | GET /emails/emails/count | Get email count |
get_email_html | GET /emails/{emailId}/html | Get email content as HTML. For displaying emails in browser context. |
get_email_html_query | GET /emails/{emailId}/htmlQuery | Parse and return text from an email, stripping HTML and decoding encoded characters |
get_email_links | GET /emails/{emailId}/links | Parse and return list of links found in an email (only works for HTML content) |
get_email_preview_ur_ls | GET /emails/{emailId}/urls | Get email URLs for viewing in browser or downloading |
get_email_text_lines | GET /emails/{emailId}/textLines | Parse and return text from an email, stripping HTML and decoding encoded characters |
get_emails_paginated | GET /emails | Get all emails in all inboxes in paginated form. Email API list all. |
get_gravatar_url_for_email_address | GET /emails/gravatarFor | |
get_latest_email | GET /emails/latest | Get latest email in all inboxes. Most recently received. |
get_latest_email_in_inbox1 | GET /emails/latestIn | Get latest email in an inbox. Use WaitForController to get emails that may not have arrived yet. |
get_organization_emails_paginated | GET /emails/organization | Get all organization emails. List team or shared test email accounts |
get_raw_email_contents | GET /emails/{emailId}/raw | Get raw email string. Returns unparsed raw SMTP message with headers and body. |
get_raw_email_json | GET /emails/{emailId}/raw/json | Get raw email in JSON. Unparsed SMTP message in JSON wrapper format. |
get_unread_email_count | GET /emails/unreadCount | Get unread email count |
mark_as_read | PATCH /emails/{emailId}/read | Mark an email as read on unread |
reply_to_email | PUT /emails/{emailId} | Reply to an email |
send_email_source_optional | POST /emails | Send email |
validate_email | POST /emails/{emailId}/validate | Validate email HTML contents |
apply_imap_flag_operation
EmailPreview apply_imap_flag_operation(email_id, imap_flag_operation_options)
Set IMAP flags associated with a message. Only supports 'Seen' flag.
Apply RFC3501 section-2.3.2 IMAP flag operations on an 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::EmailControllerApi.new
email_id = 'email_id_example' # String |
imap_flag_operation_options = MailSlurpClient::ImapFlagOperationOptions.new # ImapFlagOperationOptions |
begin
#Set IMAP flags associated with a message. Only supports 'Seen' flag.
result = api_instance.apply_imap_flag_operation(email_id, imap_flag_operation_options)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->apply_imap_flag_operation: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ||
imap_flag_operation_options | ImapFlagOperationOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
delete_all_emails
delete_all_emails
Delete all emails in all inboxes.
Deletes all emails in your account. Be careful as emails cannot be recovered
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::EmailControllerApi.new
begin
#Delete all emails in all inboxes.
api_instance.delete_all_emails
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->delete_all_emails: #{e}"
end
Parameters
This endpoint does not need any parameter.
Return type
nil (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
delete_email
delete_email(email_id)
Delete an email
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email to delete
begin
#Delete an email
api_instance.delete_email(email_id)
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->delete_email: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email to delete |
Return type
nil (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
download_attachment
String download_attachment(email_id, attachment_id, opts)
Get email attachment bytes. Returned as octet-stream
with content type header. If you have trouble with byte responses try the downloadAttachmentBase64
response endpoints and convert the base 64 encoded content to a file or string.
Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
attachment_id = 'attachment_id_example' # String | ID of attachment
opts = {
api_key: 'api_key_example' # String | Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly.
}
begin
#Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
result = api_instance.download_attachment(email_id, attachment_id, opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->download_attachment: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email | |
attachment_id | String | ID of attachment | |
api_key | String | Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. | [optional] |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/octet-stream
download_attachment_base64
DownloadAttachmentDto download_attachment_base64(email_id, attachment_id)
Get email attachment as base64 encoded string as an alternative to binary responses. Decode the base64FileContents
as a utf-8
encoded string or array of bytes depending on the contentType
.
Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment
method but allows some clients to get around issues with binary responses.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
attachment_id = 'attachment_id_example' # String | ID of attachment
begin
#Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
result = api_instance.download_attachment_base64(email_id, attachment_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->download_attachment_base64: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email | |
attachment_id | String | ID of attachment |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
download_body
String download_body(email_id)
Get email body as string. Returned as plain/text
with content type header.
Returns the specified email body for a given email as a string
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
begin
#Get email body as string. Returned as `plain/text` with content type header.
result = api_instance.download_body(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->download_body: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain, text/html
download_body_bytes
String download_body_bytes(email_id)
Get email body in bytes. Returned as octet-stream
with content type header.
Returns the specified email body for a given email as a stream / array of bytes.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
begin
#Get email body in bytes. Returned as `octet-stream` with content type header.
result = api_instance.download_body_bytes(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->download_body_bytes: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/octet-stream
forward_email
SentEmailDto forward_email(email_id, forward_email_options)
Forward email to recipients
Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from
option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
forward_email_options = MailSlurpClient::ForwardEmailOptions.new # ForwardEmailOptions |
begin
#Forward email to recipients
result = api_instance.forward_email(email_id, forward_email_options)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->forward_email: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email | |
forward_email_options | ForwardEmailOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
get_attachment_meta_data
AttachmentMetaData get_attachment_meta_data(email_id, attachment_id)
Get email attachment metadata. This is the contentType
and contentLength
of an attachment. To get the individual attachments use the downloadAttachment
methods.
Returns the metadata such as name and content-type for a given attachment and 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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
attachment_id = 'attachment_id_example' # String | ID of attachment
begin
#Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
result = api_instance.get_attachment_meta_data(email_id, attachment_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_attachment_meta_data: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email | |
attachment_id | String | ID of attachment |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_email
Email get_email(email_id, opts)
Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
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::EmailControllerApi.new
email_id = 'email_id_example' # String |
opts = {
decode: false # Boolean | Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing
}
begin
#Get email content including headers and body. Expects email to exist by ID. For emails that may not have arrived yet use the WaitForController.
result = api_instance.get_email(email_id, opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ||
decode | Boolean | Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance =D7 ). This can be a pain for testing | [optional] [default to false] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_email_attachments
Array
get_email_attachments(email_id)
Get all email attachment metadata. Metadata includes name and size of attachments.
Returns an array of attachment metadata such as name and content-type for a given email if present.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
begin
#Get all email attachment metadata. Metadata includes name and size of attachments.
result = api_instance.get_email_attachments(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_attachments: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_email_content_match
EmailContentMatchResult get_email_content_match(email_id, content_match_options)
Get email content regex pattern match results. Runs regex against email body and returns match groups.
Return the matches for a given Java style regex pattern. Do not include the typical /
at start or end of regex in some languages. Given an example your code is: 12345
the pattern to extract match looks like code is: (d{6})
. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456']
See https://docs.oracle.com/javase/8/docs/api/java/util/regex/ for more information of available patterns.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email to match against
content_match_options = MailSlurpClient::ContentMatchOptions.new # ContentMatchOptions |
begin
#Get email content regex pattern match results. Runs regex against email body and returns match groups.
result = api_instance.get_email_content_match(email_id, content_match_options)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_content_match: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email to match against | |
content_match_options | ContentMatchOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
get_email_count
CountDto get_email_count
Get email count
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::EmailControllerApi.new
begin
#Get email count
result = api_instance.get_email_count
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_count: #{e}"
end
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_email_html
String get_email_html(email_id, opts)
Get email content as HTML. For displaying emails in browser context.
Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: ?apiKey=xxx
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::EmailControllerApi.new
email_id = 'email_id_example' # String |
opts = {
decode: false # Boolean |
}
begin
#Get email content as HTML. For displaying emails in browser context.
result = api_instance.get_email_html(email_id, opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_html: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ||
decode | Boolean | [optional] [default to false] |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/html
get_email_html_query
EmailTextLinesResult get_email_html_query(email_id, html_selector)
Parse and return text from an email, stripping HTML and decoding encoded characters
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email to perform HTML query on
html_selector = 'html_selector_example' # String | HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/ for more information.
begin
#Parse and return text from an email, stripping HTML and decoding encoded characters
result = api_instance.get_email_html_query(email_id, html_selector)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_html_query: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email to perform HTML query on | |
html_selector | String | HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/ for more information. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_email_links
EmailLinksResult get_email_links(email_id)
Parse and return list of links found in an email (only works for HTML content)
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email to fetch text for
begin
#Parse and return list of links found in an email (only works for HTML content)
result = api_instance.get_email_links(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_links: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email to fetch text for |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_email_preview_ur_ls
EmailPreviewUrls get_email_preview_ur_ls(email_id)
Get email URLs for viewing in browser or downloading
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
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::EmailControllerApi.new
email_id = 'email_id_example' # String |
begin
#Get email URLs for viewing in browser or downloading
result = api_instance.get_email_preview_ur_ls(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_preview_ur_ls: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_email_text_lines
EmailTextLinesResult get_email_text_lines(email_id, opts)
Parse and return text from an email, stripping HTML and decoding encoded characters
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email to fetch text for
opts = {
decode_html_entities: true, # Boolean | Decode HTML entities
line_separator: 'line_separator_example' # String | Line separator character
}
begin
#Parse and return text from an email, stripping HTML and decoding encoded characters
result = api_instance.get_email_text_lines(email_id, opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_email_text_lines: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email to fetch text for | |
decode_html_entities | Boolean | Decode HTML entities | [optional] |
line_separator | String | Line separator character | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_emails_paginated
PageEmailProjection get_emails_paginated(opts)
Get all emails in all inboxes in paginated form. Email API list all.
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
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::EmailControllerApi.new
opts = {
inbox_id: ['inbox_id_example'], # Array<String> | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
page: 0, # Integer | Optional page in email list pagination
size: 20, # Integer | Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results
sort: 'ASC', # String | Optional createdAt sort direction ASC or DESC
unread_only: false, # Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
search_filter: 'search_filter_example', # String | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Optional filter emails received after given date time
before: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Optional filter emails received before given date time
}
begin
#Get all emails in all inboxes in paginated form. Email API list all.
result = api_instance.get_emails_paginated(opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_emails_paginated: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inbox_id | Array | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] |
page | Integer | Optional page in email list pagination | [optional] [default to 0] |
size | Integer | Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
unread_only | Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly | [optional] [default to false] |
search_filter | String | Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body | [optional] |
since | DateTime | Optional filter emails received after given date time | [optional] |
before | DateTime | Optional filter emails received before given date time | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_gravatar_url_for_email_address
GravatarUrl get_gravatar_url_for_email_address(email_address, opts)
Get gravatar url for email address
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::EmailControllerApi.new
email_address = 'email_address_example' # String |
opts = {
size: 'size_example' # String |
}
begin
result = api_instance.get_gravatar_url_for_email_address(email_address, opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_gravatar_url_for_email_address: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_address | String | ||
size | String | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_latest_email
Email get_latest_email(opts)
Get latest email in all inboxes. Most recently received.
Get the newest email in all inboxes or in a passed set of inbox IDs
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::EmailControllerApi.new
opts = {
inbox_ids: ['inbox_ids_example'] # Array<String> | Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes
}
begin
#Get latest email in all inboxes. Most recently received.
result = api_instance.get_latest_email(opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_latest_email: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inbox_ids | Array | Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_latest_email_in_inbox1
Email get_latest_email_in_inbox1(inbox_id)
Get latest email in an inbox. Use WaitForController
to get emails that may not have arrived yet.
Get the newest email in all inboxes or in a passed set of inbox IDs
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::EmailControllerApi.new
inbox_id = 'inbox_id_example' # String | ID of the inbox you want to get the latest email from
begin
#Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
result = api_instance.get_latest_email_in_inbox1(inbox_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_latest_email_in_inbox1: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inbox_id | String | ID of the inbox you want to get the latest email from |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_organization_emails_paginated
PageEmailProjection get_organization_emails_paginated(opts)
Get all organization emails. List team or shared test email accounts
By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
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::EmailControllerApi.new
opts = {
inbox_id: ['inbox_id_example'], # Array<String> | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
page: 0, # Integer | Optional page in email list pagination
size: 20, # Integer | Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results
sort: 'ASC', # String | Optional createdAt sort direction ASC or DESC
unread_only: false, # Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
search_filter: 'search_filter_example', # String | Optional search filter search filter for emails.
since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Optional filter emails received after given date time
before: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Optional filter emails received before given date time
}
begin
#Get all organization emails. List team or shared test email accounts
result = api_instance.get_organization_emails_paginated(opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_organization_emails_paginated: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inbox_id | Array | Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. | [optional] |
page | Integer | Optional page in email list pagination | [optional] [default to 0] |
size | Integer | Optional page size in email list pagination. Maximum size is 100. Use page and sort to page through larger results | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
unread_only | Boolean | Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly | [optional] [default to false] |
search_filter | String | Optional search filter search filter for emails. | [optional] |
since | DateTime | Optional filter emails received after given date time | [optional] |
before | DateTime | Optional filter emails received before given date time | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_raw_email_contents
String get_raw_email_contents(email_id)
Get raw email string. Returns unparsed raw SMTP message with headers and body.
Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
begin
#Get raw email string. Returns unparsed raw SMTP message with headers and body.
result = api_instance.get_raw_email_contents(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_raw_email_contents: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
get_raw_email_json
RawEmailJson get_raw_email_json(email_id)
Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
begin
#Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
result = api_instance.get_raw_email_json(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_raw_email_json: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
get_unread_email_count
UnreadCount get_unread_email_count
Get unread email count
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
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::EmailControllerApi.new
begin
#Get unread email count
result = api_instance.get_unread_email_count
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->get_unread_email_count: #{e}"
end
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
mark_as_read
EmailPreview mark_as_read(email_id, opts)
Mark an email as read on unread
Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread
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::EmailControllerApi.new
email_id = 'email_id_example' # String |
opts = {
read: true # Boolean | What value to assign to email read property. Default true.
}
begin
#Mark an email as read on unread
result = api_instance.mark_as_read(email_id, opts)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->mark_as_read: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ||
read | Boolean | What value to assign to email read property. Default true. | [optional] [default to true] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
reply_to_email
SentEmailDto reply_to_email(email_id, reply_to_email_options)
Reply to an email
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to
, cc
, and bcc
.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of the email that should be replied to
reply_to_email_options = MailSlurpClient::ReplyToEmailOptions.new # ReplyToEmailOptions |
begin
#Reply to an email
result = api_instance.reply_to_email(email_id, reply_to_email_options)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->reply_to_email: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of the email that should be replied to | |
reply_to_email_options | ReplyToEmailOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
send_email_source_optional
send_email_source_optional(inbox_id, send_email_options, opts)
Send email
Alias for InboxController.sendEmail
method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the 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::EmailControllerApi.new
inbox_id = 'inbox_id_example' # String | ID of the inbox you want to send the email from
send_email_options = MailSlurpClient::SendEmailOptions.new # SendEmailOptions |
opts = {
use_domain_pool: true, # Boolean | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
virtual_send: true # Boolean | Optionally create inbox to send from that is a virtual inbox and won't send to external addresses
}
begin
#Send email
api_instance.send_email_source_optional(inbox_id, send_email_options, opts)
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->send_email_source_optional: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inbox_id | String | ID of the inbox you want to send the email from | |
send_email_options | SendEmailOptions | ||
use_domain_pool | Boolean | Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. | [optional] |
virtual_send | Boolean | Optionally create inbox to send from that is a virtual inbox and won't send to external addresses | [optional] |
Return type
nil (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
validate_email
ValidationDto validate_email(email_id)
Validate email HTML contents
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
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::EmailControllerApi.new
email_id = 'email_id_example' # String | ID of email
begin
#Validate email HTML contents
result = api_instance.validate_email(email_id)
p result
rescue MailSlurpClient::ApiError => e
puts "Exception when calling EmailControllerApi->validate_email: #{e}"
end
Parameters
Name | Type | Description | Notes |
---|---|---|---|
email_id | String | ID of email |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /