CustomFormSendMailParametersGroup
extends ParametersGroup
in package
This is the form model (send custom form mail resource) parameters group class.
Table of Contents
| $attachments | : array<string|int, mixed> | |
|---|---|---|
| $body | : string | |
| $mailAccountPId | : string | |
| $subject | : string | |
| $to | : string | |
| $validator | : ParametersValidator | |
| addAttachment() | Adds a new attachment to the array of attachments for this parameters group. | : void |
| setAttachments() | Sets an array of attachments as a parameter for this parameters group. | : void |
| setBody() | Sets the send mail body parameter for this parameters group. | : void |
| setMailAccountPId() | Sets the send mail mailAccountPId parameter for this parameters group. | : void |
| setSubject() | Sets the send mail subject parameter for this parameters group. | : void |
| setTo() | Sets the send mail to parameter for this parameters group. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : CustomFormSendMailParametersValidator |
Properties
$attachments
protected
array<string|int, mixed>
$attachments
$body
protected
string
$body
$mailAccountPId
protected
string
$mailAccountPId
$subject
protected
string
$subject
$to
protected
string
$to
$validator
protected
ParametersValidator
$validator
Methods
addAttachment()
Adds a new attachment to the array of attachments for this parameters group.
public
addAttachment(CustomFormSendMailAttachmentParametersGroup $attachment) : void
Parameters
- $attachment : CustomFormSendMailAttachmentParametersGroup
Return values
void —setAttachments()
Sets an array of attachments as a parameter for this parameters group.
public
setAttachments(array<string|int, CustomFormSendMailAttachmentParametersGroup> $attachments) : void
Parameters
- $attachments : array<string|int, CustomFormSendMailAttachmentParametersGroup>
Return values
void —setBody()
Sets the send mail body parameter for this parameters group.
public
setBody(string $body) : void
Parameters
- $body : string
Return values
void —setMailAccountPId()
Sets the send mail mailAccountPId parameter for this parameters group.
public
setMailAccountPId(string $mailAccountPId) : void
Parameters
- $mailAccountPId : string
Return values
void —setSubject()
Sets the send mail subject parameter for this parameters group.
public
setSubject(string $subject) : void
Parameters
- $subject : string
Return values
void —setTo()
Sets the send mail to parameter for this parameters group.
public
setTo(string $to) : void
Parameters
- $to : string
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
getValidator() : CustomFormSendMailParametersValidator