| <?xml version="1.0" encoding="UTF-8"?> | |
| <!-- | |
| Licensed to the Apache Software Foundation (ASF) under one or more | |
| contributor license agreements. See the NOTICE file distributed with | |
| this work for additional information regarding copyright ownership. | |
| The ASF licenses this file to You under the Apache License, Version 2.0 | |
| (the "License"); you may not use this file except in compliance with | |
| the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, software | |
| distributed under the License is distributed on an "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| See the License for the specific language governing permissions and | |
| limitations under the License. | |
| --> | |
| <document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |
| xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> | |
| <properties> | |
| <title>LoggerAppenderMail</title> | |
| </properties> | |
| <body> | |
| <section name="LoggerAppenderMail"> | |
| <p><code>LoggerAppenderMail</code> appends log events via email.</p> | |
| <p class="alert alert-warning"><strong>Note:</strong> When working in Windows, make sure that the | |
| <code>SMTP</code> and <code>smpt_port</code> values in php.ini are set to the correct values for | |
| your email server (address and port).</p> | |
| <subsection name="Layout"> | |
| <p>This appender requires a layout. If no layout is specified in configuration, | |
| <code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code> will be used by default.</p> | |
| </subsection> | |
| <subsection name="Parameters"> | |
| <p>The following parameters are available:</p> | |
| <table> | |
| <thead> | |
| <tr> | |
| <th>Parameter</th> | |
| <th>Type</th> | |
| <th>Required</th> | |
| <th>Default</th> | |
| <th>Description</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td>to</td> | |
| <td>string</td> | |
| <td><strong>Yes</strong></td> | |
| <td>-</td> | |
| <td>Email address(es) to which the log will be sent. Multiple email addresses may be specified | |
| by separating them with a comma.</td> | |
| </tr> | |
| <tr> | |
| <td>from</td> | |
| <td>string</td> | |
| <td><strong>Yes</strong></td> | |
| <td>-</td> | |
| <td>Email address which will be used in the From field.</td> | |
| </tr> | |
| <tr> | |
| <td>subject</td> | |
| <td>string</td> | |
| <td>No</td> | |
| <td>Log4php Report</td> | |
| <td>Subject of the email message.</td> | |
| </tr> | |
| <tr> | |
| <td>bufferSize</td> | |
| <td>integer</td> | |
| <td>No</td> | |
| <td>null</td> | |
| <td>If set, determines how many messages will be buffered before sending them to the | |
| recipient. If not set, all messages will be sent when the appender is closed.</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </subsection> | |
| <subsection name="Changelog"> | |
| <table class="table table-striped table-bordered table-not-wide"> | |
| <thead> | |
| <tr> | |
| <th>Version</th> | |
| <th>Description</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td><code>3.0.0</code></td> | |
| <td>Added buffering and the <em>bufferSize</em> parameter.</td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </subsection> | |
| <subsection name="Buffering"> | |
| <p>The <code>bufferSize</code> parameter determines how many messages will be buffered before sending | |
| them together in a single email. When not set, all messages will be buffered, and the email will not | |
| be sent until the script exits.</p> | |
| <p>Setting the <code>bufferSize</code> to 1 means that each message will be sent in it's own email. | |
| Setting it to 5 means that messages will be sent in batches of 5, etc...</p> | |
| </subsection> | |
| <subsection name="Examples"> | |
| <p>This example shows how to configure <code>LoggerAppenderMail</code> to send the log to two email | |
| addresses.</p> | |
| <div class="auto-tabs"> | |
| <ul> | |
| <li>XML</li> | |
| <li>PHP</li> | |
| </ul> | |
| <div class="tab-content" > | |
| <div class="tab-pane"> | |
| <pre class="prettyprint"><![CDATA[ | |
| <configuration xmlns="http://logging.apache.org/log4php/"> | |
| <appender name="default" class="LoggerAppenderMail"> | |
| <layout class="LoggerLayoutSimple" /> | |
| <param name="to" value="foo@example.com,baz@example.com" /> | |
| <param name="from" value="logger@example.com" /> | |
| </appender> | |
| <root> | |
| <appender_ref ref="default" /> | |
| </root> | |
| </configuration> | |
| ]]></pre> | |
| </div> | |
| <div class="tab-pane"> | |
| <pre class="prettyprint"><![CDATA[ | |
| array( | |
| 'appenders' => array( | |
| 'default' => array( | |
| 'class' => 'LoggerAppenderMail', | |
| 'layout' => array( | |
| 'class' => 'LoggerLayoutSimple', | |
| ), | |
| 'params' => array( | |
| 'to' => 'foo@example.com,baz@example.com', | |
| 'from' => 'logger@example.com' | |
| ), | |
| ), | |
| ), | |
| 'rootLogger' => array( | |
| 'appenders' => array('default'), | |
| ), | |
| ); | |
| ]]></pre> | |
| </div> | |
| </div> | |
| </div> | |
| </subsection> | |
| </section> | |
| </body> | |
| </document> |