• Home
• Pimcore
• Model
• Tool
• Email
• Log

PHP Class Pimcore\Model\Tool\Email\Log

Mostra file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property	Type	Description
$bcc	string	The blind carbon copy recipients (multiple recipients are separated by a ",")
$bodyHtml	string	Contains the rendered html content of the email
$bodyText	string	Contains the rendered text content of the email
$cc	string	The carbon copy recipients (multiple recipients are separated by a ",")
$documentId	integer | null	Id of the email document or null if no document was given
$emailLogExistsHtml	integer	Contains 1 if a html logfile exists and 0 if no html logfile exists
$emailLogExistsText	integer	Contains 1 if a text logfile exists and 0 if no text logfile exists
$from	string	The "from" email address
$id	integer	EmailLog Id
$modificationDate	integer	Modification date as timestamp
$params	array	Parameters passed for replacement
$requestUri	string	The request URI from were the email was sent
$sentDate	integer	Contains the timestamp when the email was sent
$subject	string	Contains the rendered subject of the email
$to	string	The "to" recipients (multiple recipients are separated by a ",")

Public Methods

Method	Description
delete ( )	Removes the log file entry from the db and removes the log files on the system
getBcc ( ) : string	Returns the blind carbon copy recipients
getBccAsArray ( ) : array	Returns the blind carbon copy recipients as array
getBodyHtml ( ) : string | null	returns the html content of the email
getBodyText ( ) : string	Returns the text version of the email
getById ( integer $id ) : EmailLog | null	Returns the EmailLog entry by the given id
getCc ( ) : string	Returns the carbon copy recipients
getCcAsArray ( ) : array	Returns the carbon copy recipients as array
getCreationDate ( ) : integer	Returns the creation date as unix timestamp
getDocumentId ( ) : integer | null	Returns the email document id
getEmailLogExistsHtml ( ) : integer	Returns 1 if a html email log file exists and 0 if no html log file exists
getEmailLogExistsText ( ) : integer	Returns 1 if a text email log file exists and 0 if no text log file exists
getFrom ( ) : string	Returns the "from" email address
getHtmlLog ( ) : string | false	Returns the content of the html log file
getId ( ) : integer	Returns the email log id
getModificationDate ( ) : integer	Returns the modification date
getParams ( ) : string	Returns the dynamic parameter
getRequestUri ( ) : string	Returns the request uri
getSentDate ( ) : integer	Returns the sent date and time as unix timestamp
getSubject ( ) : string	Returns the subject
getTextLog ( ) : string | false	Returns the content of the text log file
getTo ( ) : string	Returns the "to" recipients
getToAsArray ( ) : array	Returns the "to" recipients as array
save ( )	Saves the email log entry (forwards to $this->update())
setBcc ( $bcc )
setBodyHtml ( $html )
setBodyText ( $text )
setCc ( $cc )
setCreationDate ( integer $creationDate ) : void	Sets the creation date (unix timestamp)
setDocumentId ( $id )
setEmailLogExistsHtml ( )	Checks if a html log file exits and sets $this->emailLogExistsHtml to 0 or 1
setEmailLogExistsText ( )	Checks if a text log file exits and sets $this->emailLogExistsText to 0 or 1
setFrom ( $from )
setId ( $id )
setModificationDate ( integer $modificationDate )	Sets the modification date
setParams ( $params )
setRequestUri ( $requestUri )
setSentDate ( integer $sentDate ) : void	Sets the sent date and time
setSubject ( $subject )
setTo ( $to )

Protected Methods

Method	Description
buildArray ( $data )	Helper to get the recipients as array
update ( )	Updates and save the email log entry to the db and the file-system

Method Details

Property Details