What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

imap_open
Prev	XXXI. IMAP Functions	Next

imap_open

Name

imap_open — Opens a connection to an IMAP server and mailbox

Synopsis

int imap_open(mailbox, username, password[, flags]); string mailbox: Mailbox name string username: Username string password: Password int flags (optional): Connection options

Returns

IMAP connection ID or FALSE on error

Description

Connects to an IMAP server and mailbox using the specified username and password .

The format of the host string is important. The hostname must be enclosed in curly braces folloed directly by the mailbox name that is to be opened. To open the users personal mailbox, use the mailbox name INBOX.

If there is an error connecting, use imap_errors() to retrieve the error string.

flags can be a bitmask of the following:

`OP_READONLY`	Open mailbox read-only
`OP_ANONYMOUS`	Don't use of update a .newrc if using an NNTP connection
`OP_HALFOPEN`	Open a connection but do not open a mailbox. Applies only to IMAP and NNTP
`CL_EXPUNGE`	Automatically expunge mailbox when closed.

Version

From versions 3.0 and 4.0

Example

Example 610. Connect to an IMAP server

<?php
$user = "myuser";
$pass = "mypass";
$imap = imap_open("{imap.mycompany.com}INBOX", $user, $pass);
if (!$imap) {
   print_r(imap_errors());
}
?>

Example 611. Connect to a POP server

<?php
$user = "myuser";
$pass = "mypass";

// note the use of /pop3 and the port number
$imap = imap_open("{pop.mycompany.com:110/pop3}INBOX", $user, $pass);
if (!$imap) {
   print_r(imap_errors());
}
?>

Example 612. Connect to an NNTP server

<?php
$user = "myuser";
$pass = "mypass";

// note the use of the port number and /nntp
// instead of a mailbox, use a usetnet group name
$imap = imap_open("{nntp.mycompany.com:119/nntp}alt.test", $user, $pass);
if (!$imap) {
   print_r(imap_errors());
}
?>

Example 613. Connect to an IAMP or POP server over SSL

<?php
$user = "myuser";
$pass = "mypass";

// note different port number and /imap/ssl
// if using a POP server, use /pop3/ssl
// if using self-signed certificate, use /imap/ssl/novalidate-cert
$imap = imap_open("{imap.mycompany.com:993/imap/ssl}INBOX", $user, $pass);
if (!$imap) {
   print_r(imap_errors());
}
?>

Prev	Home	Next
imap_num_recent	Up	imap_ping

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.