1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# -*- coding: utf-8 -*-
# interfaces.py
# Copyright (C) 2014 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Interfaces for the IMAP module.
"""
from zope.interface import Interface, Attribute
class IMessageContainer(Interface):
"""
I am a container around the different documents that a message
is split into.
"""
fdoc = Attribute('The flags document for this message, if any.')
hdoc = Attribute('The headers document for this message, if any.')
cdocs = Attribute('The dict of content documents for this message, '
'if any.')
def walk(self):
"""
Return an iterator to the docs for all the parts.
:rtype: iterator
"""
class IMessageStore(Interface):
"""
I represent a generic storage for LEAP Messages.
"""
def create_message(self, mbox, uid, message):
"""
Put the passed message into this IMessageStore.
:param mbox: the mbox this message belongs.
:param uid: the UID that identifies this message in this mailbox.
:param message: a IMessageContainer implementor.
"""
def put_message(self, mbox, uid, message):
"""
Put the passed message into this IMessageStore.
:param mbox: the mbox this message belongs.
:param uid: the UID that identifies this message in this mailbox.
:param message: a IMessageContainer implementor.
"""
def remove_message(self, mbox, uid):
"""
Remove the given message from this IMessageStore.
:param mbox: the mbox this message belongs.
:param uid: the UID that identifies this message in this mailbox.
"""
def get_message(self, mbox, uid):
"""
Get a IMessageContainer for the given mbox and uid combination.
:param mbox: the mbox this message belongs.
:param uid: the UID that identifies this message in this mailbox.
:return: IMessageContainer
"""
class IMessageStoreWriter(Interface):
"""
I represent a storage that is able to write its contents to another
different IMessageStore.
"""
def write_messages(self, store):
"""
Write the documents in this IMessageStore to a different
storage. Usually this will be done from a MemoryStorage to a DbStorage.
:param store: another IMessageStore implementor.
"""
|
