Documentation

RecipientEmailNotification
in package
implements ModelInterface, ArrayAccess

RecipientEmailNotification Class Doc Comment

Tags
category

Class

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
getEmailBody()  : string|null
Gets email_body
getEmailBodyMetadata()  : PropertyMetadata
Gets email_body_metadata
getEmailSubject()  : string|null
Gets email_subject
getEmailSubjectMetadata()  : PropertyMetadata
Gets email_subject_metadata
getModelName()  : string
The original name of the model.
getSupportedLanguage()  : string|null
Gets supported_language
getSupportedLanguageMetadata()  : PropertyMetadata
Gets supported_language_metadata
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.
setEmailBody()  : $this
Sets email_body
setEmailBodyMetadata()  : $this
Sets email_body_metadata
setEmailSubject()  : $this
Sets email_subject
setEmailSubjectMetadata()  : $this
Sets email_subject_metadata
setSupportedLanguage()  : $this
Sets supported_language
setSupportedLanguageMetadata()  : $this
Sets supported_language_metadata
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 = ['email_body' => 'emailBody', 'email_body_metadata' => 'emailBodyMetadata', 'email_subject' => 'emailSubject', 'email_subject_metadata' => 'emailSubjectMetadata', 'supported_language' => 'supportedLanguage', 'supported_language_metadata' => 'supportedLanguageMetadata']

$getters

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

protected static array<string|int, string> $getters = ['email_body' => 'getEmailBody', 'email_body_metadata' => 'getEmailBodyMetadata', 'email_subject' => 'getEmailSubject', 'email_subject_metadata' => 'getEmailSubjectMetadata', 'supported_language' => 'getSupportedLanguage', 'supported_language_metadata' => 'getSupportedLanguageMetadata']

$setters

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

protected static array<string|int, string> $setters = ['email_body' => 'setEmailBody', 'email_body_metadata' => 'setEmailBodyMetadata', 'email_subject' => 'setEmailSubject', 'email_subject_metadata' => 'setEmailSubjectMetadata', 'supported_language' => 'setSupportedLanguage', 'supported_language_metadata' => 'setSupportedLanguageMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['email_body' => null, 'email_body_metadata' => null, 'email_subject' => null, 'email_subject_metadata' => null, 'supported_language' => null, 'supported_language_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'recipientEmailNotification'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['email_body' => '?string', 'email_body_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'email_subject' => '?string', 'email_subject_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'supported_language' => '?string', 'supported_language_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata']

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 —

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

getSupportedLanguage()

Gets supported_language

public getSupportedLanguage() : 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 —

setEmailBody()

Sets email_body

public setEmailBody(string|null $email_body) : $this
Parameters
$email_body : string|null

Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters.

Return values
$this —

setEmailSubject()

Sets email_subject

public setEmailSubject(string|null $email_subject) : $this
Parameters
$email_subject : string|null

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

Return values
$this —

setEmailSubjectMetadata()

Sets email_subject_metadata

public setEmailSubjectMetadata(PropertyMetadata $email_subject_metadata) : $this
Parameters
$email_subject_metadata : PropertyMetadata

Metadata that indicates whether the emailSubject property can be edited.

Return values
$this —

setSupportedLanguage()

Sets supported_language

public setSupportedLanguage(string|null $supported_language) : $this
Parameters
$supported_language : string|null

A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).

Return values
$this —

setSupportedLanguageMetadata()

Sets supported_language_metadata

public setSupportedLanguageMetadata(PropertyMetadata $supported_language_metadata) : $this
Parameters
$supported_language_metadata : PropertyMetadata

Metadata that indicates whether the supportedLanguage property can be edited.

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