Skip to content

EmailsApi.md

Latest commit

 

History

History
389 lines (281 loc) · 12.6 KB

EmailsApi.md

File metadata and controls

389 lines (281 loc) · 12.6 KB

ElasticEmail::EmailsApi

All URIs are relative to https://api.elasticemail.com/v4

Method HTTP request Description
emails_by_msgid_view_get GET /emails/{msgid}/view View Email
emails_by_transactionid_status_get GET /emails/{transactionid}/status Get Status
emails_mergefile_post POST /emails/mergefile Send Bulk Emails CSV
emails_post POST /emails Send Bulk Emails
emails_transactional_post POST /emails/transactional Send Transactional Email

emails_by_msgid_view_get

emails_by_msgid_view_get(msgid)

View Email

Returns email details for viewing or rendering. Required Access Level: None

Examples

require 'time'
require 'ElasticEmail'
# setup authorization
ElasticEmail.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
end

api_instance = ElasticEmail::EmailsApi.new
msgid = 'msgid_example' # String | Message identifier

begin
  # View Email
  result = api_instance.emails_by_msgid_view_get(msgid)
  p result
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_by_msgid_view_get: #{e}"
end

Using the emails_by_msgid_view_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> emails_by_msgid_view_get_with_http_info(msgid)

begin
  # View Email
  data, status_code, headers = api_instance.emails_by_msgid_view_get_with_http_info(msgid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EmailData>
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_by_msgid_view_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
msgid String Message identifier

Return type

EmailData

Authorization

apikey

HTTP request headers

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

emails_by_transactionid_status_get

emails_by_transactionid_status_get(transactionid, opts)

Get Status

Get status details of an email transaction. Required Access Level: ViewReports

Examples

require 'time'
require 'ElasticEmail'
# setup authorization
ElasticEmail.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
end

api_instance = ElasticEmail::EmailsApi.new
transactionid = 'transactionid_example' # String | Transaction identifier
opts = {
  show_failed: true, # Boolean | Include Bounced email addresses.
  show_sent: true, # Boolean | Include Sent email addresses.
  show_delivered: true, # Boolean | Include all delivered email addresses.
  show_pending: true, # Boolean | Include Ready to send email addresses.
  show_opened: true, # Boolean | Include Opened email addresses.
  show_clicked: true, # Boolean | Include Clicked email addresses.
  show_abuse: true, # Boolean | Include Reported as abuse email addresses.
  show_unsubscribed: true, # Boolean | Include Unsubscribed email addresses.
  show_errors: true, # Boolean | Include error messages for bounced emails.
  show_message_ids: true # Boolean | Include all MessageIDs for this transaction
}

begin
  # Get Status
  result = api_instance.emails_by_transactionid_status_get(transactionid, opts)
  p result
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_by_transactionid_status_get: #{e}"
end

Using the emails_by_transactionid_status_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> emails_by_transactionid_status_get_with_http_info(transactionid, opts)

begin
  # Get Status
  data, status_code, headers = api_instance.emails_by_transactionid_status_get_with_http_info(transactionid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EmailJobStatus>
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_by_transactionid_status_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
transactionid String Transaction identifier
show_failed Boolean Include Bounced email addresses. [optional][default to false]
show_sent Boolean Include Sent email addresses. [optional][default to false]
show_delivered Boolean Include all delivered email addresses. [optional][default to false]
show_pending Boolean Include Ready to send email addresses. [optional][default to false]
show_opened Boolean Include Opened email addresses. [optional][default to false]
show_clicked Boolean Include Clicked email addresses. [optional][default to false]
show_abuse Boolean Include Reported as abuse email addresses. [optional][default to false]
show_unsubscribed Boolean Include Unsubscribed email addresses. [optional][default to false]
show_errors Boolean Include error messages for bounced emails. [optional][default to false]
show_message_ids Boolean Include all MessageIDs for this transaction [optional][default to false]

Return type

EmailJobStatus

Authorization

apikey

HTTP request headers

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

emails_mergefile_post

emails_mergefile_post(merge_email_payload)

Send Bulk Emails CSV

Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp

Examples

require 'time'
require 'ElasticEmail'
# setup authorization
ElasticEmail.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
end

api_instance = ElasticEmail::EmailsApi.new
merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example', name: 'name_example'}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # MergeEmailPayload | Email data

begin
  # Send Bulk Emails CSV
  result = api_instance.emails_mergefile_post(merge_email_payload)
  p result
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_mergefile_post: #{e}"
end

Using the emails_mergefile_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> emails_mergefile_post_with_http_info(merge_email_payload)

begin
  # Send Bulk Emails CSV
  data, status_code, headers = api_instance.emails_mergefile_post_with_http_info(merge_email_payload)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EmailSend>
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_mergefile_post_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
merge_email_payload MergeEmailPayload Email data

Return type

EmailSend

Authorization

apikey

HTTP request headers

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

emails_post

emails_post(email_message_data)

Send Bulk Emails

Send bulk merge email. Required Access Level: SendHttp

Examples

require 'time'
require 'ElasticEmail'
# setup authorization
ElasticEmail.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
end

api_instance = ElasticEmail::EmailsApi.new
email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})], content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailMessageData | Email data

begin
  # Send Bulk Emails
  result = api_instance.emails_post(email_message_data)
  p result
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_post: #{e}"
end

Using the emails_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> emails_post_with_http_info(email_message_data)

begin
  # Send Bulk Emails
  data, status_code, headers = api_instance.emails_post_with_http_info(email_message_data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EmailSend>
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_post_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
email_message_data EmailMessageData Email data

Return type

EmailSend

Authorization

apikey

HTTP request headers

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

emails_transactional_post

emails_transactional_post(email_transactional_message_data)

Send Transactional Email

Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp

Examples

require 'time'
require 'ElasticEmail'
# setup authorization
ElasticEmail.configure do |config|
  # Configure API key authorization: apikey
  config.api_key['X-ElasticEmail-ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-ElasticEmail-ApiKey'] = 'Bearer'
end

api_instance = ElasticEmail::EmailsApi.new
email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']}), content: ElasticEmail::EmailContent.new({from: 'John Doe <email@domain.com>'})}) # EmailTransactionalMessageData | Email data

begin
  # Send Transactional Email
  result = api_instance.emails_transactional_post(email_transactional_message_data)
  p result
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_transactional_post: #{e}"
end

Using the emails_transactional_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> emails_transactional_post_with_http_info(email_transactional_message_data)

begin
  # Send Transactional Email
  data, status_code, headers = api_instance.emails_transactional_post_with_http_info(email_transactional_message_data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EmailSend>
rescue ElasticEmail::ApiError => e
  puts "Error when calling EmailsApi->emails_transactional_post_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
email_transactional_message_data EmailTransactionalMessageData Email data

Return type

EmailSend

Authorization

apikey

HTTP request headers

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