程序包 com.sh.mail.mime4j.stream

类 MimeTokenStream

java.lang.Object

com.sh.mail.mime4j.stream.MimeTokenStream

public class MimeTokenStream
extends Object

Description:

Title:首亨软件 - TSS/CRM等

从以下版本开始:

Aug 16, 2012

构造器概要

构造器

构造器	说明
MimeTokenStream()	Constructs a standard (lax) stream.
MimeTokenStream(MimeConfig config)
MimeTokenStream(MimeConfig config, DecodeMonitor monitor, BodyDescriptorBuilder bodyDescBuilder)
MimeTokenStream(MimeConfig config, DecodeMonitor monitor, FieldBuilder fieldBuilder, BodyDescriptorBuilder bodyDescBuilder)
MimeTokenStream(MimeConfig config, BodyDescriptorBuilder bodyDescBuilder)

方法概要

修饰符和类型	方法	说明
BodyDescriptor	getBodyDescriptor()	Gets a descriptor for the current entity.
MimeConfig	getConfig()
InputStream	getDecodedInputStream()	This method returns a transfer decoded stream based on the MIME fields with the standard defaults.
Field	getField()	This method is valid, if getState() returns EntityState.T_FIELD.
InputStream	getInputStream()
Reader	getReader()	Gets a reader configured for the current body or body part.
RecursionMode	getRecursionMode()	Gets the current recursion mode.
EntityState	getState()	Returns the current state.
boolean	isRaw()	Determines if this parser is currently in raw mode.
EntityState	next()	This method advances the token stream to the next token.
void	parse(InputStream stream)	Instructs the MimeTokenStream to parse the given streams contents.
Field	parseHeadless(InputStream stream, String contentType)	Instructs the MimeTokenStream to parse the given content with the content type.
void	setRecursionMode(RecursionMode mode)	Sets the current recursion.
static final String	stateToString(EntityState state)	Renders a state as a string suitable for logging.
void	stop()	Finishes the parsing and stops reading lines.

从类继承的方法 java.lang.Object

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

构造器详细资料

MimeTokenStream

public MimeTokenStream()

Constructs a standard (lax) stream. Optional validation events will be logged only. Use MimeConfig.setStrictParsing(boolean) to turn on strict parsing mode and pass the config object to MimeTokenStream(MimeConfig) to create a stream that strictly validates the input.

MimeTokenStream

public MimeTokenStream(MimeConfig config)

MimeTokenStream

public MimeTokenStream(MimeConfig config,
 BodyDescriptorBuilder bodyDescBuilder)

MimeTokenStream

public MimeTokenStream(MimeConfig config,
 DecodeMonitor monitor,
 BodyDescriptorBuilder bodyDescBuilder)

MimeTokenStream

public MimeTokenStream(MimeConfig config,
 DecodeMonitor monitor,
 FieldBuilder fieldBuilder,
 BodyDescriptorBuilder bodyDescBuilder)

方法详细资料

parse

public void parse(InputStream stream)

Instructs the MimeTokenStream to parse the given streams contents. If the MimeTokenStream has already been in use, resets the streams internal state.

参数:

stream - InputStream

parseHeadless

public Field parseHeadless(InputStream stream,
 String contentType)

Instructs the MimeTokenStream to parse the given content with the content type. The message stream is assumed to have no message header and is expected to begin with a message body. This can be the case when the message content is transmitted using a different transport protocol such as HTTP.

If the MimeTokenStream has already been in use, resets the streams internal state.

参数:

stream - InputStream

contentType - String

返回:

a parsed Field representing the input contentType

isRaw

public boolean isRaw()

Determines if this parser is currently in raw mode.

返回:

true if in raw mode, false otherwise.

另请参阅:

• setRecursionMode(RecursionMode)

getRecursionMode

public RecursionMode getRecursionMode()

Gets the current recursion mode. The recursion mode specifies the approach taken to parsing parts. RecursionMode.M_RAW mode does not parse the part at all. RecursionMode.M_RECURSE mode recursively parses each mail when an message/rfc822 part is encountered; RecursionMode.M_NO_RECURSE does not.

返回:

RecursionMode.M_RECURSE, RecursionMode.M_RAW or RecursionMode.M_NO_RECURSE

setRecursionMode

public void setRecursionMode(RecursionMode mode)

Sets the current recursion. The recursion mode specifies the approach taken to parsing parts. RecursionMode.M_RAW mode does not parse the part at all. RecursionMode.M_RECURSE mode recursively parses each mail when an message/rfc822 part is encountered; RecursionMode.M_NO_RECURSE does not.

参数:

mode - RecursionMode.M_RECURSE, RecursionMode.M_RAW or RecursionMode.M_NO_RECURSE

stop

public void stop()

Finishes the parsing and stops reading lines. NOTE: No more lines will be parsed but the parser will still trigger 'end' events to match previously triggered 'start' events.

getState

public EntityState getState()

Returns the current state.

返回:

EntityState

getInputStream

public InputStream getInputStream()

getDecodedInputStream

public InputStream getDecodedInputStream()

This method returns a transfer decoded stream based on the MIME fields with the standard defaults. This method is valid, if getState() returns either of EntityState.T_RAW_ENTITY, EntityState.T_PREAMBLE, or EntityState.T_EPILOGUE.

返回:

Data stream, depending on the current state.

抛出:

IllegalStateException - getState() returns an invalid value.

getReader

public Reader getReader()

Gets a reader configured for the current body or body part. The reader will return a transfer and charset decoded stream of characters based on the MIME fields with the standard defaults. This is a conveniance method and relies on {link #getInputStream()}. Consult the javadoc for that method for known limitations.

返回:

Reader

getBodyDescriptor

public BodyDescriptor getBodyDescriptor()

Gets a descriptor for the current entity. This method is valid if getState() returns:

• EntityState.T_BODY
• EntityState.T_START_MULTIPART
• EntityState.T_EPILOGUE
• EntityState.T_PREAMBLE

返回:

BodyDescriptor, not nulls

getField

public Field getField()

This method is valid, if getState() returns EntityState.T_FIELD.

返回:

String with the fields raw contents.

抛出:

IllegalStateException - getState() returns another value than EntityState.T_FIELD.

next

public EntityState next()
                 throws IOException,
MimeException

This method advances the token stream to the next token.

返回:

EntityState

抛出:

IllegalStateException - The method has been called, although getState() was already EntityState.T_END_OF_STREAM.

IOException - IOException

MimeException - MimeException

stateToString

public static final String stateToString(EntityState state)

Renders a state as a string suitable for logging.

参数:

state - EntityState

返回:

rendered as string, not null

getConfig

public MimeConfig getConfig()