com.day.cq.mcm.emailprovider.types

Interface Email

All Superinterfaces:

BaseType, NamedType

public interface Email
extends NamedType

Defines interface of email/newsletter to be sent to emailprovider. The methods for name and identifier are inherited from NamedType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL_CLASSIFICATION The email classification type would be stored as this parameter name in the email

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent() Get the email content
java.lang.String	getFromAddress() Get the email address for sender.
Resource	getResource()
java.lang.String	getSubject() Get the email subject.
boolean	isHtml() Whether the content is plain text or HTML
void	setContent(java.lang.String content) Set the email content
void	setFromAddress(java.lang.String fromAddress) Set the sender's email address.
void	setHtml(boolean isHtml) Set whether content is plain text or HTML
void	setResource(Resource resource) Set the resource to that of associated newsletter
void	setSubject(java.lang.String subject) Set the email subject

Methods inherited from interface com.day.cq.mcm.emailprovider.types.NamedType

getName, setName

Methods inherited from interface com.day.cq.mcm.emailprovider.types.BaseType

addParam, getId, getParam, getParams, setId, setParams

Field Detail

EMAIL_CLASSIFICATION

static final java.lang.String EMAIL_CLASSIFICATION

The email classification type would be stored as this parameter name in the email

See Also:

Constant Field Values

Method Detail

getSubject

java.lang.String getSubject()

Get the email subject.

Returns:

the subject for the email.

setSubject

void setSubject(java.lang.String subject)

Set the email subject

Parameters:

subject - The email subject.

getContent

java.lang.String getContent()

Get the email content

Returns:

The email content which could be a text or html.

setContent

void setContent(java.lang.String content)

Set the email content

Parameters:

content - The email content which could be text or html

isHtml

boolean isHtml()

Whether the content is plain text or HTML

Returns:

true if HTML, false otherwise.

setHtml

void setHtml(boolean isHtml)

Set whether content is plain text or HTML

Parameters:

isHtml - true if HTML, false otherwise.

getFromAddress

java.lang.String getFromAddress()

Get the email address for sender.

Returns:

the sender's email address.

setFromAddress

void setFromAddress(java.lang.String fromAddress)

Set the sender's email address.

Parameters:

fromAddress - sender's email address

setResource

void setResource(Resource resource)

Set the resource to that of associated newsletter

Parameters:

resource - of associated newsletter

getResource

Resource getResource()

Returns:

resource associated with newsletter