org.jasig.portlet.emailpreview.service.link

Interface IEmailLinkService

All Known Implementing Classes:

SimpleEmailLinkServiceImpl

public interface IEmailLinkService

IEmailLinkService provides links to an external webmail client.

Author:

Jen Bourey, jbourey@unicon.net

Method Summary

Methods

Modifier and Type	Method and Description
List<ConfigurationParameter>	getAdminConfigurationParameters()
String	getInboxUrl(MailStoreConfiguration config) Get the URL of the inbox for this portlet request and mail store configuration.
String	getKey() Return the unique key for this link service.
List<ConfigurationParameter>	getUserConfigurationParameters()

Method Detail

getKey

String getKey()

Return the unique key for this link service. This key will be used to retrieve a link service instances from the registry.

Returns:

getInboxUrl

String getInboxUrl(MailStoreConfiguration config)

Get the URL of the inbox for this portlet request and mail store configuration. This method may simply provide the URL of an external webmail client. Some implementations may wish to support SSO or implement other interesting client-specific URLs.

Parameters:

config -

Returns:

getAdminConfigurationParameters

List<ConfigurationParameter> getAdminConfigurationParameters()

getUserConfigurationParameters

List<ConfigurationParameter> getUserConfigurationParameters()