Class: SibApiV3Sdk::SendSmtpEmail
- Inherits:
-
Object
- Object
- SibApiV3Sdk::SendSmtpEmail
- Defined in:
- lib/sib-api-v3-sdk/models/send_smtp_email.rb
Instance Attribute Summary collapse
-
#attachment ⇒ Object
Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed).
-
#bcc ⇒ Object
List of email addresses and names (optional) of the recipients in bcc.
-
#cc ⇒ Object
List of email addresses and names (optional) of the recipients in cc.
-
#headers ⇒ Object
Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email.
-
#html_content ⇒ Object
HTML body of the message ( Mandatory if ‘templateId’ is not passed, ignored if ‘templateId’ is passed ).
-
#message_versions ⇒ Object
You can customize and send out multiple versions of a templateId.
-
#params ⇒ Object
Pass the set of attributes to customize the template.
-
#reply_to ⇒ Object
Returns the value of attribute reply_to.
-
#sender ⇒ Object
Returns the value of attribute sender.
-
#subject ⇒ Object
Subject of the message.
-
#tags ⇒ Object
Tag your emails to find them more easily.
-
#template_id ⇒ Object
Id of the template.
-
#text_content ⇒ Object
Plain Text body of the message ( Ignored if ‘templateId’ is passed ).
-
#to ⇒ Object
Mandatory if messageVersions are not passed, ignored if messageVersions are passed.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_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 ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SendSmtpEmail
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 = {}) ⇒ SendSmtpEmail
Initializes the object
99 100 101 102 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 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 99 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'sender') self.sender = attributes[:'sender'] end if attributes.has_key?(:'to') if (value = attributes[:'to']).is_a?(Array) self.to = value end end if attributes.has_key?(:'bcc') if (value = attributes[:'bcc']).is_a?(Array) self.bcc = value end end if attributes.has_key?(:'cc') if (value = attributes[:'cc']).is_a?(Array) self.cc = value end end if attributes.has_key?(:'htmlContent') self.html_content = attributes[:'htmlContent'] end if attributes.has_key?(:'textContent') self.text_content = attributes[:'textContent'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'replyTo') self.reply_to = attributes[:'replyTo'] end if attributes.has_key?(:'attachment') if (value = attributes[:'attachment']).is_a?(Array) self. = value end end if attributes.has_key?(:'headers') self.headers = attributes[:'headers'] end if attributes.has_key?(:'templateId') self.template_id = attributes[:'templateId'] end if attributes.has_key?(:'params') self.params = attributes[:'params'] end if attributes.has_key?(:'messageVersions') if (value = attributes[:'messageVersions']).is_a?(Array) self. = value end end if attributes.has_key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self. = value end end end |
Instance Attribute Details
#attachment ⇒ Object
Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, ‘[src="https://attachment.domain.com/myAttachmentFromUrl.jpg" />", "name":"myAttachmentFromUrl.jpg", example content", "name":"myAttachmentFromBase64.jpg"]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If ’templateId’ is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then ‘attachment’ is ignored )
40 41 42 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 40 def @attachment end |
#bcc ⇒ Object
List of email addresses and names (optional) of the recipients in bcc
23 24 25 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 23 def bcc @bcc end |
#cc ⇒ Object
List of email addresses and names (optional) of the recipients in cc
26 27 28 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 26 def cc @cc end |
#headers ⇒ Object
Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. ‘sender.ip’ header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in ‘This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `"X-Mailin-custom":"some_custom_header"`.
43 44 45 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 43 def headers @headers end |
#html_content ⇒ Object
HTML body of the message ( Mandatory if ‘templateId’ is not passed, ignored if ‘templateId’ is passed )
29 30 31 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 29 def html_content @html_content end |
#message_versions ⇒ Object
You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use messageVersions to batch send emails - developers.sendinblue.com/docs/batch-send-transactional-emails
52 53 54 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 52 def @message_versions end |
#params ⇒ Object
Pass the set of attributes to customize the template. For example, "LNAME":"Doe". It’s considered only if template is in New Template Language format.
49 50 51 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 49 def params @params end |
#reply_to ⇒ Object
Returns the value of attribute reply_to.
37 38 39 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 37 def reply_to @reply_to end |
#sender ⇒ Object
Returns the value of attribute sender.
17 18 19 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 17 def sender @sender end |
#subject ⇒ Object
Subject of the message. Mandatory if ‘templateId’ is not passed
35 36 37 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 35 def subject @subject end |
#tags ⇒ Object
Tag your emails to find them more easily
55 56 57 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 55 def @tags end |
#template_id ⇒ Object
Id of the template. Mandatory if messageVersions are passed
46 47 48 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 46 def template_id @template_id end |
#text_content ⇒ Object
Plain Text body of the message ( Ignored if ‘templateId’ is passed )
32 33 34 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 32 def text_content @text_content end |
#to ⇒ Object
Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, ["email":"[email protected]", "email":"[email protected]"]
20 21 22 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 20 def to @to end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 58 def self.attribute_map { :'sender' => :'sender', :'to' => :'to', :'bcc' => :'bcc', :'cc' => :'cc', :'html_content' => :'htmlContent', :'text_content' => :'textContent', :'subject' => :'subject', :'reply_to' => :'replyTo', :'attachment' => :'attachment', :'headers' => :'headers', :'template_id' => :'templateId', :'params' => :'params', :'message_versions' => :'messageVersions', :'tags' => :'tags' } end |
.swagger_types ⇒ Object
Attribute type mapping.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 78 def self.swagger_types { :'sender' => :'SendSmtpEmailSender', :'to' => :'Array<SendSmtpEmailTo>', :'bcc' => :'Array<SendSmtpEmailBcc>', :'cc' => :'Array<SendSmtpEmailCc>', :'html_content' => :'String', :'text_content' => :'String', :'subject' => :'String', :'reply_to' => :'SendSmtpEmailReplyTo', :'attachment' => :'Array<SendSmtpEmailAttachment>', :'headers' => :'Object', :'template_id' => :'Integer', :'params' => :'Object', :'message_versions' => :'Array<SendSmtpEmailMessageVersions>', :'tags' => :'Array<String>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 189 def ==(o) return true if self.equal?(o) self.class == o.class && sender == o.sender && to == o.to && bcc == o.bcc && cc == o.cc && html_content == o.html_content && text_content == o.text_content && subject == o.subject && reply_to == o.reply_to && == o. && headers == o.headers && template_id == o.template_id && params == o.params && == o. && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
244 245 246 247 248 249 250 251 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 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 244 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = SibApiV3Sdk.const_get(type).new temp_model.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
310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 310 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
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 223 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
210 211 212 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 210 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
216 217 218 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 216 def hash [sender, to, bcc, cc, html_content, text_content, subject, reply_to, , headers, template_id, params, , ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
176 177 178 179 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 176 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
290 291 292 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 290 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
296 297 298 299 300 301 302 303 304 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 296 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
284 285 286 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 284 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
183 184 185 |
# File 'lib/sib-api-v3-sdk/models/send_smtp_email.rb', line 183 def valid? true end |