Class: Sendpost::EmailMessageObject

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/models/email_message_object.rb

Overview

Email message object containing all the details required to send an email. At minimum, you need to provide from, to, and either subject with htmlBody/textBody or a template.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailMessageObject

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 129

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Sendpost::EmailMessageObject` initialize method"
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'track_opens')
    self.track_opens = attributes[:'track_opens']
  else
    self.track_opens = true
  end

  if attributes.key?(:'track_clicks')
    self.track_clicks = attributes[:'track_clicks']
  else
    self.track_clicks = true
  end

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

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

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

Instance Attribute Details

#amp_body ⇒ Object

AMP HTML content for supported email clients (Gmail, Yahoo). Enables interactive email experiences like carousels, forms, and real-time content. See https://amp.dev/about/email/ for more details.



41
42
43
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 41

def amp_body
  @amp_body
end

#attachments ⇒ Object

File attachments to include with the email. Maximum total attachment size: 25MB. Supported formats: PDF, images, documents, etc.



62
63
64
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 62

def attachments
  @attachments
end

#from ⇒ Object

The sender's email address and optional display name



20
21
22
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 20

def from
  @from
end

#groups ⇒ Object

Tags/groups to categorize this email for analytics and reporting. Use groups to segment your email statistics (e.g., by campaign, email type, or customer segment).



59
60
61
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 59

def groups
  @groups
end

#headers ⇒ Object

Custom email headers to include in the message. Common uses: adding List-Unsubscribe headers, custom tracking IDs, or priority flags. Note: Some headers like From, To, Subject are set automatically and cannot be overridden.



50
51
52
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 50

def headers
  @headers
end

#html_body ⇒ Object

HTML content of the email. Supports Handlebars templating for personalization. Use {customFieldName} to insert recipient-specific values.



35
36
37
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 35

def html_body
  @html_body
end

#ippool ⇒ Object

Name of the IP pool to use for sending this email. If not specified, the default IP pool for the sub-account will be used.



47
48
49
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 47

def ippool
  @ippool
end

#pre_text ⇒ Object

Preview text (preheader) shown in email clients before opening the email. This text appears after the subject line in most email clients' inbox view.



32
33
34
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 32

def pre_text
  @pre_text
end

#reply_to ⇒ Object

The reply-to email address. If not specified, replies will go to the from address



23
24
25
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 23

def reply_to
  @reply_to
end

#subject ⇒ Object

Email subject line. Supports Handlebars templating for personalization. Example: "Hello, {firstName}! Your order is ready"



29
30
31
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 29

def subject
  @subject
end

#template ⇒ Object

Name of a pre-defined template to use for this email. When specified, the template's subject, htmlBody, and textBody will be used unless explicitly overridden in this request.



44
45
46
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 44

def template
  @template
end

#text_body ⇒ Object

Plain text content of the email. Used as fallback when HTML cannot be rendered. Also improves deliverability as some spam filters prefer multipart emails.



38
39
40
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 38

def text_body
  @text_body
end

#to ⇒ Object

List of recipients. Each recipient can have their own CC, BCC, and custom fields for personalization. Maximum 1000 recipients per API call.



26
27
28
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 26

def to
  @to
end

#track_clicks ⇒ Object

Whether to track link clicks by rewriting URLs through SendPost's tracking domain. When enabled, all links in htmlBody are replaced with tracking URLs. Default: true (if not specified)



56
57
58
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 56

def track_clicks
  @track_clicks
end

#track_opens ⇒ Object

Whether to track email opens using a tracking pixel. When enabled, a 1x1 transparent image is inserted into the HTML body. Default: true (if not specified)



53
54
55
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 53

def track_opens
  @track_opens
end

#webhook_endpoint ⇒ Object

Custom webhook URL to receive events for this specific email. Overrides the default webhook configured at the account level. Useful for per-email or per-customer webhook routing.



65
66
67
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 65

def webhook_endpoint
  @webhook_endpoint
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 387

def self._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 = Sendpost.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



90
91
92
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 90

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 95

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 68

def self.attribute_map
  {
    :'from' => :'from',
    :'reply_to' => :'replyTo',
    :'to' => :'to',
    :'subject' => :'subject',
    :'pre_text' => :'preText',
    :'html_body' => :'htmlBody',
    :'text_body' => :'textBody',
    :'amp_body' => :'ampBody',
    :'template' => :'template',
    :'ippool' => :'ippool',
    :'headers' => :'headers',
    :'track_opens' => :'trackOpens',
    :'track_clicks' => :'trackClicks',
    :'groups' => :'groups',
    :'attachments' => :'attachments',
    :'webhook_endpoint' => :'webhookEndpoint'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 363

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 122

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 100

def self.openapi_types
  {
    :'from' => :'EmailAddress',
    :'reply_to' => :'EmailAddress',
    :'to' => :'Array<Recipient>',
    :'subject' => :'String',
    :'pre_text' => :'String',
    :'html_body' => :'String',
    :'text_body' => :'String',
    :'amp_body' => :'String',
    :'template' => :'String',
    :'ippool' => :'String',
    :'headers' => :'Hash<String, String>',
    :'track_opens' => :'Boolean',
    :'track_clicks' => :'Boolean',
    :'groups' => :'Array<String>',
    :'attachments' => :'Array<Attachment>',
    :'webhook_endpoint' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 327

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from == o.from &&
      reply_to == o.reply_to &&
      to == o.to &&
      subject == o.subject &&
      pre_text == o.pre_text &&
      html_body == o.html_body &&
      text_body == o.text_body &&
      amp_body == o.amp_body &&
      template == o.template &&
      ippool == o.ippool &&
      headers == o.headers &&
      track_opens == o.track_opens &&
      track_clicks == o.track_clicks &&
      groups == o.groups &&
      attachments == o.attachments &&
      webhook_endpoint == o.webhook_endpoint
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 458

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


350
351
352
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 350

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



356
357
358
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 356

def hash
  [from, reply_to, to, subject, pre_text, html_body, text_body, amp_body, template, ippool, headers, track_opens, track_clicks, groups, attachments, webhook_endpoint].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 226

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @from.nil?
    invalid_properties.push('invalid value for "from", from cannot be nil.')
  end

  if @to.nil?
    invalid_properties.push('invalid value for "to", to cannot be nil.')
  end

  if @to.length > 1000
    invalid_properties.push('invalid value for "to", number of items must be less than or equal to 1000.')
  end

  if @to.length < 1
    invalid_properties.push('invalid value for "to", number of items must be greater than or equal to 1.')
  end

  if !@subject.nil? && @subject.to_s.length > 998
    invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 998.')
  end

  if !@pre_text.nil? && @pre_text.to_s.length > 200
    invalid_properties.push('invalid value for "pre_text", the character length must be smaller than or equal to 200.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



434
435
436
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 434

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 440

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

Returns:

  • (String) —

    String presentation of the object



428
429
430
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 428

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/sendpost_ruby_sdk/models/email_message_object.rb', line 258

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @from.nil?
  return false if @to.nil?
  return false if @to.length > 1000
  return false if @to.length < 1
  return false if !@subject.nil? && @subject.to_s.length > 998
  return false if !@pre_text.nil? && @pre_text.to_s.length > 200
  true
end