← Back to branch summary

~ubuntu-branches/ubuntu/karmic/libtinymail/karmic

« back to all changes in this revision

Viewing changes to docs/devel/reference/libtinymail-docs.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-10-12 11:21:12 UTC
  • Revision ID: james.westby@ubuntu.com-20071012112112-fod9fs7yrooxjr7i
Tags: upstream-0.0.2
Import upstream version 0.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/devel/reference/libtinymail-docs.sgml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
 
 
5
<!ENTITY libtinymail-TnyEnums SYSTEM "xml/tny-enums.xml">
 
6
<!ENTITY libtinymail-TnyAccount SYSTEM "xml/tny-account.xml">
 
7
<!ENTITY libtinymail-TnyStoreAccount SYSTEM "xml/tny-store-account.xml">
 
8
<!ENTITY libtinymail-TnyFolderStore SYSTEM "xml/tny-folder-store.xml">
 
9
<!ENTITY libtinymail-TnyFolderStoreQuery SYSTEM "xml/tny-folder-store-query.xml">
 
10
<!ENTITY libtinymail-TnyTransportAccount SYSTEM "xml/tny-transport-account.xml">
 
11
<!ENTITY libtinymail-TnyAccountStore SYSTEM "xml/tny-account-store.xml">
 
12
<!ENTITY libtinymail-TnyHeader SYSTEM "xml/tny-header.xml">
 
13
<!ENTITY libtinymail-TnyStatus SYSTEM "xml/tny-status.xml">
 
14
<!ENTITY libtinymail-TnyMsg SYSTEM "xml/tny-msg.xml">
 
15
<!ENTITY libtinymail-TnyMimePart SYSTEM "xml/tny-mime-part.xml">
 
16
<!ENTITY libtinymail-TnyStream SYSTEM "xml/tny-stream.xml">
 
17
<!ENTITY libtinymail-TnyFsStream SYSTEM "xml/tny-fs-stream.xml">
 
18
<!ENTITY libtinymail-TnyFolder SYSTEM "xml/tny-folder.xml">
 
19
<!ENTITY libtinymail-TnyDevice SYSTEM "xml/tny-device.xml">
 
20
<!ENTITY libtinymail-TnyList SYSTEM "xml/tny-list.xml">
 
21
<!ENTITY libtinymail-TnyIterator SYSTEM "xml/tny-iterator.xml">
 
22
<!ENTITY libtinymail-TnySimpleList SYSTEM "xml/tny-simple-list.xml">
 
23
<!ENTITY libtinymail-TnyMsgRemoveStrategy SYSTEM "xml/tny-msg-remove-strategy.xml">
 
24
<!ENTITY libtinymail-TnyMsgReceiveStrategy SYSTEM "xml/tny-msg-receive-strategy.xml">
 
25
<!ENTITY libtinymail-TnySendQueue SYSTEM "xml/tny-send-queue.xml">
 
26
<!ENTITY libtinymail-TnyPair SYSTEM "xml/tny-pair.xml">
 
27
<!ENTITY libtinymail-TnyLockable SYSTEM "xml/tny-lockable.xml">
 
28
<!ENTITY libtinymail-TnyNoopLockable SYSTEM "xml/tny-noop-lockable.xml">
 
29
<!ENTITY libtinymail-TnyFolderMonitor SYSTEM "xml/tny-folder-monitor.xml">
 
30
<!ENTITY libtinymail-TnyFolderStats SYSTEM "xml/tny-folder-stats.xml">
 
31
<!ENTITY libtinymail-TnyFolderObserver SYSTEM "xml/tny-folder-observer.xml">
 
32
<!ENTITY libtinymail-TnyFolderChange SYSTEM "xml/tny-folder-change.xml">
 
33
<!ENTITY libtinymail-TnyFolderStoreObserver SYSTEM "xml/tny-folder-store-observer.xml">
 
34
<!ENTITY libtinymail-TnyFolderStoreChange SYSTEM "xml/tny-folder-store-change.xml">
 
35
<!ENTITY libtinymail-TnyPasswordGetter SYSTEM "xml/tny-password-getter.xml">
 
36
<!ENTITY libtinymail-TnyMergeFolder SYSTEM "xml/tny-merge-folder.xml">
 
37
<!ENTITY libtinymail-TnyShared SYSTEM "xml/tny-shared.xml">
 
