Documentation

SendEmailOptions
in package

MailSlurp

implements ModelInterface, ArrayAccess, JsonSerializable

SendEmailOptions Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

DISCRIMINATOR = null
SEND_STRATEGY_SINGLE_MESSAGE = 'SINGLE_MESSAGE'
VALIDATE_EMAIL_ADDRESSES_NO_VALIDATION = 'NO_VALIDATION'
VALIDATE_EMAIL_ADDRESSES_VALIDATE_ERROR_IF_INVALID = 'VALIDATE_ERROR_IF_INVALID'
VALIDATE_EMAIL_ADDRESSES_VALIDATE_FILTER_REMOVE_INVALID = 'VALIDATE_FILTER_REMOVE_INVALID'
$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$openAPIFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$openAPIModelName : string: The original name of the model.
$openAPINullables : array<string|int, mixed>: Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull : array<string|int, mixed>: If a nullable field gets set to null, insert it here
$openAPITypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)
__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getAddTrackingPixel() : bool|null: Gets add_tracking_pixel
getAttachments() : array<string|int, string>|null: Gets attachments
getBcc() : array<string|int, string>|null: Gets bcc
getBody() : string|null: Gets body
getBodyParts() : array<string|int, SendEmailBodyPart>|null: Gets body_parts
getCc() : array<string|int, string>|null: Gets cc
getCharset() : string|null: Gets charset
getCustomHeaders() : array<string, string>|null: Gets custom_headers
getFilterBouncedRecipients() : bool|null: Gets filter_bounced_recipients
getFrom() : string|null: Gets from
getHtml() : bool|null: Gets html
getIgnoreEmptyRecipients() : bool|null: Gets ignore_empty_recipients
getIsHtml() : bool|null: Gets is_html
getIsXAmpHtml() : bool|null: Gets is_x_amp_html
getModelName() : string: The original name of the model.
getReplyTo() : string|null: Gets reply_to
getSendStrategy() : string|null: Gets send_strategy
getSendStrategyAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getSubject() : string|null: Gets subject
getTemplate() : string|null: Gets template
getTemplateVariables() : array<string, object>|null: Gets template_variables
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTo() : array<string|int, string>|null: Gets to
getToContacts() : array<string|int, string>|null: Gets to_contacts
getToGroup() : string|null: Gets to_group
getUseInboxName() : bool|null: Gets use_inbox_name
getValidateEmailAddresses() : string|null: Gets validate_email_addresses
getValidateEmailAddressesAllowableValues() : array<string|int, string>: Gets allowable values of the enum
isNullable() : bool: Checks if a property is nullable
isNullableSetToNull() : bool: Checks if a nullable property is set to null.
jsonSerialize() : mixed: Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed|null: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
openAPIFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
openAPITypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
setAddTrackingPixel() : self: Sets add_tracking_pixel
setAttachments() : self: Sets attachments
setBcc() : self: Sets bcc
setBody() : self: Sets body
setBodyParts() : self: Sets body_parts
setCc() : self: Sets cc
setCharset() : self: Sets charset
setCustomHeaders() : self: Sets custom_headers
setFilterBouncedRecipients() : self: Sets filter_bounced_recipients
setFrom() : self: Sets from
setHtml() : self: Sets html
setIgnoreEmptyRecipients() : self: Sets ignore_empty_recipients
setIsHtml() : self: Sets is_html
setIsXAmpHtml() : self: Sets is_x_amp_html
setReplyTo() : self: Sets reply_to
setSendStrategy() : self: Sets send_strategy
setSubject() : self: Sets subject
setTemplate() : self: Sets template
setTemplateVariables() : self: Sets template_variables
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTo() : self: Sets to
setToContacts() : self: Sets to_contacts
setToGroup() : self: Sets to_group
setUseInboxName() : self: Sets use_inbox_name
setValidateEmailAddresses() : self: Sets validate_email_addresses
toHeaderValue() : string: Gets a header-safe presentation of the object
valid() : bool: Validate all the properties in the model return true if all passed
openAPINullables() : array<string|int, mixed>: Array of nullable properties
getOpenAPINullablesSetToNull() : array<string|int, bool>: Array of nullable field names deliberately set to null
setIfExists() : void: Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull() : void: Setter - Array of nullable field names deliberately set to null

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

SEND_STRATEGY_SINGLE_MESSAGE


    public
        mixed
    SEND_STRATEGY_SINGLE_MESSAGE
    = 'SINGLE_MESSAGE'

