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

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   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.mail.Address;
  23
  24 /**
  25  * A generic wrapper interface for mail delivery.
  26  * <p>
  27  * @author Roland Haeder<roland@mxchange.org>
  28  */
  29 public interface WrapableEmailDelivery extends Serializable {
  30
  31         /**
  32          * Getter fo template name
  33          * <p>
  34          * @return Template name
  35          */
  36         String getTemplateName ();
  37
  38         /**
  39          * Setter fo template name
  40          * <p>
  41          * @param templateName Template name
  42          */
  43         void setTemplateName (final String templateName);
  44
  45         /**
  46          * Getter for recipient email address
  47          * <p>
  48          * @return Email address recipient
  49          */
  50         Address getRecipient ();
  51
  52         /**
  53          * Setter for recipient email address
  54          * <p>
  55          * @param recipient Email address recipient
  56          */
  57         void setRecipient (final Address recipient);
  58
  59         /**
  60          * Getter for optional properties
  61          * <p>
  62          * @return Optional properties
  63          */
  64         Properties getTemplateVariables ();
  65
  66         /**
  67          * Setter for optional properties
  68          * <p>
  69          * @param properties Optional properties
  70          */
  71         void setTemplateVariables (final Properties properties);
  72
  73         /**
  74          * Getter for subject line
  75          * <p>
  76          * @return Subject line
  77          */
  78         String getSubjectLine ();
  79
  80         /**
  81          * Setter for subject line
  82          * <p>
  83          * @param subjectLine Subject line
  84          */
  85         void setSubjectLine (final String subjectLine);
  86
  87         /**
  88          * Getter for locale
  89          * <p>
  90          * @return Locale instance
  91          */
  92         Locale getLocale ();
  93
  94         /**
  95          * Setter for locale
  96          * <p>
  97          * @param locale Locale instance
  98          */
  99         void setLocale (final Locale locale);
 100
 101 }