org.dbflute.mail.CardView Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.dbflute.mail;

import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.mail.Address;

import org.dbflute.mail.send.supplement.attachment.SMailAttachment;
import org.dbflute.optional.OptionalThing;

/**
 * @author jflute
 * @since 0.4.0 (2015/06/12 Friday)
 */
public interface CardView {

    // ===================================================================================
    //                                                                    Postcard Request
    //                                                                    ================
    OptionalThing getDeliveryCategory();

    OptionalThing getReceiverLocale();

    OptionalThing getSubject();

    OptionalThing getFrom();

    List getToList();

    List getCcList();

    List getBccList();

    List getReplyToList();

    Map getAttachmentMap();

    // ===================================================================================
    //                                                                           Body File
    //                                                                           =========
    OptionalThing getBodyFile();

    boolean hasBodyFile();

    boolean isAlsoHtmlFile();

    boolean isFromFilesystem();

    boolean hasTemplateVariable();

    Map getTemplaetVariableMap();

    boolean isWholeFixedTextUsed();

    // ===================================================================================
    //                                                                           Body Text
    //                                                                           =========
    OptionalThing getPlainBody();

    boolean hasHtmlBody();

    OptionalThing getHtmlBody();

    // ===================================================================================
    //                                                                             Logging
    //                                                                             =======
    boolean hasPushedLogging();

    Map getPushedLoggingMap();

    boolean hasOfficeManagedLogging();

    Map> getOfficeManagedLoggingMap();

    // ===================================================================================
    //                                                                       Postie Option
    //                                                                       =============
    boolean isAsync();

    int getRetryCount();

    long getIntervalMillis();

    boolean isSuppressSendFailure();
}