eu.easyrpa.openframework.email.service.javax

Class ImapPop3EmailService

java.lang.Object

eu.easyrpa.openframework.email.service.javax.ImapPop3EmailService

All Implemented Interfaces:

InboundEmailService

public class ImapPop3EmailService
extends Object
implements InboundEmailService

Implementation of inbound email services that is working based on IMAP and POP3 protocols.

Constructor Summary

Constructors

Constructor and Description
ImapPop3EmailService(String server, InboundEmailProtocol protocol, String secret)

Method Summary

Modifier and Type	Method and Description
EmailMessage	copyMessage(EmailMessage message, String targetFolder) Makes a copy of given email message in the specified folder.
boolean	createFolder(String folderName) Creates a new folder with given name in the mailbox.
boolean	deleteFolder(String folderName) Deletes given mailbox folder with all messages and sub-folders contained in it.
void	deleteMessage(EmailMessage message) Deletes given email message from the mailbox.
void	deleteMessages(List<EmailMessage> messages) Deletes given email messages from the mailbox.
List<EmailMessage>	fetchAllMessages(Predicate<EmailMessage> isSatisfy) Gets all email messages contained in all mailbox folders and satisfy to specific condition.
EmailMessage	fetchMessage(String messageId) Searches email message in the mailbox with given message ID.
List<EmailMessage>	fetchMessages(String folderName, Predicate<EmailMessage> isSatisfy) Gets email messages contained in the mailbox folder with given name and satisfy to specific condition.
List<EmailMessage>	fetchUnreadMessages(String folderName, boolean markRead) Gets unread messages contained in the mailbox folder with given name.
int	getBatchSize()
String	getHost()
MessageConverter<javax.mail.Message>	getMessageConverter()
int	getMessageCount(String folderName) Gets amount of email messages in the mailbox folder with given name.
String	getPort()
InboundEmailProtocol	getProtocol()
javax.mail.Session	getSession()
javax.mail.Store	getStore()
List<String>	listFolders() Gets the list of folder names that are present in the mailbox.
EmailMessage	moveMessage(EmailMessage message, String targetFolder) Moves given email message to the specified folder.
boolean	renameFolder(String folderName, String newFolderName) Renames given mailbox folder.
void	setBatchSize(int batchSize)
void	setMessageConverter(MessageConverter<javax.mail.Message> messageConverter)
void	updateMessage(EmailMessage message) Updates parameters of given email message in the mailbox.
void	updateMessages(List<EmailMessage> messages) Updates parameters of given email messages in the mailbox.
CompletableFuture<List<EmailMessage>>	waitMessages(String folderName, Predicate<EmailMessage> isSatisfy, Duration timeout, Duration checkInterval) Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImapPop3EmailService

public ImapPop3EmailService(String server,
                            InboundEmailProtocol protocol,
                            String secret)

Method Detail

getHost

public String getHost()

getPort

public String getPort()

getProtocol

public InboundEmailProtocol getProtocol()

getSession

public javax.mail.Session getSession()

getStore

public javax.mail.Store getStore()

getMessageConverter

public MessageConverter<javax.mail.Message> getMessageConverter()

setMessageConverter

public void setMessageConverter(MessageConverter<javax.mail.Message> messageConverter)

getBatchSize

public int getBatchSize()

setBatchSize

public void setBatchSize(int batchSize)

getMessageCount

public int getMessageCount(String folderName)

Description copied from interface: InboundEmailService

Gets amount of email messages in the mailbox folder with given name.

Specified by:

getMessageCount in interface InboundEmailService

Parameters:

folderName - the name of mailbox folder where is necessary to count messages.

Returns:

amount of email messages in the mailbox folder with given name.

fetchMessage

public EmailMessage fetchMessage(String messageId)

Description copied from interface: InboundEmailService

Searches email message in the mailbox with given message ID.

It views all mailbox folders to find the necessary message.

Specified by:

fetchMessage in interface InboundEmailService

Parameters:

messageId - the unique identifier of email message that is necessary to find.

Returns:

EmailMessage object representing found email message or null if nothing is found.

fetchMessages

public List<EmailMessage> fetchMessages(String folderName,
                                        Predicate<EmailMessage> isSatisfy)

Description copied from interface: InboundEmailService

Gets email messages contained in the mailbox folder with given name and satisfy to specific condition.

Specified by:

fetchMessages in interface InboundEmailService

Parameters:

folderName - the name of mailbox folder where is necessary to collect email messages.

isSatisfy - lambda expression representing specific condition. It should return true to let email message get into results.

Returns:

list of EmailMessage objects representing satisfying email messages.

fetchAllMessages

public List<EmailMessage> fetchAllMessages(Predicate<EmailMessage> isSatisfy)

Description copied from interface: InboundEmailService

