org.springframework.roo.addon.email.addon

Interface MailOperations

All Superinterfaces:

org.springframework.roo.project.Feature

All Known Implementing Classes:

MailOperationsImpl

public interface MailOperations
extends org.springframework.roo.project.Feature

Provides email configuration operations.

Since:

1.0

Author:

Ben Alex, Manuel Iborra

Field Summary

Fields

Modifier and Type	Field and Description
static String	FEATURE_NAME

Method Summary

Modifier and Type	Method and Description
List<String>	getAllServiceImpl(String currentService) Get all the services implementations of the current project
void	installReceiveEmailSupport(String host, String port, String protocol, String username, String password, Boolean starttls, String jndiName, String profile, org.springframework.roo.project.maven.Pom module, org.springframework.roo.model.JavaType service, boolean force) Add support to obtain emails received into the configured account
void	installSendEmailSupport(String host, String port, String protocol, String username, String password, Boolean starttls, String jndiName, String profile, org.springframework.roo.project.maven.Pom module, org.springframework.roo.model.JavaType service, boolean force) Add support to send emails from the configured account
boolean	isEmailInstallationPossible() Indicates whether the command for adding mail support to the user's project is available.

Methods inherited from interface org.springframework.roo.project.Feature

getName, isInstalledInModule

Field Detail

FEATURE_NAME

static final String FEATURE_NAME

See Also:

Constant Field Values

Method Detail

installSendEmailSupport

void installSendEmailSupport(String host,
                             String port,
                             String protocol,
                             String username,
                             String password,
                             Boolean starttls,
                             String jndiName,
                             String profile,
                             org.springframework.roo.project.maven.Pom module,
                             org.springframework.roo.model.JavaType service,
                             boolean force)

Add support to send emails from the configured account

Parameters:

host - Server host

port - Server port

protocol - Protocol used to send emails

username - Account username

password - Account password

starttls - Enable or disable the use of the STARTTLS command

jndiName - Enable and set JNDI to send emails

profile - Indicate the profile where the properties will be set

module - Indicate the module where the properties will be set

service - Service implementantion where create an instance of JavaMailSender

force - Indicate if the properties will be overwritten

installReceiveEmailSupport

void installReceiveEmailSupport(String host,
                                String port,
                                String protocol,
                                String username,
                                String password,
                                Boolean starttls,
                                String jndiName,
                                String profile,
                                org.springframework.roo.project.maven.Pom module,
                                org.springframework.roo.model.JavaType service,
                                boolean force)

Add support to obtain emails received into the configured account

Parameters:

host - Server host

port - Server port

protocol - Protocol used to receive emails

username - Account username

password - Account password

starttls - Enable or disable the use of the STARTTLS command

jndiName - Enable and set JNDI to receive emails

profile - Indicate the profile where the properties will be set

module - Indicate the module where the properties will be set

service - Service implementantion where create an instance of MailReceiverService

force - Indicate if the properties will be overwritten

isEmailInstallationPossible

boolean isEmailInstallationPossible()

Indicates whether the command for adding mail support to the user's project is available.

Returns:

see above

getAllServiceImpl

List<String> getAllServiceImpl(String currentService)

Get all the services implementations of the current project

Parameters:

currentService - String that represents a service selected

Returns:

list with the package and name of all services implementations