ru.dlabs71.library.email

Class DEmailReceiver

java.lang.Object

ru.dlabs71.library.email.DEmailReceiver

public final class DEmailReceiver
extends Object

The class implements a facade pattern for receiving messages. After creating the class, you must set a folder name using the folder(String folderName) method. If you don't it, then the client will try to use the "INBOX" folder.

Checking and reading emails executes as pageable. By the default page has the size = 50 elements and start index is 0. You can use a customize page request by using the methods supports pageable requests (e.g. readEmail(PageRequest) or checkEmail(PageRequest)).

Project name: d-email

Creation date: 2023-09-02

Since:

1.0.0

Author:

Ivanov Danila

Field Summary

Fields

Modifier and Type	Field and Description
static PageRequest	DEFAULT_PAGE_REQUEST Default page request.
static String	FOLDER_NAME_KEY_METADATA The key to the folder name in the metadata of the response.

Constructor Summary

Constructors

Constructor and Description
DEmailReceiver(ImapProperties properties) The constructor of the class.

Method Summary

Modifier and Type	Method and Description
PageResponse<MessageView>	checkEmail() Checks email (first 50 messages).
PageResponse<MessageView>	checkEmail(PageRequest pageRequest) Checks email.
Map<Integer,Boolean>	clearCurrentFolder() Delete all messages in the current folder.
boolean	deleteMessageById(Integer id) Delete one message by the identifier.
Map<Integer,Boolean>	deleteMessages(Collection<Integer> ids) Delete several messages by its identifiers.
DEmailReceiver	folder(String folderName) Changes folder for reading messages.
String	getCurrentFolder() Returns a using folder in the mailbox.
static DEmailReceiver	of(ImapProperties properties) Creates instance of the DEmailReceiver class.
PageResponse<IncomingMessage>	readEmail() Reads email (first 50 messages).
PageResponse<IncomingMessage>	readEmail(PageRequest pageRequest) Reads email.
IncomingMessage	readMessageById(Integer id) Reads one email message by its identifier.
EmailParticipant	receiver() Returns email receiver object.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_REQUEST

public static final PageRequest DEFAULT_PAGE_REQUEST

Default page request.

FOLDER_NAME_KEY_METADATA

public static final String FOLDER_NAME_KEY_METADATA

The key to the folder name in the metadata of the response.

See Also:

Constant Field Values

Constructor Detail

DEmailReceiver

public DEmailReceiver(ImapProperties properties)

The constructor of the class.

Parameters:

properties - properties for connecting to an email server by IMAP protocol

Method Detail

of

public static DEmailReceiver of(ImapProperties properties)

Creates instance of the DEmailReceiver class.

Parameters:

properties - properties for connecting to an email server by IMAP protocol

Returns:

instance of the DEmailReceiver class

folder

public DEmailReceiver folder(String folderName)

Changes folder for reading messages.

Parameters:

folderName - the name of folder

Returns:

instance of the DEmailReceiver class

receiver

public EmailParticipant receiver()

Returns email receiver object.

Returns:

object of the EmailParticipant class

getCurrentFolder

public String getCurrentFolder()

Returns a using folder in the mailbox.

checkEmail

public PageResponse<MessageView> checkEmail()

Checks email (first 50 messages). Returns only common information about messages. The messages won't have a read flag.

This method uses default page requests from the constant DEFAULT_PAGE_REQUEST.

Returns:

object of class PageResponse. Elements in the list of data have the type MessageView.

checkEmail

public PageResponse<MessageView> checkEmail(PageRequest pageRequest)

Checks email. Returns only common information about messages. The messages won't have a read flag.

This method supports page requests. You need to manage a page request yourself. Use the pageRequest parameter for it.

Parameters:

pageRequest - the configuration of a page request

Returns:

object of class PageResponse. Elements in the list of data have the type MessageView.

readEmail

public PageResponse<IncomingMessage> readEmail()

Reads email (first 50 messages). Returns full information about messages (with a content and attachment). The read flag will be set up in every message.

This method uses default page requests from the constant DEFAULT_PAGE_REQUEST.

Returns:

object of class PageResponse. Elements in the list of data have the type IncomingMessage.

readEmail

public PageResponse<IncomingMessage> readEmail(PageRequest pageRequest)

Reads email. Returns full information about messages (with a content and attachment). The read flag will be set up in every message.

This method supports page requests. You need to manage a page request yourself. Use the pageRequest parameter for it.

Parameters:

pageRequest - the configuration of a page request

Returns:

object of class PageResponse. Elements in the list of data have the type IncomingMessage.

readMessageById

public IncomingMessage readMessageById(Integer id)

Reads one email message by its identifier.

Parameters:

id - identifier message

Returns:

object of the class IncomingMessage

clearCurrentFolder

public Map<Integer,Boolean> clearCurrentFolder()

Delete all messages in the current folder. Use the method folder(String folderName) to change folder. By default, it's "INBOX".

Returns:

a map with a key is a message ID, and a value is the result of deletion (true or false).

deleteMessages

public Map<Integer,Boolean> deleteMessages(Collection<Integer> ids)

Delete several messages by its identifiers.

Parameters:

ids - the list of message identifiers

Returns:

a map with a key is a message ID, and a value is the result of deletion (true or false).

deleteMessageById

public boolean deleteMessageById(Integer id)

Delete one message by the identifier.

Parameters:

id - the message identifier

Returns:

true if the message was deleted successfully, or else false