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

#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 96

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 105

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 151

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 161

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 213

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 283

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 294

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 225

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 350

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 412

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 422

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 360

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 475

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 486

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 545

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 556

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

Options Hash (opts):

:decode (Boolean) —

Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (default to false)

Returns:

(Email)

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

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 677

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 687

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 740

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 751

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_count(opts = {}) ⇒ `CountDto`

Get email count

Parameters:

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

the optional parameters

Returns:

(CountDto)

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

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

Returns:

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

CountDto data, response status code and response headers

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

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] || {}

  # 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):

:decode (Boolean) — default: default to false

Returns:

(String)

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

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

:decode (Boolean) — default: default to false

Returns:

(EmailHtmlDto)

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

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

:decode (Boolean)

Returns:

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

EmailHtmlDto data, response status code and response headers

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

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[:'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] || '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 994

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 1005

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

:decode (Boolean)

Returns:

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

String data, response status code and response headers

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

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[:'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(['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

Returns:

(EmailLinksResult)

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

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

Returns:

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

EmailLinksResult data, response status code and response headers

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

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] || {}

  # 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 1124

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 1134

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_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 1188

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 1200

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_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

Options Hash (opts):

:decode (Boolean) —

Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing

Returns:

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

Email data, response status code and response headers

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

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] || {}
  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] || '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_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

Returns:

(PageEmailProjection)

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

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
:before (DateTime) —

Optional filter emails received before given date time

Returns:

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

PageEmailProjection data, response status code and response headers

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

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?

  # 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 1342

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 1352

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 1406

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 1465

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 1475

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 1416

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
:before (DateTime) —

Optional filter emails received before given date time

Returns:

(PageEmailProjection)

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

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
:before (DateTime) —

Optional filter emails received before given date time

Returns:

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

PageEmailProjection data, response status code and response headers

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

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?

  # 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 = {}) ⇒ `String`

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:

(String)

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

def get_raw_email_contents(email_id, opts = {})
  data, _status_code, _headers = get_raw_email_contents_with_http_info(email_id, opts)
  data
end

#get_raw_email_contents_with_http_info(email_id, opts = {}) ⇒ `Array<(String, 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<(String, Integer, Hash)>) —

String data, response status code and response headers

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

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] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain'])

  # 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_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 1678

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 1688

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

Returns:

(UnreadCount)

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

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

Returns:

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

UnreadCount data, response status code and response headers

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

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] || {}

  # 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_as_read(email_id, opts = {}) ⇒ `EmailPreview`

Mark an email as read on unread Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread

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 1797

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 on unread Marks an email as read or unread. Pass boolean read flag to set value. This is useful if you want to read an email but keep it as unread

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 1808

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 1862

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 1873

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

#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 1934

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 1947

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

#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 2002

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 2012

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)>

#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_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_text_lines(email_id, opts = {}) ⇒ EmailTextLinesResult

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

#get_email_with_http_info(email_id, opts = {}) ⇒ Array<(Email, 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 = {}) ⇒ String

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

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

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

#get_unread_email_count(opts = {}) ⇒ UnreadCount

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

#mark_as_read(email_id, opts = {}) ⇒ EmailPreview

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

#reply_to_email(email_id, reply_to_email_options, opts = {}) ⇒ SentEmailDto

#reply_to_email_with_http_info(email_id, reply_to_email_options, opts = {}) ⇒ Array<(SentEmailDto, Integer, Hash)>

#send_email_source_optional(send_email_options, opts = {}) ⇒ nil

#send_email_source_optional_with_http_info(send_email_options, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#validate_email(email_id, opts = {}) ⇒ ValidationDto

#validate_email_with_http_info(email_id, opts = {}) ⇒ Array<(ValidationDto, 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)>`

#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_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_text_lines(email_id, opts = {}) ⇒ `EmailTextLinesResult`

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

#get_email_with_http_info(email_id, opts = {}) ⇒ `Array<(Email, 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 = {}) ⇒ `String`

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

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

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

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

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

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

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

#reply_to_email(email_id, reply_to_email_options, opts = {}) ⇒ `SentEmailDto`

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

#send_email_source_optional(send_email_options, opts = {}) ⇒ `nil`

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

#validate_email(email_id, opts = {}) ⇒ `ValidationDto`

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