org.apache.james.mime4j.mboxiterator

Class MboxIterator

java.lang.Object

org.apache.james.mime4j.mboxiterator.MboxIterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<CharBufferWrapper>

public class MboxIterator
extends Object
implements Iterable<CharBufferWrapper>, Closeable

Class that provides an iterator over email messages inside an mbox file. An mbox file is a sequence of email messages separated by From_ lines.

Description ot the file format:

• http://tools.ietf.org/html/rfc4155
• http://qmail.org/man/man5/mbox.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MboxIterator.Builder

Method Summary

Modifier and Type	Method and Description
static String	bufferDetailsToString(Buffer buffer) Utility method to log important details about buffers.
void	close()
static MboxIterator.Builder	fromFile(File filePath)
static MboxIterator.Builder	fromFile(String file)
protected void	initMboxIterator() initialize the Mailbox iterator
Iterator<CharBufferWrapper>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

initMboxIterator

protected void initMboxIterator()
                         throws IOException

initialize the Mailbox iterator

Throws:

IOException

CharConversionException

iterator

public Iterator<CharBufferWrapper> iterator()

Specified by:

iterator in interface Iterable<CharBufferWrapper>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

fromFile

public static MboxIterator.Builder fromFile(File filePath)

fromFile

public static MboxIterator.Builder fromFile(String file)

bufferDetailsToString

public static String bufferDetailsToString(Buffer buffer)

Utility method to log important details about buffers.

Parameters:

buffer -