jasenmessage.java

来自「spam source codejasen-0.9jASEN - java An」· Java 代码 · 共 99 行

/*
 * @(#)JasenMessage.java	30/10/2004
 *
 * Copyright (c) 2004, 2005  jASEN.org
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *
 *   3. The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 *   4. Any modification or additions to the software must be contributed back
 *      to the project.
 *
 *   5. Any investigation or reverse engineering of source code or binary to
 *      enable emails to bypass the filters, and hence inflict spam and or viruses
 *      onto users who use or do not use jASEN could subject the perpetrator to
 *      criminal and or civil liability.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JASEN.ORG,
 * OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jasen.interfaces;

import java.io.Serializable;

import javax.mail.internet.InternetAddress;

import org.jasen.error.JasenException;

/**
 * <P>
 * 	Represents a simplified MimeMessage which provides access to the minimal amount of message information required by the engine.
 * </P>
 * @author Jason Polites
 */
public interface JasenMessage extends Serializable
{
    /**
     * <P>
     * Returns the "envelope" sender.  This means the "actual" sender of the message.
     * </P>
     * <P>
     * If this is not known, return the "From" address.
     * </P>
     * @return The email address of the envelope sender
     * @throws JasenException
     */
    public String getEnvelopeSender() throws JasenException;

    /**
     * Returns the "From" header address.
     * <br/>
     * If this is not known, return the "From" address or "Reply-To" or "Return-Path"
     * @return The contents of the From header
     * @throws JasenException
     */
    public InternetAddress getFrom() throws JasenException;

    /**
     * Gets the text/plain part of the message
     * @return A String representation of the text/plain MIME part in the message
     * @throws JasenException
     */
    public String getTextPart() throws JasenException;

    /**
     * Gets the HTML part (if it exists)
     * @return A String representation of the text/html MIME part in the message, or null if no such part exists
     * @throws JasenException
     */
    public String getHtmlPart() throws JasenException;

    /**
     * Returns the names of all attachments in the message
     * @return A String array containing only the filenames of any attachments found in the message, or null if there are none
     * @throws JasenException
     */
    public String[] getAttachmentNames() throws JasenException;

}