38
<!ENTITY libtinymail-TnyCombinedAccount SYSTEM "xml/tny-combined-account.xml">
 
39
 
 
40
<!ENTITY libtinymail-camel-TnyCamelSendQueue SYSTEM "xml/tny-camel-send-queue.xml">
 
41
<!ENTITY libtinymail-camel-TnyCamelMsgRemoveStrategy SYSTEM "xml/tny-camel-msg-remove-strategy.xml">
 
42
<!ENTITY libtinymail-camel-TnyCamelFullMsgReceiveStrategy SYSTEM "xml/tny-camel-full-msg-receive-strategy.xml">
 
43
<!ENTITY libtinymail-camel-TnyCamelPartialMsgReceiveStrategy SYSTEM "xml/tny-camel-partial-msg-receive-strategy.xml">
 
44
<!ENTITY libtinymail-camel-TnyCamelAccount SYSTEM "xml/tny-camel-account.xml">
 
45
<!ENTITY libtinymail-camel-TnyCamelStoreAccount SYSTEM "xml/tny-camel-store-account.xml">
 
46
<!ENTITY libtinymail-camel-TnyCamelIMAPStoreAccount SYSTEM "xml/tny-camel-imap-store-account.xml">
 
47
<!ENTITY libtinymail-camel-TnyCamelNNTPStoreAccount SYSTEM "xml/tny-camel-nntp-store-account.xml">
 
48
<!ENTITY libtinymail-camel-TnyCamelPOPStoreAccount SYSTEM "xml/tny-camel-pop-store-account.xml">
 
49
<!ENTITY libtinymail-camel-TnyCamelTransportAccount SYSTEM "xml/tny-camel-transport-account.xml">
 
50
<!ENTITY libtinymail-camel-TnyCamelStream SYSTEM "xml/tny-camel-stream.xml">
 
51
<!ENTITY libtinymail-camel-TnyCamelFolder SYSTEM "xml/tny-camel-folder.xml">
 
52
<!ENTITY libtinymail-camel-TnyCamelIMAPFolder SYSTEM "xml/tny-camel-imap-folder.xml">
 
53
<!ENTITY libtinymail-camel-TnyCamelNNTPFolder SYSTEM "xml/tny-camel-nntp-folder.xml">
 
54
<!ENTITY libtinymail-camel-TnyCamelPOPFolder SYSTEM "xml/tny-camel-pop-folder.xml">
 
55
<!ENTITY libtinymail-camel-TnyCamelMimePart SYSTEM "xml/tny-camel-mime-part.xml">
 
56
<!ENTITY libtinymail-camel-TnyCamelMsg SYSTEM "xml/tny-camel-msg.xml">
 
57
<!ENTITY libtinymail-camel-TnySessionCamel SYSTEM "xml/tny-session-camel.xml">
 
58
<!ENTITY libtinymail-camel-TnyStreamCamel SYSTEM "xml/tny-stream-camel.xml">
 
59
<!ENTITY libtinymail-camel-TnyCamelShared SYSTEM "xml/tny-camel-shared.xml">
 
60
 
 
61
<!ENTITY libtinymail-gnomevfs-TnyVfsStream SYSTEM "xml/tny-vfs-stream.xml">
 
62
 
 
63
<!ENTITY libtinymailui-gtk-TnyGtkAttachmentMimePartView SYSTEM "xml/tny-gtk-attachment-mime-part-view.xml">
 
64
<!ENTITY libtinymailui-gtk-TnyGtkEnums SYSTEM "xml/tny-gtk-enums.xml">
 
65
<!ENTITY libtinymailui-gtk-TnyGtkFolderStoreTreeModel SYSTEM "xml/tny-gtk-folder-store-tree-model.xml">
 
66
<!ENTITY libtinymailui-gtk-TnyGtkAccountListModel SYSTEM "xml/tny-gtk-account-list-model.xml">
 
67
<!ENTITY libtinymailui-gtk-TnyGtkAttachListModel SYSTEM "xml/tny-gtk-attach-list-model.xml">
 
68
<!ENTITY libtinymailui-gtk-TnyGtkHeaderListModel SYSTEM "xml/tny-gtk-header-list-model.xml">
 
69
<!ENTITY libtinymailui-gtk-TnyGtkTextBufferStream SYSTEM "xml/tny-gtk-text-buffer-stream.xml">
 
