PHP Class Pimcore\Model\Document\Newsletter

Inheritance: extends PageSnippet
Datei anzeigen Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$enableTrackingParameters boolean enables adding tracking parameters to all links
$from string Contains the from email address
$sendingMode string
$subject string Contains the email subject
$trackingParameterMedium string
$trackingParameterName string
$trackingParameterSource string
$type string Static type of the document

Public Methods

Method Description
getEnableTrackingParameters ( ) : boolean
getFrom ( ) : string Returns the "from" email address
getFromAsArray ( ) : array Returns the "from" email address as array
getSendingMode ( ) : string
getSubject ( ) : string Returns the email subject
getTmpStoreId ( ) : string
getTrackingParameterMedium ( ) : string
getTrackingParameterName ( ) : string returns key by default
getTrackingParameterSource ( ) : string
setEnableTrackingParameters ( boolean $enableTrackingParameters )
setFrom ( string $from ) Sets the "from" email address
setSendingMode ( string $sendingMode )
setSubject ( string $subject ) Contains the email subject
setTrackingParameterMedium ( string $trackingParameterMedium )
setTrackingParameterName ( string $trackingParameterName )
setTrackingParameterSource ( string $trackingParameterSource )

Method Details

getEnableTrackingParameters() public method

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

getSendingMode() public method

public getSendingMode ( ) : string
return string

getSubject() public method

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

getTmpStoreId() public method

public getTmpStoreId ( ) : string
return string

getTrackingParameterMedium() public method

getTrackingParameterName() public method

returns key by default
public getTrackingParameterName ( ) : string
return string

getTrackingParameterSource() public method

setEnableTrackingParameters() public method

public setEnableTrackingParameters ( boolean $enableTrackingParameters )
$enableTrackingParameters boolean

setFrom() public method

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

setSendingMode() public method

public setSendingMode ( string $sendingMode )
$sendingMode string

setSubject() public method

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

setTrackingParameterMedium() public method

public setTrackingParameterMedium ( string $trackingParameterMedium )
$trackingParameterMedium string

setTrackingParameterName() public method

public setTrackingParameterName ( string $trackingParameterName )
$trackingParameterName string

setTrackingParameterSource() public method

public setTrackingParameterSource ( string $trackingParameterSource )
$trackingParameterSource string

Property Details

$enableTrackingParameters public_oe property

enables adding tracking parameters to all links
public bool $enableTrackingParameters
return boolean

$from public_oe property

Contains the from email address
public string $from
return string

$sendingMode public_oe property

public string $sendingMode
return string

$subject public_oe property

Contains the email subject
public string $subject
return string

$trackingParameterMedium public_oe property

public string $trackingParameterMedium
return string

$trackingParameterName public_oe property

public string $trackingParameterName
return string

$trackingParameterSource public_oe property

public string $trackingParameterSource
return string

$type public_oe property

Static type of the document
public string $type
return string