Libpop3 - A simple POP3 library (C)opyright 2001-2002 Kristian Van Der Vliet

Introduction

Libpop3 is a small, simple library that allows you to perform common POP3
functions including retrieving & deleting mail from a remote server.  The API
is small & clean, and the library does not rely on any other libraries other
than Glibc.

Libpop3 was originally written as part of the Whisper mail client for the
AtheOS operating system, but has been tested and is known to compile & work on
both AtheOS 0.3.7, and Linux Mandrake 8.0  Other versions of Linux are expected
to work.

You can contact me at vanders@cableinet.co.uk, and you can check for new
versions of libpop3 on my webpage at http://www.shagged.org/~vanders/

License

Libpop3 is distributed under the GNU Lesser General Public License, and is
Copyright 2001-2002 Kristian Van Der Vliet.  Please see the file COPYING,
included with Libpop3, for more information.  Alternatively, you can visit the
GNU website at http://www.gnu.org

Building & Installing

Libpop3 can be built as either a static (.a) or shared (.so) library, and the
Makefile includes targets for both.  By default Libpop3 is built as a static
library.

To build libpop3 as a static library, enter the following commands:

bash$ make

To build libpop3 as a shared library, enter the following commands:

bash$ make shared

If you build libpop3 as a static library, you can copy the libpop3.a &
inc/libpop3.h files to wherever you wish (In most cases, this will be in your
project working directory).  If you build libpop3 as a shared library, you
should also run "make install".  The shared object libpop3.so is copied to
/usr/local/lib/ and the header file inc/libpop3.h is copied to
usr/local/includes/

Using libpop3

For information on the libpop3 API, please see the file API, which is included
with libpop3.

Compiling with libpop3 depends on wether you are using the static or the shared
library.  If you are using the shared library, you can build a project by
including -lpop3 in your GCC flags.  For example:

bash$ gcc myproject.c -lpop3 -o myproject

Will link your code against libpop3 which is in /usr/local/lib/

If you are using the static library, you must also tell GCC the path to the
library object (libpop3.a).  For example, if you have copied libpop3.a into
your project directory, in a subdirectory named "libs", you could use:

bash$ gcc myproject.c -L./libs/ -lpop3 -o myproject

You can find more about the GCC flags from the GCC manual page or with the
online documentation at http://www.gnu.org