class SibApiV3Sdk::SendSmtpEmail
Attributes
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, `[{"url":"", "name":"myAttachmentFromUrl.jpg"}, {"content":"base64 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 )
List of email addresses and names (optional) of the recipients in bcc
List of email addresses and names (optional) of the recipients in cc
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, `{"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_header"}`.
HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed )
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
Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. It's considered only if template is in New Template Language format.
Subject of the message. Mandatory if 'templateId' is not passed
Id of the template. Mandatory if messageVersions are passed
Plain Text body of the message ( Ignored if 'templateId' is passed )
Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{"name":"Jimmy", "email":"jimmy98@example.com"}, {"name":"Joe", "email":"joe@example.com"}]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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.attachment = 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.message_versions = value end end if attributes.has_key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self.tags = value end end end
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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 && attachment == o.attachment && headers == o.headers && template_id == o.template_id && params == o.params && message_versions == o.message_versions && tags == o.tags end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
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/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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/sib-api-v3-sdk/models/send_smtp_email.rb, line 210 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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, attachment, headers, template_id, params, message_versions, tags].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sib-api-v3-sdk/models/send_smtp_email.rb, line 176 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sib-api-v3-sdk/models/send_smtp_email.rb, line 284 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/sib-api-v3-sdk/models/send_smtp_email.rb, line 183 def valid? true end