/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is "SMS Library for the Java platform".
 *
 * The Initial Developer of the Original Code is Markus Eriksson.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
package org.marre.mime.encoder;

import java.io.IOException;
import java.io.OutputStream;

import org.marre.mime.MimeBodyPart;

/**
 * Interface for all mime encoders.
 * 
 * @author Markus Eriksson
 * @version $Id$
 */
public interface MimeEncoder
{
    /**
     * Writes the content-type of the message to the given stream.
     * 
     * @param os
     *            The stream to write to
     * @param msg
     *            The message to get the content-type from
     * @throws IOException
     *             Thrown if we fail to write the content-type to the stream
     */
    void writeContentType(OutputStream os, MimeBodyPart msg) throws IOException;

    /**
     * Writes the headers of the message to the given stream.
     * 
     * @param os
     *            The stream to write to
     * @param msg
     *            The message to get the headers from
     * @throws IOException
     *             Thrown if we fail to write the headers to the stream
     */
    void writeHeaders(OutputStream os, MimeBodyPart msg) throws IOException;

    /**
     * Writes the body of the message to the given stream.
     * 
     * @param os
     *            The stream to write to
     * @param msg
     *            The message to get the data from
     * @throws IOException
     *             Thrown if we fail to write the body to the stream
     */
    void writeBody(OutputStream os, MimeBodyPart msg) throws IOException;
}
