1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is "SMS Library for the Java platform".
15 *
16 * The Initial Developer of the Original Code is Markus Eriksson.
17 * Portions created by the Initial Developer are Copyright (C) 2002
18 * the Initial Developer. All Rights Reserved.
19 *
20 * Contributor(s):
21 *
22 * Alternatively, the contents of this file may be used under the terms of
23 * either the GNU General Public License Version 2 or later (the "GPL"), or
24 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
25 * in which case the provisions of the GPL or the LGPL are applicable instead
26 * of those above. If you wish to allow use of your version of this file only
27 * under the terms of either the GPL or the LGPL, and not to allow others to
28 * use your version of this file under the terms of the MPL, indicate your
29 * decision by deleting the provisions above and replace them with the notice
30 * and other provisions required by the GPL or the LGPL. If you do not delete
31 * the provisions above, a recipient may use your version of this file under
32 * the terms of any one of the MPL, the GPL or the LGPL.
33 *
34 * ***** END LICENSE BLOCK ***** */
35 package org.marre.mime.encoder;
36
37 import java.io.IOException;
38 import java.io.OutputStream;
39
40 import org.marre.mime.MimeBodyPart;
41
42 /***
43 * Interface for all mime encoders.
44 *
45 * @author Markus Eriksson
46 * @version $Id: MimeEncoder.java,v 1.4 2004/11/02 17:59:55 c95men Exp $
47 */
48 public interface MimeEncoder
49 {
50 /***
51 * Writes the content-type of the message to the given stream.
52 *
53 * @param theOs
54 * The stream to write to
55 * @param theMsg
56 * The message to get the content-type from
57 * @throws IOException
58 * Thrown if we fail to write the content-type to the stream
59 */
60 void writeContentType(OutputStream theOs, MimeBodyPart theMsg) throws IOException;
61
62 /***
63 * Writes the headers of the message to the given stream.
64 *
65 * @param theOs
66 * The stream to write to
67 * @param theMsg
68 * The message to get the headers from
69 * @throws IOException
70 * Thrown if we fail to write the headers to the stream
71 */
72 void writeHeaders(OutputStream theOs, MimeBodyPart theMsg) throws IOException;
73
74 /***
75 * Writes the body of the message to the given stream.
76 *
77 * @param theOs
78 * The stream to write to
79 * @param theMsg
80 * The message to get the data from
81 * @throws IOException
82 * Thrown if we fail to write the body to the stream
83 */
84 void writeBody(OutputStream theOs, MimeBodyPart theMsg) throws IOException;
85 }