com.day.cq.mcm.emailprovider.types

Interface EmailTools

public interface EmailTools

Defines interface for all the tools that are supported by external mail provider. These tools are basically a mapping of a name with the corresponding HTML

Method Summary

Modifier and Type	Method and Description
void	addMapping(String toolName, String toolHtml, String toolText) This function adds a tool mapping.
String	getHtmlMapping(String toolName) This method returns a HTML mapping associated with the tool.
Map<String,String>	getHtmlMappings() This method returns all the tool-HTMl mappings.
String	getTextMapping(String toolName) This method returns the text mapping associated with the tool.
Map<String,String>	getTextMappings() This method returns all tool-Text mappings.
void	removeMapping(String toolName) This method removes a tool mapping.

Method Detail

addMapping

void addMapping(String toolName,
                String toolHtml,
                String toolText)

This function adds a tool mapping.

Parameters:

toolName - name of the tool

toolHtml - The HTML associated with the tool.

toolText - The text associated with the tool.

removeMapping

void removeMapping(String toolName)

This method removes a tool mapping.

Parameters:

toolName - the name of the tool.

getHtmlMapping

String getHtmlMapping(String toolName)

This method returns a HTML mapping associated with the tool.

Parameters:

toolName - name of the tool.

Returns:

The HTMl mapping with the tool.

getHtmlMappings

Map<String,String> getHtmlMappings()

This method returns all the tool-HTMl mappings.

Returns:

a map containing tool name and HTML mapping.

getTextMapping

String getTextMapping(String toolName)

This method returns the text mapping associated with the tool.

Parameters:

toolName - the name of the tool.

Returns:

The text associated with the tool.

getTextMappings

Map<String,String> getTextMappings()

This method returns all tool-Text mappings.

Returns:

A map containing tool name and text mapping.