Modifier and Type	Class and Description
public static enum	StreamProvider.EncoderTypes Enumeration with the different encoder types supported by the Mail API.

Method Summary

Modifier and Type	Method and Description
public InputStream	Returns: the decoder inputBase64(InputStream the InputStream in) Creates a 'base64' decoder from the InputStream.
public InputStream	Returns: the decoder inputBinary(InputStream the InputStream in) Creates a 'binary', '7bit' and '8bit' decoder from the InputStream.
public LineInputStream	Returns: the LineInputStream inputLineStream(InputStream the InputStream in, boolean allow UTF-8 characters? allowutf8) Creates a new LineInputStream that supports reading CRLF terminated lines containing only US-ASCII characters from an input stream
public InputStream	Returns: the decoder inputQ(InputStream the InputStream in) Creates a 'q' decoder from the InputStream.
public InputStream	Returns: the decoder inputQP(InputStream the InputStream in) Creates a 'quoted-printable' decoder from the InputStream.
public InputStream	Returns: the InputStream inputSharedByteArray(byte[] the byte array buff) Creates a new InputStream from the underlying byte array to be shared between multiple readers.
public InputStream	Returns: the decoder inputUU(InputStream the InputStream in) Creates a 'uuencode', 'x-uuencode' and 'x-uue' decoder from the InputStream.
public OutputStream	Returns: the encoder outputB(OutputStream the OutputStream out) Creates a 'b' encoder from the OutputStream.
public OutputStream	Returns: the encoder outputBase64(OutputStream the OutputStream out) Creates a 'base64' encoder from the OutputStream.
public OutputStream	Returns: the encoder outputBinary(OutputStream the OutputStream out) Creates a 'binary', '7bit' and '8bit' encoder from the OutputStream.
public LineOutputStream	Returns: the LineOutputStream outputLineStream(OutputStream the OutputStream out, boolean allow UTF-8 characters? allowutf8) Creates a new LineOutputStream that supports writing out Strings as a sequence of bytes terminated by a CRLF sequence.
public OutputStream	Returns: the encoder outputQ(OutputStream the OutputStream out, boolean true if we are Q-encoding a word within a phrase. encodingWord) Creates a 'q' encoder.
public OutputStream	Returns: the encoder outputQP(OutputStream the OutputStream out) Creates a 'quoted-printable' encoder from the OutputStream.
public OutputStream	Returns: the encoder outputUU(OutputStream the OutputStream out, String Specifies a name for the encoded buffer. It can be null. filename) Creates a 'uuencode', 'x-uuencode' and 'x-uue' encoder from the OutputStream.
public static StreamProvider	Returns: a stream provider provider() Creates a stream provider object.

Method Detail

inputBase64	back to summary
public InputStream inputBase64(InputStream in) Creates a 'base64' decoder from the InputStream. Parameters in:InputStream the InputStream Returns:InputStream the decoder

inputBase64

back to summary

public InputStream inputBase64(InputStream in)

Creates a 'base64' decoder from the InputStream.

Parameters

in:InputStream: the InputStream

Returns:InputStream

the decoder

inputBinary	back to summary
public InputStream inputBinary(InputStream in) Creates a 'binary', '7bit' and '8bit' decoder from the InputStream. Parameters in:InputStream the InputStream Returns:InputStream the decoder

inputBinary

back to summary

public InputStream inputBinary(InputStream in)

Creates a 'binary', '7bit' and '8bit' decoder from the InputStream.

Parameters

in:InputStream: the InputStream

Returns:InputStream

the decoder

inputLineStream	back to summary
public LineInputStream inputLineStream(InputStream in, boolean allowutf8) Creates a new LineInputStream that supports reading CRLF terminated lines containing only US-ASCII characters from an input stream Parameters in:InputStream the InputStream allowutf8:boolean allow UTF-8 characters? Returns:LineInputStream the LineInputStream

inputLineStream

back to summary

public LineInputStream inputLineStream(InputStream in, boolean allowutf8)

Creates a new LineInputStream that supports reading CRLF terminated lines containing only US-ASCII characters from an input stream

Parameters

in:InputStream: the InputStream
allowutf8:boolean: allow UTF-8 characters?

Returns:LineInputStream

the LineInputStream

inputQ	back to summary
public InputStream inputQ(InputStream in) Creates a 'q' decoder from the InputStream. Parameters in:InputStream the InputStream Returns:InputStream the decoder

