jodd.mail

Class ReceiverBuilder

java.lang.Object

jodd.mail.ReceiverBuilder

public class ReceiverBuilder
extends java.lang.Object

Fluent builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReceiverBuilder.ReceiverRunner

Constructor Summary

Constructors

Constructor and Description
ReceiverBuilder(ReceiveMailSession session)

Method Summary

Modifier and Type	Method and Description
ReceiverBuilder	envelopeOnly() Receives only envelopes.
ReceiverBuilder	filter(EmailFilter emailFilter) Define applied filters.
ReceiverBuilder	fromFolder(java.lang.String fromFolder) Sets the working folder.
ReceivedEmail[]	get() Receives the emails as specified by the builder.
ReceiverBuilder	mark(jakarta.mail.Flags.Flag flagToSet) Marks message with given flag.
ReceiverBuilder	markDeleted() Deletes messages upon receiving.
ReceiverBuilder	markSeen() Marks messages as seen after receiving them.
ReceiverBuilder	moveToFolder(java.lang.String targetFolder) Defines target folder where message will be moved.
ReceiverBuilder	unmark(jakarta.mail.Flags.Flag flagToUnset) Unmarks a message with given flag.
ReceiverBuilder.ReceiverRunner	with(java.util.function.Consumer<ReceivedEmails> consumer) Wraps the received emails, so they not get processed until user really needs them.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiverBuilder

public ReceiverBuilder(ReceiveMailSession session)

Method Detail

filter

public ReceiverBuilder filter(EmailFilter emailFilter)

Define applied filters.

markSeen

public ReceiverBuilder markSeen()

Marks messages as seen after receiving them.

mark

public ReceiverBuilder mark(jakarta.mail.Flags.Flag flagToSet)

Marks message with given flag.

unmark

public ReceiverBuilder unmark(jakarta.mail.Flags.Flag flagToUnset)

Unmarks a message with given flag.

markDeleted

public ReceiverBuilder markDeleted()

Deletes messages upon receiving.

fromFolder

public ReceiverBuilder fromFolder(java.lang.String fromFolder)

Sets the working folder. \

moveToFolder

public ReceiverBuilder moveToFolder(java.lang.String targetFolder)

Defines target folder where message will be moved.

envelopeOnly

public ReceiverBuilder envelopeOnly()

Receives only envelopes.

get

public ReceivedEmail[] get()

Receives the emails as specified by the builder.

with

public ReceiverBuilder.ReceiverRunner with(java.util.function.Consumer<ReceivedEmails> consumer)

Wraps the received emails, so they not get processed until user really needs them.