NameDateSize

..16-Mar-201612 KiB

.svnignore29-Dec-2012382

AUTHORS29-Dec-20123.6 KiB

autogen.sh29-Dec-2012758

ChangeLog29-Dec-2012262.5 KiB

configure.ac29-Dec-201220 KiB

COPYING29-Dec-201224.7 KiB

docs/29-Dec-20124 KiB

gentypes.sh29-Dec-20121.1 KiB

gtk-doc.make.distcheck.patch29-Dec-2012837

INSTALL29-Dec-201215.4 KiB

libtinymail/29-Dec-20124 KiB

libtinymail-acap/29-Dec-20124 KiB

libtinymail-camel/29-Dec-20124 KiB

libtinymail-gio/29-Dec-20124 KiB

libtinymail-gnome-desktop/29-Dec-20124 KiB

libtinymail-gnomevfs/29-Dec-20124 KiB

libtinymail-gpe/29-Dec-20124 KiB

libtinymail-moblin/29-Dec-20124 KiB

libtinymail-olpc/29-Dec-20124 KiB

libtinymail-test/29-Dec-20124 KiB

libtinymail-tp/29-Dec-20124 KiB

libtinymail.spec.in29-Dec-20122.7 KiB

libtinymailui/29-Dec-20124 KiB

libtinymailui-gnome-keyring/29-Dec-20124 KiB

libtinymailui-gtk/29-Dec-20124 KiB

libtinymailui-gtkhtml/29-Dec-20124 KiB

libtinymailui-mozembed/29-Dec-20124 KiB

libtinymailui-webkit/29-Dec-20124 KiB

m4/29-Dec-20124 KiB

Makefile.am29-Dec-20121.4 KiB

NEWS29-Dec-201264

po/29-Dec-20124 KiB

README29-Dec-20125.9 KiB

tests/29-Dec-20124 KiB

TODO29-Dec-2012406

tools/29-Dec-20124 KiB

README

