Documentation

EmailSettings
in package
implements ModelInterface, ArrayAccess

EmailSettings Class Doc Comment

Tags
category

Class

description

A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. IMPORTANT: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.

author

Swagger Codegen team apihelp@docusign.com

license

The Docusign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__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
getBccEmailAddresses()  : array<string|int, BccEmailAddress>
Gets bcc_email_addresses
getModelName()  : string
The original name of the model.
getReplyEmailAddressOverride()  : string|null
Gets reply_email_address_override
getReplyEmailNameOverride()  : string|null
Gets reply_email_name_override
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setBccEmailAddresses()  : $this
Sets bcc_email_addresses
setReplyEmailAddressOverride()  : $this
Sets reply_email_address_override
setReplyEmailNameOverride()  : $this
Sets reply_email_name_override
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$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 = ['bcc_email_addresses' => 'bccEmailAddresses', 'reply_email_address_override' => 'replyEmailAddressOverride', 'reply_email_name_override' => 'replyEmailNameOverride']

$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 = ['bcc_email_addresses' => 'getBccEmailAddresses', 'reply_email_address_override' => 'getReplyEmailAddressOverride', 'reply_email_name_override' => 'getReplyEmailNameOverride']

$setters

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

protected static array<string|int, string> $setters = ['bcc_email_addresses' => 'setBccEmailAddresses', 'reply_email_address_override' => 'setReplyEmailAddressOverride', 'reply_email_name_override' => 'setReplyEmailNameOverride']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['bcc_email_addresses' => null, 'reply_email_address_override' => null, 'reply_email_name_override' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'emailSettings'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['bcc_email_addresses' => '\\DocuSign\\eSign\\Model\\BccEmailAddress[]', 'reply_email_address_override' => '?string', 'reply_email_name_override' => '?string']

Methods

__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> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getReplyEmailAddressOverride()

Gets reply_email_address_override

public getReplyEmailAddressOverride() : string|null
Return values
string|null —

getReplyEmailNameOverride()

Gets reply_email_name_override

public getReplyEmailNameOverride() : string|null
Return values
string|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> —

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
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

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

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 —

setBccEmailAddresses()

Sets bcc_email_addresses

public setBccEmailAddresses(array<string|int, BccEmailAddress> $bcc_email_addresses) : $this
Parameters
$bcc_email_addresses : array<string|int, BccEmailAddress>

A list of email addresses that receive a copy of all email communications for an envelope. You can use this for archiving purposes.

Return values
$this —

setReplyEmailAddressOverride()

Sets reply_email_address_override

public setReplyEmailAddressOverride(string|null $reply_email_address_override) : $this
Parameters
$reply_email_address_override : string|null
Return values
$this —

setReplyEmailNameOverride()

Sets reply_email_name_override

public setReplyEmailNameOverride(string|null $reply_email_name_override) : $this
Parameters
$reply_email_name_override : string|null
Return values
$this —

setters()

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

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

swaggerFormats()

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

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

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

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

Search results