Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * MUA (Mail User Agent) interface.
5 *
6 * This Source Code Form is subject to the terms of the Mozilla Public License,
7 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
8 * obtain one at https://mozilla.org/MPL/2.0/.
9 *
10 * @package   phpMyFAQ
11 * @author    Matteo Scaramuccia <matteo@phpmyfaq.de>
12 * @copyright 2009-2026 phpMyFAQ Team
13 * @license   https://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
14 * @link      https://www.phpmyfaq.de
15 * @since     2009-09-11
16 */
17
18declare(strict_types=1);
19
20namespace phpMyFAQ\Mail;
21
22/**
23 * Interface MailUserAgentInterface
24 *
25 * @package phpMyFAQ\Mail
26 */
27interface MailUserAgentInterface
28{
29    /**
30     * Send the message using an e-mail.
31     *
32     * @param string $recipients Recipients of the e-mail as a comma-separated list of RFC 2822 compliant elements
33     * @param array<string, int|string|null> $headers Headers of the e-mail
34     * @param string $body Body of the e-mail
35     * @return int The number of successful recipients. Can be 0 which indicates failure
36     */
37    public function send(string $recipients, array $headers, string $body): int;
38}