3 namespace Org\Mxchange\CoreFramework\Mailer;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
7 use Org\Mxchange\CoreFramework\Manager\Login\ManageableMember;
10 * An interface for deliverable mail aka. mailer classes
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 interface DeliverableMail extends FrameworkInterface {
33 * Adds a user class to the recipient list for current template
35 * @param $userInstance An instance of a user class
38 function addRecipientByUserInstance (ManageableMember $userInstance);
41 * Use subject line provided by the (XML) template otherwise a subject line must be set
45 function useSubjectFromTemplate ();
48 * Deliver email to the recipient(s)
52 function deliverEmail ();
55 * Send notification to the admin
59 function sendAdminNotification ();