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