net.freeutils.tnef.mime

Class TNEFMime

java.lang.Object

net.freeutils.tnef.mime.TNEFMime

public class TNEFMime
extends java.lang.Object

The TNEFMime class provides high-level utility methods to access TNEF streams and extract their contents, using the JavaMail API. Note: This class is experimental and is intended to show possible uses of the Java TNEF package.

Since:

2003-04-29

Author:

Amichai Rothman

Constructor Summary

Constructors

Constructor and Description
TNEFMime()

Method Summary

Modifier and Type	Method and Description
protected static void	addTextPart(javax.mail.Multipart mp, java.lang.String text, java.lang.String contentType) Adds a text part to the given multipart, with the given text and content type, using the UTF-8 encoding (and utf-8 charset parameter).
static TNEFMimeMessage	convert(javax.mail.Session session, Message message) Constructs a TNEFMimeMessage from the given TNEF Message.
static javax.mail.internet.MimeMessage	convert(javax.mail.Session session, javax.mail.internet.MimeMessage message) Converts TNEF parts within given message to MIME-structured parts (recursively).
static javax.mail.internet.MimeMessage	convert(javax.mail.Session session, javax.mail.internet.MimeMessage message, boolean embed) Converts TNEF parts within given message to MIME-structured parts (recursively).
static javax.mail.Part	convert(javax.mail.Session session, javax.mail.Part part) Converts TNEF parts within given part to MIME-structured parts (recursively).
static javax.mail.Part	convert(javax.mail.Session session, javax.mail.Part part, boolean embed) Converts TNEF parts within given part to MIME-structured parts (recursively).
static TNEFMimeMessage	convert(javax.mail.Session session, TNEFInputStream in) Constructs a TNEFMimeMessage from the given TNEFInputStream.
static boolean	extractTNEF(javax.mail.Part part, java.lang.String tnefFilename) Extracts a TNEF attachment from a specified message Part (recursively).
static boolean	extractTNEF(java.lang.String mimeFilename, java.lang.String tnefFilename) Extracts a TNEF attachment from a specified MIME file.
static void	main(java.lang.String[] args) Main entry point for command-line utility.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TNEFMime

public TNEFMime()

Method Detail

extractTNEF

public static boolean extractTNEF(java.lang.String mimeFilename,
                                  java.lang.String tnefFilename)
                           throws java.io.IOException,
                                  javax.mail.MessagingException

Extracts a TNEF attachment from a specified MIME file.

Parameters:

mimeFilename - the filename of a file containing a MIME message

tnefFilename - the filename of a file to which the TNEF attachment extracted from the MIME message should be written

Returns:

true if a TNEF attachment was extracted, false otherwise

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

extractTNEF

public static boolean extractTNEF(javax.mail.Part part,
                                  java.lang.String tnefFilename)
                           throws java.io.IOException,
                                  javax.mail.MessagingException

Extracts a TNEF attachment from a specified message Part (recursively).

Parameters:

part - a message Part which may contain a TNEF attachment or additional parts

tnefFilename - the filename of a file to which the TNEF attachment extracted from the Part should be written

Returns:

true if a TNEF attachment was extracted, false otherwise

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

addTextPart

protected static void addTextPart(javax.mail.Multipart mp,
                                  java.lang.String text,
                                  java.lang.String contentType)
                           throws javax.mail.MessagingException

Adds a text part to the given multipart, with the given text and content type, using the UTF-8 encoding (and utf-8 charset parameter).

Parameters:

mp - the multipart to add the text to

text - the text to add

contentType - the full text mime type

Throws:

javax.mail.MessagingException - if an error occurs while accessing a mime part

convert

public static TNEFMimeMessage convert(javax.mail.Session session,
                                      TNEFInputStream in)
                               throws java.io.IOException,
                                      javax.mail.MessagingException

Constructs a TNEFMimeMessage from the given TNEFInputStream. TNEF Attributes are both added to the message, and translated into Mime fields and structure (where applicable).

Parameters:

session - the session used to handle the MimeMessage

in - the TNEFInputStream containing message to convert

Returns:

the converted TNEFMimeMessage

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

convert

public static TNEFMimeMessage convert(javax.mail.Session session,
                                      Message message)
                               throws java.io.IOException,
                                      javax.mail.MessagingException

Constructs a TNEFMimeMessage from the given TNEF Message. TNEF Attributes are both added to the message, and translated into Mime fields and structures (where applicable).

Parameters:

session - the session used to handle the MimeMessage

message - the Message to convert

Returns:

the converted TNEFMimeMessage

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

convert

public static javax.mail.internet.MimeMessage convert(javax.mail.Session session,
                                                      javax.mail.internet.MimeMessage message)
                                               throws java.io.IOException,
                                                      javax.mail.MessagingException

Converts TNEF parts within given message to MIME-structured parts (recursively).

Parameters:

session - a Session instance used in creating new Parts

message - the MIME message to convert

Returns:

the given message instance, with TNEF attachment parts replaced by MIME-structured parts

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

convert

public static javax.mail.internet.MimeMessage convert(javax.mail.Session session,
                                                      javax.mail.internet.MimeMessage message,
                                                      boolean embed)
                                               throws java.io.IOException,
                                                      javax.mail.MessagingException

Converts TNEF parts within given message to MIME-structured parts (recursively).

Parameters:

session - a Session instance used in creating new Parts

message - the MIME message to convert

embed - if true, the messages obtained from converted TNEF parts are embedded in the message in place of the TNEF parts. If false, the first TNEF part encountered is converted to a mime message and returned.

Returns:

the given message instance, with TNEF attachment parts replaced by MIME-structured parts

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

convert

public static javax.mail.Part convert(javax.mail.Session session,
                                      javax.mail.Part part)
                               throws java.io.IOException,
                                      javax.mail.MessagingException

Converts TNEF parts within given part to MIME-structured parts (recursively).

Parameters:

session - a Session instance used in creating new Parts

part - the MIME part to convert

Returns:

the original part, with TNEF attachment parts replaced by MIME-structured parts. If the part itself is a TNEF attachment, a converted MimeMessage is returned instead.

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

convert

public static javax.mail.Part convert(javax.mail.Session session,
                                      javax.mail.Part part,
                                      boolean embed)
                               throws java.io.IOException,
                                      javax.mail.MessagingException

Converts TNEF parts within given part to MIME-structured parts (recursively).

Parameters:

session - a Session instance used in creating new Parts

part - the MIME part to convert

embed - if true, the messages obtained from converted TNEF parts are embedded in the part in place of the TNEF parts. If false, the first TNEF part encountered is converted to a mime message and returned.

Returns:

the original part, with TNEF attachment parts replaced by MIME-structured parts. If the part itself is a TNEF attachment, a converted MimeMessage is returned instead.

Throws:

java.io.IOException - if an I/O error occurs

javax.mail.MessagingException - if an error occurs while accessing a mime part

main

public static void main(java.lang.String[] args)

Main entry point for command-line utility.

Parameters:

args - the command-line arguments