PHP Class Pimcore\Model\Document\Email

Inheritance: extends PageSnippet
Mostra file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$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

Public Methods

Method Description
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

Protected Methods

Method Description
getAsArray ( $key ) : array Helper to return receivers as array

Method Details

getAsArray() protected method

Helper to return receivers as array
protected getAsArray ( $key ) : array
$key
return array

getBcc() public method

Returns the blind carbon copy receivers
public getBcc ( ) : string
return string

getBccAsArray() public method

Returns the blind carbon copy receivers as array
public getBccAsArray ( ) : array
return array

getCc() public method

Returns the carbon copy receivers
public getCc ( ) : string
return string

getCcAsArray() public method

Returns the carbon copy receivers as array
public getCcAsArray ( ) : array
return array

getFrom() public method

Returns the "from" email address
public getFrom ( ) : string
return string

getFromAsArray() public method

Returns the "from" email address as array
public getFromAsArray ( ) : array
return array

getSubject() public method

Returns the email subject
public getSubject ( ) : string
return string

getTo() public method

Returns the "to" receivers
public getTo ( ) : string
return string

getToAsArray() public method

Returns the "to" receivers as array
public getToAsArray ( ) : array
return array

setBcc() public method

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

setCc() public method

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

setFrom() public method

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

setSubject() public method

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

setTo() public method

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

validateEmailAddress() public static method

Helper to validate a email address
public static validateEmailAddress ( $emailAddress ) : string | null
$emailAddress
return string | null | null - returns "null" if the email address is invalid otherwise the email address is returned

Property Details

$bcc public_oe property

Contains the blind carbon copy recipients
public string $bcc
return string

$cc public_oe property

Contains the carbon copy recipients
public string $cc
return string

$from public_oe property

Contains the from email address
public string $from
return string

$subject public_oe property

Contains the email subject
public string $subject
return string

$to public_oe property

Contains the email addresses of the recipients
public string $to
return string

$type public_oe property

Static type of the document
public string $type
return string