MessageUtility

java.lang.Object
- com.openexchange.mail.utils.MessageUtility

```
public final class MessageUtility
extends java.lang.Object
```
MessageUtility - Provides various helper methods for message processing.

Author:

Thorben Betten

Field Summary

Fields
Modifier and Type Field and Description

static char UNKNOWN
The unknown character: '�'

Fields
Modifier and Type	Field and Description
`static char`	`UNKNOWN` The unknown character: `'�'`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String`	`checkCharset(MailPart p, ContentType ct)` Gets a valid charset-encoding for specified textual part; meaning its content type matches `text/*`.
`static java.lang.String`	`checkCharset(javax.mail.Part p, ContentType ct)` Gets a valid charset-encoding for specified textual part; meaning its content type matches `text/*`.
`static javax.activation.DataHandler`	`dhFor(javax.activation.DataSource dataSource, javax.activation.DataContentHandler dch, java.lang.Object object, java.lang.String objectMimeType)` Creates a new `DataHandler` with specified `DataSource`, `DataContentHandler`, object and MIME type set.
`static byte[]`	`getBytesFrom(java.io.InputStream in)` Gets the byte content from specified input stream.
`static java.io.InputStream`	`getPartInputStream(javax.mail.Part p)` Gets the input stream of specified part.
`static boolean`	`isAscii(byte[] bytes)` Check if specified bytes contain ascii-only content.
`static boolean`	`isBig5(java.lang.String charset)` Checks if specified charset name can be considered as BIG5.
`static boolean`	`isGB2312(java.lang.String charset)` Checks if specified charset name can be considered as GB2312.
`static boolean`	`isShiftJis(java.lang.String charset)` Checks if specified charset name can be considered as Shift-JIS.
`static boolean`	`isSpecialCharset(java.lang.String charset)` Checks if passed character encoding experienced some special handling when reading text content.
`static java.lang.String`	`readBytes(byte[] bytes, java.lang.String charset)` Reads a string from given input stream using direct buffering.
`static java.lang.String`	`readMailPart(MailPart mailPart, java.lang.String charset)` Reads the stream content from given mail part.
`static java.lang.String`	`readMimePart(javax.mail.Part p, ContentType ct)` Reads the string out of MIME part's input stream.
`static java.lang.String`	`readMimePart(javax.mail.Part p, java.lang.String charset)` Reads the string out of MIME part's input stream.
`static java.lang.String`	`readStream(java.io.InputStream inStream, java.lang.String charset)` Reads a string from given input stream using direct buffering.
`static java.lang.String`	`readStream(StreamDataSource.InputStreamProvider streamProvider, java.lang.String charset)` Reads a string from given input stream using direct buffering.
`static void`	`setContent(javax.mail.Message message, javax.mail.Part part)` Sets the message content
`static void`	`setContent(javax.mail.Multipart multipart, javax.mail.Part part)` Sets the multipart content
`static void`	`setContent(javax.mail.Multipart multipart, java.lang.String contentType, javax.mail.Part part)` Sets the multipart content
`static void`	`setText(java.lang.String text, javax.mail.Part part)` Convenience method that sets the given String as this part's content, with a primary MIME type of "text/plain; charset=us-ascii".
`static void`	`setText(java.lang.String text, java.lang.String charset, javax.mail.Part part)` Convenience method that sets the given String as this part's content, with a primary MIME type of "text/plain".
`static void`	`setText(java.lang.String text, java.lang.String charset, java.lang.String subtype, javax.mail.Part part)` Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
`static java.lang.String`	`simpleHtmlDuplicateRemoval(java.lang.String html)` Detects possible duplicate <html> tags and removes all but last.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNKNOWN
```
public static final char UNKNOWN
```
    The unknown character: '�'
    
    See Also:
    Constant Field Values
- Method Detail
  - checkCharset
```
public static java.lang.String checkCharset(MailPart p,
                            ContentType ct)
                                     throws com.openexchange.exception.OXException
```
    Gets a valid charset-encoding for specified textual part; meaning its content type matches text/*.
    
    Parameters:
    p - The part to detect a charset for
    ct - The part's content type
    
    Returns:
    A valid charset-encoding for specified textual part.
    
    Throws:
    
    com.openexchange.exception.OXException - If part's input stream cannot be obtained
  - checkCharset
```
public static java.lang.String checkCharset(javax.mail.Part p,
                            ContentType ct)
```
    Gets a valid charset-encoding for specified textual part; meaning its content type matches text/*.
    
    Parameters:
    p - The part to detect a charset for
    ct - The part's content type
    
    Returns:
    A valid charset-encoding for specified textual part.
  - getPartInputStream
```
public static java.io.InputStream getPartInputStream(javax.mail.Part p)
```
    Gets the input stream of specified part.
    
    Parameters:
    p - The part whose input stream shall be returned
    
    Returns:
    The part's input stream.
  - readMimePart
```
public static java.lang.String readMimePart(javax.mail.Part p,
                            ContentType ct)
                                     throws javax.mail.MessagingException
```
    Reads the string out of MIME part's input stream. On first try the input stream retrieved by javax.mail.Part.getInputStream() is used. If an I/O error occurs (java.io.IOException) then the next try is with part's raw input stream. If everything fails an empty string is returned.
    
    Parameters:
    p - The javax.mail.Part object
    ct - The part's content type
    
    Returns:
    The string read from part's input stream or the empty string "" if everything failed
    
    Throws:
    
    javax.mail.MessagingException - If an error occurs in part's getter methods
  - readMimePart
```
public static java.lang.String readMimePart(javax.mail.Part p,
                            java.lang.String charset)
                                     throws javax.mail.MessagingException
```
    Reads the string out of MIME part's input stream. On first try the input stream retrieved by javax.mail.Part.getInputStream() is used. If an I/O error occurs (java.io.IOException) then the next try is with part's raw input stream. If everything fails an empty string is returned.
    
    Parameters:
    p - The javax.mail.Part object
    charset - The charset
    
    Returns:
    The string read from part's input stream or the empty string "" if everything failed
    
    Throws:
    
    javax.mail.MessagingException - If an error occurs in part's getter methods
  - readMailPart
```
public static java.lang.String readMailPart(MailPart mailPart,
                            java.lang.String charset)
                                     throws java.io.IOException,
                                            com.openexchange.exception.OXException
```
    Reads the stream content from given mail part.
    
    Parameters:
    mailPart - The mail part
    charset - The charset encoding used to generate a String object from raw bytes
    
    Returns:
    the String read from mail part's stream
    
    Throws:
    
    java.io.IOException
    
    com.openexchange.exception.OXException
  - readBytes
```
public static java.lang.String readBytes(byte[] bytes,
                         java.lang.String charset)
                                  throws java.io.IOException
```
    Reads a string from given input stream using direct buffering.
    
    Parameters:
    bytes - The bytes to read
    charset - The charset
    
    Returns:
    The String read from input stream
    
    Throws:
    
    java.io.IOException - If an I/O error occurs
  - readStream
```
public static java.lang.String readStream(StreamDataSource.InputStreamProvider streamProvider,
                          java.lang.String charset)
                                   throws java.io.IOException
```
    Reads a string from given input stream using direct buffering.
    
    Parameters:
    streamProvider - The input stream provider
    charset - The charset
    
    Returns:
    The String read from input stream
    
    Throws:
    
    java.io.IOException - If an I/O error occurs
  - readStream
```
public static java.lang.String readStream(java.io.InputStream inStream,
                          java.lang.String charset)
                                   throws java.io.IOException
```
    Reads a string from given input stream using direct buffering.
    
    Parameters:
    inStream - The input stream
    charset - The charset
    
    Returns:
    The String read from input stream
    
    Throws:
    
    java.io.IOException - If an I/O error occurs
  - isSpecialCharset
```
public static boolean isSpecialCharset(java.lang.String charset)
```
    Checks if passed character encoding experienced some special handling when reading text content.
    - Big5
    - GB18030
    - GB2312
    - Shift-Jis
    Parameters:
    charset - The character encoding to check
    
    Returns:
    true if passed character encoding experienced some special handling; otherwise false
  - isBig5
```
public static boolean isBig5(java.lang.String charset)
```
    Checks if specified charset name can be considered as BIG5.
    
    Parameters:
    charset - The charset name to check
    
    Returns:
    true if charset name can be considered as BIG5; otherwise false
  - isGB2312
```
public static boolean isGB2312(java.lang.String charset)
```
    Checks if specified charset name can be considered as GB2312.
    
    Parameters:
    charset - The charset name to check
    
    Returns:
    true if charset name can be considered as GB2312; otherwise false
  - isShiftJis
```
public static boolean isShiftJis(java.lang.String charset)
```
    Checks if specified charset name can be considered as Shift-JIS.
    
    Parameters:
    charset - The charset name to check
    
    Returns:
    true if charset name can be considered as Shift-JIS; otherwise false
  - getBytesFrom
```
public static byte[] getBytesFrom(java.io.InputStream in)
                           throws java.io.IOException
```
    Gets the byte content from specified input stream.
    
    Parameters:
    in - The input stream to get the byte content from
    
    Returns:
    The byte content
    
    Throws:
    
    java.io.IOException - If an I/O error occurs
  - isAscii
```
public static boolean isAscii(byte[] bytes)
```
    Check if specified bytes contain ascii-only content.
    
    Parameters:
    bytes - The bytes to check
    
    Returns:
    true if bytes are ascii-only; otherwise false
  - simpleHtmlDuplicateRemoval
```
public static java.lang.String simpleHtmlDuplicateRemoval(java.lang.String html)
```
    Detects possible duplicate <html> tags and removes all but last.
    
    Parameters:
    html - The HTML content
    
    Returns:
    The HTML content with duplicate <html> tags removed
  - dhFor
```
public static javax.activation.DataHandler dhFor(javax.activation.DataSource dataSource,
                                 javax.activation.DataContentHandler dch,
                                 java.lang.Object object,
                                 java.lang.String objectMimeType)
                                          throws javax.mail.MessagingException
```
    Creates a new DataHandler with specified DataSource, DataContentHandler, object and MIME type set.
    
    Parameters:
    dataSource - The data source
    dch - The data content handler (optional; null is accepted)
    object - The object (optional; null is accepted)
    objectMimeType - The MIME type (optional; null is accepted)
    
    Returns:
    The resulting data handler
    
    Throws:
    
    javax.mail.MessagingException - If creating such a data handler fail
  - setContent
```
public static void setContent(javax.mail.Message message,
              javax.mail.Part part)
                       throws javax.mail.MessagingException
```
    Sets the message content
    
    Parameters:
    message - The message to set
    part - The part
    
    Throws:
    
    javax.mail.MessagingException - If setting content fails
  - setContent
```
public static void setContent(javax.mail.Multipart multipart,
              javax.mail.Part part)
                       throws javax.mail.MessagingException
```
    Sets the multipart content
    
    Parameters:
    multipart - The multipart to set
    part - The part
    
    Throws:
    
    javax.mail.MessagingException - If setting content fails
  - setContent
```
public static void setContent(javax.mail.Multipart multipart,
              java.lang.String contentType,
              javax.mail.Part part)
                       throws javax.mail.MessagingException
```
    Sets the multipart content
    
    Parameters:
    multipart - The multipart to set
    contentType - The content type
    part - The part
    
    Throws:
    
    javax.mail.MessagingException - If setting content fails
  - setText
```
public static void setText(java.lang.String text,
           javax.mail.Part part)
                    throws javax.mail.MessagingException
```
    Convenience method that sets the given String as this part's content, with a primary MIME type of "text/plain; charset=us-ascii".
    
    Parameters:
    text - The text content to set
    charset - The charset to use for the text
    
    Throws:
    
    javax.mail.MessagingException - If an error occurs
  - setText
```
public static void setText(java.lang.String text,
           java.lang.String charset,
           javax.mail.Part part)
                    throws javax.mail.MessagingException
```
    Convenience method that sets the given String as this part's content, with a primary MIME type of "text/plain".
    The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.
    
    Parameters:
    text - The text content to set
    charset - The charset to use for the text
    
    Throws:
    
    javax.mail.MessagingException - If an error occurs
  - setText
```
public static void setText(java.lang.String text,
           java.lang.String charset,
           java.lang.String subtype,
           javax.mail.Part part)
                    throws javax.mail.MessagingException
```
    Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
    The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.
    
    Parameters:
    text - The text content to set
    charset - The charset to use for the text
    subtype - The MIME subtype to use (e.g., "html")
    
    Throws:
    
    javax.mail.MessagingException - If an error occurs

Class MessageUtility

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

Method Detail

checkCharset

checkCharset

getPartInputStream

readMimePart

readMimePart

readMailPart

readBytes

readStream

readStream

isSpecialCharset

isBig5

isGB2312

isShiftJis

getBytesFrom

isAscii

simpleHtmlDuplicateRemoval

dhFor

setContent

setContent

setContent

setText

setText

setText