src/org/mxchange/jmailee/model/delivery/wrapper/WrapableEmailDelivery.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jmailee.model.delivery.wrapper;
  18
  19 import java.io.Serializable;
  20 import java.util.Locale;
  21 import java.util.Properties;
  22 import javax.ejb.Local;
  23 import javax.mail.Address;
  24
  25 /**
  26  * A generic wrapper interface for mail delivery.
  27  * <p>
  28  * @author Roland Häder<roland@mxchange.org>
  29  */
  30 @Local
  31 public interface WrapableEmailDelivery extends Serializable {
  32
  33         /**
  34          * Getter fo template name
  35          * <p>
  36          * @return Template name
  37          */
  38         String getTemplateName ();
  39
  40         /**
  41          * Setter fo template name
  42          * <p>
  43          * @param templateName Template name
  44          */
  45         void setTemplateName (final String templateName);
  46
  47         /**
  48          * Getter for recipient email address
  49          * <p>
  50          * @return Email address recipient
  51          */
  52         Address getRecipient ();
  53
  54         /**
  55          * Setter for recipient email address
  56          * <p>
  57          * @param recipient Email address recipient
  58          */
  59         void setRecipient (final Address recipient);
  60
  61         /**
  62          * Getter for optional properties
  63          * <p>
  64          * @return Optional properties
  65          */
  66         Properties getTemplateVariables ();
  67
  68         /**
  69          * Setter for optional properties
  70          * <p>
  71          * @param properties Optional properties
  72          */
  73         void setTemplateVariables (final Properties properties);
  74
  75         /**
  76          * Getter for subject line
  77          * <p>
  78          * @return Subject line
  79          */
  80         String getSubjectLine ();
  81
  82         /**
  83          * Setter for subject line
  84          * <p>
  85          * @param subjectLine Subject line
  86          */
  87         void setSubjectLine (final String subjectLine);
  88
  89         /**
  90          * Getter for locale
  91          * <p>
  92          * @return Locale instance
  93          */
  94         Locale getLocale ();
  95
  96         /**
  97          * Setter for locale
  98          * <p>
  99          * @param locale Locale instance
 100          */
 101         void setLocale (final Locale locale);
 102
 103 }