Class: MailSlurpClient::EmailControllerApi

#apply_imap_flag_operation(email_id, imap_flag_operation_options, opts = {}) ⇒ `EmailPreview`

Set IMAP flags associated with a message. Only supports '\Seen' flag. Apply RFC3501 section-2.3.2 IMAP flag operations on an email

Parameters:

email_id (String)
imap_flag_operation_options (ImapFlagOperationOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(EmailPreview)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 28

def apply_imap_flag_operation(email_id, imap_flag_operation_options, opts = {})
  data, _status_code, _headers = apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts)
  data
end

#apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts = {}) ⇒ `Array<(EmailPreview, Integer, Hash)>`

Set IMAP flags associated with a message. Only supports '\Seen' flag. Apply RFC3501 section-2.3.2 IMAP flag operations on an email

Parameters:

email_id (String)
imap_flag_operation_options (ImapFlagOperationOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(EmailPreview, Integer, Hash)>) —

EmailPreview data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 39

def apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.apply_imap_flag_operation ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.apply_imap_flag_operation"
  end
  # verify the required parameter 'imap_flag_operation_options' is set
  if @api_client.config.client_side_validation && imap_flag_operation_options.nil?
    fail ArgumentError, "Missing the required parameter 'imap_flag_operation_options' when calling EmailControllerApi.apply_imap_flag_operation"
  end
  # resource path
  local_var_path = '/emails/{emailId}/imap-flag-operation'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(imap_flag_operation_options) 

  # return_type
  return_type = opts[:return_type] || 'EmailPreview' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#apply_imap_flag_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#can_send(inbox_id, send_email_options, opts = {}) ⇒ `CanSendEmailResults`

Check if email can be sent and options are valid. Can user send email to given recipient or is the recipient blocked

Parameters:

inbox_id (String) —

ID of the inbox you want to send the email from
send_email_options (SendEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(CanSendEmailResults)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 98

def can_send(inbox_id, send_email_options, opts = {})
  data, _status_code, _headers = can_send_with_http_info(inbox_id, send_email_options, opts)
  data
end

#can_send_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ `Array<(CanSendEmailResults, Integer, Hash)>`

Check if email can be sent and options are valid. Can user send email to given recipient or is the recipient blocked

Parameters:

inbox_id (String) —

ID of the inbox you want to send the email from
send_email_options (SendEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(CanSendEmailResults, Integer, Hash)>) —

CanSendEmailResults data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 109

def can_send_with_http_info(inbox_id, send_email_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.can_send ...'
  end
  # verify the required parameter 'inbox_id' is set
  if @api_client.config.client_side_validation && inbox_id.nil?
    fail ArgumentError, "Missing the required parameter 'inbox_id' when calling EmailControllerApi.can_send"
  end
  # verify the required parameter 'send_email_options' is set
  if @api_client.config.client_side_validation && send_email_options.nil?
    fail ArgumentError, "Missing the required parameter 'send_email_options' when calling EmailControllerApi.can_send"
  end
  # resource path
  local_var_path = '/emails/can-send'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = inbox_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(send_email_options) 

  # return_type
  return_type = opts[:return_type] || 'CanSendEmailResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#can_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_email_body(email_id, opts = {}) ⇒ `CheckEmailBodyResults`

Detect broken links, spelling, and images in email content Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(CheckEmailBodyResults)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 168

def check_email_body(email_id, opts = {})
  data, _status_code, _headers = check_email_body_with_http_info(email_id, opts)
  data
end

#check_email_body_feature_support(email_id, opts = {}) ⇒ `CheckEmailBodyFeatureSupportResults`

Show which mail clients support the HTML and CSS features used in an email body. Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(CheckEmailBodyFeatureSupportResults)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 230

def check_email_body_feature_support(email_id, opts = {})
  data, _status_code, _headers = check_email_body_feature_support_with_http_info(email_id, opts)
  data
end

#check_email_body_feature_support_with_http_info(email_id, opts = {}) ⇒ `Array<(CheckEmailBodyFeatureSupportResults, Integer, Hash)>`

Show which mail clients support the HTML and CSS features used in an email body. Detect HTML and CSS features inside an email body and return a report of email client support across different platforms and versions.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(CheckEmailBodyFeatureSupportResults, Integer, Hash)>) —

CheckEmailBodyFeatureSupportResults data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 240

def check_email_body_feature_support_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.check_email_body_feature_support ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.check_email_body_feature_support"
  end
  # resource path
  local_var_path = '/emails/{emailId}/check-email-body-feature-support'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CheckEmailBodyFeatureSupportResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#check_email_body_feature_support\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_email_body_with_http_info(email_id, opts = {}) ⇒ `Array<(CheckEmailBodyResults, Integer, Hash)>`

Detect broken links, spelling, and images in email content Find dead links, broken images, and spelling mistakes in email body. Will call included links via HTTP so do not invoke if your links are sensitive or stateful. Any resource that returns a 4xx or 5xx response or is not reachable via HEAD or GET HTTP operations will be considered unhealthy.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(CheckEmailBodyResults, Integer, Hash)>) —

CheckEmailBodyResults data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 178

def check_email_body_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.check_email_body ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.check_email_body"
  end
  # resource path
  local_var_path = '/emails/{emailId}/check-email-body'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CheckEmailBodyResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#check_email_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_email_client_support(check_email_client_support_options, opts = {}) ⇒ `CheckEmailClientSupportResults`

Show which email programs and devices support the features used in an email body. Evaluate the features used in an email body and return a report of email client support across different platforms and versions.

Parameters:

