Inheritance diagram for QuotedPrintableCodec:

Description

Codec for the Quoted-Printable section of RFC1521 .

The Quoted-Printable encoding is intended to represent data that largely consists of octets that correspond to printable characters in the ASCII character set. It encodes the data in such a way that the resulting octets are unlikely to be modified by mail transport. If the data being encoded are mostly ASCII text, the encoded form of the data remains largely recognizable by humans. A body which is entirely ASCII may also be encoded in Quoted-Printable to ensure the integrity of the data should the message pass through a character- translating, and/or line-wrapping gateway.

Note:

Rules #3, #4, and #5 of the quoted-printable spec are not implemented yet because the complete quoted-printable spec does not lend itself well into the byte[] oriented codec framework. Complete the codec once the steamable codec framework is ready. The motivation behind providing the codec in a partial form is that it can already come in handy for those applications that do not require quoted-printable line formatting (rules #3, #4, #5), for instance Q codec.

See also: RFC 1521 MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies

Author: Apache Software Foundation

Since: 1.3

Version

Id: QuotedPrintableCodec.java,v 1.7 2004/04/09 22:21:07 ggregory Exp

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
	QuotedPrintableCodec ()
	Default constructor.

	QuotedPrintableCodec (String charset)
	Constructor which allows for the selection of a default charset. More...

byte[]	encode (byte[] bytes)
	Encodes an array of bytes into an array of quoted-printable 7-bit characters. More...

byte[]	decode (byte[] bytes) throws DecoderException
	Decodes an array of quoted-printable characters into an array of original bytes. More...

String	encode (String pString) throws EncoderException
	Encodes a string into its quoted-printable form using the default string charset. More...

String	decode (String pString, String charset) throws DecoderException, UnsupportedEncodingException
	Decodes a quoted-printable string into its original form using the specified string charset. More...

String	decode (String pString) throws DecoderException
	Decodes a quoted-printable string into its original form using the default string charset. More...

Object	encode (Object pObject) throws EncoderException
	Encodes an object into its quoted-printable safe form. More...

Object	decode (Object pObject) throws DecoderException
	Decodes a quoted-printable object into its original form. More...

String	getDefaultCharset ()
	Returns the default charset used for string decoding and encoding. More...

String	encode (String pString, String charset) throws UnsupportedEncodingException
	Encodes a string into its quoted-printable form using the specified charset. More...

Static Public Member Functions
static final byte[]	encodeQuotedPrintable (BitSet printable, byte[] bytes)
	Encodes an array of bytes into an array of quoted-printable 7-bit characters. More...

static final byte[]	decodeQuotedPrintable (byte[] bytes) throws DecoderException
	Decodes an array quoted-printable characters into an array of original bytes. More...

Constructor & Destructor Documentation

◆ QuotedPrintableCodec()

QuotedPrintableCodec ( String charset )

Parameters

charset the default string charset to use.

Member Function Documentation

◆ encodeQuotedPrintable()

static final byte [] encodeQuotedPrintable	(	BitSet	printable,
		byte[]	bytes
	)

static

Unsafe characters are escaped.

This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in RFC 1521 and is suitable for encoding binary data and unformatted text.

Parameters

printable	bitset of characters deemed quoted-printable
bytes	array of bytes to be encoded

Returns: array of bytes containing quoted-printable data

◆ decodeQuotedPrintable()

static final byte [] decodeQuotedPrintable ( byte[] bytes ) throws DecoderException

static

Escaped characters are converted back to their original representation.

This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in RFC 1521.

Parameters

bytes array of quoted-printable characters

Returns: array of original bytes

Exceptions

DecoderException Thrown if quoted-printable decoding is unsuccessful

◆ encode() [1/4]

byte [] encode ( byte[] bytes )

Unsafe characters are escaped.

This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in RFC 1521 and is suitable for encoding binary data and unformatted text.

Parameters

bytes array of bytes to be encoded

Returns: array of bytes containing quoted-printable data

Implements BinaryEncoder.

◆ decode() [1/4]

byte [] decode ( byte[] bytes ) throws DecoderException

Escaped characters are converted back to their original representation.

This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in RFC 1521.

Parameters

bytes array of quoted-printable characters

Returns: array of original bytes

Exceptions

DecoderException Thrown if quoted-printable decoding is unsuccessful

Implements BinaryDecoder.

◆ encode() [2/4]

String encode ( String pString ) throws EncoderException

Unsafe characters are escaped.

This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in RFC 1521 and is suitable for encoding binary data.

Parameters

pString string to convert to quoted-printable form

Returns: quoted-printable string

Exceptions

EncoderException Thrown if quoted-printable encoding is unsuccessful

See also: getDefaultCharset()

Implements StringEncoder.

◆ decode() [2/4]

String decode	(	String	pString,
		String	charset
	)		throws DecoderException, UnsupportedEncodingException

Escaped characters are converted back to their original representation.

Parameters

pString	quoted-printable string to convert into its original form
charset	the original string charset

Returns: original string

Exceptions

DecoderException	Thrown if quoted-printable decoding is unsuccessful
UnsupportedEncodingException	Thrown if charset is not supported

◆ decode() [3/4]

String decode ( String pString ) throws DecoderException

Escaped characters are converted back to their original representation.

Parameters

pString quoted-printable string to convert into its original form

Returns: original string

Exceptions

DecoderException	Thrown if quoted-printable decoding is unsuccessful
UnsupportedEncodingException	Thrown if charset is not supported

See also: getDefaultCharset()

Implements StringDecoder.

◆ encode() [3/4]

Object encode ( Object pObject ) throws EncoderException

Unsafe characters are escaped.

Parameters

pObject string to convert to a quoted-printable form

Returns: quoted-printable object

Exceptions

EncoderException Thrown if quoted-printable encoding is not applicable to objects of this type or if encoding is unsuccessful

Implements Encoder.

◆ decode() [4/4]

Object decode ( Object pObject ) throws DecoderException

Escaped characters are converted back to their original representation.

Parameters

pObject quoted-printable object to convert into its original form

Returns: original object

Exceptions

DecoderException Thrown if quoted-printable decoding is not applicable to objects of this type if decoding is unsuccessful

Implements Decoder.

◆ getDefaultCharset()

String getDefaultCharset ( )

Returns: the default string charset.

◆ encode() [4/4]

String encode	(	String	pString,
		String	charset
	)		throws UnsupportedEncodingException

Unsafe characters are escaped.

This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in RFC 1521 and is suitable for encoding binary data and unformatted text.

Parameters

pString	string to convert to quoted-printable form
charset	the charset for pString

Returns: quoted-printable string

Exceptions

UnsupportedEncodingException Thrown if the charset is not supported

Description

Notice

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ QuotedPrintableCodec()

Member Function Documentation

◆ encodeQuotedPrintable()

◆ decodeQuotedPrintable()

◆ encode() [1/4]

◆ decode() [1/4]

◆ encode() [2/4]

◆ decode() [2/4]

◆ decode() [3/4]

◆ encode() [3/4]

◆ decode() [4/4]

◆ getDefaultCharset()

◆ encode() [4/4]