class ElasticEmail::EmailContent

Proper e-mail content

Attributes

attach_files[RW]

Names of previously uploaded files that should be sent as downloadable attachments

attachments[RW]

Attachments provided by sending binary data

body[RW]

List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)

envelope_from[RW]

E-mail with an optional name to be used as the envelope from address (e.g.: John Doe <email@domain.com>)

from[RW]

Your e-mail with an optional name (e.g.: John Doe <email@domain.com>)

headers[RW]

A key-value collection of custom e-mail headers.

merge[RW]

A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc.

postback[RW]

Postback header.

reply_to[RW]

To what address should the recipients reply to (e.g. John Doe <email@domain.com>)

subject[RW]

Default subject of email.

template_name[RW]

Name of template.

utm[RW]

Utm marketing data to be attached to every link in this e-mail.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/ElasticEmail/models/email_content.rb, line 74
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/ElasticEmail/models/email_content.rb, line 56
def self.attribute_map
  {
    :'body' => :'Body',
    :'merge' => :'Merge',
    :'attachments' => :'Attachments',
    :'headers' => :'Headers',
    :'postback' => :'Postback',
    :'envelope_from' => :'EnvelopeFrom',
    :'from' => :'From',
    :'reply_to' => :'ReplyTo',
    :'subject' => :'Subject',
    :'template_name' => :'TemplateName',
    :'attach_files' => :'AttachFiles',
    :'utm' => :'Utm'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ElasticEmail/models/email_content.rb, line 223
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ElasticEmail/models/email_content.rb, line 104
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ElasticEmail::EmailContent` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ElasticEmail::EmailContent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'body')
    if (value = attributes[:'body']).is_a?(Array)
      self.body = value
    end
  end

  if attributes.key?(:'merge')
    if (value = attributes[:'merge']).is_a?(Hash)
      self.merge = value
    end
  end

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end

  if attributes.key?(:'headers')
    if (value = attributes[:'headers']).is_a?(Hash)
      self.headers = value
    end
  end

  if attributes.key?(:'postback')
    self.postback = attributes[:'postback']
  end

  if attributes.key?(:'envelope_from')
    self.envelope_from = attributes[:'envelope_from']
  end

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.key?(:'reply_to')
    self.reply_to = attributes[:'reply_to']
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.key?(:'template_name')
    self.template_name = attributes[:'template_name']
  end

  if attributes.key?(:'attach_files')
    if (value = attributes[:'attach_files']).is_a?(Array)
      self.attach_files = value
    end
  end

  if attributes.key?(:'utm')
    self.utm = attributes[:'utm']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/ElasticEmail/models/email_content.rb, line 97
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ElasticEmail/models/email_content.rb, line 79
def self.openapi_types
  {
    :'body' => :'Array<BodyPart>',
    :'merge' => :'Hash<String, String>',
    :'attachments' => :'Array<MessageAttachment>',
    :'headers' => :'Hash<String, String>',
    :'postback' => :'String',
    :'envelope_from' => :'String',
    :'from' => :'String',
    :'reply_to' => :'String',
    :'subject' => :'String',
    :'template_name' => :'String',
    :'attach_files' => :'Array<String>',
    :'utm' => :'Utm'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ElasticEmail/models/email_content.rb, line 191
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      body == o.body &&
      merge == o.merge &&
      attachments == o.attachments &&
      headers == o.headers &&
      postback == o.postback &&
      envelope_from == o.envelope_from &&
      from == o.from &&
      reply_to == o.reply_to &&
      subject == o.subject &&
      template_name == o.template_name &&
      attach_files == o.attach_files &&
      utm == o.utm
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ElasticEmail/models/email_content.rb, line 253
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = ElasticEmail.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/ElasticEmail/models/email_content.rb, line 324
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ElasticEmail/models/email_content.rb, line 230
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ElasticEmail/models/email_content.rb, line 210
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/ElasticEmail/models/email_content.rb, line 216
def hash
  [body, merge, attachments, headers, postback, envelope_from, from, reply_to, subject, template_name, attach_files, utm].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ElasticEmail/models/email_content.rb, line 178
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ElasticEmail/models/email_content.rb, line 300
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ElasticEmail/models/email_content.rb, line 306
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ElasticEmail/models/email_content.rb, line 294
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ElasticEmail/models/email_content.rb, line 185
def valid?
  true
end