PHP Class Pimcore\Model\Tool\Email\Log

Inheritance: extends Pimcore\Model\AbstractModel
Datei anzeigen 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

buildArray() protected method

Helper to get the recipients as array
protected buildArray ( $data )

delete() public method

Removes the log file entry from the db and removes the log files on the system
public delete ( )

getBcc() public method

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

getBccAsArray() public method

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

getBodyHtml() public method

returns the html content of the email
public getBodyHtml ( ) : string | null
return string | null | null

getBodyText() public method

Returns the text version of the email
public getBodyText ( ) : string
return string

getById() public static method

Returns the EmailLog entry by the given id
public static getById ( integer $id ) : EmailLog | null
$id integer
return EmailLog | null

getCc() public method

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

getCcAsArray() public method

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

getCreationDate() public method

Returns the creation date as unix timestamp
public getCreationDate ( ) : integer
return integer

getDocumentId() public method

Returns the email document id
public getDocumentId ( ) : integer | null
return integer | null

getEmailLogExistsHtml() public method

Returns 1 if a html email log file exists and 0 if no html log file exists
public getEmailLogExistsHtml ( ) : integer
return integer - 0 or 1

getEmailLogExistsText() public method

Returns 1 if a text email log file exists and 0 if no text log file exists
public getEmailLogExistsText ( ) : integer
return integer - 0 or 1

getFrom() public method

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

getHtmlLog() public method

Returns the content of the html log file
public getHtmlLog ( ) : string | false
return string | false | false

getId() public method

Returns the email log id
public getId ( ) : integer
return integer

getModificationDate() public method

Returns the modification date
public getModificationDate ( ) : integer
return integer - Timestamp

getParams() public method

Returns the dynamic parameter
public getParams ( ) : string
return string

getRequestUri() public method

Returns the request uri
public getRequestUri ( ) : string
return string

getSentDate() public method

Returns the sent date and time as unix timestamp
public getSentDate ( ) : integer
return integer

getSubject() public method

Returns the subject
public getSubject ( ) : string
return string

getTextLog() public method

Returns the content of the text log file
public getTextLog ( ) : string | false
return string | false | false

getTo() public method

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

getToAsArray() public method

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

save() public method

Saves the email log entry (forwards to $this->update())
public save ( )

setBcc() public method

public setBcc ( $bcc )
$bcc

setBodyHtml() public method

public setBodyHtml ( $html )
$html

setBodyText() public method

public setBodyText ( $text )
$text

setCc() public method

public setCc ( $cc )
$cc

setCreationDate() public method

Sets the creation date (unix timestamp)
public setCreationDate ( integer $creationDate ) : void
$creationDate integer
return void

setDocumentId() public method

public setDocumentId ( $id )
$id

setEmailLogExistsHtml() public method

Checks if a html log file exits and sets $this->emailLogExistsHtml to 0 or 1

setEmailLogExistsText() public method

Checks if a text log file exits and sets $this->emailLogExistsText to 0 or 1

setFrom() public method

public setFrom ( $from )
$from

setId() public method

public setId ( $id )
$id

setModificationDate() public method

Sets the modification date
public setModificationDate ( integer $modificationDate )
$modificationDate integer

setParams() public method

public setParams ( $params )
$params

setRequestUri() public method

public setRequestUri ( $requestUri )
$requestUri

setSentDate() public method

Sets the sent date and time
public setSentDate ( integer $sentDate ) : void
$sentDate integer - Timestamp
return void

setSubject() public method

public setSubject ( $subject )
$subject

setTo() public method

public setTo ( $to )
$to

update() protected method

Updates and save the email log entry to the db and the file-system
protected update ( )

Property Details

$bcc public_oe property

The blind carbon copy recipients (multiple recipients are separated by a ",")
public string $bcc
return string

$bodyHtml public_oe property

Contains the rendered html content of the email
public string $bodyHtml
return string

$bodyText public_oe property

Contains the rendered text content of the email
public string $bodyText
return string

$cc public_oe property

The carbon copy recipients (multiple recipients are separated by a ",")
public string $cc
return string

$documentId public_oe property

Id of the email document or null if no document was given
public int|null $documentId
return integer | null

$emailLogExistsHtml public_oe property

Contains 1 if a html logfile exists and 0 if no html logfile exists
public int $emailLogExistsHtml
return integer

$emailLogExistsText public_oe property

Contains 1 if a text logfile exists and 0 if no text logfile exists
public int $emailLogExistsText
return integer

$from public_oe property

The "from" email address
public string $from
return string

$id public_oe property

EmailLog Id
public int $id
return integer

$modificationDate public_oe property

Modification date as timestamp
public int $modificationDate
return integer

$params public_oe property

Parameters passed for replacement
public array $params
return array

$requestUri public_oe property

The request URI from were the email was sent
public string $requestUri
return string

$sentDate public_oe property

Contains the timestamp when the email was sent
public int $sentDate
return integer

$subject public_oe property

Contains the rendered subject of the email
public string $subject
return string

$to public_oe property

The "to" recipients (multiple recipients are separated by a ",")
public string $to
return string