com.day.cq.mailer.email

Interface EmailTemplate<Type extends org.apache.commons.mail.Email>

Type Parameters:

Type -

All Superinterfaces:

MessageTemplate<Type>

public interface EmailTemplate<Type extends org.apache.commons.mail.Email>
extends MessageTemplate<Type>

Define a Template that can be used to build Emails.

Since:

5.4

See Also:

MessageTemplate

Method Summary

Modifier and Type	Method and Description
Charset	getCharSet()
javax.mail.internet.InternetAddress	getFrom()
String	getSubject()
String	getText()
void	setCharSet(Charset charSet)
void	setFrom(javax.mail.internet.InternetAddress from)
void	setSubject(String subject)
void	setText(String text)

Methods inherited from interface com.day.cq.mailer.MessageTemplate

buildMessage, buildMessage, dispose, getType, put

Method Detail

setText

void setText(String text)

Parameters:

text - to set as body of this message

getText

String getText()

Returns:

message body set on template

setSubject

void setSubject(String subject)

Parameters:

subject - to be used for the email

getSubject

String getSubject()

Returns:

the subject set to this template

setFrom

void setFrom(javax.mail.internet.InternetAddress from)
      throws javax.mail.internet.AddressException

Parameters:

from - and Address to be used as from

Throws:

javax.mail.internet.AddressException - in case the address is in invalid format

getFrom

javax.mail.internet.InternetAddress getFrom()

Returns:

the address set

setCharSet

void setCharSet(Charset charSet)

Parameters:

charSet - to use for sending

getCharSet

Charset getCharSet()

Returns:

charSet set