io.github.amyassist.amy.plugin.email

Class EMailLogic

java.lang.Object

io.github.amyassist.amy.plugin.email.EMailLogic

@Service
public class EMailLogic
extends Object

Logic class for the email functionality, that defines all the behavior

Author:

Patrick Singer, Felix Burk, Patrick Gebhardt

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AMY_MAIL_ADDRESS_KEY Key for the Amy mail address in the config - declared protected for tests
protected static String	AMY_MAIL_PW_KEY Key for the Amy mail password in the config - declared protected for tests

Constructor Summary

Constructors

Constructor and Description
EMailLogic()

Method Summary

Modifier and Type	Method and Description
void	connectToMailServer() Connect to mail server with stored credentials, if there are any
boolean	connectToMailServer(EMailCredentials credentials) Set up connection to mail server with given parameters.
void	disconnectFromMailServer() Disconnect from currently connected mail service
EMailCredentials	getCredentials() Get the currently saved mail credentials
MessageDTO[]	getMailsForREST(int amount) Get all mails in the inbox and convert them to MessageDTO objects for the REST class to send to the web app
int	getNewMessageCount(boolean checkForImportant) Returns number of new messages in inbox.
boolean	hasNewMessages(boolean checkForImportant) returns if unread messages have been found
boolean	isConnectedToMailServer() Check if mail is currently connected to a mail server
String	printMessages(int amount, boolean important) Converts all new messages to a readable string

Methods inherited from class java.lang.Object

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

Field Detail

AMY_MAIL_ADDRESS_KEY

protected static final String AMY_MAIL_ADDRESS_KEY

Key for the Amy mail address in the config - declared protected for tests

See Also:

Constant Field Values

AMY_MAIL_PW_KEY

protected static final String AMY_MAIL_PW_KEY

Key for the Amy mail password in the config - declared protected for tests

See Also:

Constant Field Values

Constructor Detail

EMailLogic

public EMailLogic()

Method Detail

hasNewMessages

public boolean hasNewMessages(boolean checkForImportant)

returns if unread messages have been found

Parameters:

checkForImportant - set this to true if you want to look for IMPORTANT new mails, set this to false if you only want to look for new mails

Returns:

true, if messages have been found, else false

Throws:

IllegalStateException - when mail session is not connected

getNewMessageCount

public int getNewMessageCount(boolean checkForImportant)

Returns number of new messages in inbox. The word "new" here refers to unread messages

Parameters:

checkForImportant - put true here if you want the amount of new important mails

Returns:

number of messages in inbox

Throws:

IllegalStateException - when mail session is not connected

printMessages

public String printMessages(int amount,
                            boolean important)

Converts all new messages to a readable string

Parameters:

amount - amount of mails to print, put -1 here if you want every mail to be printed

important - set this to true, if you only want the important mails to be converted, set this to false if you want every message to be converted

Returns:

readable String of new messages

Throws:

IllegalStateException - when mail session is not connected

getMailsForREST

public MessageDTO[] getMailsForREST(int amount)

Get all mails in the inbox and convert them to MessageDTO objects for the REST class to send to the web app

Parameters:

amount - the amount of mails, put -1 here if you want all mails

Returns:

array with the requested mails, from newest to oldest, empty array if there was an error

Throws:

IllegalStateException - when mail session is not connected

connectToMailServer

public boolean connectToMailServer(EMailCredentials credentials)

Set up connection to mail server with given parameters. Put empty strings into all parameters if you want to connect with the Amy mail account

Parameters:

credentials - the email credentials

Returns:

true if connecting was successful, else false

isConnectedToMailServer

public boolean isConnectedToMailServer()

Check if mail is currently connected to a mail server

Returns:

true, if connected to mail server, else false

disconnectFromMailServer

public void disconnectFromMailServer()

Disconnect from currently connected mail service

getCredentials

public EMailCredentials getCredentials()

Get the currently saved mail credentials

Returns:

mail credentials if existing, else null

connectToMailServer

@PostConstruct
public void connectToMailServer()

Connect to mail server with stored credentials, if there are any