Package com.day.cq.mcm.api.newsletter
Interface NewsLetter
-
public interface NewsLetter
This object describes a newsletter and gives status information etc. todo: extend messageTemplate- Since:
- 5.4
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AuthorizableMailingList
getAuthorizableMailingList()
Access the Subscribers to this NewsletterInternetAddress
getFromAddress()
MessageTemplate
getMessageTemplate()
java.lang.String
getPath()
Return the content path.Session
getSession()
java.lang.String
getSubject()
Get the subject for sending this newsletter.void
setAuthorizableMailingList(AuthorizableMailingList list)
Sets the receivers of this List.void
setFromAddress(InternetAddress value)
void
setSubject(java.lang.String subject)
Set the subject for this newsletter.
-
-
-
Method Detail
-
getPath
java.lang.String getPath()
Return the content path.- Returns:
- The content path.
-
getSubject
java.lang.String getSubject()
Get the subject for sending this newsletter.- Returns:
- The subject.
-
setSubject
void setSubject(java.lang.String subject)
Set the subject for this newsletter.- Parameters:
subject
- the subject
-
getSession
Session getSession()
- Returns:
- used to build this letter
- Since:
- 5.4
-
setAuthorizableMailingList
void setAuthorizableMailingList(AuthorizableMailingList list)
Sets the receivers of this List.- Parameters:
list
- ofAuthorizable
this Letter should be send to.
-
getAuthorizableMailingList
AuthorizableMailingList getAuthorizableMailingList()
Access the Subscribers to this Newsletter- Returns:
- all Subscribers of this Newsletter
-
getFromAddress
InternetAddress getFromAddress()
- Returns:
- The from address or null.
-
setFromAddress
void setFromAddress(InternetAddress value) throws AddressException
- Parameters:
value
- the from address- Throws:
AddressException
- if the value doesn'tInternetAddress.validate()
validate validate}
-
getMessageTemplate
MessageTemplate getMessageTemplate()
- Returns:
- The Template build from this newsletter
-
-