VALIDATE_EMAIL_ADDRESSES_NO_VALIDATION


    public
        mixed
    VALIDATE_EMAIL_ADDRESSES_NO_VALIDATION
    = 'NO_VALIDATION'

VALIDATE_EMAIL_ADDRESSES_VALIDATE_ERROR_IF_INVALID


    public
        mixed
    VALIDATE_EMAIL_ADDRESSES_VALIDATE_ERROR_IF_INVALID
    = 'VALIDATE_ERROR_IF_INVALID'

VALIDATE_EMAIL_ADDRESSES_VALIDATE_FILTER_REMOVE_INVALID


    public
        mixed
    VALIDATE_EMAIL_ADDRESSES_VALIDATE_FILTER_REMOVE_INVALID
    = 'VALIDATE_FILTER_REMOVE_INVALID'

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


    protected
    static    array<string|int, string>
    $attributeMap
     = ['to_contacts' => 'toContacts', 'to_group' => 'toGroup', 'to' => 'to', 'from' => 'from', 'cc' => 'cc', 'bcc' => 'bcc', 'subject' => 'subject', 'reply_to' => 'replyTo', 'custom_headers' => 'customHeaders', 'body' => 'body', 'html' => 'html', 'is_html' => 'isHTML', 'charset' => 'charset', 'attachments' => 'attachments', 'template_variables' => 'templateVariables', 'template' => 'template', 'send_strategy' => 'sendStrategy', 'use_inbox_name' => 'useInboxName', 'add_tracking_pixel' => 'addTrackingPixel', 'filter_bounced_recipients' => 'filterBouncedRecipients', 'validate_email_addresses' => 'validateEmailAddresses', 'ignore_empty_recipients' => 'ignoreEmptyRecipients', 'is_x_amp_html' => 'isXAmpHtml', 'body_parts' => 'bodyParts']

$container

Associative array for storing property values


    protected
        array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


    protected
    static    array<string|int, string>
    $getters
     = ['to_contacts' => 'getToContacts', 'to_group' => 'getToGroup', 'to' => 'getTo', 'from' => 'getFrom', 'cc' => 'getCc', 'bcc' => 'getBcc', 'subject' => 'getSubject', 'reply_to' => 'getReplyTo', 'custom_headers' => 'getCustomHeaders', 'body' => 'getBody', 'html' => 'getHtml', 'is_html' => 'getIsHtml', 'charset' => 'getCharset', 'attachments' => 'getAttachments', 'template_variables' => 'getTemplateVariables', 'template' => 'getTemplate', 'send_strategy' => 'getSendStrategy', 'use_inbox_name' => 'getUseInboxName', 'add_tracking_pixel' => 'getAddTrackingPixel', 'filter_bounced_recipients' => 'getFilterBouncedRecipients', 'validate_email_addresses' => 'getValidateEmailAddresses', 'ignore_empty_recipients' => 'getIgnoreEmptyRecipients', 'is_x_amp_html' => 'getIsXAmpHtml', 'body_parts' => 'getBodyParts']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['to_contacts' => 'uuid', 'to_group' => 'uuid', 'to' => null, 'from' => null, 'cc' => null, 'bcc' => null, 'subject' => null, 'reply_to' => null, 'custom_headers' => null, 'body' => null, 'html' => null, 'is_html' => null, 'charset' => null, 'attachments' => null, 'template_variables' => null, 'template' => 'uuid', 'send_strategy' => null, 'use_inbox_name' => null, 'add_tracking_pixel' => null, 'filter_bounced_recipients' => null, 'validate_email_addresses' => null, 'ignore_empty_recipients' => null, 'is_x_amp_html' => null, 'body_parts' => null]

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'SendEmailOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, mixed>
    $openAPINullables
     = ['to_contacts' => true, 'to_group' => true, 'to' => true, 'from' => true, 'cc' => true, 'bcc' => true, 'subject' => true, 'reply_to' => true, 'custom_headers' => true, 'body' => true, 'html' => true, 'is_html' => true, 'charset' => true, 'attachments' => true, 'template_variables' => true, 'template' => true, 'send_strategy' => true, 'use_inbox_name' => true, 'add_tracking_pixel' => true, 'filter_bounced_recipients' => true, 'validate_email_addresses' => true, 'ignore_empty_recipients' => true, 'is_x_amp_html' => true, 'body_parts' => true]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here


    protected
        array<string|int, mixed>
    $openAPINullablesSetToNull
     = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $openAPITypes
     = ['to_contacts' => 'string[]', 'to_group' => 'string', 'to' => 'string[]', 'from' => 'string', 'cc' => 'string[]', 'bcc' => 'string[]', 'subject' => 'string', 'reply_to' => 'string', 'custom_headers' => 'array<string,string>', 'body' => 'string', 'html' => 'bool', 'is_html' => 'bool', 'charset' => 'string', 'attachments' => 'string[]', 'template_variables' => 'array<string,object>', 'template' => 'string', 'send_strategy' => 'string', 'use_inbox_name' => 'bool', 'add_tracking_pixel' => 'bool', 'filter_bounced_recipients' => 'bool', 'validate_email_addresses' => 'string', 'ignore_empty_recipients' => 'bool', 'is_x_amp_html' => 'bool', 'body_parts' => '\\MailSlurp\\Models\\SendEmailBodyPart[]']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['to_contacts' => 'setToContacts', 'to_group' => 'setToGroup', 'to' => 'setTo', 'from' => 'setFrom', 'cc' => 'setCc', 'bcc' => 'setBcc', 'subject' => 'setSubject', 'reply_to' => 'setReplyTo', 'custom_headers' => 'setCustomHeaders', 'body' => 'setBody', 'html' => 'setHtml', 'is_html' => 'setIsHtml', 'charset' => 'setCharset', 'attachments' => 'setAttachments', 'template_variables' => 'setTemplateVariables', 'template' => 'setTemplate', 'send_strategy' => 'setSendStrategy', 'use_inbox_name' => 'setUseInboxName', 'add_tracking_pixel' => 'setAddTrackingPixel', 'filter_bounced_recipients' => 'setFilterBouncedRecipients', 'validate_email_addresses' => 'setValidateEmailAddresses', 'ignore_empty_recipients' => 'setIgnoreEmptyRecipients', 'is_x_amp_html' => 'setIsXAmpHtml', 'body_parts' => 'setBodyParts']

