1 | <?php |
||
29 | class Driver_Sendmail extends Base |
||
30 | { |
||
31 | /** |
||
32 | * Creates the mail handler object |
||
33 | * |
||
34 | * @param array $config Configuration details as an array |
||
35 | * |
||
36 | * @return \csphere\core\mail\Driver_Sendmail |
||
37 | **/ |
||
38 | |||
39 | public function __construct(array $config) |
||
46 | |||
47 | /** |
||
48 | * Prepares a mail by setting its content |
||
49 | * |
||
50 | * @param string $subject Subject to use in email |
||
51 | * @param string $message Message to use in email |
||
52 | * @param string $type Defaults to text/plain |
||
53 | * |
||
54 | * @return boolean |
||
55 | **/ |
||
56 | |||
57 | public function prepare($subject, $message, $type = 'text/plain') |
||
76 | |||
77 | /** |
||
78 | * Sends the prepared content to a given email |
||
79 | * |
||
80 | * @param string $email Email target |
||
81 | * @param boolean $clear Defaults to true which keeps mail data |
||
82 | * |
||
83 | * @return boolean |
||
84 | **/ |
||
85 | |||
86 | public function send($email, $clear = true) |
||
103 | } |
||
104 |
Adding a
@return
annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.