ru.dlabs71.library.email.client.receiver

Class IMAPDClient

java.lang.Object

ru.dlabs71.library.email.client.receiver.IMAPDClient

All Implemented Interfaces:

DClient, ReceiverDClient

public class IMAPDClient
extends Object
implements ReceiverDClient

This class is an implementation of the interface ReceiverDClient. It provides opportunities for reading messages from email using the IMAP protocol. An IMAP connection will be established by creating the class at once. Then, you need to set up a store - email account. An IMAP connection may work with only one account at one time.

You should use the instance of the ImapProperties class, for configure this class.

Project name: d-email

Creation date: 2023-10-25

Since:

1.0.0

Author:

Ivanov Danila

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_INBOX_FOLDER_NAME The default name of the inbox mail folder.
static String	DEFAULT_OUTBOX_FOLDER_NAME The default name of the outbox mail folder.

Constructor Summary

Constructors

Constructor and Description
IMAPDClient(ImapProperties imapProperties) Constructor of the class.

Method Summary

Modifier and Type	Method and Description
List<MessageView>	checkEmailMessages(String folderName, PageRequest pageRequest) Returns short information about messages.
void	closeFolder(jakarta.mail.Folder folder) Closes the opened folder.
jakarta.mail.Session	connect() Connects to the email server using the IMAP protocol.
Map<Integer,Boolean>	deleteAllMessages(String folderName) Deletes all messages in a folder.
boolean	deleteMessage(String folderName, int id) Deletes a message in a folder by its ID.
Map<Integer,Boolean>	deleteMessages(String folderName, Collection<Integer> ids) Deletes several messages in a folder by their IDs.
EmailParticipant	getPrincipal() Returns name and email address used for connection.
String	getProtocolName() Returns a using protocol name.
Integer	getTotalCount(String folderName) Returns the total count of email messages in the folder.
jakarta.mail.Folder	openFolderForRead(String folderName) Opens the folder for only read.
jakarta.mail.Folder	openFolderForWrite(String folderName) Opens the folder for read and write.
IncomingMessage	readMessageById(String folderName, int id) Reads message by its ID (number message).
List<IncomingMessage>	readMessages(String folderName, PageRequest pageRequest) Return full information about messages.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INBOX_FOLDER_NAME

public static final String DEFAULT_INBOX_FOLDER_NAME

The default name of the inbox mail folder.

See Also:

Constant Field Values

DEFAULT_OUTBOX_FOLDER_NAME

public static final String DEFAULT_OUTBOX_FOLDER_NAME

The default name of the outbox mail folder.

See Also:

Constant Field Values

Constructor Detail

IMAPDClient

public IMAPDClient(ImapProperties imapProperties)

Constructor of the class.

An IMAP connection and store will be created with the class at once.

Parameters:

imapProperties - properties for creating an IMAP connection

Method Detail

connect

public jakarta.mail.Session connect()
                             throws SessionException

Connects to the email server using the IMAP protocol.

Specified by:

connect in interface DClient

Returns:

Session object

Throws:

SessionException - The connection to the server has failed. The properties are broken.

getProtocolName

public final String getProtocolName()

Returns a using protocol name.

Specified by:

getProtocolName in interface DClient

getPrincipal

public final EmailParticipant getPrincipal()

Returns name and email address used for connection.

Specified by:

getPrincipal in interface DClient

getTotalCount

public Integer getTotalCount(String folderName)

Returns the total count of email messages in the folder.

Specified by:

getTotalCount in interface ReceiverDClient

Parameters:

folderName - the folder name (For example: INBOX, OUTBOX, etc.)

Returns:

total count of messages

checkEmailMessages

public List<MessageView> checkEmailMessages(String folderName,
                                            PageRequest pageRequest)

Returns short information about messages. without content. Use it when you "check" an email. Messages won't be marked as read.

Specified by:

checkEmailMessages in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

pageRequest - selection size information

Returns:

list of a MessageView

readMessages

public List<IncomingMessage> readMessages(String folderName,
                                          PageRequest pageRequest)

Return full information about messages. Use it when you "read" an email. Messages will be marked as read.

Specified by:

readMessages in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

pageRequest - selection size information

Returns:

list of a IncomingMessage

readMessageById

public IncomingMessage readMessageById(String folderName,
                                       int id)

Reads message by its ID (number message). Message will be marked as read.

Specified by:

readMessageById in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

id - unique identifier of a message within the folder

Returns:

object of a class IncomingMessage

openFolderForRead

public jakarta.mail.Folder openFolderForRead(String folderName)

Opens the folder for only read. Changes are forbidden. If you even read the message, it won't be marked as read.

Specified by:

openFolderForRead in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

Returns:

an object of the class Folder

openFolderForWrite

public jakarta.mail.Folder openFolderForWrite(String folderName)

Opens the folder for read and write.

Specified by:

openFolderForWrite in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

Returns:

an object of the class Folder

closeFolder

public void closeFolder(jakarta.mail.Folder folder)

Closes the opened folder.

Specified by:

closeFolder in interface ReceiverDClient

Parameters:

folder - an object of the class Folder

deleteMessage

public boolean deleteMessage(String folderName,
                             int id)

Deletes a message in a folder by its ID.

Specified by:

deleteMessage in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

id - unique identifier of a message within the folder

Returns:

true if the message was deleted successfully, or else false

deleteMessages

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

Deletes several messages in a folder by their IDs.

Specified by:

deleteMessages in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

ids - unique identifiers of messages within the folder

Returns:

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

deleteAllMessages

public Map<Integer,Boolean> deleteAllMessages(String folderName)

Deletes all messages in a folder.

Specified by:

deleteAllMessages in interface ReceiverDClient

Parameters:

folderName - the folder name in you account

Returns:

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