From bd6f318ac4eb9764d66102d7d9a38700f1f76052 Mon Sep 17 00:00:00 2001 From: Jakub Vrana Date: Sat, 7 Aug 2004 08:02:25 +0000 Subject: [PATCH] Document flags (bug #27017), add all options, compress examples git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@165613 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/imap/functions/imap-open.xml | 214 +++++++++++++++++++------ 1 file changed, 167 insertions(+), 47 deletions(-) diff --git a/reference/imap/functions/imap-open.xml b/reference/imap/functions/imap-open.xml index 915c99e79b..bbabaa03aa 100644 --- a/reference/imap/functions/imap-open.xml +++ b/reference/imap/functions/imap-open.xml @@ -1,5 +1,5 @@ - + @@ -32,6 +32,123 @@ besides those in the printable ASCII space have to be encoded with imap_utf7_encode. + + All names which start with { are remote names, and are + in the form "{" remote_system_name [":" port] [flags] "}" + [mailbox_name] where: + + + + remote_system_name - Internet domain name or + bracketed IP address of server. + + + + + port - optional TCP port number, default is the + default port for that service + + + + + flags - optional flags, see following table. + + + + + mailbox_name - remote mailbox name, default is INBOX + + + + + + + Optional flags for names + + + + Flag + Description + + + + + /service=service + mailbox access service, default is "imap" + + + /user=user + remote user name for login on the server + + + /authuser=user + remote authentication user; if specified this is the user name + whose password is used (e.g. administrator) + + + /anonymous + remote access as anonymous user + + + /debug + record protocol telemetry in application's debug log + + + /secure + do not transmit a plaintext password over the network + + + /imap, /imap2, + /imap2bis, /imap4, + /imap4rev1 + equivalent to /service=imap + + + /pop3 + equivalent to /service=pop3 + + + /nntp + equivalent to /service=nntp + + + /norsh + do not use rsh or ssh to establish a preauthenticated IMAP + session + + + /ssl + use the Secure Socket Layer to encrypt the session + + + /validate-cert + validate certificates from TLS/SSL server (this is the default + behavior) + + + /novalidate-cert + do not validate certificates from TLS/SSL server, needed if + server uses self-signed certificates + + + /tls + force use of start-TLS to encrypt the session, and reject + connection to servers that do not support it + + + /notls + do not do start-TLS to encrypt the session, even with servers + that support it + + + /readonly + request read-only mailbox open (IMAP only; ignored on NNTP, and + an error with SMTP and POP3) + + + +
+ The options are a bit mask with one or more of the following: @@ -59,65 +176,68 @@ imap_expunge) + + + OP_DEBUG - Debug protocol negotiations + + + + + OP_SHORTCACHE - Short (elt-only) caching + + + + + OP_SILENT - Don't pass up events (internal use) + + + + + OP_PROTOTYPE - Return driver prototype + + + + + OP_EXPUNGE - Silently expunge recycle stream + + + + + OP_SECURE - Don't do non-secure authentication + + - To connect to an IMAP server running on port 143 on the - local machine, do the following: - - + + Different use of <function>imap_open</function> + -]]> - - - To connect to a POP3 server on port 110 on the local server, use: - - - -]]> - - - To connect to an SSL IMAP or POP3 server, add /ssl after the protocol - specification: - - - -]]> - - - To connect to an SSL IMAP or POP3 server with a self-signed - certificate, add /ssl/novalidate-cert after the protocol specification: - - - -]]> - - - To connect to an NNTP server on port 119 on the local server, use: - - - ]]> - - To connect to a remote server replace "localhost" with the name - or the IP address of the server you want to connect to. - + + <function>imap_open</function> example