PHP Class Pimcore\Tool\Newsletter

Show file Open project: pimcore/pimcore Class Usage Examples

Protected Properties

Property	Type	Description
$class	Pimcore\Model\Object\ClassDefinition

Public Methods

Method	Description
__construct ( null $classId = null )
addNoteOnObject ( $object, $title )
checkParams ( array $params ) : boolean
confirm ( string $token ) : boolean
getClass ( ) : ClassDefinition
getObjectByToken ( $token ) : boolean
isEmailExists ( array $params ) : boolean	Checks if e-mail address already exists in the database.
prepareMail ( Newsletter $newsletterDocument, SendingParamContainer $sendingContainer = null, string \| null $hostUrl = null ) : Mail
sendConfirmationMail ( $object, $mailDocument, array $params = [] )
sendMail ( Pimcore\Model\Tool\Newsletter\Config $newsletter, Concrete $object, $emailAddress = null, $hostUrl = null )
sendNewsletterDocumentBasedMail ( Mail $mail, SendingParamContainer $sendingContainer )
setClass ( ClassDefinition $class )
subscribe ( $params ) : mixed
unsubscribe ( $object ) : boolean
unsubscribeByEmail ( string $email ) : boolean
unsubscribeByToken ( string $token ) : boolean

Protected Methods

Method	Description
getClassName ( ) : string
obfuscateEmail ( $email )

Method Details

__construct() public method

public __construct ( null $classId = null )
$classId	null

addNoteOnObject() public method

public addNoteOnObject ( $object, $title )
$object
$title

checkParams() public method

public checkParams ( array $params ) : boolean
$params	array
return	boolean

confirm() public method

public confirm ( string $token ) : boolean
$token	string
return	boolean

getClass() public method

public getClass ( ) : ClassDefinition
return	Pimcore\Model\Object\ClassDefinition

getClassName() protected method

protected getClassName ( ) : string
return	string

getObjectByToken() public method

public getObjectByToken ( $token ) : boolean
$token
return	boolean

isEmailExists() public method

Checks if e-mail address already exists in the database.

public isEmailExists ( array $params ) : boolean
$params	array
return	boolean

obfuscateEmail() protected static method

protected static obfuscateEmail ( $email )

prepareMail() public static method

public static prepareMail ( Newsletter $newsletterDocument, SendingParamContainer $sendingContainer = null, string \| null $hostUrl = null ) : Mail
$newsletterDocument	Pimcore\Model\Document\Newsletter
$sendingContainer	Pimcore\Document\Newsletter\SendingParamContainer
$hostUrl	string \| null
return	Pimcore\Mail

sendConfirmationMail() public method

public sendConfirmationMail ( $object, $mailDocument, array $params = [] )
$object
$mailDocument
$params	array

sendMail() public static method

public static sendMail ( Pimcore\Model\Tool\Newsletter\Config $newsletter, Concrete $object, $emailAddress = null, $hostUrl = null )
$newsletter	Pimcore\Model\Tool\Newsletter\Config
$object	Pimcore\Model\Object\Concrete

sendNewsletterDocumentBasedMail() public static method

public static sendNewsletterDocumentBasedMail ( Mail $mail, SendingParamContainer $sendingContainer )
$mail	Pimcore\Mail
$sendingContainer	Pimcore\Document\Newsletter\SendingParamContainer

setClass() public method

public setClass ( ClassDefinition $class )
$class	Pimcore\Model\Object\ClassDefinition

unsubscribe() public method

public unsubscribe ( $object ) : boolean
$object
return	boolean

unsubscribeByEmail() public method

public unsubscribeByEmail ( string $email ) : boolean
$email	string
return	boolean

unsubscribeByToken() public method

public unsubscribeByToken ( string $token ) : boolean
$token	string
return	boolean

Property Details

$class protected property

protected ClassDefinition,Pimcore\Model\Object $class
return	Pimcore\Model\Object\ClassDefinition