[TASK] Clean up the phpDoc of t3lib/interfaces/
[Packages/TYPO3.CMS.git] / t3lib / interfaces / interface.t3lib_mail_maileradapter.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2011 Ingo Renner <ingo@typo3.org>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Mailer Adapter interface
30 *
31 * @author Ingo Renner <ingo@typo3.org>
32 * @package TYPO3
33 * @subpackage t3lib
34 */
35 interface t3lib_mail_MailerAdapter {
36
37 /**
38 * Mail sending function
39 *
40 * @param string $to Mail recipient.
41 * @param string $subject Mail subject.
42 * @param string $messageBody Mail body.
43 * @param array $additionalHeaders Additional mail headers.
44 * @param array $additionalParameters Additional mailer parameters.
45 * @param boolean $fakeSending Whether to fake sending or not, used in Unit Tests.
46 * @return boolean TRUE if the mail was successfully sent, FALSE otherwise.
47 */
48 public function mail($to, $subject, $messageBody, $additionalHeaders = NULL, $additionalParameters = NULL, $fakeSending = FALSE);
49
50 }
51
52 ?>