From f0ffb387356941fa8518b3c546a239cf49c3524a Mon Sep 17 00:00:00 2001
From: sgiehl <stefangiehl@gmail.com>
Date: Sat, 26 May 2012 21:08:06 +0000
Subject: moved another interface to its own file; fixed/added lot of doc
 blocks

git-svn-id: http://dev.piwik.org/svn/trunk@6325 59fd770c-687e-43c8-a1e3-f5a4ff64c105
---
 core/Mail.php | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'core/Mail.php')

diff --git a/core/Mail.php b/core/Mail.php
index 1abe8f0cb3..8c1fa3c2e8 100644
--- a/core/Mail.php
+++ b/core/Mail.php
@@ -21,14 +21,21 @@ class Piwik_Mail extends Zend_Mail
 {
 	/**
 	 * Default charset utf-8
-	 * @param string $charset
+	 *
+	 * @param string  $charset  charset, defaults to utf-8
 	 */
 	public function __construct($charset = 'utf-8')
 	{
 		parent::__construct($charset);
 		$this->initSmtpTransport();
 	}
-	
+
+	/**
+	 * Sets the sender to use
+	 *
+	 * @param string       $email
+	 * @param null|string  $name
+	 */
 	public function setFrom($email, $name = null)
 	{
 		$hostname = Piwik_Config::getInstance()->mail['defaultHostnameIfEmpty'];
@@ -46,7 +53,10 @@ class Piwik_Mail extends Zend_Mail
 		$email = str_replace('{DOMAIN}', $piwikHost, $email);
 		parent::setFrom($email, $name);
 	}
-	
+
+	/**
+	 * @return void
+	 */
 	private function initSmtpTransport()
 	{
 		$mailConfig = Piwik_Config::getInstance()->mail;
-- 
cgit v1.2.3