 |
LVI. IMAP, POP3 and NNTP Functions
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
methods.
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
libc-client.a.
注:
To build the c-client library with SSL or/and Kerberos support read
the docs supplied with the package.
注:
In Mandrake Linux, the IMAP library (libc-client.a)
is compiled without Kerberos support. A separate version with SSL
(client-PHP4.a) is installed. The library must
be recompiled in order to add Kerberos support.
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.
IMAP is not supported on systems earlier that Windows 2000. This is because it
uses encryption functions in order to enable SSL connections to the mail
servers.
注:
Depending how the c-client was configured, you might also need to add
--with-imap-ssl=/path/to/openssl/
and/or --with-kerberos=/path/to/kerberos
into the PHP configure line.
本扩展模块在 php.ini 中未定义任何配置选项。 以下常量由本扩展模块定义,因此只有在本扩展模块被编译到
PHP 中,或者在运行时被动态加载后才有效。
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
documents:
RFC2821: Simple Mail
Transfer Protocol (SMTP).
RFC2822: Standard for
ARPA internet text messages.
RFC2060: Internet
Message Access Protocol (IMAP) Version 4rev1.
RFC1939: Post
Office Protocol Version 3 (POP3).
RFC977: Network News
Transfer Protocol (NNTP).
RFC2076: Common
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
IMAP by Dianna Mullet & Kevin Mullet.
James Triplett <jm-php at vj8 dot net>
06-Apr-2006 10:50
Building Apache2, PHP and IMAP requires a shareable version
of the c-client library, but the standard UW code doesn't provide one.
I couldn't find any way to build with the libc-client.a without generating piles of relocation errors. (gcc on Solaris 10)
The IMAP c-client library can be built shareable with the following steps:
1. fix the Makefile in .../imap-2004/c-client to include:
BASECFLAGS="-fPIC -O3"
2. make
3. mkdir tmp
4. cd tmp
5. ar xv ../c-client.a (to extract the .o files)
6. gcc -shared -o c-client.so *.o (to create the .so library)
7. copy that c-client.so to /usr/local/imap/lib/libc-client.so
(it may be necessary to hide the libc-client.a)
8. configure PHP ; make; make install
info at toyflish dot de
16-Dec-2005 06:26
if you are on SuSE9.3 64 and still compiling errors you have to add the -fPIC flag to the EXTRACFLAGS in imap-Makefile.
BjarneDM macintosh at mathiesen dot info
21-Oct-2005 03:49
Mac OS X client install notes with DarwinPorts
The c-client.a isn't present on your system after you've installed the imap-uw package. !But! it's actually present at a specific time during the install phase as it's being complied from source - it's just deleted at the end of the compilation process. So, we'll have to break the install process down into it's component processes and get hold of what we need at the appropriate time:
sudo port fetch imap-uw
sudo port extract imap-uw
sudo port patch imap-uw
sudo port configure imap-uw
sudo port build imap-uw
imapLib=/darwinports/var/db/dports/distfiles/imap-uw/lib
imapIncludes=/darwinports/var/db/dports/distfiles/imap-uw/include
sudo mkdir ${imapLib} ${imapInclude}
cd /darwinports/var/db/dports/build/*/*/*/c-client
sudo cp *.c ${imapLib}
sudo cp *.h ${imapIncludes}
sudo cp c-client.a ${imapLib}/libc-client.a
cd ${imapLib}
ranlib - libc-client.a
sudo port install imap-uw
Now, you can just specify:
--with-imap=/darwinports/var/db/dports/distfiles/imap-uw \
--with-imap-ssl=/darwinports \
in your ./configure command.
php at got2get dot net
07-Sep-2005 11:04
Install note for FreeBSD:
If you get this:
/libexec/ld-elf.so.1: /usr/local/lib/php/20041030/imap.so: Undefined symbol "ssl_onceonlyinit"
...in your httpd-error.log.
It is because you compiled cclient without SSL support.
However. In order for me to get SquirrelMail woorking, I had to install ports/mail/imap-uw with WITHOUT_SSL=yes and same option for ports/mail/cclient. After doing this, I recompiled cclient w/o any options to get SSL support, and then installed posrt/mail/php5-imap.
This works. But if you just want SSL everywhere - install imap-uw normally, which will install cclient too. After that, install php5-imap normally as well - and you have a working system with SSL.
Hope this saves more people from wasting too much time like I just did ;)
- Nicolai
v dot 0000000001 dot -0006398047 at vertabiz dot com
24-Jun-2005 12:01
Since this library at a whole is fairly poorly documented, and it doesn't help that there's 30-something functions, and many of the functions do the same things, I have gone through and categorized the functions. Hopefully this will help somebody else, I know it will help me!! -Justin
CONNECTION, ERRORS & QUOTAS
===========================
imap_timeout
imap_ping
imap_open
imap_reopen
imap_close
imap_check **(fairly useless)
imap_alerts
imap_errors
imap_last_error
imap_get_quota
imap_get_quotaroot
imap_set_quota
MESSAGES - READING
==================
imap_uid
imap_msgno
imap_fetchbody
imap_fetchheader
imap_fetchstructure
imap_fetch_overview
imap_body
imap_rfc822_parse_adrlist
imap_rfc822_parse_headers
MESSAGES - WRITING
==================
imap_mail_compose
imap_mail
imap_append
imap_rfc822_write_address
MESSAGES - OPERATIONS
=====================
imap_undelete
imap_thread
imap_delete
imap_mail_copy
imap_mail_move
imap_expunge
imap_clearflag_full
imap_setflag_full
MESSAGES - DECODE/ENCODE
========================
imap_utf7_decode
imap_utf7_encode
imap_utf8
imap_8bit
imap_base64
imap_binary
imap_mime_header_decode
imap_qprint
FOLDERS
=======
imap_createmailbox
imap_deletemailbox
imap_getmailboxes
imap_mailboxmsginfo
imap_renamemailbox
imap_headers **(fairly useless)
imap_status
imap_sort
imap_search
imap_listscan
NNTP
====
imap_unsubscribe
imap_subscribe
imap_getsubscribed
UNUSED (should be deprecated)
=============================
imap_num_msg - use imap_mailboxmsginfo()
imap_num_recent - use imap_mailboxmsginfo()
imap_header - alias of imap_headerinfo()
imap_scanmailbox - alias of imap_listscan()
imap_listsubscribed - alias of imap_lsub()
imap_listmailbox - alias of imap_list()
imap_lsub - use imap_getsubscribed()
imap_list - use imap_getmailboxes()
imap_bodystruct - not documented
imap_getacl - not documented
imap_setacl - not documented
imap_headerinfo - use imap_fetch_overview()
Anonymous
14-Apr-2005 03:13
If you are having difficulty compiling on netbsd from source and want imap support then you should know that the c-client library is compiled with kerberos support. Unfortunately gssapi_krb5 and k5crypto is not on the system (or at least wasn't for me). I didn't have administrative level access to add these libraries so I had to do the following. I still have to test that it worked 100% but at least it compiled without complaining.
Comment the following segments from the configure script.
Segment 1 -- test for gssapi_krb5 library
case gssapi_krb5 in
c|c_r|pthread*) ;;
*)
if test "$ext_shared" = "yes"; then
IMAP_SHARED_LIBADD="$IMAP_SHARED_LIBADD -lgssapi_krb5"
else
case gssapi_krb5 in
c|c_r|pthread*) ;;
*)
LIBS="$LIBS -lgssapi_krb5"
;;
esac
fi
;;
esac
Segment 2 -- test for k5crypto
case k5crypto in
c|c_r|pthread*) ;;
*)
if test "$ext_shared" = "yes"; then
IMAP_SHARED_LIBADD="$IMAP_SHARED_LIBADD -lk5crypto"
else
case k5crypto in
c|c_r|pthread*) ;;
*)
LIBS="$LIBS -lk5crypto"
;;
esac
fi
;;
esac
BTW. Since I was only compiling for the modules (they have suPHP so I compile all my own modules when I need them) I only dropped this in for the php configure script parameters
./configure --with-imap=shared,xxxxxx --with-kerberos=xxxxxx --with-imap-ssl
This is verified working via an imap test. One excellent test that I located on the phpbuilder.com site. Here it is. Modify the address, port, protocol type, username, and password appropriately. The post was 5 years old but the script still works fine. The posters name was "Matthew"
<HTML>
<HEAD>
<TITLE>imap_check</TITLE>
</HEAD>
<BODY>
<?
//check for new messages
$mailbox = imap_open("{localhost/pop3:110}INBOX",
"#username#","#password#");
// Check messages
$check = imap_check($mailbox);
print("<PRE>");
print("Date most recent message : " . $check->Date);
print("<BR>");
print("Connection type : " . $check->Driver);
print("<BR>");
print("Name of the mailbox : " . $check->Mailbox);
print("<BR>");
print("Number of messages : " . $check->Nmsgs);
print("<BR>");
print("Number of recent messages : " . $check->Recent);
print("<BR>");
print("</PRE>");
// show headers for messages
$index=1;
$header = imap_header($mailbox, $index);
print("<PRE>");
print("Header Date : " . $header->Date . "<BR>");
print("Header To : " . $header->to) . "<BR>";
print("Header From : " . $header->From . "<BR>");
print("Header cc : " . $header->cc . "<BR>");
print("Header ReplyTo : " . $header->ReplyTo . "<BR>");
print("Header Subject : " . $header->Subject . "<BR></PRE>");
print("<PRE>");
print(imap_body($mailbox,$index));
print("</PRE><HR>");
imap_close($mailbox);
?>
</BODY></HTML>
seem dot iges at mail dot ee
15-Feb-2005 09:48
If you like me disvoer that "make slx" fails, but you're damn sure you've openssl installed then, it might be that the lib and include paths on your distro are different then the defaults provided in the imap-2004a (or imap-XXXXx). To modify go to dir ../imap-2004a/src/osdep/unix and edit the section (shown below) in the Makefile
# Extended flags needed for SSL. You may need to modify.
#SSLDIR=/usr/local/ssl
SSLDIR=/etc/ssl
SSLCERTS=$(SSLDIR)/certs
SSLKEYS=$(SSLCERTS)
#SSLINCLUDE=$(SSLDIR)/include
SSLINCLUDE=/usr/include/openssl
#SSLLIB=$(SSLDIR)/lib
SSLLIB=/usr/lib
SSLCRYPTO=-lcrypto
Commented out SSLDIR, SSLINCLUDE and SSLIB are defaults and the uncommented are valid paths for Slackware (10.0/10.1).
You should also check your ld.so.conf for valid paths.
antivert
14-Jan-2005 12:55
Note that is not not necessary to disable SSL in the IMAP compile to make it work with PHP 5.0.3.
1. Compile IMAP with SSL support for your system:
cd /path/to/imap/source/
make <system type> (ldb, lnx, etc)
mkdir include
mkdir lib
2. Make links in IMAP source directory:
cd /path/to/imap/source/c-client
cp *.h ../include/
cp *.c ../lib/
cp c-client.a ../lib/libc-client.a
3. Compile PHP with SSL support, --with-imap=/path/to/imap/source/ . If SSL support fails, you'll get a configure-time error that IMAP doesn't work. This is a lie, you just need to get SSL support working in PHP. On certain linux systems, with OpenSSL 0.9.7, this means adding --with-openssl=/usr (if the OpenSSL files are in /usr/include/openssl/) instead of the proper directory containing the OpenSSL files. For some reason, giving a parent directory makes PHP able to find the OpenSSL include files.
4. PHP should build.
Alternately, you can disable SSL during the IMAP build, as per the previous directions posted here.
amit dot gupta at prudence-india dot com
18-Nov-2004 04:44
I faced problem in compiling imap with php-5.0.2 release version. Then following commands on snapshot version solved my problem
# tar -zxvf imap-2004b.DEV.tar.Z
# cd imap-2004b.DEV.SNAP-0411051435/
# make lnp SSLTYPE=none
# cp -r /usr/local/imap-2004b.DEV.SNAP-0411051435/c-client/*.h /usr/local/imap-2004b.DEV.SNAP-0411051435/include/
# cp -r /usr/local/imap-2004b.DEV.SNAP-0411051435/c-client/*.c /usr/local/imap-2004b.DEV.SNAP-0411051435/lib/
# ln -s /usr/local/imap-2004b.DEV.SNAP-0411051435/c-client/c-client.a /usr/local/imap-2004b.DEV.SNAP-0411051435/lib/libc-client.a
# tar -zxvf php5-STABLE-200411180530.tar.gz
# cd php5-STABLE-200411180530
./configure --with-apxs2=/usr/sbin/apxs --enable-shared --with-mod_charset --enable-force-cgi-redirect --enable-fastcgi --enable-magic-quotes --with-openssl --with-zlib --enable-bcmath --enable-calendar --with-curl --with-curlwrappers --enable-dba --with-gdbm --with-cdb --with-inifile --with-flatfile --enable-dbase --enable-dbx --enable-dio --with-fam --enable-filepro --enable-ftp --with-ldap --enable-mbstring --with-mysql=/usr/include --with-zlib-dir --enable-shmop --enable-soap --enable-sockets --enable-sysvmsg --enable-sysvsem --enable-sysvshm --enable-wddx --with-pic --enable-versioning --with-pgsql --with-java=/usr/java/jdk1.5.0/ --with-imap=/usr/local/imap-2004b.DEV.SNAP-0411051435 --with-kerberos
# make
# make install
Thus, php compiled sucessufully with imap support on fedora core 1.
Pete Spicer, sleeping [at] myperch.org
18-Jul-2004 06:19
I have a pretty much stock set-up of SuSE 8.1 Personal (Apache, PHP et al built by me) and IMAP-2004 refused to build for me.
What I found was, using the make lsu (for SuSE) almost worked built I was getting odd build results, i.e. make failures.
The problem? GCC 3.2. If you don't have an older GCC available, please install one! I installed the gcc_old package from SuSE and built with the following command:
CC=gcc297 make lsu SSLTYPE=none
The result was a perfect build. So if you are getting errors, please try an earlier build of GCC.
Tomas V.V.Cox
11-May-2004 09:15
For compiling this extension without compiling imap from sources I did (this was mandrake):
Install the following rpms:
imap
imap-devel
openssl
openssl-devel
krb5
krb5-devel
pam
pam-devel
Do the trick:
# mkdir /usr/include/imap/lib
# cp /usr/lib/libc-client-PHP4.a /usr/include/imap/lib/libc-client.a
And the configure line:
./configure <options> --with-imap=/usr/include/imap --with-imap-ssl
(don't forget --enable-pear ;)
sysadmin at grmtech dot com
27-Mar-2004 08:01
The manual mentions:
"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 libc-client.a.
"
A. Please do not copy rather make symbolic links like this:
ln -s c-client include
ln -s c-client lib
B. You do not need to copy c-client.a to libc-client.a.
The make command used to compile the imap-2002e source code creates the symbolic link from c-client.a to libc-client.a
The imap client version used for the above two points is:
1. imap-2002e
my 2 cents,
sysadmin
http://www.grmtech.com
peder at godvik dot no
10-Mar-2004 12:24
Additionally to Mauricio's procedure; You must check the Makefile to find the correct system type that you are compiling on. Mauricio's example assumes you are using Linux. -Check the README for imap-xxxx for further details.
Fjor
15-Feb-2004 09:50
Additionally to Mauricio's procedure, I had to make a symlink to the c-client library this way:
cd imap-xxxx/c-client
ln -s c-client.a libc-client.a
(Tested with imap-200e)
Fjor (GDL/Mexico)
dev at puertocity dot com
27-Nov-2003 12:38
A tip for imap support installation:
With SSL support:
------------------
tar -zxf imap-xxxxx.tar.Z
cd imap-xxxxx
make slx
ln -sf c-client include
ln -sf c-client lib
cd ..
tar -jxf php-4.3.x.tar.bz2
cd php-4.3.x
./configure --with-imap=../imap-xxxxx --with-imap-ssl=/path-to-openssl
With out SSL support:
---------------------
tar -zxf imap-xxxxx.tar.Z
cd imap-xxxxx
make slx SSLTYPE=none
ln -sf c-client include
ln -sf c-client lib
cd ..
tar -jxf php-4.3.x.tar.bz2
cd php-4.3.x
./configure --with-imap=../imap-xxxxx
Good Luck
Mauricio
millz at incogen dot com
11-Oct-2003 07:19
I experienced a problem when adding IMAP support into PHP. The php configure script would die when trying to see if "IMAP Works..." and the config.log would complain about libc-client.a references.
It was similar to the problem reported here:
http://lists.horde.org/archives/imp/Week-of-Mon-20030915/034692.html
I resolved it by compiling IMAP like this (replace <ARCH> with the proper OS type for your system, get that from the top of the Makefile):
make <ARCH> SSLTYPE=none
That turned off the SSL support in the IMAP files and seemed to resolve my php compile problem.
BTW, I also followed the directions about making a new /usr/local/imap... directory that are mentioned at the top of the page.
k3nny at squidart dot co dot za
01-Aug-2003 08:02
After having numerous problems compiling PHP with IMAP support, both PHP problems and IMAP problems I found this simple solution to the problem, which I've tried with several versions of IMAP and all worked perfectly!
tar -zxf imap-xxxxx.tar.Z
cd imap-xxxxx
make slx
ln -sf c-client include
ln -sf c-client lib
cd ..
tar -jxf php-4.3.x.tar.bz2
cd php-4.3.x
./configure --with-imap=../imap-xxxxx
It worked everytime for me, hope it does for you!
Kenneth
naveed at php dot net
12-Jan-2003 11:49
Beware!
If you are trying to make a connection with POP3 mailbox,then some of IMAP functions will not work correctly as you might expecting .This is because the difference of workings in POP3 and IMAP protocols.
These functions work correctly for IMAP mailboxes but some of the fnctions will return nothing, when connected to a POP3 mailbox.(even no error message).
duckel at electroporn dot de
23-May-2002 02:16
please don't copy the .h files in the system include directory! the unix.h file from the washington.edu c-client conflicts with another file called unix.h
make a dir called "imap" in either /usr/include or /usr/local/include or whatever you wish, copy the header files there and the .a file prefix'ish in /usr/lib or /usr/local/lib or whatever you used for the include files.
then tell configure with --with-imap=/usr the "prefix" of your installation.
then works without problem ;)
netshadow at madpoets dot org
03-Nov-2001 05:42
I just found something a bit bizarre. I was having problems with the pages taking too long to load (15-20sec) when they opened an imap connection. I was pulling my hair out trying to figure out what was wrong.
Turns out it was quite simple. I was letting it default to 143 for the port. When i specified the port number (i.e. {localhost:143} rather than {localhost} ) It reduced page load time to a few seconds.
raoul at runtheotherway dot com
22-Oct-2001 10:11
I have found the order in which you connect to you POP server with IMAP 2000 and your database with PostgreSQL 7.1.2 can cause problems.
Make sure that you connect first to your POP server then get your db connection. This will prevent you from getting an invalid stream from imap_open().
|  |