File: README

package info (click to toggle)
libsylph 1.1.0-21.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,344 kB
  • sloc: ansic: 30,577; sh: 8,819; makefile: 156
file content (168 lines) | stat: -rw-r--r-- 4,616 bytes parent folder | download | duplicates (9)
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
	LibSylph -- E-Mail client library

   Copyright (C) 1999-2008 Hiroyuki Yamamoto

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

   For more details see the file COPYING.


What's LibSylph
===============

LibSylph is an e-mail client library which is derived from Sylpheed.
LibSylph is a lightweight but featureful library. It has many common e-mail
related features and other useful functions, and you can utilize them from
your application. Moreover you can create a new e-mail client by wrapping
LibSylph with any UI.

LibSylph is a free software distributed under the GNU LGPL.

Currently implemented major features
====================================

Supported protocols

	o POP3
	o IMAP4rev1
	o SMTP
	o NNTP
	o SSL/TLSv1 (POP3, SMTP, IMAP4rev1, NNTP)
	o IPv6

Features

	o OOP-like message management
	o multiple accounts
	o powerful filtering
	o powerful search (query search and search folder)
	o MIME handling
	o SMTP AUTH support (PLAIN / LOGIN / CRAM-MD5)
	o CRAM-MD5 authentication (SMTP AUTH / IMAP4rev1)
	o APOP authentication (POP3)
	o multiple MH folder support
	o per-folder configuration
	o autoconf, automake support
	o internationalization of messages by gettext
	o m17n (multilingualization) support

and more.

Installation
============

See INSTALL for installation instructions.

Usage
=====

Preparation before running
--------------------------

If you are using a character encodings other than UTF-8 for filename on
Unix-like OS, you must set the following environmental variable (it will not
work correctly if it is not specified):

(use locale-specific encoding)
% export G_FILENAME_ENCODING=@locale

or

(manually specifying encoding)
% export G_FILENAME_ENCODING=ISO-8859-1

If you want to display messages translated to your language,
you must specify some environmental variables related to locale.
For example:

% export LANG=de_DE

(replace de_DE to the actual locale name)

If you don't want translated messages, set LC_MESSAGES to "C"
(and unset LC_ALL if specified).

How to use
----------

The simplest way for linking:

gcc -o foo foo.c `pkg-config glib-2.0 --cflags --libs` -lsylph

If you want to auto detect LibSylph with configure script, use the following
in configure.ac:

AC_ARG_WITH(libsylph,
            [AC_HELP_STRING([--with-libsylph=DIR],
                            [search for LibSylph in DIR/include and DIR/lib])],
            [if test "x$with_libsylph" != x; then
                CPPFLAGS="$CPPFLAGS -I$with_libsylph/include"
                LDFLAGS="$LDFLAGS -L$with_libsylph/lib"
             fi])
AC_CHECK_LIB(sylph, syl_init,, AC_MSG_ERROR(Test for LibSylph failed.))

There are sample programs under examples directory in the distributed packages.
The method of compilation is described at the head of the sources as a comment.
The license of these sample programs is public domain.
See examples/README for details.

Documentation
-------------

The reference manuals are under doc directory (Japanese).
See doc/README.ja for details.

Information
===========

You can check the newest version and information about Sylpheed and LibSylph
at:

	http://sylpheed.sraoss.jp/

Feedback
========

Comments, ideas and (most of all) bug reports (and especially patches) are
very welcome.

Subversion
==========

You can get the newest source code from the Subversion repository.

To retrieve Sylpheed trunk tree, move to an appropriate directory,
and run the command:

	svn checkout svn://sylpheed.sraoss.jp/sylpheed/trunk

Then a source tree named 'trunk' will be created under the current directory.

The subdirectory of sylpheed is divided as following:

    * trunk/     Main tree
    * branches/  Miscellaneous experimental branches
    * tags/      Release-tagged branches

To update to the newest source tree, run the command:

	svn update

at the target directory.

The libsylph branch is located at branches/libsylph .

-- 
Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>