1About
2=====
3
4Project tinymail is an attempt to create an E-mail client framework for small
5devices.
6
7Documentation
8=============
9
10Online :
11
12API reference manual per API version: http://tinymail.org/API/
13Development website and info: http://tinymail.org/trac/tinymail
14Marketing documentation & contact: http://tinymail.org
15
16To generate the API documentation yourself:
17
18./autogen.sh --enable-gtk-doc --enable-tests && make
19./autogen.sh --enable-doxygen && make
20
21Your documentation will be generated in docs/devel/reference and 
22docs/devel/doxygen. Tinymail being glib/gobject based will give you the best 
23results when using gtk-doc for API documentation generation.
24
25Development tips
26================
27You can find the Check unit test framework at http://check.sourceforge.net/
28You'll need it if you build with --enable-unit-tests which will compile the
29unit tests. Check the sources of the unit tests for more information.
30
31It's highly recommended to set the CFLAGS environment to include -DDEBUG and 
32-DDBC: CFLAGS="-DDBC -DDEBUG" ./autogen.sh --enable-unit-tests ....
33
34The DBC define will enable Design By Contract assertions, the DEBUG define will
35enable certain debugging checks, assertions, features and messages.
36
37Run all unit tests with 'make check'.
38
39Building tips
40=============
41
42Checkout docs/building.txt 
43
44You can set the CFLAGS="-DDEVEL" environment variable to enable a debug build.
45
46For building from repository source code, you simply do something like this:
47
48./autogen.sh --prefix=/opt/tinymail 
49make
50make install
51
52You can use --enable-gtk-doc to build API documentation in docs/devel/reference
53You can use --enable-gnome=no/yes to disable or enable some GNOME features.
54You can use --with-html-component=COMPONENT to select which HTML component to
55use. There's also the option "none" to build no HTML component.
56
57Packager tips
58=============
59
60You can use make dist, make distcheck and make distclean for distribution
61building and package preparations. You can of course use --prefix and all other
62typical autotools settings and configuration flags.
63
64Supported platforms & devices
65=============================
66
67  o. One Laptop Per Child platform (OLPC)
68  o. Maemo platform (For example for the Nokia 770, N800 & N900)
69  o. GPE platform (For example for PocketPC)
70  o. GNOME desktop platform
71  o. Moblin platform
72
73Information for developers who would like to tryout the demo user interface:
74============================================================================
75
76This information only applies to the desktop support of tinymail!
77
78The libtinymail-gnome-desktop is an implementation that will work on a typical
79GNOME desktop. It has been tested on Ubuntu Breezy, Dapper and on Fedora Core 4
80and 5.
81
82It uses GConf for storing the account settings, it can use gnome-keyring and
83GnomePasswordDialog for password management. It can also use build-in infrast-
84ructure for password handling. It can use GnomeVFS and normal FILE operations.
85It can use a GtkMozEmbed HTML component (which is not recommended). It can 
86(soon) also use a GtkHTML HTMl component (recommended).
87
88To disable GnomeVFS, icon lookups using the MIME-type, GnomePasswordDialog and
89gnome-keyring, you use the --enable-gnome=no compilation option during the 
90./autogen.sh or ./configure.
91
92To select the HTML component you use the --with-html-component=COMPONENT
93option. Possible values for COMPONENT are mozembed, none and gtkhtml.
94
95If you want to create a test account, use something like this. You should also
96take a look at tny-account-store.c in libtinymail-gnome-desktop. Please note
97that *this* example does *not* mean that *all* tinymail-using applications will
98be configurable using this method! This method is for the demo-ui only!
99
100gconftool-2 -s /apps/tinymail/cache_dir -t string .tinymail
101gconftool-2 -s /apps/tinymail/accounts/count -t int 1
102gconftool-2 -s /apps/tinymail/accounts/0/name -t string "Account name"
103gconftool-2 -s /apps/tinymail/accounts/0/proto -t string imap
104gconftool-2 -s /apps/tinymail/accounts/0/type -t string store
105gconftool-2 -s /apps/tinymail/accounts/0/user -t string [username]
106gconftool-2 -s /apps/tinymail/accounts/0/hostname -t string [mailserver]
107
108To use SSL (other values are "tls" - recommended - and "never"):
109
110gconftool-2 -s /apps/tinymail/accounts/0/options -t list --list-type=string '[use_ssl=wrapped]'
111
112Distribution specific: also check out requirements.txt
113------------------------------------------------------
114
115Ubuntu Breezy & Dapper
116----------------------
117
118Required Packages
119
120  gnome-devel
121  subversion
122  firefox-dev
123  libcamel1.2-dev or install camel-lite via camel-lite-builder
124  libnm-glib-0-dev
125  automake-1.7
126
127Building
128
129  Both Ubuntu Breezy & Dapper support the default ./autogen.sh && make && make 
130  install. Provided you installed the above packages.
131
132Dependencies
133
134  If you want the unit tests, check above at the Development tips section. You
135  can find a URL to Check. There's often also Debian packages that will work
136  with Ubuntu Dapper & Breezy (and maybe/probably also with newer versions of
137  both the Debian and Ubuntu distributions).
138
139 If you want the Python bindings: python-gtk2-dev, python2.4-dev
140
141Ubuntu Edgy Eft & Debian
142------------------------
143
144See Ubuntu Breezy and Dapper above
145
146Packages
147  The debian/ directory contains ready to use packaging scripts for a desktop
148  configuration. To compile packages, run ./autogen.sh and then start the
149  packaging script with for example 'dpkg-buildpackage -rfakeroot'.
150
151Fedora Core 4 & 5
152-----------------
153
154Required Packages
155
156  Subversion
157  gnome-common
158  evolution-data-server-devel
159  NetworkManager-devel
160  NetworkManager-glib
161  NetworkManager-glib-devel
162  gnome-keyring-devel
163  automake-1.7
164
165Building
166  
167  Use --with-html-component=none to disable building any HTML component. Because
168  Fedora Core 4 uses a quite old gnome-keyring API, it's recommended to also use
169  --enable-gnome=no when building on Fedora Core 4. 
170
171Dependencies
172
173  If you want the unit tests, check above at the Development tips section. You
174  can find a URL to Check sources.
175
176
177