diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-20 07:37:04 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-21 07:25:59 +0400 |
commit | e74ecaf307804e0f9d37c7842f9fbbd9f36ba8bb (patch) | |
tree | fb6815a7d592ee0baa5ee066cf46f1e6bbdc5415 /core/Mail.php | |
parent | 5e5e45f43c117589839a15d0e1ef851479f7cb00 (diff) |
Refs #4200, documented Mail class.
Diffstat (limited to 'core/Mail.php')
-rw-r--r-- | core/Mail.php | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/core/Mail.php b/core/Mail.php index a0a8ec8e5a..903d773fac 100644 --- a/core/Mail.php +++ b/core/Mail.php @@ -14,15 +14,16 @@ use Zend_Mail; /** * Class for sending mails, for more information see: + * [http://framework.zend.com/manual/en/zend.mail.html](#http://framework.zend.com/manual/en/zend.mail.html) * * @package Piwik * @see Zend_Mail, libs/Zend/Mail.php - * @link http://framework.zend.com/manual/en/zend.mail.html + * @api */ class Mail extends Zend_Mail { /** - * Default charset utf-8 + * Constructor. * * @param string $charset charset, defaults to utf-8 */ @@ -33,10 +34,10 @@ class Mail extends Zend_Mail } /** - * Sets the sender to use + * Sets the sender. * - * @param string $email - * @param null|string $name + * @param string $email Email address of the sender. + * @param null|string $name Name of the sender. * @return Zend_Mail */ public function setFrom($email, $name = null) @@ -82,4 +83,4 @@ class Mail extends Zend_Mail Mail::setDefaultTransport($tr); ini_set("smtp_port", $mailConfig['port']); } -} +}
\ No newline at end of file |