framework/main/interfaces/mailer/class_DeliverableMail.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Mailer;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7 use Org\Mxchange\CoreFramework\Manager\Login\ManageableMember;
   8
   9 /**
  10  * An interface for deliverable mail aka. mailer classes
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  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
  17  *
  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.
  22  *
  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.
  27  *
  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/>.
  30  */
  31 interface DeliverableMail extends FrameworkInterface {
  32         /**
  33          * Adds a user class to the recipient list for current template
  34          *
  35          * @param       $userInstance   An instance of a user class
  36          * @return      void
  37          */
  38         function addRecipientByUserInstance (ManageableMember $userInstance);
  39
  40         /**
  41          * Use subject line provided by the (XML) template otherwise a subject line must be set
  42          *
  43          * @return      void
  44          */
  45         function useSubjectFromTemplate ();
  46
  47         /**
  48          * Deliver email to the recipient(s)
  49          *
  50          * @return      void
  51          */
  52         function deliverEmail ();
  53
  54         /**
  55          * Send notification to the admin
  56          *
  57          * @return      void
  58          */
  59         function sendAdminNotification ();
  60
  61 }