org.xwiki.mail

Interface MailContentStore

@Role
public interface MailContentStore

Save, load and delete mail content.

Since:

6.4M3

Version:

$Id: dfacd8aceaf47d3d1e9663a76b4d11255e4e4ce3 $

Method Summary

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

Method Detail

save

void save(String batchId,
          ExtendedMimeMessage 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.4.1

load

ExtendedMimeMessage load(javax.mail.Session session,
                         String batchId,
                         String uniqueMessageId)
                  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

uniqueMessageId - the unique 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

Since:

7.4.1

delete

void delete(String batchId,
            String uniqueMessageId)
     throws MailStoreException

Remove a message from the store.

Parameters:

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

uniqueMessageId - the unique id of the message that was originally saved

Throws:

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