Gets all email messages contained in all mailbox folders and satisfy to specific condition.

Specified by:

fetchAllMessages in interface InboundEmailService

Parameters:

isSatisfy - lambda expression representing specific condition. It should return true to let email message get into results.

Returns:

list of EmailMessage objects representing satisfying email messages.

fetchUnreadMessages

public List<EmailMessage> fetchUnreadMessages(String folderName,
                                              boolean markRead)

Description copied from interface: InboundEmailService

Gets unread messages contained in the mailbox folder with given name.

Specified by:

fetchUnreadMessages in interface InboundEmailService

Parameters:

folderName - the name of mailbox folder where is necessary to search unread messages.

markRead - whether is necessary to mark all found unread messages as read immediately.

Returns:

list of EmailMessage objects representing unread email messages.

waitMessages

public CompletableFuture<List<EmailMessage>> waitMessages(String folderName,
                                                          Predicate<EmailMessage> isSatisfy,
                                                          Duration timeout,
                                                          Duration checkInterval)

Description copied from interface: InboundEmailService

Waits appearing of email messages in the mailbox folder with given name that satisfy to specific condition.

Specified by:

waitMessages in interface InboundEmailService

Parameters:

folderName - the name of mailbox folder where is necessary to check messages.

isSatisfy - lambda expression representing specific condition. It should return true to let email message get into results.

timeout - the maximum time of waiting necessary messages.

checkInterval - amount of time that defines period of checking newly come messages.

Returns:

CompletableFuture object with list of EmailMessage objects representing satisfying email messages as result.

copyMessage

public EmailMessage copyMessage(EmailMessage message,
                                String targetFolder)

Description copied from interface: InboundEmailService

Makes a copy of given email message in the specified folder.

Specified by:

copyMessage in interface InboundEmailService

Parameters:

message - the source email message that should be copied.

targetFolder - the name of mailbox folder where the email message should be copied.

Returns:

EmailMessage object representing copied message.

moveMessage

public EmailMessage moveMessage(EmailMessage message,
                                String targetFolder)

Description copied from interface: InboundEmailService

Moves given email message to the specified folder.

Specified by:

moveMessage in interface InboundEmailService

Parameters:

message - the source email message that should be moved.

targetFolder - the name of mailbox folder where the email message should be moved.

Returns:

EmailMessage object representing moved message. The source message will be deleted.

updateMessage

public void updateMessage(EmailMessage message)

Description copied from interface: InboundEmailService

Updates parameters of given email message in the mailbox.

Specified by:

updateMessage in interface InboundEmailService

Parameters:

message - the email message whose parameters should be updated in the mailbox.

updateMessages

public void updateMessages(List<EmailMessage> messages)

Description copied from interface: InboundEmailService

Updates parameters of given email messages in the mailbox.

Specified by:

updateMessages in interface InboundEmailService

Parameters:

messages - the list of email messages whose parameters should be updated in the mailbox.

deleteMessage

public void deleteMessage(EmailMessage message)

Description copied from interface: InboundEmailService

Deletes given email message from the mailbox.

The message is deleted permanently without Trash.

Specified by:

deleteMessage in interface InboundEmailService

Parameters:

message - the email message to delete.

deleteMessages

public void deleteMessages(List<EmailMessage> messages)

Description copied from interface: InboundEmailService

Deletes given email messages from the mailbox.

Messages are deleted permanently without Trash.

Specified by:

deleteMessages in interface InboundEmailService

Parameters:

messages - the list of email messages to delete.

listFolders

public List<String> listFolders()

Description copied from interface: InboundEmailService

Gets the list of folder names that are present in the mailbox.

Specified by:

listFolders in interface InboundEmailService

Returns:

list of folder names that are present in the mailbox.

createFolder

public boolean createFolder(String folderName)

Description copied from interface: InboundEmailService

Creates a new folder with given name in the mailbox.

Specified by:

createFolder in interface InboundEmailService

Parameters:

folderName - the name of folder to create.

Returns:

true if the folder has been created successfully and false otherwise.

renameFolder

public boolean renameFolder(String folderName,
                            String newFolderName)

Description copied from interface: InboundEmailService

Renames given mailbox folder.

Specified by:

renameFolder in interface InboundEmailService

Parameters:

folderName - the name of source mailbox folder.

newFolderName - a new name of the folder.

Returns:

true if the folder has been renamed successfully and false otherwise.

deleteFolder

public boolean deleteFolder(String folderName)

Description copied from interface: InboundEmailService

Deletes given mailbox folder with all messages and sub-folders contained in it.

Specified by:

deleteFolder in interface InboundEmailService

Parameters:

folderName - the name of mailbox folder to delete.

Returns:

true if the folder has been deleted successfully and false otherwise.