inputQ

back to summary

public InputStream inputQ(InputStream in)

Creates a 'q' decoder from the InputStream.

Parameters

in:InputStream: the InputStream

Returns:InputStream

the decoder

inputQP	back to summary
public InputStream inputQP(InputStream in) Creates a 'quoted-printable' decoder from the InputStream. Parameters in:InputStream the InputStream Returns:InputStream the decoder

inputQP

back to summary

public InputStream inputQP(InputStream in)

Creates a 'quoted-printable' decoder from the InputStream.

Parameters

in:InputStream: the InputStream

Returns:InputStream

the decoder

inputSharedByteArray	back to summary
public InputStream inputSharedByteArray(byte[] buff) Creates a new InputStream from the underlying byte array to be shared between multiple readers. Parameters buff:byte[] the byte array Returns:InputStream the InputStream

inputSharedByteArray

back to summary

public InputStream inputSharedByteArray(byte[] buff)

Creates a new InputStream from the underlying byte array to be shared between multiple readers.

Parameters

buff:byte[]: the byte array

Returns:InputStream

the InputStream

inputUU	back to summary
public InputStream inputUU(InputStream in) Creates a 'uuencode', 'x-uuencode' and 'x-uue' decoder from the InputStream. Parameters in:InputStream the InputStream Returns:InputStream the decoder

inputUU

back to summary

public InputStream inputUU(InputStream in)

Creates a 'uuencode', 'x-uuencode' and 'x-uue' decoder from the InputStream.

Parameters

in:InputStream: the InputStream

Returns:InputStream

the decoder

outputB	back to summary
public OutputStream outputB(OutputStream out) Creates a 'b' encoder from the OutputStream. Parameters out:OutputStream the OutputStream Returns:OutputStream the encoder

outputB

back to summary

public OutputStream outputB(OutputStream out)

Creates a 'b' encoder from the OutputStream.

Parameters

out:OutputStream: the OutputStream

Returns:OutputStream

the encoder

outputBase64	back to summary
public OutputStream outputBase64(OutputStream out) Creates a 'base64' encoder from the OutputStream. Parameters out:OutputStream the OutputStream Returns:OutputStream the encoder

outputBase64

back to summary

public OutputStream outputBase64(OutputStream out)

Creates a 'base64' encoder from the OutputStream.

Parameters

out:OutputStream: the OutputStream

Returns:OutputStream

the encoder

outputBinary	back to summary
public OutputStream outputBinary(OutputStream out) Creates a 'binary', '7bit' and '8bit' encoder from the OutputStream. Parameters out:OutputStream the OutputStream Returns:OutputStream the encoder

outputBinary

back to summary

public OutputStream outputBinary(OutputStream out)

Creates a 'binary', '7bit' and '8bit' encoder from the OutputStream.

Parameters

out:OutputStream: the OutputStream

Returns:OutputStream

the encoder

outputLineStream	back to summary
public LineOutputStream outputLineStream(OutputStream out, boolean allowutf8) Creates a new LineOutputStream that supports writing out Strings as a sequence of bytes terminated by a CRLF sequence. The String must contain only US-ASCII characters. Parameters out:OutputStream the OutputStream allowutf8:boolean allow UTF-8 characters? Returns:LineOutputStream the LineOutputStream

outputLineStream

back to summary

public LineOutputStream outputLineStream(OutputStream out, boolean allowutf8)

Creates a new LineOutputStream that supports writing out Strings as a sequence of bytes terminated by a CRLF sequence. The String must contain only US-ASCII characters.

Parameters

out:OutputStream: the OutputStream
allowutf8:boolean: allow UTF-8 characters?

Returns:LineOutputStream

the LineOutputStream

outputQ	back to summary
public OutputStream outputQ(OutputStream out, boolean encodingWord) Creates a 'q' encoder. Parameters out:OutputStream the OutputStream encodingWord:boolean true if we are Q-encoding a word within a phrase. Returns:OutputStream the encoder

outputQ

back to summary

public OutputStream outputQ(OutputStream out, boolean encodingWord)

Creates a 'q' encoder.

Parameters

out:OutputStream: the OutputStream
encodingWord:boolean: true if we are Q-encoding a word within a phrase.

Returns:OutputStream

the encoder

outputQP	back to summary
public OutputStream outputQP(OutputStream out) Creates a 'quoted-printable' encoder from the OutputStream. Parameters out:OutputStream the OutputStream Returns:OutputStream the encoder

