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
Modifier and TypeMethodDescriptionAccess the Subscribers to this NewslettergetPath()Return the content path.Get the subject for sending this newsletter.voidSets the receivers of this List.voidsetFromAddress(InternetAddress value) voidsetSubject(String subject) Set the subject for this newsletter.
-
Method Details
-
getPath
String getPath()Return the content path.- Returns:
- The content path.
-
getSubject
String getSubject()Get the subject for sending this newsletter.- Returns:
- The subject.
-
setSubject
Set the subject for this newsletter.- Parameters:
subject- the subject
-
getSession
Session getSession()- Returns:
- used to build this letter
- Since:
- 5.4
-
setAuthorizableMailingList
Sets the receivers of this List.- Parameters:
list- ofAuthorizablethis 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
- 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
-