org.xwiki.mail

Interface MailContentStore

@Role
@Unstable
public interface MailContentStore

Save, load and delete mail content.

Since:

6.4M3

Version:

$Id: 192149bfa399b0b51f06fb59ec9ecf0a15b52f9f $

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(String batchId, String messageId) Remove a message from the store.
javax.mail.internet.MimeMessage	load(javax.mail.Session session, String batchId, String messageId) Load message from the store.
void	save(String batchId, javax.mail.internet.MimeMessage message) Save MimeMessage to the store.

Method Detail

save

void save(String batchId,
        javax.mail.internet.MimeMessage message)
          throws MailStoreException

Save MimeMessage to the store.

Parameters:

batchId - the batch id of the message to be saved

message - the message to serialize in the store

Throws:

MailStoreException - when an error occurs when saving the message to the store

Since:

7.1RC1

load

javax.mail.internet.MimeMessage load(javax.mail.Session session,
                                   String batchId,
                                   String messageId)
                                     throws MailStoreException

Load message from the store.

Parameters:

session - the JavaMail session used to send the mail

batchId - the batch id of the message that was originally saved

messageId - the id of the message that was originally saved

Returns:

the MimeMessage instance deserialized from the store

Throws:

MailStoreException - when an error occurs when loading the message from the store

delete

void delete(String batchId,
          String messageId)
            throws MailStoreException

Remove a message from the store.

Parameters:

batchId - the batch id of the message that was originally saved

messageId - the id of the message that was originally saved

Throws:

MailStoreException - when an error occurs when deleting the message from the store