001    /****************************************************************
002     * Licensed to the Apache Software Foundation (ASF) under one   *
003     * or more contributor license agreements.  See the NOTICE file *
004     * distributed with this work for additional information        *
005     * regarding copyright ownership.  The ASF licenses this file   *
006     * to you under the Apache License, Version 2.0 (the            *
007     * "License"); you may not use this file except in compliance   *
008     * with the License.  You may obtain a copy of the License at   *
009     *                                                              *
010     *   http://www.apache.org/licenses/LICENSE-2.0                 *
011     *                                                              *
012     * Unless required by applicable law or agreed to in writing,   *
013     * software distributed under the License is distributed on an  *
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
015     * KIND, either express or implied.  See the License for the    *
016     * specific language governing permissions and limitations      *
017     * under the License.                                           *
018     ****************************************************************/
019    
020    
021    package org.apache.james.protocols.smtp;
022    
023    import java.io.IOException;
024    import java.io.InputStream;
025    import java.io.OutputStream;
026    import java.util.List;
027    
028    import org.apache.mailet.MailAddress;
029    
030    /**
031     * The MailEnvelope of a SMTP-Transaction
032     * 
033     *
034     */
035    public interface MailEnvelope {
036    
037        /**
038         * Return the size of the message. If the message is "empty" it will return -1
039         * 
040         * @return size
041         */
042            int getSize();
043    
044            /**
045             * Return the recipients which where supplied in the RCPT TO: command
046             * 
047             * @return recipients
048             */
049            List<MailAddress> getRecipients();
050    
051            /**
052             * Return the sender of the mail which was supplied int the MAIL FROM: command. If its a "null" sender,
053             * null will get returned
054             * 
055             * @return sender
056             */
057            MailAddress getSender();
058    
059    
060            /**
061             * Return the OutputStream of the message
062             * 
063             * @return out
064             * @throws IOException
065             */
066            OutputStream getMessageOutputStream() throws IOException;
067    
068            /**
069             * Return the InputStream of the message
070             * 
071             * @return in
072             * @throws IOException
073             */
074            InputStream getMessageInputStream() throws IOException;
075    }