PHP Класс Pimcore\Model\Document\Email

Наследование: extends PageSnippet
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$bcc string Contains the blind carbon copy recipients
$cc string Contains the carbon copy recipients
$from string Contains the from email address
$subject string Contains the email subject
$to string Contains the email addresses of the recipients
$type string Static type of the document

Открытые методы

Метод Описание
getBcc ( ) : string Returns the blind carbon copy receivers
getBccAsArray ( ) : array Returns the blind carbon copy receivers as array
getCc ( ) : string Returns the carbon copy receivers
getCcAsArray ( ) : array Returns the carbon copy receivers as array
getFrom ( ) : string Returns the "from" email address
getFromAsArray ( ) : array Returns the "from" email address as array
getSubject ( ) : string Returns the email subject
getTo ( ) : string Returns the "to" receivers
getToAsArray ( ) : array Returns the "to" receivers as array
setBcc ( string $bcc ) Sets the blind carbon copy receivers (multiple receivers should be separated with a ",")
setCc ( string $cc ) Sets the carbon copy receivers (multiple receivers should be separated with a ",")
setFrom ( string $from ) Sets the "from" email address
setSubject ( string $subject ) Contains the email subject
setTo ( string $to ) Sets the "to" receiver
validateEmailAddress ( $emailAddress ) : string | null Helper to validate a email address

Защищенные методы

Метод Описание
getAsArray ( $key ) : array Helper to return receivers as array

Описание методов

getAsArray() защищенный метод

Helper to return receivers as array
protected getAsArray ( $key ) : array
$key
Результат array

getBcc() публичный метод

Returns the blind carbon copy receivers
public getBcc ( ) : string
Результат string

getBccAsArray() публичный метод

Returns the blind carbon copy receivers as array
public getBccAsArray ( ) : array
Результат array

getCc() публичный метод

Returns the carbon copy receivers
public getCc ( ) : string
Результат string

getCcAsArray() публичный метод

Returns the carbon copy receivers as array
public getCcAsArray ( ) : array
Результат array

getFrom() публичный метод

Returns the "from" email address
public getFrom ( ) : string
Результат string

getFromAsArray() публичный метод

Returns the "from" email address as array
public getFromAsArray ( ) : array
Результат array

getSubject() публичный метод

Returns the email subject
public getSubject ( ) : string
Результат string

getTo() публичный метод

Returns the "to" receivers
public getTo ( ) : string
Результат string

getToAsArray() публичный метод

Returns the "to" receivers as array
public getToAsArray ( ) : array
Результат array

setBcc() публичный метод

Sets the blind carbon copy receivers (multiple receivers should be separated with a ",")
public setBcc ( string $bcc )
$bcc string

setCc() публичный метод

Sets the carbon copy receivers (multiple receivers should be separated with a ",")
public setCc ( string $cc )
$cc string

setFrom() публичный метод

Sets the "from" email address
public setFrom ( string $from )
$from string

setSubject() публичный метод

Contains the email subject
public setSubject ( string $subject )
$subject string

setTo() публичный метод

Sets the "to" receiver
public setTo ( string $to )
$to string

validateEmailAddress() публичный статический метод

Helper to validate a email address
public static validateEmailAddress ( $emailAddress ) : string | null
$emailAddress
Результат string | null | null - returns "null" if the email address is invalid otherwise the email address is returned

Описание свойств

$bcc публичное свойство

Contains the blind carbon copy recipients
public string $bcc
Результат string

$cc публичное свойство

Contains the carbon copy recipients
public string $cc
Результат string

$from публичное свойство

Contains the from email address
public string $from
Результат string

$subject публичное свойство

Contains the email subject
public string $subject
Результат string

$to публичное свойство

Contains the email addresses of the recipients
public string $to
Результат string

$type публичное свойство

Static type of the document
public string $type
Результат string