Class CEmailLogRoute

CEmailLogRoute sends selected log messages to email addresses.

The target email addresses may be specified via setEmails emails property. Optionally, you may set the email setSubject subject, the setSentFrom sentFrom address and any additional setHeaders headers.

CComponent

CLogRoute

CEmailLogRoute

Package: system\logging
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/logging/CEmailLogRoute.php

Methods summary
`protected`	# `processLogs( array $logs )` Sends log messages to specified email addresses. Sends log messages to specified email addresses. Parameters `$logs` `array` $logs list of log messages
`protected`	# `sendEmail( string $email, string $subject, string $message )` Sends an email. Sends an email. Parameters `$email` `string` $email single email address `$subject` `string` $subject email subject `$message` `string` $message email content
`public array`	# `getEmails( )` Returns `array` list of destination email addresses
`public`	# `setEmails( mixed $value )` Parameters `$value` `mixed` $value list of destination email addresses. If the value is a string, it is assumed to be comma-separated email addresses.
`public string`	# `getSubject( )` Returns `string` email subject. Defaults to CEmailLogRoute::DEFAULT_SUBJECT
`public`	# `setSubject( string $value )` Parameters `$value` `string` $value email subject.
`public string`	# `getSentFrom( )` Returns `string` send from address of the email
`public`	# `setSentFrom( string $value )` Parameters `$value` `string` $value send from address of the email
`public array`	# `getHeaders( )` Returns `array` additional headers to use when sending an email. Since 1.1.4
`public`	# `setHeaders( mixed $value )` Parameters `$value` `mixed` $value list of additional headers to use when sending an email. If the value is a string, it is assumed to be line break separated headers. Since 1.1.4

Methods inherited from CLogRoute
`collectLogs(), formatLogMessage(), init()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public boolean`	`$utf8`	`false`	# set this property to true value in case log data you're going to send through emails contains non-latin or UTF-8 characters. Emails would be UTF-8 encoded. set this property to true value in case log data you're going to send through emails contains non-latin or UTF-8 characters. Emails would be UTF-8 encoded. Since 1.1.13

Properties inherited from CLogRoute
`$categories, $enabled, $except, $filter, $levels, $logs`

Magic properties summary
`public array`	`$emails`	# List of destination email addresses. List of destination email addresses.
`public string`	`$subject`	# Email subject. Defaults to CEmailLogRoute::DEFAULT_SUBJECT. Email subject. Defaults to CEmailLogRoute::DEFAULT_SUBJECT.
`public string`	`$sentFrom`	# Send from address of the email. Send from address of the email.
`public array`	`$headers`	# Additional headers to use when sending an email. Additional headers to use when sending an email.

Packages

Classes

Interfaces

Class CEmailLogRoute

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Since

Parameters

Since

Since