class SibApiV3Sdk::SendEmail
Attributes
Pass the list of content (base64 encoded) and name of the attachment. For example, [{"content":"base64 encoded content 1", "name":"attcahment1"}, {"content":"base64 encoded content 2", "name":"attcahment2"}].
Absolute url of the attachment (no local file). Extension allowed: 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 and eps
Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}
List of the email addresses of the recipients in bcc
List of the email addresses of the recipients in cc
List of the email addresses of the recipients. For example, ['abc@example.com', 'asd@example.com'].
Pass the set of 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, {"Content-Type":"text/html", "charset":"iso-8859-1", "sender.ip":"1.2.3.4"}
Email address which shall be used by campaign recipients to reply back
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sib-api-v3-sdk/models/send_email.rb, line 45 def self.attribute_map { :'email_to' => :'emailTo', :'email_bcc' => :'emailBcc', :'email_cc' => :'emailCc', :'reply_to' => :'replyTo', :'attachment_url' => :'attachmentUrl', :'attachment' => :'attachment', :'headers' => :'headers', :'attributes' => :'attributes', :'tags' => :'tags' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sib-api-v3-sdk/models/send_email.rb, line 76 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?(:'emailTo') if (value = attributes[:'emailTo']).is_a?(Array) self.email_to = value end end if attributes.has_key?(:'emailBcc') if (value = attributes[:'emailBcc']).is_a?(Array) self.email_bcc = value end end if attributes.has_key?(:'emailCc') if (value = attributes[:'emailCc']).is_a?(Array) self.email_cc = value end end if attributes.has_key?(:'replyTo') self.reply_to = attributes[:'replyTo'] end if attributes.has_key?(:'attachmentUrl') self.attachment_url = attributes[:'attachmentUrl'] 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?(:'attributes') self.attributes = attributes[:'attributes'] 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_email.rb, line 60 def self.swagger_types { :'email_to' => :'Array<String>', :'email_bcc' => :'Array<String>', :'email_cc' => :'Array<String>', :'reply_to' => :'String', :'attachment_url' => :'String', :'attachment' => :'Array<SendEmailAttachment>', :'headers' => :'Object', :'attributes' => :'Object', :'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_email.rb, line 149 def ==(o) return true if self.equal?(o) self.class == o.class && email_to == o.email_to && email_bcc == o.email_bcc && email_cc == o.email_cc && reply_to == o.reply_to && attachment_url == o.attachment_url && attachment == o.attachment && headers == o.headers && attributes == o.attributes && 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_email.rb, line 199 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_email.rb, line 265 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_email.rb, line 178 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_email.rb, line 165 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_email.rb, line 171 def hash [email_to, email_bcc, email_cc, reply_to, attachment_url, attachment, headers, attributes, 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_email.rb, line 131 def list_invalid_properties invalid_properties = Array.new if @email_to.nil? invalid_properties.push('invalid value for "email_to", email_to cannot be nil.') end 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_email.rb, line 251 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_email.rb, line 239 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_email.rb, line 142 def valid? return false if @email_to.nil? true end