These functions are not limited to the IMAP protocol,
despite their name. The underlying c-client library also supports
NNTP, POP3 and local mailbox access
This extension requires the c-client library to be installed.
Grab the latest version from ftp://ftp.cac.washington.edu/imap/
and compile it.
It's important that you do not copy the IMAP source files directly into
the system include directory as there may be conflicts. Instead, create
a new directory inside the system include directory, such as
/usr/local/imap-2000b/ (location and name
depend on your setup and IMAP version), and inside this new
directory create additional directories named lib/
and include/. From the c-client
directory from your IMAP source tree, copy all the *.h
files into include/ and all the
*.c files into lib/.
Additionally when you compiled IMAP, a file named
c-client-a was created. Also put this in the
lib/ directory but rename it as
To build the c-client library with SSL or/and Kerberos support read
the docs supplied with the package.
To get these functions to work, you have to compile PHP with
--with-imap[=DIR], where DIR is the
c-client install prefix. From our example above, you would use
--with-imap=/usr/local/imap-2000b. This location
depends on where you created this directory according to the
description above. Windows users may include the
php_imap.dll DLL in php.ini
Depending how the c-client was configured, you might also need to add
into the PHP configure line.
The IMAP extension cannot be used in conjuction with
the recode or YAZ extensions. This is due to the fact that they
both share the same internal symbol.
This extension has no configuration directives defined in php.ini.
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
This document can't go into detail on all the topics touched by
the provided functions. Further information is provided by the
documentation of the c-client library source
(docs/internal.txt). and the following RFC
RFC2821: Simple Mail
Transfer Protocol (SMTP).
RFC2822: Standard for
ARPA internet text messages.
Message Access Protocol (IMAP) Version 4rev1.
Office Protocol Version 3 (POP3).
RFC977: Network News
Transfer Protocol (NNTP).
Internet Message Headers.
RFC2045 , RFC2046 , RFC2047 , RFC2048 & RFC2049: Multipurpose
Internet Mail Extensions (MIME).
A detailed overview is also available in the books
Programming Internet Email
by David Wood and Managing
by Dianna Mullet & Kevin Mullet.