io.github.amyassist.amy.plugin.email.rest

Class EMailResource

java.lang.Object

io.github.amyassist.amy.plugin.email.rest.EMailResource

@Path(value="email")
public class EMailResource
extends Object

Rest Resource for email

Author:

Muhammed Kaya

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH the resource path for this plugin

Constructor Summary

Constructors

Constructor and Description
EMailResource()

Method Summary

Modifier and Type	Method and Description
boolean	connect(EMailCredentials credentials) Connect to a mail service with the given parameters
void	disconnect() Disconnect the currently running connection to the mail server
MessageDTO[]	getMails(int amount) REST implementation of EMailLogic.getMailsForREST(int)
boolean	isConnected() Check, if currently connected to mail server

Methods inherited from class java.lang.Object

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

Field Detail

PATH

public static final String PATH

the resource path for this plugin

See Also:

Constant Field Values

Constructor Detail

EMailResource

public EMailResource()

Method Detail

isConnected

@GET
 @Path(value="isConnected")
 @Produces(value="application/json")
public boolean isConnected()

Check, if currently connected to mail server

Returns:

true, if currently connected to mail server, else false

connect

@POST
 @Path(value="connect")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public boolean connect(EMailCredentials credentials)

Connect to a mail service with the given parameters

Parameters:

credentials - the email credentials

Returns:

true if connecting was successful, else false

getMails

@GET
 @Path(value="getMails/{amount}")
 @Produces(value="application/json")
public MessageDTO[] getMails(@PathParam(value="amount")
                                                                                                            int amount)

REST implementation of EMailLogic.getMailsForREST(int)

Parameters:

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

Returns:

Array of all mails in inbox

disconnect

@POST
 @Path(value="disconnect")
public void disconnect()

Disconnect the currently running connection to the mail server