check_email_client_support_options (CheckEmailClientSupportOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(CheckEmailClientSupportResults)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 292

def check_email_client_support(check_email_client_support_options, opts = {})
  data, _status_code, _headers = check_email_client_support_with_http_info(check_email_client_support_options, opts)
  data
end

#check_email_client_support_with_http_info(check_email_client_support_options, opts = {}) ⇒ `Array<(CheckEmailClientSupportResults, Integer, Hash)>`

Show which email programs and devices support the features used in an email body. Evaluate the features used in an email body and return a report of email client support across different platforms and versions.

Parameters:

check_email_client_support_options (CheckEmailClientSupportOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(CheckEmailClientSupportResults, Integer, Hash)>) —

CheckEmailClientSupportResults data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 302

def check_email_client_support_with_http_info(check_email_client_support_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.check_email_client_support ...'
  end
  # verify the required parameter 'check_email_client_support_options' is set
  if @api_client.config.client_side_validation && check_email_client_support_options.nil?
    fail ArgumentError, "Missing the required parameter 'check_email_client_support_options' when calling EmailControllerApi.check_email_client_support"
  end
  # resource path
  local_var_path = '/emails/check-email-client-support'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(check_email_client_support_options) 

  # return_type
  return_type = opts[:return_type] || 'CheckEmailClientSupportResults' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#check_email_client_support\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_all_emails(opts = {}) ⇒ `nil`

Delete all emails in all inboxes. Deletes all emails in your account. Be careful as emails cannot be recovered

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 355

def delete_all_emails(opts = {})
  delete_all_emails_with_http_info(opts)
  nil
end

#delete_all_emails_with_http_info(opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

Delete all emails in all inboxes. Deletes all emails in your account. Be careful as emails cannot be recovered

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 364

def delete_all_emails_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.delete_all_emails ...'
  end
  # resource path
  local_var_path = '/emails'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#delete_all_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email(email_id, opts = {}) ⇒ `nil`

Delete an email Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.

Parameters:

email_id (String) —

ID of email to delete
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 410

def delete_email(email_id, opts = {})
  delete_email_with_http_info(email_id, opts)
  nil
end

#delete_email_with_http_info(email_id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

Delete an email Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.

Parameters:

email_id (String) —

ID of email to delete
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 420

def delete_email_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.delete_email ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.delete_email"
  end
  # resource path
  local_var_path = '/emails/{emailId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#delete_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_attachment(email_id, attachment_id, opts = {}) ⇒ `String`

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.

Parameters:

email_id (String) —

ID of email
attachment_id (String) —

ID of attachment
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.

Returns:

(String)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 472

def download_attachment(email_id, attachment_id, opts = {})
  data, _status_code, _headers = download_attachment_with_http_info(email_id, attachment_id, opts)
  data
end

#download_attachment_base64(email_id, attachment_id, opts = {}) ⇒ `DownloadAttachmentDto`

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.

Parameters:

email_id (String) —

ID of email
attachment_id (String) —

ID of attachment
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(DownloadAttachmentDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 542

def download_attachment_base64(email_id, attachment_id, opts = {})
  data, _status_code, _headers = download_attachment_base64_with_http_info(email_id, attachment_id, opts)
  data
end

#download_attachment_base64_with_http_info(email_id, attachment_id, opts = {}) ⇒ `Array<(DownloadAttachmentDto, Integer, Hash)>`

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.

Parameters:

email_id (String) —

ID of email
attachment_id (String) —

ID of attachment
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(DownloadAttachmentDto, Integer, Hash)>) —

DownloadAttachmentDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 553

def download_attachment_base64_with_http_info(email_id, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.download_attachment_base64 ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.download_attachment_base64"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.download_attachment_base64"
  end
  # resource path
  local_var_path = '/emails/{emailId}/attachments/{attachmentId}/base64'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'DownloadAttachmentDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#download_attachment_base64\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_attachment_with_http_info(email_id, attachment_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

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.

Parameters:

email_id (String) —

ID of email
attachment_id (String) —

ID of attachment
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

: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.

Returns:

(Array<(String, Integer, Hash)>) —

String data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 484

def download_attachment_with_http_info(email_id, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.download_attachment ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.download_attachment"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.download_attachment"
  end
  # resource path
  local_var_path = '/emails/{emailId}/attachments/{attachmentId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = opts[:'api_key'] if !opts[:'api_key'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#download_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_body(email_id, opts = {}) ⇒ `String`

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

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(String)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 609

def download_body(email_id, opts = {})
  data, _status_code, _headers = download_body_with_http_info(email_id, opts)
  data
end

#download_body_bytes(email_id, opts = {}) ⇒ `String`

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.

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(String)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 671

def download_body_bytes(email_id, opts = {})
  data, _status_code, _headers = download_body_bytes_with_http_info(email_id, opts)
  data
end

#download_body_bytes_with_http_info(email_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

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.

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(String, Integer, Hash)>) —

String data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 681

def download_body_bytes_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.download_body_bytes ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.download_body_bytes"
  end
  # resource path
  local_var_path = '/emails/{emailId}/body-bytes'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#download_body_bytes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_body_with_http_info(email_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

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

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(String, Integer, Hash)>) —

String data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 619

def download_body_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.download_body ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.download_body"
  end
  # resource path
  local_var_path = '/emails/{emailId}/body'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'text/html'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#download_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#forward_email(email_id, forward_email_options, opts = {}) ⇒ `SentEmailDto`

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.

Parameters:

email_id (String) —

ID of email
forward_email_options (ForwardEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(SentEmailDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 734

def forward_email(email_id, forward_email_options, opts = {})
  data, _status_code, _headers = forward_email_with_http_info(email_id, forward_email_options, opts)
  data
end

#forward_email_with_http_info(email_id, forward_email_options, opts = {}) ⇒ `Array<(SentEmailDto, Integer, Hash)>`

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.

Parameters:

email_id (String) —

ID of email
forward_email_options (ForwardEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(SentEmailDto, Integer, Hash)>) —

SentEmailDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 745

def forward_email_with_http_info(email_id, forward_email_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.forward_email ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.forward_email"
  end
  # verify the required parameter 'forward_email_options' is set
  if @api_client.config.client_side_validation && forward_email_options.nil?
    fail ArgumentError, "Missing the required parameter 'forward_email_options' when calling EmailControllerApi.forward_email"
  end
  # resource path
  local_var_path = '/emails/{emailId}/forward'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(forward_email_options) 

  # return_type
  return_type = opts[:return_type] || 'SentEmailDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#forward_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attachment_meta_data(email_id, attachment_id, opts = {}) ⇒ `AttachmentMetaData`

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.

Parameters:

email_id (String) —

ID of email
attachment_id (String) —

ID of attachment
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(AttachmentMetaData)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 804

def get_attachment_meta_data(email_id, attachment_id, opts = {})
  data, _status_code, _headers = get_attachment_meta_data_with_http_info(email_id, attachment_id, opts)
  data
end

#get_attachment_meta_data_with_http_info(email_id, attachment_id, opts = {}) ⇒ `Array<(AttachmentMetaData, Integer, Hash)>`

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.

Parameters:

email_id (String) —

ID of email
attachment_id (String) —

ID of attachment
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(AttachmentMetaData, Integer, Hash)>) —

AttachmentMetaData data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 815

def get_attachment_meta_data_with_http_info(email_id, attachment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_attachment_meta_data ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_attachment_meta_data"
  end
  # verify the required parameter 'attachment_id' is set
  if @api_client.config.client_side_validation && attachment_id.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_id' when calling EmailControllerApi.get_attachment_meta_data"
  end
  # resource path
  local_var_path = '/emails/{emailId}/attachments/{attachmentId}/metadata'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s)).sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AttachmentMetaData' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_attachment_meta_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email(email_id, opts = {}) ⇒ `Email`

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

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Email)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 871

def get_email(email_id, opts = {})
  data, _status_code, _headers = get_email_with_http_info(email_id, opts)
  data
end

#get_email_attachments(email_id, opts = {}) ⇒ `Array<AttachmentMetaData>`

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.

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<AttachmentMetaData>)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 933

def get_email_attachments(email_id, opts = {})
  data, _status_code, _headers = get_email_attachments_with_http_info(email_id, opts)
  data
end

#get_email_attachments_with_http_info(email_id, opts = {}) ⇒ `Array<(Array<AttachmentMetaData>, Integer, Hash)>`

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.

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(Array<AttachmentMetaData>, Integer, Hash)>) —

Array<AttachmentMetaData> data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 943

def get_email_attachments_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_attachments ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_attachments"
  end
  # resource path
  local_var_path = '/emails/{emailId}/attachments'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<AttachmentMetaData>' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_content_match(email_id, content_match_options, opts = {}) ⇒ `EmailContentMatchResult`

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: (\d6)`. 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 docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

Parameters:

email_id (String) —

ID of email to match against
content_match_options (ContentMatchOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(EmailContentMatchResult)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 996

def get_email_content_match(email_id, content_match_options, opts = {})
  data, _status_code, _headers = get_email_content_match_with_http_info(email_id, content_match_options, opts)
  data
end

#get_email_content_match_with_http_info(email_id, content_match_options, opts = {}) ⇒ `Array<(EmailContentMatchResult, Integer, Hash)>`

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: (\d6)`. 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 docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

Parameters:

email_id (String) —

ID of email to match against
content_match_options (ContentMatchOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(EmailContentMatchResult, Integer, Hash)>) —

EmailContentMatchResult data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1007

