| java.lang.Object
 org.sakaiproject.util.EmailNotification
org.sakaiproject.util.SiteEmailNotification
All known Subclasses: org.sakaiproject.mailarchive.impl.SiteEmailNotificationMail, org.sakaiproject.content.impl.SiteEmailNotificationContent, uk.ac.cam.caret.sakai.rwiki.component.service.impl.SiteEmailNotificationRWiki, org.sakaiproject.component.app.syllabus.SiteEmailNotificationSyllabus, org.sakaiproject.announcement.impl.SiteEmailNotificationAnnc,
| SiteEmailNotification | | public class SiteEmailNotification extends EmailNotification (Code) | |
SiteEmailNotification is an EmailNotification that selects the site's participants (based on site access) as the recipients of the notification.
getRecipients() is satified here (although it can be customized by the extensions to this class).
The following should be specified to extend the class:
- getResourceAbility() - to require an additional permission to qualify as a recipient (other than site membership)
- addSpecialRecipients() - to add other recipients
|
| Method Summary | |
| protected void | addSpecialRecipients(List users, Reference ref)
Add to the user list any other users who should be notified about this ref's change. | | public NotificationAction | getClone()
| | protected List | getRecipients(Event event)
| | protected String | getResourceAbility()
Get the additional security function string needed for the resource that is the target of the notification
users who get notified need to have this ability with this resource, too. | | protected String | getTo(Event event)
Format a to address, sensitive to the notification service's replyable configuration. | | protected String | getToSite(Event event)
Format the to site email address.
Parameters:
event - The event that matched criteria to cause the notification. | | protected String | getToSiteNoReply(Event event)
Format a to address, to the related site, but with no reply.
Parameters:
event - The event that matched criteria to cause the notification. |
| SiteEmailNotification | | public SiteEmailNotification()(Code) | | Construct.
|
| SiteEmailNotification | | public SiteEmailNotification(String siteId)(Code) | | Construct.
Parameters:
siteId - The id of the site whose users will get a mailing. |
| addSpecialRecipients | | protected void addSpecialRecipients(List users, Reference ref)(Code) | | Add to the user list any other users who should be notified about this ref's change.
Parameters:
users - The user list, already populated based on site visit and resource ability.
Parameters:
ref - The entity reference. |
| getResourceAbility | | protected String getResourceAbility()(Code) | | Get the additional security function string needed for the resource that is the target of the notification
users who get notified need to have this ability with this resource, too.
The additional ability string needed for a user to receive notification. |
| getTo | | protected String getTo(Event event)(Code) | | Format a to address, sensitive to the notification service's replyable configuration.
Parameters:
event - |
| getToSite | | protected String getToSite(Event event)(Code) | | Format the to site email address.
Parameters:
event - The event that matched criteria to cause the notification. the email address attribution for the site. |
| getToSiteNoReply | | protected String getToSiteNoReply(Event event)(Code) | | Format a to address, to the related site, but with no reply.
Parameters:
event - The event that matched criteria to cause the notification. a to address, to the related site, but with no reply. |
| Methods inherited from org.sakaiproject.util.EmailNotification | protected List digestRecipients(List recipients, Notification notification, Event event)(Code)(Java Doc)
protected String findHeader(String header, List headers)(Code)(Java Doc)
protected String findHeaderValue(String header, List headers)(Code)(Java Doc)
public NotificationAction getClone()(Code)(Java Doc)
protected String getFrom(Event event)(Code)(Java Doc)
protected String getFromEventUser(Event event)(Code)(Java Doc)
protected String getFromService()(Code)(Java Doc)
protected List getHeaders(Event event)(Code)(Java Doc)
protected String getMessage(Event event)(Code)(Java Doc)
protected int getOption(User user, Notification notification, Event event)(Code)(Java Doc)
protected List getRecipients(Event event)(Code)(Java Doc)
protected String getSite()(Code)(Java Doc)
protected String getTag(String newline, String title)(Code)(Java Doc)
protected List immediateRecipients(List recipients, Notification notification, Event event)(Code)(Java Doc)
protected boolean isBodyHTML(Event event)(Code)(Java Doc)
protected boolean isImmediateDeliveryOption(int option, Notification notification)(Code)(Java Doc)
public void notify(Notification notification, Event event)(Code)(Java Doc)
public void set(Element el)(Code)(Java Doc)
public void set(NotificationAction other)(Code)(Java Doc)
public void toXml(Element el)(Code)(Java Doc)
|
|
|