__construct()

Constructor


    public
                    __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__toString()

Gets the string presentation of the object


    public
                    __toString() : string

Return values

string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static        attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getAddTrackingPixel()

Gets add_tracking_pixel


    public
                    getAddTrackingPixel() : bool|null

Return values

bool|null —

getAttachments()

Gets attachments


    public
                    getAttachments() : array<string|int, string>|null

Return values

array<string|int, string>|null —

getBcc()

Gets bcc


    public
                    getBcc() : array<string|int, string>|null

Return values

array<string|int, string>|null —

getBody()

Gets body


    public
                    getBody() : string|null

Return values

string|null —

getBodyParts()

Gets body_parts


    public
                    getBodyParts() : array<string|int, SendEmailBodyPart>|null

Return values

array<string|int, SendEmailBodyPart>|null —

getCc()

Gets cc


    public
                    getCc() : array<string|int, string>|null

Return values

array<string|int, string>|null —

getCharset()

Gets charset


    public
                    getCharset() : string|null

Return values

string|null —

getCustomHeaders()

Gets custom_headers


    public
                    getCustomHeaders() : array<string, string>|null

Return values

array<string, string>|null —

getFilterBouncedRecipients()

Gets filter_bounced_recipients


    public
                    getFilterBouncedRecipients() : bool|null

Return values

bool|null —

getFrom()

Gets from


    public
                    getFrom() : string|null

Return values

string|null —

getHtml()

Gets html


    public
                    getHtml() : bool|null

Return values

bool|null —

getIgnoreEmptyRecipients()

Gets ignore_empty_recipients


    public
                    getIgnoreEmptyRecipients() : bool|null

Return values

bool|null —

getIsHtml()

Gets is_html


    public
                    getIsHtml() : bool|null

Return values

bool|null —

getIsXAmpHtml()

Gets is_x_amp_html


    public
                    getIsXAmpHtml() : bool|null

Return values

bool|null —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getReplyTo()

Gets reply_to


    public
                    getReplyTo() : string|null

Return values

string|null —

getSendStrategy()

Gets send_strategy


    public
                    getSendStrategy() : string|null

Return values

string|null —

getSendStrategyAllowableValues()

Gets allowable values of the enum


    public
                    getSendStrategyAllowableValues() : array<string|int, string>

Return values

array<string|int, string> —

getSubject()

