/**********************************************************************************
* $URL: https://source.sakaiproject.org/svn/mailarchive/trunk/mailarchive-api/api/src/java/org/sakaiproject/mailarchive/api/MailArchiveMessage.java $
* $Id: MailArchiveMessage.java 105079 2012-02-24 23:08:11Z ottenhoff@longsight.com $
***********************************************************************************
*
* Copyright (c) 2003, 2004, 2005, 2006, 2008 The Sakai Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.opensource.org/licenses/ECL-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
**********************************************************************************/
package org.sakaiproject.mailarchive.api;
import org.sakaiproject.message.api.Message;
/**
* <p>
* MailArchiveMessage is the Interface for a Salao Mail Archive message.
* </p>
* <p>
* The mail archive message has header fields (from, date) and a body (text). Each message also has an id, unique within the group. All fields are read only.
* </p>
*/
public interface MailArchiveMessage extends Message
{
/**
* A (MailArchiveMessageHeader) cover for getHeader to access the mail archive message header.
*
* @return The mail archive message header.
*/
public MailArchiveMessageHeader getMailArchiveHeader();
/**
* Get the html body, as a string.
*
* @return The html-encoded body, as a string.
*/
public String getHtmlBody();
/**
* Get the formatted body (either html or plain-text converted to html), as a string.
*
* @return The formatted body as a string.
*/
public String getFormattedBody();
}