1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.mail

File MailContentStore.java

 

Code metrics

0
0
0
1
65
10
0
-
-
0
-

Classes

Class Line # Actions
MailContentStore 33 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.mail;
21   
22    import javax.mail.Session;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * Save, load and delete mail content.
28    *
29    * @version $Id: dfacd8aceaf47d3d1e9663a76b4d11255e4e4ce3 $
30    * @since 6.4M3
31    */
32    @Role
 
33    public interface MailContentStore
34    {
35    /**
36    * Save MimeMessage to the store.
37    *
38    * @param batchId the batch id of the message to be saved
39    * @param message the message to serialize in the store
40    * @throws MailStoreException when an error occurs when saving the message to the store
41    * @since 7.4.1
42    */
43    void save(String batchId, ExtendedMimeMessage message) throws MailStoreException;
44   
45    /**
46    * Load message from the store.
47    *
48    * @param session the JavaMail session used to send the mail
49    * @param batchId the batch id of the message that was originally saved
50    * @param uniqueMessageId the unique id of the message that was originally saved
51    * @return the MimeMessage instance deserialized from the store
52    * @throws MailStoreException when an error occurs when loading the message from the store
53    * @since 7.4.1
54    */
55    ExtendedMimeMessage load(Session session, String batchId, String uniqueMessageId) throws MailStoreException;
56   
57    /**
58    * Remove a message from the store.
59    *
60    * @param batchId the batch id of the message that was originally saved
61    * @param uniqueMessageId the unique id of the message that was originally saved
62    * @throws MailStoreException when an error occurs when deleting the message from the store
63    */
64    void delete(String batchId, String uniqueMessageId) throws MailStoreException;
65    }