| org.sakaiproject.mailarchive.api.MailArchiveChannel
| MailArchiveChannel | | public interface MailArchiveChannel extends MessageChannel(Code) | |
MailArchiveChannel is the extension to the MessageChannel interface for a Sakai Mail Archive service. Messages in the MailArchiveChannel are MailArchiveMessages with MailArchiveMessageHeaders.
Security on the channel include:
- mailarchive.channel.read
- mailarchive.channel.remove.any
- mailarchive.channel.remove.own
- mailarchive.channel.post
Security Roles for the channel include:
- mailarchive.member: read, remove.own, post
- mailarchive.administrator: mailarchive.member, remove.any
Usage Events generated:
- mailarchive.channel.read - mailarchive message resource id
- mailarchive.channel.remove.any - mailarchive message resource id
- mailarchive.channel.remove.own - mailarchive message resource id
- mailarchive.channel.post - mailarchive message resource id
|
| Method Summary | |
| public MailArchiveMessage | addMailArchiveMessage(String subject, String fromAddress, Time dateSent, List mailHeaders, List attachments, String body)
a (MailArchiveMessage) cover for addMessage to add a new message to this channel.
Parameters:
subject - The message header subject.
Parameters:
fromAddress - The mail from: address from the message.
Parameters:
dateSent - The date: sent from the message.
Parameters:
mailHeaders - The full set of mail headers from the message.
Parameters:
attachments - The message header attachments, a vector of Reference objects.
Parameters:
body - The message body. | | public boolean | allowAddMessage(User user)
check permissions for addMessage() for the given user.
Parameters:
user - The user. | | public boolean | getEnabled()
true if the channel enabled, false if not. | | public MailArchiveMessage | getMailArchiveMessage(String messageId)
A (MailArchiveMessage) cover for getMessage to return a specific mail archive group message, as specified by message id.
Parameters:
messageId - The id of the message to get. | | public boolean | getOpen()
true if the channel is open to messages from outside the membership, false if not. |
| addMailArchiveMessage | | public MailArchiveMessage addMailArchiveMessage(String subject, String fromAddress, Time dateSent, List mailHeaders, List attachments, String body) throws PermissionException(Code) | | a (MailArchiveMessage) cover for addMessage to add a new message to this channel.
Parameters:
subject - The message header subject.
Parameters:
fromAddress - The mail from: address from the message.
Parameters:
dateSent - The date: sent from the message.
Parameters:
mailHeaders - The full set of mail headers from the message.
Parameters:
attachments - The message header attachments, a vector of Reference objects.
Parameters:
body - The message body. The newly added message.
exception:
PermissionException - If the user does not have write permission to the channel. |
| allowAddMessage | | public boolean allowAddMessage(User user)(Code) | | check permissions for addMessage() for the given user.
Parameters:
user - The user. true if the specified user is allowed to addMessage(...), false if not. |
| getEnabled | | public boolean getEnabled()(Code) | | true if the channel enabled, false if not. |
| getMailArchiveMessage | | public MailArchiveMessage getMailArchiveMessage(String messageId) throws IdUnusedException, PermissionException(Code) | | A (MailArchiveMessage) cover for getMessage to return a specific mail archive group message, as specified by message id.
Parameters:
messageId - The id of the message to get. the MailArchiveMessage that has the specified id.
exception:
IdUnusedException - If this name is not a defined message in this announcement channel.
exception:
PermissionException - If the user does not have any permissions to read the message. |
| getOpen | | public boolean getOpen()(Code) | | true if the channel is open to messages from outside the membership, false if not. |
|
|