org.sakaiproject.service.legacy.email
Interface MailArchiveService

All Superinterfaces:
EntityProducer, MessageService
All Known Implementing Classes:
BaseMailArchiveService

public interface MailArchiveService
extends MessageService

MailArchiveService is the extension to MessageService configured for the Mail Archive.

Channels are MailArchiveChannels, and Messages are MailArchiveMessages with MailArchiveMessageHeaders.

Security in the mail archive service, in addition to that defined in the channels, include:

  • mailarchive.channel.remove
  • Usage Events are generated:

    Version:
    $Revision: 2371 $
    Author:
    University of Michigan, CHEF Software Development Team
    See Also:
    org.chefproject.core.MailArchiveChannel

    Nested Class Summary
     
    Nested classes inherited from class org.sakaiproject.service.legacy.entity.EntityProducer
    EntityProducer.ChangeType
     
    Field Summary
    static String HEADER_INNER_CONTENT_TYPE
              Message header that indicates the Content-Type of the message body of an archived message - this may be different from the original outer-envelope Content-Type (outer might be multipart)
    static String HEADER_OUTER_CONTENT_TYPE
              Message header that indicates the original outer-envelope Content-Type of an archived message
    static String REFERENCE_ROOT
              This string starts the references to resources in this service.
    static String SECURE_MAIL_ADD
              Security lock / event for adding channel / message.
    static String SECURE_MAIL_READ
              Security lock / event for reading channel / message.
    static String SECURE_MAIL_READ_DRAFT
              Security lock / event for accessing someone elses draft.
    static String SECURE_MAIL_REMOVE_ANY
              Security lock / event for removing anyone's message or channel.
    static String SECURE_MAIL_REMOVE_OWN
              Security lock / event for removing one's own message.
    static String SECURE_MAIL_ROOT
              Security lock / event root for generic message events to make it a mail event.
    static String SECURE_MAIL_UPDATE_ANY
              Security lock / event for updating any message.
    static String SECURE_MAIL_UPDATE_OWN
              Security lock / event for updating one's own message or the channel.
    static String SERVICE_NAME
              This string can be used to find the service in the service manager.
     
    Fields inherited from interface org.sakaiproject.service.legacy.message.MessageService
    REF_TYPE_CHANNEL, REF_TYPE_CHANNEL_GROUPS, REF_TYPE_MESSAGE, SECURE_ADD, SECURE_ALL_GROUPS, SECURE_READ, SECURE_READ_DRAFT, SECURE_REMOVE_ANY, SECURE_REMOVE_OWN, SECURE_UPDATE_ANY, SECURE_UPDATE_OWN
     
    Method Summary
     MailArchiveChannelEdit addMailArchiveChannel(String ref)
              A (MailArchiveChannel) cover for add() to add a new announcement channel.
     MailArchiveChannel getMailArchiveChannel(String ref)
              A (MailArchiveChannel) cover for getChannel() to return a specific mail archive group.
     
    Methods inherited from interface org.sakaiproject.service.legacy.message.MessageService
    addChannel, allowAddChannel, allowEditChannel, allowGetChannel, allowRemoveChannel, cancelChannel, cancelMessage, channelReference, commitChannel, editChannel, getChannel, getChannelIds, getChannels, getMessage, getMessages, messageReference, messageReference, removeChannel
     
    Methods inherited from interface org.sakaiproject.service.legacy.entity.EntityProducer
    archive, getEntity, getEntityAuthzGroups, getEntityDescription, getEntityResourceProperties, getEntityUrl, getHttpAccess, getLabel, importEntities, merge, parseEntityReference, syncWithSiteChange, willArchiveMerge, willImport
     

    Field Detail

    SERVICE_NAME

    public static final String SERVICE_NAME
    This string can be used to find the service in the service manager.


    REFERENCE_ROOT

    public static final String REFERENCE_ROOT
    This string starts the references to resources in this service.

    See Also:
    Constant Field Values

    SECURE_MAIL_ROOT

    public static final String SECURE_MAIL_ROOT
    Security lock / event root for generic message events to make it a mail event.

    See Also:
    Constant Field Values

    SECURE_MAIL_READ

    public static final String SECURE_MAIL_READ
    Security lock / event for reading channel / message.

    See Also:
    Constant Field Values

    SECURE_MAIL_ADD

    public static final String SECURE_MAIL_ADD
    Security lock / event for adding channel / message.

    See Also:
    Constant Field Values

    SECURE_MAIL_REMOVE_OWN

    public static final String SECURE_MAIL_REMOVE_OWN
    Security lock / event for removing one's own message.

    See Also:
    Constant Field Values

    SECURE_MAIL_REMOVE_ANY

    public static final String SECURE_MAIL_REMOVE_ANY
    Security lock / event for removing anyone's message or channel.

    See Also:
    Constant Field Values

    SECURE_MAIL_UPDATE_OWN

    public static final String SECURE_MAIL_UPDATE_OWN
    Security lock / event for updating one's own message or the channel.

    See Also:
    Constant Field Values

    SECURE_MAIL_UPDATE_ANY

    public static final String SECURE_MAIL_UPDATE_ANY
    Security lock / event for updating any message.

    See Also:
    Constant Field Values

    SECURE_MAIL_READ_DRAFT

    public static final String SECURE_MAIL_READ_DRAFT
    Security lock / event for accessing someone elses draft.

    See Also:
    Constant Field Values

    HEADER_OUTER_CONTENT_TYPE

    public static final String HEADER_OUTER_CONTENT_TYPE
    Message header that indicates the original outer-envelope Content-Type of an archived message

    See Also:
    Constant Field Values

    HEADER_INNER_CONTENT_TYPE

    public static final String HEADER_INNER_CONTENT_TYPE
    Message header that indicates the Content-Type of the message body of an archived message - this may be different from the original outer-envelope Content-Type (outer might be multipart)

    See Also:
    Constant Field Values
    Method Detail

    getMailArchiveChannel

    public MailArchiveChannel getMailArchiveChannel(String ref)
                                             throws IdUnusedException,
                                                    PermissionException
    A (MailArchiveChannel) cover for getChannel() to return a specific mail archive group.

    Parameters:
    ref - The channel reference.
    Returns:
    the MailArchiveChannel that has the specified name.
    Throws:
    IdUnusedException - If this name is not defined for a mail archive channel.
    PermissionException - If the user does not have any permissions to the channel.

    addMailArchiveChannel

    public MailArchiveChannelEdit addMailArchiveChannel(String ref)
                                                 throws IdUsedException,
                                                        IdInvalidException,
                                                        PermissionException
    A (MailArchiveChannel) cover for add() to add a new announcement channel.

    Parameters:
    ref - The channel reference.
    Returns:
    The newly created group.
    Throws:
    IdUsedException - if the id is not unique.
    IdInvalidException - if the id is not made up of valid characters.
    PermissionException - if the user does not have permission to add a group.