aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/mail-remote/Evolution-DataServer-Mail.idl
blob: bcadaacd479becbabd28851df1cfe6a96d8f39d5 (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
/* 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;

    struct Message {
        string uid;
        string subject;
        string to;
        string from;
    };
    typedef sequence <Message> Messages;

    /* ********************************************************************** */
    // 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;
        Folders folders;
    };
    typedef sequence <StoreChange> StoreChanges;

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

    interface Listener : Bonobo::Unknown {
        oneway void sessionChanged(in Session session, in SessionChange change);
        oneway void storeChanged(in Session session, in Store store, in StoreChanges change);
        oneway void folderChanged(in Session session, in Store store, in Folder folder, in FolderChanges changes);
    };

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

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

        StoreInfos getStores(in string pattern);

        void addListener(in Listener listener);
        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, in string from, in string recipients)
            raises (NOT_SUPPORTED, FAILED);
    };

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

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

        MessageIterator getMessages(in string pattern);

        Bonobo::Stream getMessage(in string uid);

//      void appendMessage(in MessageInfo info, in Bonobo::Stream msg);
    };
};
};
};

#endif