org.mule.extension.email.internal.mailbox.pop3

Class POP3Operations

java.lang.Object

org.mule.extension.email.internal.mailbox.pop3.POP3Operations

public class POP3Operations
extends Object

A set of operations which perform on top the POP3 email protocol.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
POP3Operations()

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.extension.api.runtime.streaming.PagingProvider<MailboxConnection,org.mule.runtime.extension.api.runtime.operation.Result<Object,POP3EmailAttributes>>	listPop3(POP3Configuration config, MailboxConnection connection, String mailboxFolder, POP3EmailPredicateBuilder pop3Matcher, boolean deleteAfterRetrieve, EmailMetadataKey outputType, int pageSize) List all the emails (with pagination) in the configured pop3 mailBoxFolder that match with the specified pop3Matcher criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

POP3Operations

public POP3Operations()

Method Detail

listPop3

@Summary(value="List all the emails in the given POP3 Mailbox Folder")
 @OutputResolver(output=EmailMetadataResolver.class)
public org.mule.runtime.extension.api.runtime.streaming.PagingProvider<MailboxConnection,org.mule.runtime.extension.api.runtime.operation.Result<Object,POP3EmailAttributes>> listPop3(@UseConfig
                                                                                                                                                                                                                                                                                                                   POP3Configuration config,
                                                                                                                                                                                                                                                                                                                   @Connection
                                                                                                                                                                                                                                                                                                                   MailboxConnection connection,
                                                                                                                                                                                                                                                                                                                   @Optional(defaultValue="INBOX")
                                                                                                                                                                                                                                                                                                                   String mailboxFolder,
                                                                                                                                                                                                                                                                                                                   @DisplayName(value="Match with") @Optional
                                                                                                                                                                                                                                                                                                                   POP3EmailPredicateBuilder pop3Matcher,
                                                                                                                                                                                                                                                                                                                   @Optional(defaultValue="false")
                                                                                                                                                                                                                                                                                                                   boolean deleteAfterRetrieve,
                                                                                                                                                                                                                                                                                                                   @MetadataKeyId @Optional(defaultValue="ANY") @Placement(tab="Advanced")
                                                                                                                                                                                                                                                                                                                   EmailMetadataKey outputType,
                                                                                                                                                                                                                                                                                                                   @Optional(defaultValue="10")
                                                                                                                                                                                                                                                                                                                   int pageSize)

List all the emails (with pagination) in the configured pop3 mailBoxFolder that match with the specified pop3Matcher criteria.

As the POP3 protocol does not support the capability to find specific emails from its UID in a folder to move/delete it. a parameter deleteAfterRetrieve is available for deleting the emails from the server right after being retrieved.

Parameters:

config - The MailboxAccessConfiguration associated to this operation.

connection - The corresponding MailboxConnection instance.

mailboxFolder - Mailbox folder where the emails are going to be fetched

pop3Matcher - Email Matcher which gives the capability of filter the retrieved emails

deleteAfterRetrieve - Specifies if the returned emails must be deleted after being retrieved or not.

Returns:

an PagingProvider composed with an Result with a List carrying all the emails content and it's corresponding IMAPEmailAttributes.