70
<!ENTITY libtinymailui-gtk-TnyGtkMsgView SYSTEM "xml/tny-gtk-msg-view.xml">
 
71
<!ENTITY libtinymailui-gtk-TnyGtkHeaderView SYSTEM "xml/tny-gtk-header-view.xml">
 
72
<!ENTITY libtinymailui-gtk-TnyGtkMsgWindow SYSTEM "xml/tny-gtk-msg-window.xml">
 
73
<!ENTITY libtinymailui-gtk-TnyGtkMimePartSaveStrategy SYSTEM "xml/tny-gtk-mime-part-save-strategy.xml">
 
74
<!ENTITY libtinymailui-gtk-TnyGtkTextMimePartView SYSTEM "xml/tny-gtk-text-mime-part-view.xml">
 
75
<!ENTITY libtinymailui-gtk-TnyGtkLockable SYSTEM "xml/tny-gtk-lockable.xml">
 
76
<!ENTITY libtinymailui-gtk-TnyGtkPasswordDialog SYSTEM "xml/tny-gtk-password-dialog.xml">
 
77
 
 
78
<!ENTITY libtinymailui-TnyMimePartSaver SYSTEM "xml/tny-mime-part-saver.xml">
 
79
<!ENTITY libtinymailui-TnyMsgWindow SYSTEM "xml/tny-msg-window.xml">
 
80
<!ENTITY libtinymailui-TnyMsgView SYSTEM "xml/tny-msg-view.xml">
 
81
<!ENTITY libtinymailui-TnyHeaderView SYSTEM "xml/tny-header-view.xml">
 
82
<!ENTITY libtinymailui-TnyPlatformFactory SYSTEM "xml/tny-platform-factory.xml">
 
83
<!ENTITY libtinymailui-TnyAccountStoreView SYSTEM "xml/tny-account-store-view.xml">
 
84
<!ENTITY libtinymailui-TnyMimePartSaveStrategy SYSTEM "xml/tny-mime-part-save-strategy.xml">
 
85
<!ENTITY libtinymailui-TnySummaryView SYSTEM "xml/tny-summary-view.xml">
 
86
<!ENTITY libtinymailui-TnyMimePartView SYSTEM "xml/tny-mime-part-view.xml">
 
87
 
 
88
<!ENTITY libtinymailui-mozembed-TnyMozEmbedStream SYSTEM "xml/tny-moz-embed-stream.xml">
 
89
<!ENTITY libtinymailui-mozembed-TnyMozEmbedMsgView SYSTEM "xml/tny-moz-embed-msg-view.xml">
 
90
<!ENTITY libtinymailui-mozembed-TnyMozEmbedHtmlMimePartView SYSTEM "xml/tny-moz-embed-html-mime-part-view.xml">
 
91
 
 
92
<!ENTITY libtinymail-gnome-desktop-TnyGnomePlatformFactory SYSTEM "xml/tny-gnome-platform-factory.xml">
 
93
<!ENTITY libtinymail-gnome-desktop-TnyGnomeAccountStore SYSTEM "xml/tny-gnome-account-store.xml">
 
94
<!ENTITY libtinymail-gnome-desktop-TnyGnomeDevice SYSTEM "xml/tny-gnome-device.xml">
 
95
 
 
96
<!ENTITY libtinymail-asyncworker-TnyAsyncWorkerQueueTask SYSTEM "xml/tny-async-worker-queue-task.xml">
 
97
<!ENTITY libtinymail-asyncworker-TnyAsyncWorkerQueue SYSTEM "xml/tny-async-worker-queue.xml">
 
98
 
 
99
<!-- !ENTITY libtinymail-queues-TnyQueue SYSTEM "xml/tny-queue.xml" //-->
 
100
<!-- !ENTITY libtinymail-queues-TnyQueueTask SYSTEM "xml/tny-queue-task.xml" //-->
 
101
<!-- !ENTITY libtinymail-queues-TnyGenericSendQueue SYSTEM "xml/tny-generic-send-queue.xml" //-->
 
102
<!-- !ENTITY libtinymail-queues-TnyGetMsgQueue SYSTEM "xml/tny-get-msg-queue.xml" //-->
 
103
 
 
104
<!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml">
 
105
 
 
106
]>
 
107
 
 
108
<book id="index">
 
109
  <bookinfo>
 
