[BUGFIX] Fix several typos in php comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Mail / MailerAdapterInterface.php
1 <?php
2 namespace TYPO3\CMS\Core\Mail;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Mailer Adapter interface
19 */
20 interface MailerAdapterInterface
21 {
22 /**
23 * Mail sending function
24 *
25 * @param string $to Mail recipient.
26 * @param string $subject Mail subject.
27 * @param string $messageBody Mail body.
28 * @param array $additionalHeaders Additional mail headers.
29 * @param array $additionalParameters Additional mailer parameters.
30 * @param bool $fakeSending Whether to fake sending or not, used in Unit Tests.
31 * @return bool TRUE if the mail was successfully sent, FALSE otherwise.
32 */
33 public function mail($to, $subject, $messageBody, $additionalHeaders = null, $additionalParameters = null, $fakeSending = false);
34 }