def get_email_content_match_with_http_info(email_id, content_match_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_content_match ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_content_match"
  end
  # verify the required parameter 'content_match_options' is set
  if @api_client.config.client_side_validation && content_match_options.nil?
    fail ArgumentError, "Missing the required parameter 'content_match_options' when calling EmailControllerApi.get_email_content_match"
  end
  # resource path
  local_var_path = '/emails/{emailId}/contentMatch'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(content_match_options) 

  # return_type
  return_type = opts[:return_type] || 'EmailContentMatchResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_content_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_content_part(email_id, content_type, opts = {}) ⇒ `EmailContentPartResult`

Get email content part by content type Get email body content parts from a multipart email message for a given content type

Parameters:

email_id (String) —

ID of email to match against
content_type (String) —

Content type
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:strict (Boolean) —

Strict content type match
:index (Integer) —

Index of content type part if multiple

Returns:

(EmailContentPartResult)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1068

def get_email_content_part(email_id, content_type, opts = {})
  data, _status_code, _headers = get_email_content_part_with_http_info(email_id, content_type, opts)
  data
end

#get_email_content_part_content(email_id, content_type, opts = {}) ⇒ `String`

Get email content part by content type raw response Get email body content parts from a multipart email message for a given content type and return as response

Parameters:

email_id (String) —

ID of email to match against
content_type (String) —

Content type
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:strict (Boolean) —

Strict content type match
:index (Integer) —

Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message.

Returns:

(String)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1143

def get_email_content_part_content(email_id, content_type, opts = {})
  data, _status_code, _headers = get_email_content_part_content_with_http_info(email_id, content_type, opts)
  data
end

#get_email_content_part_content_with_http_info(email_id, content_type, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

Get email content part by content type raw response Get email body content parts from a multipart email message for a given content type and return as response

Parameters:

email_id (String) —

ID of email to match against
content_type (String) —

Content type
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:strict (Boolean) —

Strict content type match
:index (Integer) —

Index of content type part if multiple. Starts from 0 and applies to the result list after selecting for your content type. Content type parts are sorted by order found in original MIME message.

Returns:

(Array<(String, Integer, Hash)>) —

String data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1156

def get_email_content_part_content_with_http_info(email_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_content_part_content ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_content_part_content"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling EmailControllerApi.get_email_content_part_content"
  end
  # resource path
  local_var_path = '/emails/{emailId}/contentPart/raw'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'contentType'] = content_type
  query_params[:'strict'] = opts[:'strict'] if !opts[:'strict'].nil?
  query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_content_part_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_content_part_with_http_info(email_id, content_type, opts = {}) ⇒ `Array<(EmailContentPartResult, Integer, Hash)>`

Get email content part by content type Get email body content parts from a multipart email message for a given content type

Parameters:

email_id (String) —

ID of email to match against
content_type (String) —

Content type
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:strict (Boolean) —

Strict content type match
:index (Integer) —

Index of content type part if multiple

Returns:

(Array<(EmailContentPartResult, Integer, Hash)>) —

EmailContentPartResult data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1081

def get_email_content_part_with_http_info(email_id, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_content_part ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_content_part"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling EmailControllerApi.get_email_content_part"
  end
  # resource path
  local_var_path = '/emails/{emailId}/contentPart'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'contentType'] = content_type
  query_params[:'strict'] = opts[:'strict'] if !opts[:'strict'].nil?
  query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8', 'application/xml;charset=UTF-8', 'application/json; charset=UTF-8', 'application/xml; charset=UTF-8'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailContentPartResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_content_part\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_count(opts = {}) ⇒ `CountDto`

Get email count

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (String)

Returns:

(CountDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1214

def get_email_count(opts = {})
  data, _status_code, _headers = get_email_count_with_http_info(opts)
  data
end

#get_email_count_with_http_info(opts = {}) ⇒ `Array<(CountDto, Integer, Hash)>`

Get email count

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (String)

Returns:

(Array<(CountDto, Integer, Hash)>) —

CountDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1223

def get_email_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_count ...'
  end
  # resource path
  local_var_path = '/emails/emails/count'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CountDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_html(email_id, opts = {}) ⇒ `String`

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`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:replace_cid_images (Boolean) — default: default to false

Returns:

(String)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1273

def get_email_html(email_id, opts = {})
  data, _status_code, _headers = get_email_html_with_http_info(email_id, opts)
  data
end

#get_email_html_json(email_id, opts = {}) ⇒ `EmailHtmlDto`

Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:replace_cid_images (Boolean) — default: default to false

Returns:

(EmailHtmlDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1338

def get_email_html_json(email_id, opts = {})
  data, _status_code, _headers = get_email_html_json_with_http_info(email_id, opts)
  data
end

#get_email_html_json_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailHtmlDto, Integer, Hash)>`

Get email content as HTML in JSON wrapper. For fetching entity decoded HTML content Retrieve email content as HTML response. Decodes quoted-printable entities and converts charset to UTF-8. Returns content-type `application/json;charset=utf-8` so you must call expecting that content response not JSON.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:replace_cid_images (Boolean)

Returns:

(Array<(EmailHtmlDto, Integer, Hash)>) —

EmailHtmlDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1349

def get_email_html_json_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html_json ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_html_json"
  end
  # resource path
  local_var_path = '/emails/{emailId}/html/json'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'replaceCidImages'] = opts[:'replace_cid_images'] if !opts[:'replace_cid_images'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailHtmlDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_html_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_html_query(email_id, html_selector, opts = {}) ⇒ `EmailTextLinesResult`

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

Parameters:

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 jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(EmailTextLinesResult)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1403

def get_email_html_query(email_id, html_selector, opts = {})
  data, _status_code, _headers = get_email_html_query_with_http_info(email_id, html_selector, opts)
  data
end

#get_email_html_query_with_http_info(email_id, html_selector, opts = {}) ⇒ `Array<(EmailTextLinesResult, Integer, Hash)>`

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

Parameters:

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 jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(EmailTextLinesResult, Integer, Hash)>) —

EmailTextLinesResult data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1414

def get_email_html_query_with_http_info(email_id, html_selector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html_query ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_html_query"
  end
  # verify the required parameter 'html_selector' is set
  if @api_client.config.client_side_validation && html_selector.nil?
    fail ArgumentError, "Missing the required parameter 'html_selector' when calling EmailControllerApi.get_email_html_query"
  end
  # resource path
  local_var_path = '/emails/{emailId}/htmlQuery'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'htmlSelector'] = html_selector

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailTextLinesResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_html_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_html_with_http_info(email_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

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`. Returns content-type `text/html;charset=utf-8` so you must call expecting that content response not JSON. For JSON response see the `getEmailHTMLJson` method.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:replace_cid_images (Boolean)

Returns:

(Array<(String, Integer, Hash)>) —

String data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1284

def get_email_html_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_html ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_html"
  end
  # resource path
  local_var_path = '/emails/{emailId}/html'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'replaceCidImages'] = opts[:'replace_cid_images'] if !opts[:'replace_cid_images'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/html;charset=utf-8', 'text/html'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_links(email_id, opts = {}) ⇒ `EmailLinksResult`

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

Parameters:

email_id (String) —

ID of email to fetch text for
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:selector (String) —

Optional HTML query selector for links

Returns:

(EmailLinksResult)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1472

def get_email_links(email_id, opts = {})
  data, _status_code, _headers = get_email_links_with_http_info(email_id, opts)
  data
end

#get_email_links_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailLinksResult, Integer, Hash)>`

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

Parameters:

email_id (String) —

ID of email to fetch text for
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:selector (String) —

Optional HTML query selector for links

Returns:

(Array<(EmailLinksResult, Integer, Hash)>) —

EmailLinksResult data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1483

def get_email_links_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_links ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_links"
  end
  # resource path
  local_var_path = '/emails/{emailId}/links'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'selector'] = opts[:'selector'] if !opts[:'selector'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailLinksResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_preview_ur_ls(email_id, opts = {}) ⇒ `EmailPreviewUrls`

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.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(EmailPreviewUrls)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1536

def get_email_preview_ur_ls(email_id, opts = {})
  data, _status_code, _headers = get_email_preview_ur_ls_with_http_info(email_id, opts)
  data
end

#get_email_preview_ur_ls_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailPreviewUrls, Integer, Hash)>`

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.

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(EmailPreviewUrls, Integer, Hash)>) —

EmailPreviewUrls data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1546

def get_email_preview_ur_ls_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_preview_ur_ls ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_preview_ur_ls"
  end
  # resource path
  local_var_path = '/emails/{emailId}/urls'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailPreviewUrls' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_preview_ur_ls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_screenshot_as_base64(email_id, get_email_screenshot_options, opts = {}) ⇒ `EmailScreenshotResult`

Take a screenshot of an email in a browser and return base64 encoded string Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information.

Parameters:

email_id (String)
get_email_screenshot_options (GetEmailScreenshotOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(EmailScreenshotResult)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1599

def get_email_screenshot_as_base64(email_id, get_email_screenshot_options, opts = {})
  data, _status_code, _headers = get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, opts)
  data
end

#get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, opts = {}) ⇒ `Array<(EmailScreenshotResult, Integer, Hash)>`

Take a screenshot of an email in a browser and return base64 encoded string Capture image of email screenshot and return as base64 encoded string. Useful for embedding in HTML. Be careful as this may contain sensitive information.

Parameters:

email_id (String)
get_email_screenshot_options (GetEmailScreenshotOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(EmailScreenshotResult, Integer, Hash)>) —

EmailScreenshotResult data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1610

def get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_screenshot_as_base64 ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_screenshot_as_base64"
  end
  # verify the required parameter 'get_email_screenshot_options' is set
  if @api_client.config.client_side_validation && get_email_screenshot_options.nil?
    fail ArgumentError, "Missing the required parameter 'get_email_screenshot_options' when calling EmailControllerApi.get_email_screenshot_as_base64"
  end
  # resource path
  local_var_path = '/emails/{emailId}/screenshot/base64'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(get_email_screenshot_options) 

  # return_type
  return_type = opts[:return_type] || 'EmailScreenshotResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_screenshot_as_base64\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_screenshot_as_binary(email_id, get_email_screenshot_options, opts = {}) ⇒ `nil`

Take a screenshot of an email in a browser Returns binary octet-stream of screenshot of the given email

Parameters:

email_id (String)
get_email_screenshot_options (GetEmailScreenshotOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1669

def get_email_screenshot_as_binary(email_id, get_email_screenshot_options, opts = {})
  get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, opts)
  nil
end

#get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

Take a screenshot of an email in a browser Returns binary octet-stream of screenshot of the given email

Parameters:

email_id (String)
get_email_screenshot_options (GetEmailScreenshotOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1680

def get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_screenshot_as_binary ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_screenshot_as_binary"
  end
  # verify the required parameter 'get_email_screenshot_options' is set
  if @api_client.config.client_side_validation && get_email_screenshot_options.nil?
    fail ArgumentError, "Missing the required parameter 'get_email_screenshot_options' when calling EmailControllerApi.get_email_screenshot_as_binary"
  end
  # resource path
  local_var_path = '/emails/{emailId}/screenshot/binary'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(get_email_screenshot_options) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_screenshot_as_binary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_summary(email_id, opts = {}) ⇒ `EmailPreview`

Get email data including headers but not 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. To retrieve the body see getEmail and to get raw unparsed email use the getRawEmail endpoints

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:decode (Boolean)

Returns:

(EmailPreview)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1737

def get_email_summary(email_id, opts = {})
  data, _status_code, _headers = get_email_summary_with_http_info(email_id, opts)
  data
end

#get_email_summary_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailPreview, Integer, Hash)>`

Get email data including headers but not 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. To retrieve the body see getEmail and to get raw unparsed email use the getRawEmail endpoints

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:decode (Boolean)

Returns:

(Array<(EmailPreview, Integer, Hash)>) —

EmailPreview data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1748

def get_email_summary_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_summary ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_summary"
  end
  # resource path
  local_var_path = '/emails/{emailId}/summary'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'decode'] = opts[:'decode'] if !opts[:'decode'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailPreview' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_text_lines(email_id, opts = {}) ⇒ `EmailTextLinesResult`

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.

Parameters:

email_id (String) —

ID of email to fetch text for
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:decode_html_entities (Boolean) —

Decode HTML entities
:line_separator (String) —

Line separator character

Returns:

(EmailTextLinesResult)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1803

def get_email_text_lines(email_id, opts = {})
  data, _status_code, _headers = get_email_text_lines_with_http_info(email_id, opts)
  data
end

#get_email_text_lines_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailTextLinesResult, Integer, Hash)>`

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.

Parameters:

email_id (String) —

ID of email to fetch text for
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:decode_html_entities (Boolean) —

Decode HTML entities
:line_separator (String) —

Line separator character

Returns:

(Array<(EmailTextLinesResult, Integer, Hash)>) —

EmailTextLinesResult data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1815

def get_email_text_lines_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_text_lines ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_text_lines"
  end
  # resource path
  local_var_path = '/emails/{emailId}/textLines'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'decodeHtmlEntities'] = opts[:'decode_html_entities'] if !opts[:'decode_html_entities'].nil?
  query_params[:'lineSeparator'] = opts[:'line_separator'] if !opts[:'line_separator'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailTextLinesResult' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_text_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_thread(thread_id, opts = {}) ⇒ `EmailThreadDto`

Return email thread information. Use items endpoints to get messages for thread. Return email message thread summary from Message-ID, In-Reply-To, and References header. Get messages using items endpoint

Parameters:

thread_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(EmailThreadDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1869

def get_email_thread(thread_id, opts = {})
  data, _status_code, _headers = get_email_thread_with_http_info(thread_id, opts)
  data
end

#get_email_thread_items(thread_id, opts = {}) ⇒ `EmailThreadItemsDto`

Return email thread items. Return email thread messages based on Message-ID, In-Reply-To, and References header

Parameters:

thread_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:sort (String) —

Optional createdAt sort direction ASC or DESC (default to 'ASC')

Returns:

(EmailThreadItemsDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1932

def get_email_thread_items(thread_id, opts = {})
  data, _status_code, _headers = get_email_thread_items_with_http_info(thread_id, opts)
  data
end

#get_email_thread_items_with_http_info(thread_id, opts = {}) ⇒ `Array<(EmailThreadItemsDto, Integer, Hash)>`

Return email thread items. Return email thread messages based on Message-ID, In-Reply-To, and References header

Parameters:

thread_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:sort (String) —

Optional createdAt sort direction ASC or DESC

Returns:

(Array<(EmailThreadItemsDto, Integer, Hash)>) —

EmailThreadItemsDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1943

def get_email_thread_items_with_http_info(thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_thread_items ...'
  end
  # verify the required parameter 'thread_id' is set
  if @api_client.config.client_side_validation && thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'thread_id' when calling EmailControllerApi.get_email_thread_items"
  end
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/emails/threads/{threadId}/items'.sub('{' + 'threadId' + '}', CGI.escape(thread_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailThreadItemsDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_thread_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_thread_with_http_info(thread_id, opts = {}) ⇒ `Array<(EmailThreadDto, Integer, Hash)>`

Return email thread information. Use items endpoints to get messages for thread. Return email message thread summary from Message-ID, In-Reply-To, and References header. Get messages using items endpoint

Parameters:

thread_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(EmailThreadDto, Integer, Hash)>) —

EmailThreadDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 1879

def get_email_thread_with_http_info(thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_thread ...'
  end
  # verify the required parameter 'thread_id' is set
  if @api_client.config.client_side_validation && thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'thread_id' when calling EmailControllerApi.get_email_thread"
  end
  # resource path
  local_var_path = '/emails/threads/{threadId}'.sub('{' + 'threadId' + '}', CGI.escape(thread_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailThreadDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_thread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_threads(opts = {}) ⇒ `PageEmailThreadProjection`

Return email threads in paginated form Return email message chains built from Message-ID, In-Reply-To, and References header.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:html_selector (String) —

Optional inbox filter
:page (Integer) —

Optional page index in email thread pagination (default to 0)
:size (Integer) —

Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
:sort (String) —

Optional createdAt sort direction ASC or DESC (default to 'ASC')
:search_filter (String) —

Optional search filter search filter for email threads.
:since (DateTime) —

Optional filter email threads created since time
:before (DateTime) —

Optional filter emails threads created before given date time

Returns:

(PageEmailThreadProjection)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2006

def get_email_threads(opts = {})
  data, _status_code, _headers = get_email_threads_with_http_info(opts)
  data
end

#get_email_threads_with_http_info(opts = {}) ⇒ `Array<(PageEmailThreadProjection, Integer, Hash)>`

Return email threads in paginated form Return email message chains built from Message-ID, In-Reply-To, and References header.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:html_selector (String) —

Optional inbox filter
:page (Integer) —

Optional page index in email thread pagination
:size (Integer) —

Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results
:sort (String) —

Optional createdAt sort direction ASC or DESC
:search_filter (String) —

Optional search filter search filter for email threads.
:since (DateTime) —

Optional filter email threads created since time
:before (DateTime) —

Optional filter emails threads created before given date time

Returns:

(Array<(PageEmailThreadProjection, Integer, Hash)>) —

PageEmailThreadProjection data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2022

def get_email_threads_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_threads ...'
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailControllerApi.get_email_threads, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/emails/threads'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'htmlSelector'] = opts[:'html_selector'] if !opts[:'html_selector'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageEmailThreadProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email_threads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_with_http_info(email_id, opts = {}) ⇒ `Array<(Email, Integer, Hash)>`

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

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(Email, Integer, Hash)>) —

Email data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 881

def get_email_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email"
  end
  # resource path
  local_var_path = '/emails/{emailId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8', 'application/xml;charset=UTF-8', 'application/json; charset=UTF-8', 'application/xml; charset=UTF-8'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Email' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_offset_paginated(opts = {}) ⇒ `PageEmailProjection`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (Array<String>) —

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:page (Integer) —

Optional page index in email list pagination (default to 0)
:size (Integer) —

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
:sort (String) —

Optional createdAt sort direction ASC or DESC (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 (default to false)
:search_filter (String) —

Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:since (DateTime) —

Optional filter emails received after given date time
:before (DateTime) —

Optional filter emails received before given date time
:favourited (Boolean) —

Optional filter emails that are favourited
:sync_connectors (Boolean) —

Sync connectors
:plus_address_id (String) —

Optional plus address ID filter

Returns:

(PageEmailProjection)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2095

def get_emails_offset_paginated(opts = {})
  data, _status_code, _headers = get_emails_offset_paginated_with_http_info(opts)
  data
end

#get_emails_offset_paginated_with_http_info(opts = {}) ⇒ `Array<(PageEmailProjection, Integer, Hash)>`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (Array<String>) —

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:page (Integer) —

Optional page index in email list pagination
:size (Integer) —

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:sort (String) —

Optional createdAt sort direction ASC or DESC
:unread_only (Boolean) —

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:search_filter (String) —

Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:since (DateTime) —

Optional filter emails received after given date time
:before (DateTime) —

Optional filter emails received before given date time
:favourited (Boolean) —

Optional filter emails that are favourited
:sync_connectors (Boolean) —

Sync connectors
:plus_address_id (String) —

Optional plus address ID filter

Returns:

(Array<(PageEmailProjection, Integer, Hash)>) —

PageEmailProjection data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2115

def get_emails_offset_paginated_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_emails_offset_paginated ...'
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailControllerApi.get_emails_offset_paginated, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/emails/offset-paginated'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = @api_client.build_collection_param(opts[:'inbox_id'], :multi) if !opts[:'inbox_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?
  query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
  query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageEmailProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_emails_offset_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_emails_paginated(opts = {}) ⇒ `PageEmailProjection`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (Array<String>) —

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:page (Integer) —

Optional page index in email list pagination (default to 0)
:size (Integer) —

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
:sort (String) —

Optional createdAt sort direction ASC or DESC (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 (default to false)
:search_filter (String) —

Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:since (DateTime) —

Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:before (DateTime) —

Optional filter emails received before given date time
:sync_connectors (Boolean) —

Sync connectors
:plus_address_id (String) —

Optional plus address ID filter
:favourited (Boolean) —

Optional filter emails that are favourited

Returns:

(PageEmailProjection)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2192

def get_emails_paginated(opts = {})
  data, _status_code, _headers = get_emails_paginated_with_http_info(opts)
  data
end

#get_emails_paginated_with_http_info(opts = {}) ⇒ `Array<(PageEmailProjection, Integer, Hash)>`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (Array<String>) —

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:page (Integer) —

Optional page index in email list pagination
:size (Integer) —

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:sort (String) —

Optional createdAt sort direction ASC or DESC
:unread_only (Boolean) —

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:search_filter (String) —

Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body
:since (DateTime) —

Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:before (DateTime) —

Optional filter emails received before given date time
:sync_connectors (Boolean) —

Sync connectors
:plus_address_id (String) —

Optional plus address ID filter
:favourited (Boolean) —

Optional filter emails that are favourited

Returns:

(Array<(PageEmailProjection, Integer, Hash)>) —

PageEmailProjection data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2212

def get_emails_paginated_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_emails_paginated ...'
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailControllerApi.get_emails_paginated, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/emails'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = @api_client.build_collection_param(opts[:'inbox_id'], :multi) if !opts[:'inbox_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
  query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?
  query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageEmailProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_emails_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_gravatar_url_for_email_address(email_address, opts = {}) ⇒ `GravatarUrl`

Get gravatar url for email address

Parameters:

email_address (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:size (String)

Returns:

(GravatarUrl)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2279

def get_gravatar_url_for_email_address(email_address, opts = {})
  data, _status_code, _headers = get_gravatar_url_for_email_address_with_http_info(email_address, opts)
  data
end

#get_gravatar_url_for_email_address_with_http_info(email_address, opts = {}) ⇒ `Array<(GravatarUrl, Integer, Hash)>`

Get gravatar url for email address

Parameters:

email_address (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:size (String)

Returns:

(Array<(GravatarUrl, Integer, Hash)>) —

GravatarUrl data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2289

def get_gravatar_url_for_email_address_with_http_info(email_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_gravatar_url_for_email_address ...'
  end
  # verify the required parameter 'email_address' is set
  if @api_client.config.client_side_validation && email_address.nil?
    fail ArgumentError, "Missing the required parameter 'email_address' when calling EmailControllerApi.get_gravatar_url_for_email_address"
  end
  # resource path
  local_var_path = '/emails/gravatarFor'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'emailAddress'] = email_address
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GravatarUrl' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_gravatar_url_for_email_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_latest_email(opts = {}) ⇒ `Email`

Get latest email in all inboxes. Most recently received. Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_ids (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

Returns:

(Email)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2343

def get_latest_email(opts = {})
  data, _status_code, _headers = get_latest_email_with_http_info(opts)
  data
end

#get_latest_email_in_inbox1(inbox_id, opts = {}) ⇒ `Email`

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

Parameters:

inbox_id (String) —

ID of the inbox you want to get the latest email from
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Email)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2402

def get_latest_email_in_inbox1(inbox_id, opts = {})
  data, _status_code, _headers = get_latest_email_in_inbox1_with_http_info(inbox_id, opts)
  data
end

#get_latest_email_in_inbox1_with_http_info(inbox_id, opts = {}) ⇒ `Array<(Email, Integer, Hash)>`

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

Parameters:

inbox_id (String) —

ID of the inbox you want to get the latest email from
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(Email, Integer, Hash)>) —

Email data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2412

def get_latest_email_in_inbox1_with_http_info(inbox_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_latest_email_in_inbox1 ...'
  end
  # verify the required parameter 'inbox_id' is set
  if @api_client.config.client_side_validation && inbox_id.nil?
    fail ArgumentError, "Missing the required parameter 'inbox_id' when calling EmailControllerApi.get_latest_email_in_inbox1"
  end
  # resource path
  local_var_path = '/emails/latestIn'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = inbox_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Email' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_latest_email_in_inbox1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_latest_email_with_http_info(opts = {}) ⇒ `Array<(Email, Integer, Hash)>`

Get latest email in all inboxes. Most recently received. Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_ids (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

Returns:

(Array<(Email, Integer, Hash)>) —

Email data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2353

def get_latest_email_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_latest_email ...'
  end
  # resource path
  local_var_path = '/emails/latest'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxIds'] = @api_client.build_collection_param(opts[:'inbox_ids'], :multi) if !opts[:'inbox_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Email' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_latest_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organization_emails_paginated(opts = {}) ⇒ `PageEmailProjection`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (Array<String>) —

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:page (Integer) —

Optional page index in email list pagination (default to 0)
:size (Integer) —

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
:sort (String) —

Optional createdAt sort direction ASC or DESC (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 (default to false)
:search_filter (String) —

Optional search filter search filter for emails.
:since (DateTime) —

Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:before (DateTime) —

Optional filter emails received before given date time
:sync_connectors (Boolean) —

Sync connectors
:favourited (Boolean) —

Search only favorited emails
:plus_address_id (String) —

Optional plus address ID filter

Returns:

(PageEmailProjection)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2475

def get_organization_emails_paginated(opts = {})
  data, _status_code, _headers = get_organization_emails_paginated_with_http_info(opts)
  data
end

#get_organization_emails_paginated_with_http_info(opts = {}) ⇒ `Array<(PageEmailProjection, Integer, Hash)>`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (Array<String>) —

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
:page (Integer) —

Optional page index in email list pagination
:size (Integer) —

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
:sort (String) —

Optional createdAt sort direction ASC or DESC
:unread_only (Boolean) —

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
:search_filter (String) —

Optional search filter search filter for emails.
:since (DateTime) —

Optional filter emails received after given date time. If unset will use time 24hours prior to now.
:before (DateTime) —

Optional filter emails received before given date time
:sync_connectors (Boolean) —

Sync connectors
:favourited (Boolean) —

Search only favorited emails
:plus_address_id (String) —

Optional plus address ID filter

Returns:

(Array<(PageEmailProjection, Integer, Hash)>) —

PageEmailProjection data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2495

def get_organization_emails_paginated_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_organization_emails_paginated ...'
  end
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"size"]" when calling EmailControllerApi.get_organization_emails_paginated, must be smaller than or equal to 100.'
  end

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/emails/organization'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = @api_client.build_collection_param(opts[:'inbox_id'], :multi) if !opts[:'inbox_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
  query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?
  query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageEmailProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_organization_emails_paginated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_raw_email_contents(email_id, opts = {}) ⇒ `nil`

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

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2562

def get_raw_email_contents(email_id, opts = {})
  get_raw_email_contents_with_http_info(email_id, opts)
  nil
end

#get_raw_email_contents_with_http_info(email_id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2572

def get_raw_email_contents_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_raw_email_contents ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_raw_email_contents"
  end
  # resource path
  local_var_path = '/emails/{emailId}/raw'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_raw_email_contents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_raw_email_json(email_id, opts = {}) ⇒ `RawEmailJson`

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

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(RawEmailJson)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2622

def get_raw_email_json(email_id, opts = {})
  data, _status_code, _headers = get_raw_email_json_with_http_info(email_id, opts)
  data
end

#get_raw_email_json_with_http_info(email_id, opts = {}) ⇒ `Array<(RawEmailJson, Integer, Hash)>`

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

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(RawEmailJson, Integer, Hash)>) —

RawEmailJson data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2632

def get_raw_email_json_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_raw_email_json ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_raw_email_json"
  end
  # resource path
  local_var_path = '/emails/{emailId}/raw/json'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'RawEmailJson' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_raw_email_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unread_email_count(opts = {}) ⇒ `UnreadCount`

Get unread email count Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (String) —

Optional inbox ID filter

Returns:

(UnreadCount)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2684

def get_unread_email_count(opts = {})
  data, _status_code, _headers = get_unread_email_count_with_http_info(opts)
  data
end

#get_unread_email_count_with_http_info(opts = {}) ⇒ `Array<(UnreadCount, Integer, Hash)>`

Get unread email count Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (String) —

Optional inbox ID filter

Returns:

(Array<(UnreadCount, Integer, Hash)>) —

UnreadCount data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2694

def get_unread_email_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_unread_email_count ...'
  end
  # resource path
  local_var_path = '/emails/unreadCount'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'UnreadCount' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#get_unread_email_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mark_all_as_read(opts = {}) ⇒ `nil`

Mark all emails as read or unread Marks all emails 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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:read (Boolean) —

What value to assign to email read property. Default true. (default to true)
:inbox_id (String) —

Optional inbox ID filter

Returns:

(nil)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2744

def mark_all_as_read(opts = {})
  mark_all_as_read_with_http_info(opts)
  nil
end

#mark_all_as_read_with_http_info(opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

Mark all emails as read or unread Marks all emails 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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:read (Boolean) —

What value to assign to email read property. Default true.
:inbox_id (String) —

Optional inbox ID filter

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2755

def mark_all_as_read_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.mark_all_as_read ...'
  end
  # resource path
  local_var_path = '/emails/read'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'read'] = opts[:'read'] if !opts[:'read'].nil?
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#mark_all_as_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mark_as_read(email_id, opts = {}) ⇒ `EmailPreview`

Mark an email as read or 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

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:read (Boolean) —

What value to assign to email read property. Default true. (default to true)

Returns:

(EmailPreview)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2804

def mark_as_read(email_id, opts = {})
  data, _status_code, _headers = mark_as_read_with_http_info(email_id, opts)
  data
end

#mark_as_read_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailPreview, Integer, Hash)>`

Mark an email as read or 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

Parameters:

email_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:read (Boolean) —

What value to assign to email read property. Default true.

Returns:

(Array<(EmailPreview, Integer, Hash)>) —

EmailPreview data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2815

def mark_as_read_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.mark_as_read ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.mark_as_read"
  end
  # resource path
  local_var_path = '/emails/{emailId}/read'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'read'] = opts[:'read'] if !opts[:'read'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'EmailPreview' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#mark_as_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reply_to_email(email_id, reply_to_email_options, opts = {}) ⇒ `SentEmailDto`

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`.

Parameters:

email_id (String) —

ID of the email that should be replied to
reply_to_email_options (ReplyToEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(SentEmailDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2869

def reply_to_email(email_id, reply_to_email_options, opts = {})
  data, _status_code, _headers = reply_to_email_with_http_info(email_id, reply_to_email_options, opts)
  data
end

#reply_to_email_with_http_info(email_id, reply_to_email_options, opts = {}) ⇒ `Array<(SentEmailDto, Integer, Hash)>`

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`.

Parameters:

email_id (String) —

ID of the email that should be replied to
reply_to_email_options (ReplyToEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(SentEmailDto, Integer, Hash)>) —

SentEmailDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2880

def reply_to_email_with_http_info(email_id, reply_to_email_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.reply_to_email ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.reply_to_email"
  end
  # verify the required parameter 'reply_to_email_options' is set
  if @api_client.config.client_side_validation && reply_to_email_options.nil?
    fail ArgumentError, "Missing the required parameter 'reply_to_email_options' when calling EmailControllerApi.reply_to_email"
  end
  # resource path
  local_var_path = '/emails/{emailId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(reply_to_email_options) 

  # return_type
  return_type = opts[:return_type] || 'SentEmailDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#reply_to_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_emails(search_emails_options, opts = {}) ⇒ `PageEmailProjection`

Get all emails by search criteria. Return in paginated form. Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body

Parameters:

search_emails_options (SearchEmailsOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:sync_connectors (Boolean) —

Sync connectors
:favourited (Boolean) —

Search only favourited emails
:plus_address_id (String) —

Optional plus address ID filter

Returns:

(PageEmailProjection)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2941

def search_emails(search_emails_options, opts = {})
  data, _status_code, _headers = search_emails_with_http_info(search_emails_options, opts)
  data
end

#search_emails_with_http_info(search_emails_options, opts = {}) ⇒ `Array<(PageEmailProjection, Integer, Hash)>`

Get all emails by search criteria. Return in paginated form. Search emails by given criteria return matches in paginated format. Searches against email recipients, sender, subject, email address and ID. Does not search email body

Parameters:

search_emails_options (SearchEmailsOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:sync_connectors (Boolean) —

Sync connectors
:favourited (Boolean) —

Search only favourited emails
:plus_address_id (String) —

Optional plus address ID filter

Returns:

(Array<(PageEmailProjection, Integer, Hash)>) —

PageEmailProjection data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 2954

def search_emails_with_http_info(search_emails_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.search_emails ...'
  end
  # verify the required parameter 'search_emails_options' is set
  if @api_client.config.client_side_validation && search_emails_options.nil?
    fail ArgumentError, "Missing the required parameter 'search_emails_options' when calling EmailControllerApi.search_emails"
  end
  # resource path
  local_var_path = '/emails/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'syncConnectors'] = opts[:'sync_connectors'] if !opts[:'sync_connectors'].nil?
  query_params[:'favourited'] = opts[:'favourited'] if !opts[:'favourited'].nil?
  query_params[:'plusAddressId'] = opts[:'plus_address_id'] if !opts[:'plus_address_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(search_emails_options) 

  # return_type
  return_type = opts[:return_type] || 'PageEmailProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#search_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_email_source_optional(send_email_options, opts = {}) ⇒ `nil`

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.

Parameters:

send_email_options (SendEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (String) —

ID of the inbox you want to send the email from
:use_domain_pool (Boolean) —

Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
:virtual_send (Boolean) —

Optionally create inbox to send from that is a virtual inbox and won't send to external addresses

Returns:

(nil)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 3014

def send_email_source_optional(send_email_options, opts = {})
  send_email_source_optional_with_http_info(send_email_options, opts)
  nil
end

#send_email_source_optional_with_http_info(send_email_options, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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.

Parameters:

send_email_options (SendEmailOptions)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:inbox_id (String) —

ID of the inbox you want to send the email from
:use_domain_pool (Boolean) —

Use domain pool. Optionally create inbox to send from using the mailslurp domain pool.
:virtual_send (Boolean) —

Optionally create inbox to send from that is a virtual inbox and won't send to external addresses

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 3027

def send_email_source_optional_with_http_info(send_email_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.send_email_source_optional ...'
  end
  # verify the required parameter 'send_email_options' is set
  if @api_client.config.client_side_validation && send_email_options.nil?
    fail ArgumentError, "Missing the required parameter 'send_email_options' when calling EmailControllerApi.send_email_source_optional"
  end
  # resource path
  local_var_path = '/emails'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
  query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
  query_params[:'virtualSend'] = opts[:'virtual_send'] if !opts[:'virtual_send'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(send_email_options) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#send_email_source_optional\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_email_favourited(email_id, favourited, opts = {}) ⇒ `nil`

Set email favourited state Set and return new favorite state for an email

Parameters:

email_id (String) —

ID of email to set favourite state
favourited (Boolean)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 3083

def set_email_favourited(email_id, favourited, opts = {})
  set_email_favourited_with_http_info(email_id, favourited, opts)
  nil
end

#set_email_favourited_with_http_info(email_id, favourited, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

Set email favourited state Set and return new favorite state for an email

Parameters:

email_id (String) —

ID of email to set favourite state
favourited (Boolean)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 3094

def set_email_favourited_with_http_info(email_id, favourited, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.set_email_favourited ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.set_email_favourited"
  end
  # verify the required parameter 'favourited' is set
  if @api_client.config.client_side_validation && favourited.nil?
    fail ArgumentError, "Missing the required parameter 'favourited' when calling EmailControllerApi.set_email_favourited"
  end
  # resource path
  local_var_path = '/emails/{emailId}/favourite'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'favourited'] = favourited

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#set_email_favourited\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_email(email_id, opts = {}) ⇒ `ValidationDto`

Validate email HTML contents Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ValidationDto)

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 3149

def validate_email(email_id, opts = {})
  data, _status_code, _headers = validate_email_with_http_info(email_id, opts)
  data
end

#validate_email_with_http_info(email_id, opts = {}) ⇒ `Array<(ValidationDto, Integer, Hash)>`

Validate email HTML contents Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.

Parameters:

email_id (String) —

ID of email
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ValidationDto, Integer, Hash)>) —

ValidationDto data, response status code and response headers

# File 'lib/mailslurp_client/api/email_controller_api.rb', line 3159

def validate_email_with_http_info(email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailControllerApi.validate_email ...'
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.validate_email"
  end
  # resource path
  local_var_path = '/emails/{emailId}/validate'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ValidationDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailControllerApi#validate_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailControllerApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#apply_imap_flag_operation(email_id, imap_flag_operation_options, opts = {}) ⇒ EmailPreview

#apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts = {}) ⇒ Array<(EmailPreview, Integer, Hash)>

#can_send(inbox_id, send_email_options, opts = {}) ⇒ CanSendEmailResults

#can_send_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ Array<(CanSendEmailResults, Integer, Hash)>

#check_email_body(email_id, opts = {}) ⇒ CheckEmailBodyResults

#check_email_body_feature_support(email_id, opts = {}) ⇒ CheckEmailBodyFeatureSupportResults

#check_email_body_feature_support_with_http_info(email_id, opts = {}) ⇒ Array<(CheckEmailBodyFeatureSupportResults, Integer, Hash)>

#check_email_body_with_http_info(email_id, opts = {}) ⇒ Array<(CheckEmailBodyResults, Integer, Hash)>

#check_email_client_support(check_email_client_support_options, opts = {}) ⇒ CheckEmailClientSupportResults

#check_email_client_support_with_http_info(check_email_client_support_options, opts = {}) ⇒ Array<(CheckEmailClientSupportResults, Integer, Hash)>

#delete_all_emails(opts = {}) ⇒ nil

#delete_all_emails_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

#delete_email(email_id, opts = {}) ⇒ nil

#delete_email_with_http_info(email_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#download_attachment(email_id, attachment_id, opts = {}) ⇒ String

#download_attachment_base64(email_id, attachment_id, opts = {}) ⇒ DownloadAttachmentDto

#download_attachment_base64_with_http_info(email_id, attachment_id, opts = {}) ⇒ Array<(DownloadAttachmentDto, Integer, Hash)>

#download_attachment_with_http_info(email_id, attachment_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

#download_body(email_id, opts = {}) ⇒ String

#download_body_bytes(email_id, opts = {}) ⇒ String

#download_body_bytes_with_http_info(email_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

#download_body_with_http_info(email_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

#forward_email(email_id, forward_email_options, opts = {}) ⇒ SentEmailDto

#forward_email_with_http_info(email_id, forward_email_options, opts = {}) ⇒ Array<(SentEmailDto, Integer, Hash)>

#get_attachment_meta_data(email_id, attachment_id, opts = {}) ⇒ AttachmentMetaData

#get_attachment_meta_data_with_http_info(email_id, attachment_id, opts = {}) ⇒ Array<(AttachmentMetaData, Integer, Hash)>

#get_email(email_id, opts = {}) ⇒ Email

#get_email_attachments(email_id, opts = {}) ⇒ Array<AttachmentMetaData>

#get_email_attachments_with_http_info(email_id, opts = {}) ⇒ Array<(Array<AttachmentMetaData>, Integer, Hash)>

#get_email_content_match(email_id, content_match_options, opts = {}) ⇒ EmailContentMatchResult

#get_email_content_match_with_http_info(email_id, content_match_options, opts = {}) ⇒ Array<(EmailContentMatchResult, Integer, Hash)>

#get_email_content_part(email_id, content_type, opts = {}) ⇒ EmailContentPartResult

#get_email_content_part_content(email_id, content_type, opts = {}) ⇒ String

#get_email_content_part_content_with_http_info(email_id, content_type, opts = {}) ⇒ Array<(String, Integer, Hash)>

#get_email_content_part_with_http_info(email_id, content_type, opts = {}) ⇒ Array<(EmailContentPartResult, Integer, Hash)>

#get_email_count(opts = {}) ⇒ CountDto

#get_email_count_with_http_info(opts = {}) ⇒ Array<(CountDto, Integer, Hash)>

#get_email_html(email_id, opts = {}) ⇒ String

#get_email_html_json(email_id, opts = {}) ⇒ EmailHtmlDto

#get_email_html_json_with_http_info(email_id, opts = {}) ⇒ Array<(EmailHtmlDto, Integer, Hash)>

#get_email_html_query(email_id, html_selector, opts = {}) ⇒ EmailTextLinesResult

#get_email_html_query_with_http_info(email_id, html_selector, opts = {}) ⇒ Array<(EmailTextLinesResult, Integer, Hash)>

#get_email_html_with_http_info(email_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

#get_email_links(email_id, opts = {}) ⇒ EmailLinksResult

#get_email_links_with_http_info(email_id, opts = {}) ⇒ Array<(EmailLinksResult, Integer, Hash)>

#get_email_preview_ur_ls(email_id, opts = {}) ⇒ EmailPreviewUrls

#get_email_preview_ur_ls_with_http_info(email_id, opts = {}) ⇒ Array<(EmailPreviewUrls, Integer, Hash)>

#get_email_screenshot_as_base64(email_id, get_email_screenshot_options, opts = {}) ⇒ EmailScreenshotResult

#get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, opts = {}) ⇒ Array<(EmailScreenshotResult, Integer, Hash)>

#get_email_screenshot_as_binary(email_id, get_email_screenshot_options, opts = {}) ⇒ nil

#get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#get_email_summary(email_id, opts = {}) ⇒ EmailPreview

#get_email_summary_with_http_info(email_id, opts = {}) ⇒ Array<(EmailPreview, Integer, Hash)>

#get_email_text_lines(email_id, opts = {}) ⇒ EmailTextLinesResult

#get_email_text_lines_with_http_info(email_id, opts = {}) ⇒ Array<(EmailTextLinesResult, Integer, Hash)>

#get_email_thread(thread_id, opts = {}) ⇒ EmailThreadDto

#get_email_thread_items(thread_id, opts = {}) ⇒ EmailThreadItemsDto

#get_email_thread_items_with_http_info(thread_id, opts = {}) ⇒ Array<(EmailThreadItemsDto, Integer, Hash)>

#get_email_thread_with_http_info(thread_id, opts = {}) ⇒ Array<(EmailThreadDto, Integer, Hash)>

#get_email_threads(opts = {}) ⇒ PageEmailThreadProjection

#get_email_threads_with_http_info(opts = {}) ⇒ Array<(PageEmailThreadProjection, Integer, Hash)>

#get_email_with_http_info(email_id, opts = {}) ⇒ Array<(Email, Integer, Hash)>

#get_emails_offset_paginated(opts = {}) ⇒ PageEmailProjection

#get_emails_offset_paginated_with_http_info(opts = {}) ⇒ Array<(PageEmailProjection, Integer, Hash)>

#get_emails_paginated(opts = {}) ⇒ PageEmailProjection

#get_emails_paginated_with_http_info(opts = {}) ⇒ Array<(PageEmailProjection, Integer, Hash)>

#get_gravatar_url_for_email_address(email_address, opts = {}) ⇒ GravatarUrl

#get_gravatar_url_for_email_address_with_http_info(email_address, opts = {}) ⇒ Array<(GravatarUrl, Integer, Hash)>

#get_latest_email(opts = {}) ⇒ Email

#get_latest_email_in_inbox1(inbox_id, opts = {}) ⇒ Email

#get_latest_email_in_inbox1_with_http_info(inbox_id, opts = {}) ⇒ Array<(Email, Integer, Hash)>

#get_latest_email_with_http_info(opts = {}) ⇒ Array<(Email, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `EmailControllerApi`

#api_client ⇒ `Object`

#apply_imap_flag_operation(email_id, imap_flag_operation_options, opts = {}) ⇒ `EmailPreview`

#apply_imap_flag_operation_with_http_info(email_id, imap_flag_operation_options, opts = {}) ⇒ `Array<(EmailPreview, Integer, Hash)>`

#can_send(inbox_id, send_email_options, opts = {}) ⇒ `CanSendEmailResults`

#can_send_with_http_info(inbox_id, send_email_options, opts = {}) ⇒ `Array<(CanSendEmailResults, Integer, Hash)>`

#check_email_body(email_id, opts = {}) ⇒ `CheckEmailBodyResults`

#check_email_body_feature_support(email_id, opts = {}) ⇒ `CheckEmailBodyFeatureSupportResults`

#check_email_body_feature_support_with_http_info(email_id, opts = {}) ⇒ `Array<(CheckEmailBodyFeatureSupportResults, Integer, Hash)>`

#check_email_body_with_http_info(email_id, opts = {}) ⇒ `Array<(CheckEmailBodyResults, Integer, Hash)>`

#check_email_client_support(check_email_client_support_options, opts = {}) ⇒ `CheckEmailClientSupportResults`

#check_email_client_support_with_http_info(check_email_client_support_options, opts = {}) ⇒ `Array<(CheckEmailClientSupportResults, Integer, Hash)>`

#delete_all_emails(opts = {}) ⇒ `nil`

#delete_all_emails_with_http_info(opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#delete_email(email_id, opts = {}) ⇒ `nil`

#delete_email_with_http_info(email_id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#download_attachment(email_id, attachment_id, opts = {}) ⇒ `String`

#download_attachment_base64(email_id, attachment_id, opts = {}) ⇒ `DownloadAttachmentDto`

#download_attachment_base64_with_http_info(email_id, attachment_id, opts = {}) ⇒ `Array<(DownloadAttachmentDto, Integer, Hash)>`

#download_attachment_with_http_info(email_id, attachment_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

#download_body(email_id, opts = {}) ⇒ `String`

#download_body_bytes(email_id, opts = {}) ⇒ `String`

#download_body_bytes_with_http_info(email_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

#download_body_with_http_info(email_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

#forward_email(email_id, forward_email_options, opts = {}) ⇒ `SentEmailDto`

#forward_email_with_http_info(email_id, forward_email_options, opts = {}) ⇒ `Array<(SentEmailDto, Integer, Hash)>`

#get_attachment_meta_data(email_id, attachment_id, opts = {}) ⇒ `AttachmentMetaData`

#get_attachment_meta_data_with_http_info(email_id, attachment_id, opts = {}) ⇒ `Array<(AttachmentMetaData, Integer, Hash)>`

#get_email(email_id, opts = {}) ⇒ `Email`

#get_email_attachments(email_id, opts = {}) ⇒ `Array<AttachmentMetaData>`

#get_email_attachments_with_http_info(email_id, opts = {}) ⇒ `Array<(Array<AttachmentMetaData>, Integer, Hash)>`

#get_email_content_match(email_id, content_match_options, opts = {}) ⇒ `EmailContentMatchResult`

#get_email_content_match_with_http_info(email_id, content_match_options, opts = {}) ⇒ `Array<(EmailContentMatchResult, Integer, Hash)>`

#get_email_content_part(email_id, content_type, opts = {}) ⇒ `EmailContentPartResult`

#get_email_content_part_content(email_id, content_type, opts = {}) ⇒ `String`

#get_email_content_part_content_with_http_info(email_id, content_type, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

#get_email_content_part_with_http_info(email_id, content_type, opts = {}) ⇒ `Array<(EmailContentPartResult, Integer, Hash)>`

#get_email_count(opts = {}) ⇒ `CountDto`

#get_email_count_with_http_info(opts = {}) ⇒ `Array<(CountDto, Integer, Hash)>`

#get_email_html(email_id, opts = {}) ⇒ `String`

#get_email_html_json(email_id, opts = {}) ⇒ `EmailHtmlDto`

#get_email_html_json_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailHtmlDto, Integer, Hash)>`

#get_email_html_query(email_id, html_selector, opts = {}) ⇒ `EmailTextLinesResult`

#get_email_html_query_with_http_info(email_id, html_selector, opts = {}) ⇒ `Array<(EmailTextLinesResult, Integer, Hash)>`

#get_email_html_with_http_info(email_id, opts = {}) ⇒ `Array<(String, Integer, Hash)>`

#get_email_links(email_id, opts = {}) ⇒ `EmailLinksResult`

#get_email_links_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailLinksResult, Integer, Hash)>`

#get_email_preview_ur_ls(email_id, opts = {}) ⇒ `EmailPreviewUrls`

#get_email_preview_ur_ls_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailPreviewUrls, Integer, Hash)>`

#get_email_screenshot_as_base64(email_id, get_email_screenshot_options, opts = {}) ⇒ `EmailScreenshotResult`

#get_email_screenshot_as_base64_with_http_info(email_id, get_email_screenshot_options, opts = {}) ⇒ `Array<(EmailScreenshotResult, Integer, Hash)>`

#get_email_screenshot_as_binary(email_id, get_email_screenshot_options, opts = {}) ⇒ `nil`

#get_email_screenshot_as_binary_with_http_info(email_id, get_email_screenshot_options, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#get_email_summary(email_id, opts = {}) ⇒ `EmailPreview`

#get_email_summary_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailPreview, Integer, Hash)>`

#get_email_text_lines(email_id, opts = {}) ⇒ `EmailTextLinesResult`

#get_email_text_lines_with_http_info(email_id, opts = {}) ⇒ `Array<(EmailTextLinesResult, Integer, Hash)>`

#get_email_thread(thread_id, opts = {}) ⇒ `EmailThreadDto`

#get_email_thread_items(thread_id, opts = {}) ⇒ `EmailThreadItemsDto`

#get_email_thread_items_with_http_info(thread_id, opts = {}) ⇒ `Array<(EmailThreadItemsDto, Integer, Hash)>`

#get_email_thread_with_http_info(thread_id, opts = {}) ⇒ `Array<(EmailThreadDto, Integer, Hash)>`

#get_email_threads(opts = {}) ⇒ `PageEmailThreadProjection`

#get_email_threads_with_http_info(opts = {}) ⇒ `Array<(PageEmailThreadProjection, Integer, Hash)>`

#get_email_with_http_info(email_id, opts = {}) ⇒ `Array<(Email, Integer, Hash)>`

#get_emails_offset_paginated(opts = {}) ⇒ `PageEmailProjection`

#get_emails_offset_paginated_with_http_info(opts = {}) ⇒ `Array<(PageEmailProjection, Integer, Hash)>`

#get_emails_paginated(opts = {}) ⇒ `PageEmailProjection`

#get_emails_paginated_with_http_info(opts = {}) ⇒ `Array<(PageEmailProjection, Integer, Hash)>`

#get_gravatar_url_for_email_address(email_address, opts = {}) ⇒ `GravatarUrl`

#get_gravatar_url_for_email_address_with_http_info(email_address, opts = {}) ⇒ `Array<(GravatarUrl, Integer, Hash)>`

#get_latest_email(opts = {}) ⇒ `Email`

#get_latest_email_in_inbox1(inbox_id, opts = {}) ⇒ `Email`

#get_latest_email_in_inbox1_with_http_info(inbox_id, opts = {}) ⇒ `Array<(Email, Integer, Hash)>`

#get_latest_email_with_http_info(opts = {}) ⇒ `Array<(Email, Integer, Hash)>`

#get_organization_emails_paginated(opts = {}) ⇒ `PageEmailProjection`

#get_organization_emails_paginated_with_http_info(opts = {}) ⇒ `Array<(PageEmailProjection, Integer, Hash)>`

#get_raw_email_contents(email_id, opts = {}) ⇒ `nil`

#get_raw_email_contents_with_http_info(email_id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#get_raw_email_json(email_id, opts = {}) ⇒ `RawEmailJson`

#get_raw_email_json_with_http_info(email_id, opts = {}) ⇒ `Array<(RawEmailJson, Integer, Hash)>`