aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/mail-remote/Evolution-DataServer-Mail.idl
blob: ffd32f85946d5efba1d319f02695c964c7671f1a (plain) (blame)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/* Evolution Mail Interface
 *
 * Copyright (C) 2005 Novell, Inc.
 *
 * Authors: Michael Zucchi <notzed@novell.com>
 */

#ifndef _EVOLUTION_DATASERVER_MAIL_IDL_
#define _EVOLUTION_DATASERVER_MAIL_IDL_

#include <Bonobo.idl>

module GNOME {
module Evolution {
module Mail {
    exception NOT_SUPPORTED {
//      string why;
    };

    exception FAILED {
        string why;
    };

    interface Folder;
    typedef sequence<Folder> Folders;

    struct FolderInfo {
        string name;
        string full_name;
        Folder folder;
    };
    typedef sequence <FolderInfo> FolderInfos;

    interface Store;
    typedef sequence<Store> Stores;

    struct StoreInfo {
        string name;
        string uid;
        Store store;
    };
    typedef sequence <StoreInfo> StoreInfos;

    interface Session;

    // ********************************************************************** 
    // MessageInfo wrappers
    typedef string UserFlag;
    typedef sequence <UserFlag> UserFlags;

    struct UserTag {
        string name;
        string value;   // value == "" == unset
    };
    typedef sequence <UserTag> UserTags;

    struct MessageInfo {
        string uid;
        string subject;
        string to;
        string from;
        long flags; // CamelMessageInfo flag bits
        UserFlags userFlags;
        UserTags userTags;
    };
    typedef sequence <MessageInfo> MessageInfos;

    // Used to pass to altering functions
    struct MessageInfoSet {
        string uid;
        long flagSet;   // values bits to set in the flags
        long flagMask;  // mask of bits to change in the flags
        UserFlags userFlagSet;
        UserFlags userFlagUnset;
        UserTags userTags;
    };
    typedef sequence <MessageInfoSet> MessageInfoSets;

    /* ********************************************************************** */
    // NB: tiny subset of omg properties service
    typedef string PropertyName;
    typedef sequence <PropertyName> PropertyNames;
    struct Property {
        PropertyName name;
        any value;
    };
    typedef sequence <Property> Properties;

    /* ********************************************************************** */

    enum ChangeType {
        ADDED,
        REMOVED,
        CHANGED
    };

    // ??
    struct SessionChange {
        ChangeType type;
        StoreInfos stores;
    };
    typedef sequence <SessionChange> SessionChanges;

    struct StoreChange {
        ChangeType type;
        FolderInfos folders;
    };
    typedef sequence <StoreChange> StoreChanges;

    struct FolderChange {
        ChangeType type;
        MessageInfos messages;
    };
    typedef sequence <FolderChange> FolderChanges;

    interface Listener : Bonobo::Unknown {
        oneway void sessionChanged(in Session session, in SessionChanges changes);
        // maybe folder/store should be folderinfo/storeinfo?
        oneway void storeChanged(in Session session, in Store store, in StoreChanges changes);
        oneway void folderChanged(in Session session, in Store store, in Folder folder, in FolderChanges changes);

        // session is closed/exited?
        //oneway void closed();
    };

    /* ********************************************************************** */

    interface Session : Bonobo::Unknown {
        // Flags to pass to addListener
        const long SESSION_ADDED = 1 << 0;
        const long SESSION_CHANGED = 1 << 1;
        const long SESSION_REMOVED = 1 << 2;
        const long STORE_ADDED = 1 << 3;
        const long STORE_CHANGED = 1 << 4;
        const long STORE_REMOVED = 1 << 5;
        const long FOLDER_ADDED = 1 << 6;
        const long FOLDER_CHANGED = 1 << 7;
        const long FOLDER_REMOVED = 1 << 8;

        boolean getProperties(in PropertyNames names, out Properties props);

        StoreInfos getStores(in string pattern);

        /* flags defines what to listen to */
        void addListener(in Listener listener, in long flags);
        void removeListener(in Listener listener);
    };

    interface Store : Bonobo::Unknown {
        boolean getProperties(in PropertyNames names, out Properties props);

        FolderInfos getFolders(in string pattern)
            raises (NOT_SUPPORTED, FAILED);

        void sendMessage(in Bonobo::Stream msg)
            raises (NOT_SUPPORTED, FAILED);
    };

    interface MessageIterator : Bonobo::Unknown {
        MessageInfos next(in long limit);
    };

    interface Folder : Bonobo::Unknown {
        boolean getProperties(in PropertyNames names, out Properties props);

        MessageIterator getMessages(in string pattern);

        void changeMessages(in MessageInfoSets infos);

//      Bonobo::Stream getMessage(in string uid);
//      void appendMessage(in MessageInfoSet info, in Bonobo::Stream msg);
    };
};
};
};

#endif