110
    <title>Reference Manual of the tinymail framework</title>
 
111
  </bookinfo>
 
112
 
 
113
  <preface>
 
114
    <title>Introduction</title>
 
115
    <para>Tinymail is a development framework for both accessing E-mail services 
 
116
        and building a user interface for it.</para>
 
117
    <para>It will make sure that you as a developer can do this on devices with
 
118
        low memory resources.</para>
 
119
    <para>It supports IMAP, POP and NNTP. It can be used to send 
 
120
        messages over SMTP.</para>
 
121
    <para>It's licensed as LGPL.</para>
 
122
  </preface>
 
123
 
 
124
  <reference>
 
125
    <title>Object Index</title>
 
126
        &index-Object-Tree;
 
127
  </reference>
 
128
 
 
129
  <reference>
 
130
    <title>API Reference</title>
 
131
 
 
132
        <chapter id="libtinymail">
 
133
                <title>libtinymail - main abstraction library</title>
 
134
                &libtinymail-TnyAccountStore;
 
135
                &libtinymail-TnyFolderStore;
 
136
                &libtinymail-TnyFolderStoreQuery;
 
137
                &libtinymail-TnyAccount;
 
138
                &libtinymail-TnyStoreAccount;
 
139
                &libtinymail-TnyTransportAccount;
 
140
                &libtinymail-TnyCombinedAccount;
 
141
                &libtinymail-TnySendQueue;
 
142
                &libtinymail-TnyMsg;
 
143
                &libtinymail-TnyMimePart;
 
144
                &libtinymail-TnyFolder;
 
145
                &libtinymail-TnyMergeFolder;
 
146
                &libtinymail-TnyMsgRemoveStrategy;
 
147
                &libtinymail-TnyMsgReceiveStrategy;
 
148
                &libtinymail-TnyHeader;
 
149
                &libtinymail-TnyStream;
 
150
                &libtinymail-TnyFsStream;
 
151
                &libtinymail-TnyDevice;
 
152
                &libtinymail-TnyList;
 
153
                &libtinymail-TnyIterator;
 
154
                &libtinymail-TnySimpleList;
 
155
                &libtinymail-TnyPair;
 
156
                &libtinymail-TnyLockable;
 
157
                &libtinymail-TnyNoopLockable;
 
158
                &libtinymail-TnyFolderObserver;
 
159
                &libtinymail-TnyFolderChange;
 
160
                &libtinymail-TnyFolderMonitor;
 
161
                &libtinymail-TnyFolderStats;
 
162
                &libtinymail-TnyFolderStoreObserver;
 
163
                &libtinymail-TnyFolderStoreChange;
 
164
                &libtinymail-TnyPasswordGetter;
 
165
                &libtinymail-TnyEnums;
 
166
                &libtinymail-TnyShared;
 
167
                &libtinymail-TnyStatus;
 
168
        </chapter>
 
169
 
 
170
        <chapter id="libtinymailui">
 
171
                <title>libtinymailui - ui abstraction library</title>
 
172
                &libtinymailui-TnyAccountStoreView;
 
173
                &libtinymailui-TnyHeaderView;
 
174
                &libtinymailui-TnyMsgView;
 
175
                &libtinymailui-TnyMsgWindow;
 
176
                &libtinymailui-TnyMimePartSaveStrategy;
 
177
                &libtinymailui-TnyPlatformFactory;
 
178
                &libtinymailui-TnyHeaderView;
 
179
                &libtinymailui-TnySummaryView;
 
180
                &libtinymailui-TnyMimePartView;
 
181
                &libtinymailui-TnyMimePartSaver;
 
182
        </chapter>
 
183
 
 
184
        <chapter id="libtinymailui-gtk">
 
185
        <title>libtinymailui-gtk - an optional ui implementation library</title>
 
186
                &libtinymailui-gtk-TnyGtkMsgView;
 
187
                &libtinymailui-gtk-TnyGtkMsgWindow;
 
188
                &libtinymailui-gtk-TnyGtkHeaderView;
 
189
                &libtinymailui-gtk-TnyGtkFolderStoreTreeModel;
 
190
                &libtinymailui-gtk-TnyGtkAccountListModel;
 
191
                &libtinymailui-gtk-TnyGtkHeaderListModel;
 
192
                &libtinymailui-gtk-TnyGtkAttachListModel;
 
