Skip to content
This repository was archived by the owner on Oct 2, 2019. It is now read-only.

Commit ba3e6fa

Browse files
committed
Fixes DocBlocks in Zend_Mail
Closes zendframework#677
1 parent fccf5d2 commit ba3e6fa

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

library/Zend/Mail.php

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,6 @@ public static function clearDefaultTransport()
209209
* Public constructor
210210
*
211211
* @param string $charset
212-
* @return void
213212
*/
214213
public function __construct($charset = null)
215214
{
@@ -329,8 +328,10 @@ public function setEncodingOfHeaders($encoding)
329328
/**
330329
* Set the encoding of mail headers
331330
*
332-
* @param string $encoding Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64
331+
* @param string $encoding Zend_Mime::ENCODING_QUOTEDPRINTABLE or
332+
* Zend_Mime::ENCODING_BASE64
333333
* @return Zend_Mail Provides fluent interface
334+
* @throws Zend_Mail_Exception
334335
*/
335336
public function setHeaderEncoding($encoding)
336337
{
@@ -378,7 +379,8 @@ public function setBodyText($txt, $charset = null, $encoding = Zend_Mime::ENCODI
378379
/**
379380
* Return text body Zend_Mime_Part or string
380381
*
381-
* @param bool textOnly Whether to return just the body text content or the MIME part; defaults to false, the MIME part
382+
* @param bool $textOnly Whether to return just the body text content or
383+
* the MIME part; defaults to false, the MIME part
382384
* @return false|Zend_Mime_Part|string
383385
*/
384386
public function getBodyText($textOnly = false)
@@ -562,7 +564,8 @@ protected function _addRecipientAndHeader($headerName, $email, $name)
562564
}
563565

564566
/**
565-
* Adds To-header and recipient, $email can be an array, or a single string address
567+
* Adds To-header and recipient, $email can be an array, or a single string
568+
* address
566569
*
567570
* @param string|array $email
568571
* @param string $name
@@ -583,7 +586,8 @@ public function addTo($email, $name='')
583586
}
584587

585588
/**
586-
* Adds Cc-header and recipient, $email can be an array, or a single string address
589+
* Adds Cc-header and recipient, $email can be an array, or a single string
590+
* address
587591
*
588592
* @param string|array $email
589593
* @param string $name
@@ -763,8 +767,8 @@ public function clearReplyTo()
763767
/**
764768
* Sets Default From-email and name of the message
765769
*
766-
* @param string $email
767-
* @param string Optional $name
770+
* @param string $email
771+
* @param string $name optional
768772
* @return void
769773
*/
770774
public static function setDefaultFrom($email, $name = null)
@@ -796,6 +800,7 @@ public static function clearDefaultFrom()
796800
* Sets From-name and -email based on the defaults
797801
*
798802
* @return Zend_Mail Provides fluent interface
803+
* @throws Zend_Mail_Exception
799804
*/
800805
public function setFromToDefaultFrom() {
801806
$from = self::getDefaultFrom();
@@ -813,8 +818,8 @@ public function setFromToDefaultFrom() {
813818
/**
814819
* Sets Default ReplyTo-address and -name of the message
815820
*
816-
* @param string $email
817-
* @param string Optional $name
821+
* @param string $email
822+
* @param string $name optional
818823
* @return void
819824
*/
820825
public static function setDefaultReplyTo($email, $name = null)
@@ -846,6 +851,7 @@ public static function clearDefaultReplyTo()
846851
* Sets ReplyTo-name and -email based on the defaults
847852
*
848853
* @return Zend_Mail Provides fluent interface
854+
* @throws Zend_Mail_Exception
849855
*/
850856
public function setReplyToFromDefault() {
851857
$replyTo = self::getDefaultReplyTo();
@@ -961,9 +967,10 @@ public function clearSubject()
961967
/**
962968
* Sets Date-header
963969
*
964-
* @param timestamp|string|Zend_Date $date
970+
* @param int|string|Zend_Date $date
965971
* @return Zend_Mail Provides fluent interface
966-
* @throws Zend_Mail_Exception if called subsequent times or wrong date format.
972+
* @throws Zend_Mail_Exception if called subsequent times or wrong date
973+
* format.
967974
*/
968975
public function setDate($date = null)
969976
{
@@ -1153,7 +1160,7 @@ public function addHeader($name, $value, $append = false)
11531160
/**
11541161
* Return mail headers
11551162
*
1156-
* @return void
1163+
* @return array
11571164
*/
11581165
public function getHeaders()
11591166
{

0 commit comments

Comments
 (0)