outputQP

back to summary

public OutputStream outputQP(OutputStream out)

Creates a 'quoted-printable' encoder from the OutputStream.

Parameters

out:OutputStream: the OutputStream

Returns:OutputStream

the encoder

outputUU	back to summary
public OutputStream outputUU(OutputStream out, String filename) Creates a 'uuencode', 'x-uuencode' and 'x-uue' encoder from the OutputStream. Parameters out:OutputStream the OutputStream filename:String Specifies a name for the encoded buffer. It can be null. Returns:OutputStream the encoder

outputUU

back to summary

public OutputStream outputUU(OutputStream out, String filename)

Creates a 'uuencode', 'x-uuencode' and 'x-uue' encoder from the OutputStream.

Parameters

out:OutputStream: the OutputStream
filename:String: Specifies a name for the encoded buffer. It can be null.

Returns:OutputStream

the encoder

provider back to summary

provider	back to summary
public static StreamProvider provider() Creates a stream provider object. The provider is loaded using the `ServiceLoader#load(Class)` method. If there are no available service providers, this method throws an IllegalStateException. Users are recommended to cache the result of this method. Returns:StreamProvider a stream provider

public static StreamProvider provider()

Creates a stream provider object. The provider is loaded using the ServiceLoader#load(Class) method. If there are no available service providers, this method throws an IllegalStateException. Users are recommended to cache the result of this method.

Returns:StreamProvider: a stream provider

jakarta.mail.util back to summary

public final Enum StreamProvider.EncoderTypes

Class Inheritance

extends Enum<StreamProvider.EncoderTypes>

java.lang.Object
java.lang.Enum
jakarta.mail.util.StreamProvider.EncoderTypes

Enumeration with the different encoder types supported by the Mail API.

Since: JavaMail 2.1

Field Summary

Modifier and Type	Field and Description
public static final StreamProvider.EncoderTypes	B_ENCODER
public static final StreamProvider.EncoderTypes	BASE_64
public static final StreamProvider.EncoderTypes	BINARY_ENCODER
public static final StreamProvider.EncoderTypes	BIT7_ENCODER
public static final StreamProvider.EncoderTypes	BIT8_ENCODER
private final String	encoder
public static final StreamProvider.EncoderTypes	Q_ENCODER
public static final StreamProvider.EncoderTypes	QUOTED_PRINTABLE_ENCODER
public static final StreamProvider.EncoderTypes	UU_ENCODER
public static final StreamProvider.EncoderTypes	X_UU_ENCODER
public static final StreamProvider.EncoderTypes	X_UUE

Constructor Summary

Access	Constructor and Description
private	EncoderTypes(String encoder)

Method Summary

Modifier and Type	Method and Description
public String	getEncoder()
public static StreamProvider.EncoderTypes	valueOf(String name)
public static StreamProvider.EncoderTypes[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

B_ENCODER	back to summary
public static final StreamProvider.EncoderTypes B_ENCODER

BASE_64	back to summary
public static final StreamProvider.EncoderTypes BASE_64

BINARY_ENCODER	back to summary
public static final StreamProvider.EncoderTypes BINARY_ENCODER

BIT7_ENCODER	back to summary
public static final StreamProvider.EncoderTypes BIT7_ENCODER

BIT8_ENCODER	back to summary
public static final StreamProvider.EncoderTypes BIT8_ENCODER

encoder	back to summary
private final String encoder

Q_ENCODER	back to summary
public static final StreamProvider.EncoderTypes Q_ENCODER

QUOTED_PRINTABLE_ENCODER	back to summary
public static final StreamProvider.EncoderTypes QUOTED_PRINTABLE_ENCODER

UU_ENCODER	back to summary
public static final StreamProvider.EncoderTypes UU_ENCODER

X_UU_ENCODER	back to summary
public static final StreamProvider.EncoderTypes X_UU_ENCODER

X_UUE	back to summary
public static final StreamProvider.EncoderTypes X_UUE

Constructor Detail

EncoderTypes	back to summary
private EncoderTypes(String encoder)

Method Detail

getEncoder	back to summary
public String getEncoder()

valueOf	back to summary
public static StreamProvider.EncoderTypes valueOf(String name)

values	back to summary
public static StreamProvider.EncoderTypes[] values()

public Interface StreamProvider

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum StreamProvider.EncoderTypes

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail