Skip navigation links
A C D E G H I M N O P S U V 

A

addMessage(Map<String, Object[]>) - Method in exception org.sakaiproject.mailsender.MailsenderException
 
addMessage(String) - Method in exception org.sakaiproject.mailsender.MailsenderException
 
addMessage(String, String) - Method in exception org.sakaiproject.mailsender.MailsenderException
 
addMessage(String, Object[]) - Method in exception org.sakaiproject.mailsender.MailsenderException
 
addToArchive(ConfigEntry, String, String, String, String, List<Attachment>) - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Append email to Email Archive
ALLOW_PREFIX_CHANGE_PROP - Static variable in interface org.sakaiproject.mailsender.logic.ConfigLogic
 
allowSubjectPrefixChange() - Method in interface org.sakaiproject.mailsender.logic.ConfigLogic
Allow the user to change the prefix that is prepended to the subject of emails.
AttachmentException - Exception in org.sakaiproject.mailsender
 
AttachmentException() - Constructor for exception org.sakaiproject.mailsender.AttachmentException
 
AttachmentException(String) - Constructor for exception org.sakaiproject.mailsender.AttachmentException
 
AttachmentException(Throwable) - Constructor for exception org.sakaiproject.mailsender.AttachmentException
 
AttachmentException(String, Throwable) - Constructor for exception org.sakaiproject.mailsender.AttachmentException
 

C

ComposeLogic - Interface in org.sakaiproject.mailsender.logic
 
CONFIG_SAVED - Static variable in interface org.sakaiproject.mailsender.logic.ConfigLogic
 
ConfigEntry - Class in org.sakaiproject.mailsender.model
Programmatic view of the "Options" page in Mail Sender
ConfigEntry(String, boolean, boolean, boolean, String, boolean, String, boolean) - Constructor for class org.sakaiproject.mailsender.model.ConfigEntry
 
ConfigEntry.ConfigParams - Enum in org.sakaiproject.mailsender.model
 
ConfigEntry.ReplyTo - Enum in org.sakaiproject.mailsender.model
 
ConfigEntry.SubjectPrefixType - Enum in org.sakaiproject.mailsender.model
 
ConfigLogic - Interface in org.sakaiproject.mailsender.logic
 
countUsersByGroup(String) - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Get the number of users in a group.
countUsersByRole(String) - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Gets the numbers of users in a role.

D

DEFAULT_CONFIG - Static variable in class org.sakaiproject.mailsender.model.ConfigEntry
 
DEFAULT_SUBJECT_PREFIX - Static variable in interface org.sakaiproject.mailsender.logic.ConfigLogic
 
DEFAULT_SUBJECT_PREFIX_PROP - Static variable in interface org.sakaiproject.mailsender.logic.ConfigLogic
 
DISPLAY_EMPTY_GROUPS - Static variable in interface org.sakaiproject.mailsender.logic.ConfigLogic
 

E

EMAIL_TEST_MODE_PROP - Static variable in interface org.sakaiproject.mailsender.logic.ConfigLogic
 
EmailEntry - Class in org.sakaiproject.mailsender.model
 
EmailEntry(ConfigEntry) - Constructor for class org.sakaiproject.mailsender.model.EmailEntry
 
EmailRole - Class in org.sakaiproject.mailsender.model
EmailRole (can be a role, a section, a group)
EmailRole(String, String, String, String, EmailRole.Type) - Constructor for class org.sakaiproject.mailsender.model.EmailRole
 
EmailRole(String, String, String, String, EmailRole.Type, boolean) - Constructor for class org.sakaiproject.mailsender.model.EmailRole
 
EmailRole.Type - Enum in org.sakaiproject.mailsender.model
 
EVENT_EMAIL_SEND - Static variable in interface org.sakaiproject.mailsender.logic.ExternalLogic
 
ExternalLogic - Interface in org.sakaiproject.mailsender.logic
This is the interface for logic which is external to our app logic

G

getAttachments() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getConfig() - Method in interface org.sakaiproject.mailsender.logic.ConfigLogic
Get the current tool placement config
getConfig() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getContent() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getCsrf() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getCurrentLocationId() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
 
getCurrentSite() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get the current site's details
getCurrentSiteTitle() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
 
getCurrentUser() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get details for the current user
getCurrentUserId() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
 
getDefaultSubjectPrefix() - Method in interface org.sakaiproject.mailsender.logic.ConfigLogic
Returns the default subject prefix.
getEmailGroups() - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Get a list of groups available for this tool
getEmailRoles() - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Read the tool config and build the email roles that are specified
getEmailSections() - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Get the sections as by the section info tool
getFrom() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getGroupAwareRole() - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Get group-aware role which is set in sakai.properties e.g.
getGroupAwareRoleDefault() - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
// OOTB(Out of the box) Sakai defaults
getGroupIds() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getMessages() - Method in exception org.sakaiproject.mailsender.MailsenderException
 
getOtherRecipients() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getPermissionKeys() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get a list of the permission keys for the tool
getRealmId() - Method in class org.sakaiproject.mailsender.model.EmailRole
 
getReplyTo() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
getRoleId() - Method in class org.sakaiproject.mailsender.model.EmailRole
 
getRoleIds() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getRolePlural() - Method in class org.sakaiproject.mailsender.model.EmailRole
 
getRoleSingular() - Method in class org.sakaiproject.mailsender.model.EmailRole
 
getSectionIds() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getSiteID() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get the site id for the current site
getSiteRealmID() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get the realm id for the current site
getSiteType() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get the type of the current site
getSubject() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getSubjectPrefix() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
getSubjectPrefixType() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
getType() - Method in class org.sakaiproject.mailsender.model.EmailRole
 
getUploadDirectory() - Method in interface org.sakaiproject.mailsender.logic.ConfigLogic
Get the directory where uploads should be stored
getUser(String) - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get details for a user
getUserDisplayName(String) - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Get the display name for a user by their unique id
getUserIds() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
getUsers() - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
 
getUsersByGroup(String) - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Retrieve members for the current site that are of a certain group/section
getUsersByRole(String) - Method in interface org.sakaiproject.mailsender.logic.ComposeLogic
Retrieve members for the current site that are of a certain role.

H

hasMessages() - Method in exception org.sakaiproject.mailsender.MailsenderException
 

I

isAddToArchive() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
isAllIds() - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
isAppendRecipientList() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
isDisplayEmptyGroups() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
isDisplayInvalidEmails() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
isEmailArchiveAddedToSite() - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Check if the email archive tool is added to the current site
isEmailTestMode() - Method in interface org.sakaiproject.mailsender.logic.ConfigLogic
Check if the system is currently set up in a "test" mode, indicating that e-mails should not be actually dispatched, but rather spit into a log or external file for verification purposes.
isGroupAware() - Method in class org.sakaiproject.mailsender.model.EmailRole
 
isSendMeACopy() - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
isUserAdmin(String) - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Check if this user has super admin access
isUserAllowedInLocation(String, String, String) - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Check if a user has a specified permission within a context, primarily a convenience method and passthrough
isUserSiteAdmin(String, String) - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Check if this user has site update access

M

MailsenderException - Exception in org.sakaiproject.mailsender
General exception for Mailsender.
MailsenderException() - Constructor for exception org.sakaiproject.mailsender.MailsenderException
 
MailsenderException(String, String) - Constructor for exception org.sakaiproject.mailsender.MailsenderException
 
MailsenderException(List<Map<String, Object[]>>) - Constructor for exception org.sakaiproject.mailsender.MailsenderException
 
MailsenderException(String, Exception) - Constructor for exception org.sakaiproject.mailsender.MailsenderException
 

N

NO_LOCATION - Static variable in interface org.sakaiproject.mailsender.logic.ExternalLogic
 

O

org.sakaiproject.mailsender - package org.sakaiproject.mailsender
 
org.sakaiproject.mailsender.logic - package org.sakaiproject.mailsender.logic
 
org.sakaiproject.mailsender.model - package org.sakaiproject.mailsender.model
 

P

PERM_ADMIN - Static variable in interface org.sakaiproject.mailsender.logic.ExternalLogic
 
PERM_SEND - Static variable in interface org.sakaiproject.mailsender.logic.ExternalLogic
 

S

saveConfig(ConfigEntry) - Method in interface org.sakaiproject.mailsender.logic.ConfigLogic
Save the configuration to the tool placement config space
sendEmail(ConfigEntry, String, String, Map<String, String>, String, String, List<Attachment>) - Method in interface org.sakaiproject.mailsender.logic.ExternalLogic
Send email to a list of users.
setAddToArchive(boolean) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setAllIds(boolean) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setAppendRecipientList(boolean) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setAttachments(List<String>) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setConfig(ConfigEntry) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setContent(String) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setCsrf(String) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setDisplayEmptyGroups(boolean) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setDisplayInvalidEmails(boolean) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setFrom(String) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setGroupIds(Map<String, String>) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setOtherRecipients(String) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setOtherRecipients(List<String>) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setReplyTo(String) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setRoleIds(Map<String, String>) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setSectionIds(Map<String, String>) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setSendMeACopy(boolean) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setSubject(String) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 
setSubjectPrefix(String) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setSubjectPrefixType(String) - Method in class org.sakaiproject.mailsender.model.ConfigEntry
 
setUserIds(Map<String, String>) - Method in class org.sakaiproject.mailsender.model.EmailEntry
 

U

UPLOAD_DIRECTORY_PROP - Static variable in interface org.sakaiproject.mailsender.logic.ConfigLogic
 

V

valueOf(String) - Static method in enum org.sakaiproject.mailsender.model.ConfigEntry.ConfigParams
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sakaiproject.mailsender.model.ConfigEntry.ReplyTo
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sakaiproject.mailsender.model.ConfigEntry.SubjectPrefixType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sakaiproject.mailsender.model.EmailRole.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.sakaiproject.mailsender.model.ConfigEntry.ConfigParams
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sakaiproject.mailsender.model.ConfigEntry.ReplyTo
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sakaiproject.mailsender.model.ConfigEntry.SubjectPrefixType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sakaiproject.mailsender.model.EmailRole.Type
Returns an array containing the constants of this enum type, in the order they are declared.
A C D E G H I M N O P S U V 
Skip navigation links

Copyright © 2007–2019 Sakai Project. All rights reserved.