org.sakaiproject.sitemanage.api

Interface UserNotificationProvider

public interface UserNotificationProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTIFY_FROM_CURRENT_USER Configuration parameter for sakai.properties.
static String	SITE_REF_PREFIX Entity prefix for sites

Method Summary

Modifier and Type	Method and Description
void	notifyAddedParticipant(boolean nonOfficialAccount, User user, Site site) Send email notification to added participant indicating they have been added to a site.
boolean	notifyCourseRequestAuthorizer(String instructorId, String requestEmail, String replyToEmail, String termTitle, String requestSectionInfo, String siteTitle, String siteId, String additionalInfo, String serverName) send course site request information to course authorizer return true if such email sent successfully; false otherwise
void	notifyCourseRequestRequester(String requestEmail, String supportEmailContent, String termTitle) notify course site requester
String	notifyCourseRequestSupport(String requestEmail, String serverName, String request, String termTitle, int requestListSize, String requestSectionInfo, String officialAccountName, String siteTitle, String siteId, String additionalInfo, boolean requireAuthorizer, String authorizerNotified, String authorizerNotNotified) notify support team about course creation
void	notifyNewUserEmail(User newUser, String newUserPassword, Site site) Send an email to newly added user informing them of their password.
void	notifySiteCreation(Site site, List notifySites, boolean courseSite, String termTitle, String requestEmail, boolean sendToRequestEmail, boolean sendToUser) notification for site creation
void	notifySiteImportCompleted(String toEmail, Locale locale, String siteId, String siteTitle) Notifies user when the course site import completed
void	notifyTemplateUse(Site templateSite, User templateUser, Site targetSite) send email notification to template contact people about template usage

Field Detail

NOTIFY_FROM_CURRENT_USER

static final String NOTIFY_FROM_CURRENT_USER

Configuration parameter for sakai.properties. Should the added participant emails come from the current user. The new account emails shouldn't use the current user as we don't want bounces containing passwords going back to the user who added it.

See Also:

Constant Field Values

SITE_REF_PREFIX

static final String SITE_REF_PREFIX

Entity prefix for sites

See Also:

Constant Field Values

Method Detail

notifyNewUserEmail

void notifyNewUserEmail(User newUser,
                        String newUserPassword,
                        Site site)

Send an email to newly added user informing them of their password.

Parameters:

newUser - The newly created user.

newUserPassword - The password for the newly created user.

site - The site in which the new user was created.

notifyAddedParticipant

void notifyAddedParticipant(boolean nonOfficialAccount,
                            User user,
                            Site site)

Send email notification to added participant indicating they have been added to a site.

Parameters:

nonOfficialAccount - true if the added user is a guest user rather than an official one.

user - The user who was newly added to the site.

site - The site to which the user was added as a participant.

notifyTemplateUse

void notifyTemplateUse(Site templateSite,
                       User templateUser,
                       Site targetSite)

send email notification to template contact people about template usage

Parameters:

templateSiteId -

templateUser -

templateSiteTitle -

targetSite -

notifySiteCreation

void notifySiteCreation(Site site,
                        List notifySites,
                        boolean courseSite,
                        String termTitle,
                        String requestEmail,
                        boolean sendToRequestEmail,
                        boolean sendToUser)

notification for site creation

Parameters:

site -

notifySites -

courseSite -

termTitle -

requestEmail -

sendToRequestEmail - if the email should be sent to requestEmail given.

sendToUser - if the email should be sent to the user who created the site

notifyCourseRequestAuthorizer

boolean notifyCourseRequestAuthorizer(String instructorId,
                                      String requestEmail,
                                      String replyToEmail,
                                      String termTitle,
                                      String requestSectionInfo,
                                      String siteTitle,
                                      String siteId,
                                      String additionalInfo,
                                      String serverName)

send course site request information to course authorizer return true if such email sent successfully; false otherwise

Parameters:

instructorId -

requestEmail -

replyToEmail -

termTitle -

requestSectionInfo -

siteTitle -

siteId -

additionalInfo -

serverName -

Returns:

notifyCourseRequestSupport

String notifyCourseRequestSupport(String requestEmail,
                                  String serverName,
                                  String request,
                                  String termTitle,
                                  int requestListSize,
                                  String requestSectionInfo,
                                  String officialAccountName,
                                  String siteTitle,
                                  String siteId,
                                  String additionalInfo,
                                  boolean requireAuthorizer,
                                  String authorizerNotified,
                                  String authorizerNotNotified)

notify support team about course creation

Parameters:

requestEmail -

serverName -

request -

termTitle -

requestListSize -

requestSectionInfo -

officialAccountName -

siteTitle -

siteId -

additionalInfo -

requireAuthorizer -

authorizerNotified -

authorizerNotNotified -

Returns:

notifyCourseRequestRequester

void notifyCourseRequestRequester(String requestEmail,
                                  String supportEmailContent,
                                  String termTitle)

notify course site requester

Parameters:

requestEmail -

supportEmailContent -

termTitle -

notifySiteImportCompleted

void notifySiteImportCompleted(String toEmail,
                               Locale locale,
                               String siteId,
                               String siteTitle)

Notifies user when the course site import completed

Parameters:

toEmail -

locale -

siteId -

siteTitle -