193
                &libtinymailui-gtk-TnyGtkTextBufferStream;
 
194
                &libtinymailui-gtk-TnyGtkMimePartSaveStrategy;
 
195
                &libtinymailui-gtk-TnyGtkTextMimePartView;
 
196
                &libtinymailui-gtk-TnyGtkAttachmentMimePartView;
 
197
                &libtinymailui-gtk-TnyGtkLockable;
 
198
                &libtinymailui-gtk-TnyGtkPasswordDialog;
 
199
                &libtinymailui-gtk-TnyGtkEnums;
 
200
        </chapter>
 
201
 
 
202
        <chapter id="libtinymail-gnomevfs">
 
203
                <title>libtinymail-gnomevfs - an optional implementation library</title>
 
204
                &libtinymail-gnomevfs-TnyVfsStream;
 
205
        </chapter>
 
206
 
 
207
        <chapter id="libtinymailui-mozembed">
 
208
        <title>libtinymailui-mozembed - an optional ui implementation library</title>
 
209
                &libtinymailui-mozembed-TnyMozEmbedMsgView;
 
210
                &libtinymailui-mozembed-TnyMozEmbedStream;
 
211
                &libtinymailui-mozembed-TnyMozEmbedHtmlMimePartView;
 
212
        </chapter>
 
213
 
 
214
        <chapter id="libtinymail-gnome-desktop">
 
215
        <title>libtinymail-gnome-desktop - implementations for a gnome desktop</title>
 
216
                &libtinymail-gnome-desktop-TnyGnomeAccountStore;
 
217
                &libtinymail-gnome-desktop-TnyGnomePlatformFactory;
 
218
                &libtinymail-gnome-desktop-TnyGnomeDevice;
 
219
        </chapter>
 
220
 
 
221
        <!-- chapter id="libtinymail-queues">
 
222
                <title>A queue library</title>
 
223
                &libtinymail-queues-TnyQueue;
 
224
                &libtinymail-queues-TnyQueueTask;
 
225
                &libtinymail-queues-TnyGenericSendQueue;
 
226
                &libtinymail-queues-TnyGetMsgQueue;
 
227
        </chapter //-->
 
228
 
 
229
        <!-- chapter id="libtinymail-asyncworker">
 
230
                <title>A library that implements TnyQueue</title>
 
231
                &libtinymail-asyncworker-TnyAsyncWorkerQueueTask;
 
232
                &libtinymail-asyncworker-TnyAsyncWorkerQueue;
 
233
        </chapter //-->
 
234
 
 
235
        <chapter id="libtinymail-camel">
 
236
                <title>libtinymail-camel - implementation of the main library</title>
 
237
                &libtinymail-camel-TnyCamelAccount;
 
238
                &libtinymail-camel-TnyCamelStoreAccount;
 
239
                &libtinymail-camel-TnyCamelIMAPStoreAccount;
 
240
                &libtinymail-camel-TnyCamelNNTPStoreAccount;
 
241
                &libtinymail-camel-TnyCamelPOPStoreAccount;
 
242
                &libtinymail-camel-TnyCamelTransportAccount;
 
243
                &libtinymail-camel-TnyCamelSendQueue;
 
244
                &libtinymail-camel-TnyCamelStream;
 
245
                &libtinymail-camel-TnyCamelFolder;
 
246
                &libtinymail-camel-TnyCamelMsgRemoveStrategy;
 
247
                &libtinymail-camel-TnyCamelFullMsgReceiveStrategy;
 
248
                &libtinymail-camel-TnyCamelPartialMsgReceiveStrategy;
 
249
                &libtinymail-camel-TnyCamelIMAPFolder;
 
250
                &libtinymail-camel-TnyCamelNNTPFolder;
 
251
                &libtinymail-camel-TnyCamelPOPFolder;
 
252
                &libtinymail-camel-TnyCamelMimePart;
 
253
                &libtinymail-camel-TnyCamelMsg;
 
254
                &libtinymail-camel-TnySessionCamel;
 
255
                &libtinymail-camel-TnyStreamCamel;
 
256
                &libtinymail-camel-TnyCamelShared;
 
257
        </chapter>
 
258
 
 
259
  </reference>
 
260
 
 
261
  <index>
 
262
    <title>Index</title>
 
263
  </index>
 
264
  
 
265
</book>
 
266