class MailSlurpClient::SendEmailOptions

Options for sending an email message from an inbox. You must provide one of: `to`, `toGroup`, or `toContacts` to send an email. All other parameters are optional.

Attributes

add_tracking_pixel[RW]

Add tracking pixel to email

attachments[RW]

Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods.

bcc[RW]

Optional list of bcc destination email addresses

body[RW]

Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body.

cc[RW]

Optional list of cc destination email addresses

charset[RW]

Optional charset

from[RW]

Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used.

html[RW]

Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.)

is_html[RW]

Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients

reply_to[RW]

Optional replyTo header

send_strategy[RW]

Optional strategy to use when sending the email

subject[RW]

Optional email subject line

template[RW]

Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.

template_variables[RW]

Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.

to[RW]

List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing.

to_contacts[RW]

Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients.

to_group[RW]

Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients

use_inbox_name[RW]

Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/mailslurp_client/models/send_email_options.rb, line 95
def self.attribute_map
  {
    :'add_tracking_pixel' => :'addTrackingPixel',
    :'attachments' => :'attachments',
    :'bcc' => :'bcc',
    :'body' => :'body',
    :'cc' => :'cc',
    :'charset' => :'charset',
    :'from' => :'from',
    :'html' => :'html',
    :'is_html' => :'isHTML',
    :'reply_to' => :'replyTo',
    :'send_strategy' => :'sendStrategy',
    :'subject' => :'subject',
    :'template' => :'template',
    :'template_variables' => :'templateVariables',
    :'to' => :'to',
    :'to_contacts' => :'toContacts',
    :'to_group' => :'toGroup',
    :'use_inbox_name' => :'useInboxName'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/mailslurp_client/models/send_email_options.rb, line 311
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/mailslurp_client/models/send_email_options.rb, line 150
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::SendEmailOptions` 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 `MailSlurpClient::SendEmailOptions`. 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?(:'add_tracking_pixel')
    self.add_tracking_pixel = attributes[:'add_tracking_pixel']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'use_inbox_name')
    self.use_inbox_name = attributes[:'use_inbox_name']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/mailslurp_client/models/send_email_options.rb, line 143
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/mailslurp_client/models/send_email_options.rb, line 119
def self.openapi_types
  {
    :'add_tracking_pixel' => :'Boolean',
    :'attachments' => :'Array<String>',
    :'bcc' => :'Array<String>',
    :'body' => :'String',
    :'cc' => :'Array<String>',
    :'charset' => :'String',
    :'from' => :'String',
    :'html' => :'Boolean',
    :'is_html' => :'Boolean',
    :'reply_to' => :'String',
    :'send_strategy' => :'String',
    :'subject' => :'String',
    :'template' => :'String',
    :'template_variables' => :'Object',
    :'to' => :'Array<String>',
    :'to_contacts' => :'Array<String>',
    :'to_group' => :'String',
    :'use_inbox_name' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/mailslurp_client/models/send_email_options.rb, line 273
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      add_tracking_pixel == o.add_tracking_pixel &&
      attachments == o.attachments &&
      bcc == o.bcc &&
      body == o.body &&
      cc == o.cc &&
      charset == o.charset &&
      from == o.from &&
      html == o.html &&
      is_html == o.is_html &&
      reply_to == o.reply_to &&
      send_strategy == o.send_strategy &&
      subject == o.subject &&
      template == o.template &&
      template_variables == o.template_variables &&
      to == o.to &&
      to_contacts == o.to_contacts &&
      to_group == o.to_group &&
      use_inbox_name == o.use_inbox_name
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/mailslurp_client/models/send_email_options.rb, line 339
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
    MailSlurpClient.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/mailslurp_client/models/send_email_options.rb, line 408
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/mailslurp_client/models/send_email_options.rb, line 318
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/mailslurp_client/models/send_email_options.rb, line 298
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/mailslurp_client/models/send_email_options.rb, line 304
def hash
  [add_tracking_pixel, attachments, bcc, body, cc, charset, from, html, is_html, reply_to, send_strategy, subject, template, template_variables, to, to_contacts, to_group, use_inbox_name].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/mailslurp_client/models/send_email_options.rb, line 248
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
send_strategy=(send_strategy) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] send_strategy Object to be assigned

# File lib/mailslurp_client/models/send_email_options.rb, line 263
def send_strategy=(send_strategy)
  validator = EnumAttributeValidator.new('String', ["SINGLE_MESSAGE"])
  unless validator.valid?(send_strategy)
    fail ArgumentError, "invalid value for \"send_strategy\", must be one of #{validator.allowable_values}."
  end
  @send_strategy = send_strategy
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/mailslurp_client/models/send_email_options.rb, line 384
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/mailslurp_client/models/send_email_options.rb, line 390
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/mailslurp_client/models/send_email_options.rb, line 378
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/mailslurp_client/models/send_email_options.rb, line 255
def valid?
  send_strategy_validator = EnumAttributeValidator.new('String', ["SINGLE_MESSAGE"])
  return false unless send_strategy_validator.valid?(@send_strategy)
  true
end