Class yii\log\EmailTarget

所有类 | 属性 | 方法

继承	yii\log\EmailTarget » yii\log\Target » yii\base\Component » yii\base\BaseObject
实现	yii\base\Configurable
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/log/EmailTarget.php

EmailTarget 将所选日志消息发送到指定的电子邮件地址。

您可以通过设置 $message 属性来配置要发送的电子邮件。您可以通过该属性设置目标电子邮件地址，主题等：

'components' => [
    'log' => [
         'targets' => [
             [
                 'class' => 'yii\log\EmailTarget',
                 'mailer' => 'mailer',
                 'levels' => ['error', 'warning'],
                 'message' => [
                     'from' => ['log@example.com'],
                     'to' => ['developer1@example.com', 'developer2@example.com'],
                     'subject' => 'Log message',
                 ],
             ],
         ],
    ],
],

在上面的 mailer 中，是发送电子邮件的组件的 ID，应该已经配置好了。

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$categories	array	需要记录的消息类别列表。默认为空，表示所有类别。您可以在类别末尾使用星号，以便可以使用该类别来匹配共享相同公共前缀的类别。例如，'yii\db*' 将匹配以 'yii\db\' 开头的类别，例如 'yii\db\Connection'。	yii\log\Target
$enabled	boolean\|callable	一个布尔值或一个可调用的函数返回值。从 2.	yii\log\Target
$except	array	需要排除的消息类别列表。默认为空，表示没有需要排除的消息。如果此属性不为空，则此处列出的任何类别都将从 $categories 中排除。您可以在类别末尾使用星号，以便该类别可用于匹配共享相同公共前缀的类别。例如，'yii\db*' 将匹配以 'yii\db\' 开头的类别，例如 'yii\db\Connection'。	yii\log\Target
$exportInterval	integer	累积多少条消息后才导出。默认值为 1000。请注意，应用程序终止时将始终会导出消息。如果将此属性设置为 0，则只会在应用程序终止之时导出消息。	yii\log\Target
$levels	integer	需要记录的消息级别。默认为 0，表示所有可用级别。	yii\log\Target
$logVars	array	需要记录在消息中的PHP预定义变量的列表。请注意，必须可以通过 `$GLOBALS` 访问变量。否则将不会记录。默认是 `['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER']`。从版本 2.	yii\log\Target
$mailer	yii\mail\MailerInterface\|array\|string	邮件程序对象或邮件程序对象的应用程序组件 ID。创建 EmailTarget 对象后，只有它是邮件程序对象时，才可以更改它的属性。从 2.	yii\log\EmailTarget
$message	array	用于创建 message 对象的配置数组。请注意，必须设置“to”选项，该选项指定目标电子邮件地址。	yii\log\EmailTarget
$messages	array	此日志目标从记录器中获得的消息。请参阅 yii\log\Logger::$messages 以获取有关消息结构的详细信息。	yii\log\Target
$microtime	boolean	是否以微秒记录时间。默认是 false。	yii\log\Target
$prefix	callable	一个可调用的函数，它返回一个字符串，以便为每个导出的消息添加前缀。如果未设置，将使用 getMessagePrefix()，该消息在消息前面加上上下文信息。例如用户 IP，用户 ID 和会话 ID。可调用的函数应该是 `function ($message)`。	yii\log\Target

公共方法

隐藏继承的方法

方法	描述	被定义在
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
collect()	处理给定的日志消息。此方法将使用 $levels 和 $categories 过滤给定的消息。如果需要，它还会将过滤结果导出到特定介质（例如电子邮件）。	yii\log\Target
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
export()	将日志消息发送到指定的电子邮件地址。从版本 2.0.14 开始，如果无法导出日志，此方法将抛出 LogRuntimeException 异常。	yii\log\EmailTarget
filterMessages()	根据类别和级别过滤给定的消息。	yii\log\Target
formatMessage()	为便于显示将日志消息格式化为字符串。	yii\log\Target
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getEnabled()	检查日志目标是否已启用。	yii\log\Target
getLevels()		yii\log\Target
getMessagePrefix()	返回要添加到给定消息前缀的字符串。如果配置了 $prefix，它将返回回调的结果。默认将返回用户 IP，用户 ID 和会话 ID 作为前缀。	yii\log\Target
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\log\EmailTarget
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
setEnabled()	设置是否启用此日志目标。	yii\log\Target
setLevels()	设置此目标需要记录的消息级别。	yii\log\Target
trigger()	Triggers an event.	yii\base\Component

受保护的方法

隐藏继承的方法

方法	描述	被定义在
composeMessage()	使用给定的正文内容编写邮件消息。	yii\log\EmailTarget
getContextMessage()	生成要记录的上下文信息。默认会存储用户信息，系统变量等。	yii\log\Target
getTime()	返回格式化以后的消息时间戳，格式为：'Y-m-d H:i:s'。如果 $microtime 配置为 true，则格式为 'Y-m-d H:i:s.u'。	yii\log\Target

属性详情

$mailer 公共属性

邮件程序对象或邮件程序对象的应用程序组件 ID。创建 EmailTarget 对象后，只有它是邮件程序对象时，才可以更改它的属性。

从 2.0.2 版开始，这也可以是用于创建对象的配置数组。

public yii\mail\MailerInterface|array|string $mailer = 'mailer'

$message 公共属性

用于创建 message 对象的配置数组。请注意，必须设置“to”选项，该选项指定目标电子邮件地址。

public array $message = []

方法详情

composeMessage() 受保护方法

使用给定的正文内容编写邮件消息。

protected yii\mail\MessageInterface composeMessage($body)
$body	string	邮件正文
return	yii\mail\MessageInterface	$message

export() 公共方法

将日志消息发送到指定的电子邮件地址。从版本 2.0.14 开始，如果无法导出日志，此方法将抛出 LogRuntimeException 异常。

public void export()
throws	yii\log\LogRuntimeException

init() 公共方法

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init()