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 <<<<<<< HEAD:framework/main/interfaces/mailer/class_DeliverableMail.php
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
18 >>>>>>> Some updates::inc/main/interfaces/mailer/class_DeliverableMail.php
19 * @license GNU GPL 3.0 or any newer version
20 * @link http://www.shipsimu.org
22 * This program is free software: you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation, either version 3 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 interface DeliverableMail extends FrameworkInterface {
37 * Adds a user class to the recipient list for current template
39 * @param $userInstance An instance of a user class
42 function addRecipientByUserInstance (ManageableMember $userInstance);
45 * Use subject line provided by the (XML) template otherwise a subject line must be set
49 function useSubjectFromTemplate ();
52 * Deliver email to the recipient(s)
56 function deliverEmail ();
59 * Send notification to the admin
63 function sendAdminNotification ();