ru.dlabs71.library.email.client.receiver

Interface ReceiverDClient

All Superinterfaces:

DClient

All Known Implementing Classes:

IMAPDClient

public interface ReceiverDClient
extends DClient

The general interface for a receiver client (IMAP, POP3, etc.).

Project name: d-email

Creation date: 2023-08-31

Since:

1.0.0

Author:

Ivanov Danila

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.
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.
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 interface ru.dlabs71.library.email.client.DClient

connect, getPrincipal, getProtocolName

Method Detail

getTotalCount

Integer getTotalCount(String folderName)

Returns the total count of email messages in the folder.

Parameters:

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

Returns:

total count of messages

checkEmailMessages

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.

Parameters:

folderName - the folder name in you account

pageRequest - selection size information

Returns:

list of a MessageView

readMessages

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.

Parameters:

folderName - the folder name in you account

pageRequest - selection size information

Returns:

list of a IncomingMessage

readMessageById

IncomingMessage readMessageById(String folderName,
                                int id)

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

Parameters:

folderName - the folder name in you account

id - unique identifier of a message within the folder

Returns:

object of a class IncomingMessage

openFolderForRead

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.

Parameters:

folderName - the folder name in you account

Returns:

an object of the class Folder

openFolderForWrite

jakarta.mail.Folder openFolderForWrite(String folderName)

Opens the folder for read and write.

Parameters:

folderName - the folder name in you account

Returns:

an object of the class Folder

closeFolder

void closeFolder(jakarta.mail.Folder folder)

Closes the opened folder.

Parameters:

folder - an object of the class Folder

deleteMessage

boolean deleteMessage(String folderName,
                      int id)

Deletes a message in a folder by its ID.

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

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

Deletes several messages in a folder by their IDs.

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

Map<Integer,Boolean> deleteAllMessages(String folderName)

Deletes all messages in a folder.

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).