Gets subject


    public
                    getSubject() : string|null

Return values

string|null —

getTemplate()

Gets template


    public
                    getTemplate() : string|null

Return values

string|null —

getTemplateVariables()

Gets template_variables


    public
                    getTemplateVariables() : array<string, object>|null

Return values

array<string, object>|null —

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static        getters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getTo()

Gets to


    public
                    getTo() : array<string|int, string>|null

Return values

array<string|int, string>|null —

getToContacts()

Gets to_contacts


    public
                    getToContacts() : array<string|int, string>|null

Return values

array<string|int, string>|null —

getToGroup()

Gets to_group


    public
                    getToGroup() : string|null

Return values

string|null —

getUseInboxName()

Gets use_inbox_name


    public
                    getUseInboxName() : bool|null

Return values

bool|null —

getValidateEmailAddresses()

Gets validate_email_addresses


    public
                    getValidateEmailAddresses() : string|null

Return values

string|null —

getValidateEmailAddressesAllowableValues()

Gets allowable values of the enum


    public
                    getValidateEmailAddressesAllowableValues() : array<string|int, string>

Return values

array<string|int, string> —

isNullable()

Checks if a property is nullable


    public
            static        isNullable(string $property) : bool

Parameters

$property : string

Return values

bool —

isNullableSetToNull()

Checks if a nullable property is set to null.


    public
                    isNullableSetToNull(string $property) : bool

Parameters

$property : string

Return values

bool —

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().


    public
                    jsonSerialize() : mixed

Return values

