Class: ElasticEmail::EmailContent
- Inherits:
-
Object
- Object
- ElasticEmail::EmailContent
- Defined in:
- lib/ElasticEmail/models/email_content.rb
Overview
Proper e-mail content
Instance Attribute Summary collapse
-
#attach_files ⇒ Object
Names of previously uploaded files that should be sent as downloadable attachments.
-
#attachments ⇒ Object
Attachments provided by sending binary data.
-
#body ⇒ Object
List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc).
-
#envelope_from ⇒ Object
E-mail with an optional name to be used as the envelope from address (e.g.: John Doe <email@domain.com>).
-
#from ⇒ Object
Your e-mail with an optional name (e.g.: John Doe <email@domain.com>).
-
#headers ⇒ Object
A key-value collection of custom e-mail headers.
-
#merge ⇒ Object
A key-value collection of custom merge fields, shared between recipients.
-
#postback ⇒ Object
Postback header.
-
#reply_to ⇒ Object
To what address should the recipients reply to (e.g. John Doe <email@domain.com>).
-
#subject ⇒ Object
Default subject of email.
-
#template_name ⇒ Object
Name of template.
-
#utm ⇒ Object
Returns the value of attribute utm.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EmailContent
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ EmailContent
Initializes the object
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/ElasticEmail/models/email_content.rb', line 103 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. = 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 |
Instance Attribute Details
#attach_files ⇒ Object
Names of previously uploaded files that should be sent as downloadable attachments
50 51 52 |
# File 'lib/ElasticEmail/models/email_content.rb', line 50 def attach_files @attach_files end |
#attachments ⇒ Object
Attachments provided by sending binary data
26 27 28 |
# File 'lib/ElasticEmail/models/email_content.rb', line 26 def @attachments end |
#body ⇒ Object
List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)
20 21 22 |
# File 'lib/ElasticEmail/models/email_content.rb', line 20 def body @body end |
#envelope_from ⇒ Object
E-mail with an optional name to be used as the envelope from address (e.g.: John Doe <email@domain.com>)
35 36 37 |
# File 'lib/ElasticEmail/models/email_content.rb', line 35 def envelope_from @envelope_from end |
#from ⇒ Object
Your e-mail with an optional name (e.g.: John Doe <email@domain.com>)
38 39 40 |
# File 'lib/ElasticEmail/models/email_content.rb', line 38 def from @from end |
#headers ⇒ Object
A key-value collection of custom e-mail headers.
29 30 31 |
# File 'lib/ElasticEmail/models/email_content.rb', line 29 def headers @headers end |
#merge ⇒ Object
A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: firstname, lastname etc.
23 24 25 |
# File 'lib/ElasticEmail/models/email_content.rb', line 23 def merge @merge end |
#postback ⇒ Object
Postback header.
32 33 34 |
# File 'lib/ElasticEmail/models/email_content.rb', line 32 def postback @postback end |
#reply_to ⇒ Object
To what address should the recipients reply to (e.g. John Doe <email@domain.com>)
41 42 43 |
# File 'lib/ElasticEmail/models/email_content.rb', line 41 def reply_to @reply_to end |
#subject ⇒ Object
Default subject of email.
44 45 46 |
# File 'lib/ElasticEmail/models/email_content.rb', line 44 def subject @subject end |
#template_name ⇒ Object
Name of template.
47 48 49 |
# File 'lib/ElasticEmail/models/email_content.rb', line 47 def template_name @template_name end |
#utm ⇒ Object
Returns the value of attribute utm.
52 53 54 |
# File 'lib/ElasticEmail/models/email_content.rb', line 52 def utm @utm end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
73 74 75 |
# File 'lib/ElasticEmail/models/email_content.rb', line 73 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/ElasticEmail/models/email_content.rb', line 55 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) ⇒ Object
Builds the object from hash
222 223 224 |
# File 'lib/ElasticEmail/models/email_content.rb', line 222 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
96 97 98 99 |
# File 'lib/ElasticEmail/models/email_content.rb', line 96 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/ElasticEmail/models/email_content.rb', line 78 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/ElasticEmail/models/email_content.rb', line 190 def ==(o) return true if self.equal?(o) self.class == o.class && body == o.body && merge == o.merge && == o. && 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) ⇒ Object
Deserializes the data based on type
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/ElasticEmail/models/email_content.rb', line 252 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/ElasticEmail/models/email_content.rb', line 323 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) ⇒ Object
Builds the object from hash
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/ElasticEmail/models/email_content.rb', line 229 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) ⇒ Boolean
209 210 211 |
# File 'lib/ElasticEmail/models/email_content.rb', line 209 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
215 216 217 |
# File 'lib/ElasticEmail/models/email_content.rb', line 215 def hash [body, merge, , headers, postback, envelope_from, from, reply_to, subject, template_name, attach_files, utm].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
177 178 179 180 |
# File 'lib/ElasticEmail/models/email_content.rb', line 177 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
299 300 301 |
# File 'lib/ElasticEmail/models/email_content.rb', line 299 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/ElasticEmail/models/email_content.rb', line 305 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 ⇒ String
Returns the string representation of the object
293 294 295 |
# File 'lib/ElasticEmail/models/email_content.rb', line 293 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
184 185 186 |
# File 'lib/ElasticEmail/models/email_content.rb', line 184 def valid? true end |