mixed —

Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                    listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                    offsetExists(int $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                    offsetGet(int $offset) : mixed|null

Parameters

$offset : int: Offset

Return values

mixed|null —

offsetSet()

Sets value based on offset.


    public
                    offsetSet(int|null $offset, mixed $value) : void

Parameters

$offset : int|null: Offset
$value : mixed: Value to be set

Return values

void —

offsetUnset()

Unsets offset.


    public
                    offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

openAPIFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static        openAPIFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

openAPITypes()

Array of property to type mappings. Used for (de)serialization


    public
            static        openAPITypes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setAddTrackingPixel()

Sets add_tracking_pixel


    public
                    setAddTrackingPixel(bool|null $add_tracking_pixel) : self

Parameters

$add_tracking_pixel : bool|null: Add tracking pixel to email

Return values

self —

setAttachments()

Sets attachments


    public
                    setAttachments(array<string|int, string>|null $attachments) : self

Parameters

$attachments : array<string|int, string>|null: 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.

Return values

self —

setBcc()

Sets bcc


    public
                    setBcc(array<string|int, string>|null $bcc) : self

Parameters

$bcc : array<string|int, string>|null: Optional list of bcc destination email addresses

Return values

self —

setBody()

Sets body


    public
                    setBody(string|null $body) : self

Parameters

$body : string|null: 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.

Return values

self —

setBodyParts()

Sets body_parts


    public
                    setBodyParts(array<string|int, SendEmailBodyPart>|null $body_parts) : self

Parameters

$body_parts : array<string|int, SendEmailBodyPart>|null: Email body content parts for multipart mime message. Will override body.

Return values

self —

setCc()

Sets cc


    public
                    setCc(array<string|int, string>|null $cc) : self

Parameters

$cc : array<string|int, string>|null: Optional list of cc destination email addresses

Return values

self —

setCharset()

Sets charset


    public
                    setCharset(string|null $charset) : self

Parameters

$charset : string|null: Optional charset

Return values

self —

setCustomHeaders()

Sets custom_headers


    public
                    setCustomHeaders(array<string, string>|null $custom_headers) : self

Parameters

$custom_headers : array<string, string>|null: Optional custom headers

Return values

self —

setFilterBouncedRecipients()

Sets filter_bounced_recipients


    public
                    setFilterBouncedRecipients(bool|null $filter_bounced_recipients) : self

Parameters

$filter_bounced_recipients : bool|null: Filter recipients to remove any bounced recipients from to, bcc, and cc before sending

Return values

self —

setFrom()

Sets from


    public
                    setFrom(string|null $from) : self

Parameters

$from : string|null: 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.

Return values

self —

setHtml()

Sets html


    public
                    setHtml(bool|null $html) : self

Parameters

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

Return values

self —

setIgnoreEmptyRecipients()

Sets ignore_empty_recipients


    public
                    setIgnoreEmptyRecipients(bool|null $ignore_empty_recipients) : self

Parameters

$ignore_empty_recipients : bool|null: Ignore empty recipients after validation removes all recipients as invalid and fail silently

Return values

self —

setIsHtml()

Sets is_html


    public
                    setIsHtml(bool|null $is_html) : self

Parameters

$is_html : bool|null: 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

Return values

self —

setIsXAmpHtml()

Sets is_x_amp_html


    public
                    setIsXAmpHtml(bool|null $is_x_amp_html) : self

Parameters

$is_x_amp_html : bool|null: Is content AMP4EMAIL compatible. If set will send as x-amp-html part.

Return values

self —

setReplyTo()

Sets reply_to


    public
                    setReplyTo(string|null $reply_to) : self

Parameters

$reply_to : string|null: Optional replyTo header

Return values

self —

setSendStrategy()

Sets send_strategy


    public
                    setSendStrategy(string|null $send_strategy) : self

Parameters

$send_strategy : string|null: How an email should be sent based on its recipients

Return values

self —

setSubject()

Sets subject


    public
                    setSubject(string|null $subject) : self

Parameters

$subject : string|null: Optional email subject line

Return values

self —

setTemplate()

Sets template


    public
                    setTemplate(string|null $template) : self

Parameters

$template : string|null: 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.

Return values

self —

setTemplateVariables()

Sets template_variables


    public
                    setTemplateVariables(array<string, object>|null $template_variables) : self

Parameters

$template_variables : array<string, object>|null: Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.

Return values

self —

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static        setters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setTo()

Sets to


    public
                    setTo(array<string|int, string>|null $to) : self

Parameters

$to : array<string|int, string>|null: 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.

Return values

self —

setToContacts()

Sets to_contacts


    public
                    setToContacts(array<string|int, string>|null $to_contacts) : self

Parameters

$to_contacts : array<string|int, string>|null: 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.

Return values

self —

setToGroup()

Sets to_group


    public
                    setToGroup(string|null $to_group) : self

Parameters

$to_group : string|null: 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

Return values

self —

setUseInboxName()

Sets use_inbox_name


    public
                    setUseInboxName(bool|null $use_inbox_name) : self

Parameters

$use_inbox_name : bool|null: 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.

Return values

self —

setValidateEmailAddresses()

Sets validate_email_addresses


    public
                    setValidateEmailAddresses(string|null $validate_email_addresses) : self

Parameters

$validate_email_addresses : string|null: Validate recipient email addresses before sending

Return values

self —

toHeaderValue()

Gets a header-safe presentation of the object


    public
                    toHeaderValue() : string

Return values

string —

valid()

Validate all the properties in the model return true if all passed


    public
                    valid() : bool

Return values

bool —

True if all properties are valid

openAPINullables()

Array of nullable properties


    protected
            static        openAPINullables() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null


    private
                    getOpenAPINullablesSetToNull() : array<string|int, bool>

Return values

array<string|int, bool> —

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array


    private
                    setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void

Parameters

$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

Return values

void —

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null


    private
                    setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void

Parameters

$openAPINullablesSetToNull : array<string|int, bool>

Return values

void —

SendEmailOptions in package MailSlurp implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

SEND_STRATEGY_SINGLE_MESSAGE

VALIDATE_EMAIL_ADDRESSES_NO_VALIDATION

VALIDATE_EMAIL_ADDRESSES_VALIDATE_ERROR_IF_INVALID

VALIDATE_EMAIL_ADDRESSES_VALIDATE_FILTER_REMOVE_INVALID

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAddTrackingPixel()

Return values

getAttachments()

Return values

getBcc()

Return values

getBody()

Return values

getBodyParts()

Return values

getCc()

Return values

getCharset()

Return values

getCustomHeaders()

Return values

getFilterBouncedRecipients()

Return values

getFrom()

Return values

getHtml()

Return values

getIgnoreEmptyRecipients()

Return values

getIsHtml()

Return values

getIsXAmpHtml()

Return values

getModelName()

Return values

getReplyTo()

Return values

getSendStrategy()

Return values

getSendStrategyAllowableValues()

Return values

getSubject()

Return values

getTemplate()

Return values

getTemplateVariables()

Return values

getters()

Return values

getTo()

Return values

getToContacts()

Return values

getToGroup()

Return values

getUseInboxName()

SendEmailOptions
in package

MailSlurp

implements ModelInterface, ArrayAccess, JsonSerializable