imap_open

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_open — Abre um fluxo IMAP para uma caixa de correio

Descrição

imap_open(
    string $mailbox,
    string $user,
    string $password,
    int $flags = 0,
    int $retries = 0,
    array $options = []
): IMAP\Connection|false

Abre um fluxo IMAP para a caixa de correio informada em mailbox.

Esta função também pode ser usada para abrir fluxos para servidores POP3 e NNTP, mas algumas funções e recursos estão disponíveis apenas em servidores IMAP.

Parâmetros

mailbox

Um nome de caixa de correio consiste em um servidor e um caminho de caixa de correio neste servidor. O nome especial INBOX representa a caixa de correio pessoal dos usuários atuais. Nomes de caixa de correio que contêm caracteres internacionais além daqueles no escopo ASCII imprimível precisam ser codificados com imap_utf7_encode().

Aviso

Passar dados não confiáveis para este parâmetro é inseguro, a menos que imap.enable_insecure_rsh esteja desabilitado.

A parte do servidor, que é delimitada por '{' e '}', consiste no nome ou endereço IP do servidor, uma porta opcional (prefixada por ':') e uma especificação de protocolo opcional (prefixada por '/').

A parte do servidor é obrigatória em todos os parâmetros da caixa de correio.

Todos os nomes que começam com { são nomes remotos e estão no formato "{" remote_system_name [":" port] [flags] "}" [mailbox_name] onde:

remote_system_name - Nome de domínio da Internet ou endereço IP entre colchetes do servidor.
port - número de porta TCP opcional, o padrão é a porta padrão para esse serviço
flags - sinalizadores opcionais, veja a tabela a seguir.
mailbox_name - nome da caixa de correio remota, o padrão é INBOX

**Sinalizadores opcionais para nomes**
Sinalizador	Descrição
`/service=`serviço	serviço de acesso à caixa de correio, o padrão é "imap"
`/user=`usuário	nome de usuário remoto para login no servidor
`/authuser=`usuário	usuário de autenticação remota; se especificado, este é o nome de usuário cuja senha é usada (por exemplo, administrador)
`/anonymous`	acesso remoto como usuário anônimo
`/debug`	registra a telemetria do protocolo no registro de depuração do aplicativo
`/secure`	não transmite uma senha em texto simples pela rede
`/imap`, `/imap2`, `/imap2bis`, `/imap4`, `/imap4rev1`	equivalente a `/service=imap`
`/pop3`	equivalent to `/service=pop3`
`/nntp`	equivalent a `/service=nntp`
`/norsh`	não usa rsh ou ssh para estabelecer uma sessão IMAP pré-autenticada
`/ssl`	usa o `Secure Socket Layer` (SSL) para criptografar a sessão
`/validate-cert`	valida certificados do servidor TLS/SSL (este é o comportamento padrão)
`/novalidate-cert`	não valida certificados do servidor TLS/SSL, necessário se o servidor usa certificados autoassinados
`/tls`	força o uso de `start-TLS` para criptografar a sessão e rejeita conexão com servidores que não o suportam
`/notls`	não faz uso de `start-TLS` para criptografar a sessão, mesmo com servidores que o suportam
`/readonly`	solicita abertura de caixa de correio somente leitura (somente IMAP; ignorado em NNTP e um erro com SMTP e POP3)

user

O nome de usuário

password

A senha associada a user

flags

O parâmetro flags consiste em uma máscara de bits com uma ou mais das seguintes constantes:

OP_READONLY - Abre a caixa de correio somente leitura
OP_ANONYMOUS - Não usa ou atualiza um .newsrc para notícias (somente NNTP)
OP_HALFOPEN - Para nomes IMAP e NNTP, abre uma conexão, mas não abre uma caixa de correio.
CL_EXPUNGE - Expurga a caixa de correio automaticamente ao fechar a caixa de correio (veja também imap_delete() e imap_expunge())
OP_DEBUG - Depura negociações de protocolo
OP_SHORTCACHE - Cache curto (somente elt)
OP_SILENT - Não deixa passar eventos (uso interno)
OP_PROTOTYPE - Retorna protótipo de driver
OP_SECURE - Não faz autenticação não segura

retries

Número máximo de tentativas de conexão

options

Parâmetros de conexão, as seguintes chaves (string) podem ser usadas para definir um ou mais parâmetros de conexão:

DISABLE_AUTHENTICATOR - Desativa propriedades de autenticação

Valor Retornado

Retorna uma instância IMAP\Connection em caso de sucesso, ou false em caso de falha.

Registro de Alterações

Versão	Descrição
8.1.0	Retorna uma instância IMAP\Connection agora; anteriormente, um resource era retornado.

Exemplos

Exemplo #1 Uso diferente de imap_open()

<?php
// Para conectar-se a um servidor IMAP em execução na porta 143 na máquina local,
// faça o seguinte:
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");

// Para conectar-se a um servidor POP3 na porta 110 no servidor local, use:
$mbox = imap_open ("{localhost:110/pop3}INBOX", "user_id", "password");

// Para conectar-se a um servidor SSL IMAP ou POP3, adicione /ssl após a especificação
// do protocolo:
$mbox = imap_open ("{localhost:993/imap/ssl}INBOX", "user_id", "password");

// Para conectar-se a um servidor SSL IMAP ou POP3 com um certificado autoassinado,
// adicione /ssl/novalidate-cert após a especificação do protocolo:
$mbox = imap_open ("{localhost:995/pop3/ssl/novalidate-cert}", "user_id", "password");

// Para conectar a um servidor NNTP na porta 119 no servidor local, use:
$nntp = imap_open ("{localhost:119/nntp}comp.test", "", "");
// Para se conectar a um servidor remoto, substitua "localhost" pelo nome ou
// endereço IP do servidor ao qual você deseja se conectar.
?>

Exemplo #2 Exemplo de imap_open()

<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password");

echo "<h1>Mailboxes</h1>\n";
$folders = imap_listmailbox($mbox, "{imap.example.org:143}", "*");

if ($folders == false) {
    echo "Chamada falhou<br />\n";
} else {
    foreach ($folders as $val) {
        echo $val . "<br />\n";
    }
}

echo "<h1>Cabeçalhos em INBOX</h1>\n";
$headers = imap_headers($mbox);

if ($headers == false) {
    echo "Chamada falhou<br />\n";
} else {
    foreach ($headers as $val) {
        echo $val . "<br />\n";
    }
}

imap_close($mbox);
?>

Veja Também

imap_close() - Fecha um fluxo IMAP

Melhore Esta Página

Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema

＋adicione uma nota

Notas Enviadas por Usuários (em inglês) 19 notes

down

php at dsgvoseidank dot de ¶

2 years ago

Google dropped the support of user/password authentication as of 30 may 2022.
imap_open can not be used anymore, without the support of xoauth2.
https://support.google.com/accounts/answer/6010255

There is a ToDo from 2020 that didn't make it.
https://wiki.php.net/todo/ext/imap/xoauth2

The only way is to switch to a third party lib. "php-imap"
This is so sad.

down

neekToO ¶

2 years ago

To reply to "dsgvoseidank" saying it doesnt work anymore with Gmail :

As today 26 august 2022 it is still working but you need to use google parameters to generate a password for your app on a 2FA account

down

kay at rrr dot de ¶

15 years ago

imap_open is very simple to use, but struggles a litte bit on setups with ssl and tls.

this are tested examples for different hosts and protocols.

uncomment the host/protocol line and fill in correct username and password.

Kay

<?php

#######
# localhost pop3 with and without ssl
# $authhost="{localhost:995/pop3/ssl/novalidate-cert}";
# $authhost="{localhost:110/pop3/notls}";

# localhost imap with and without ssl
# $authhost="{localhost:993/imap/ssl/novalidate-cert}";
# $authhost="{localhost:143/imap/notls}";
# $user="localuser";

# localhost nntp with and without ssl
# you have to specify an existing group, control.cancel should exist
# $authhost="{localhost:563/nntp/ssl/novalidate-cert}control.cancel";
# $authhost="{localhost:119/nntp/notls}control.cancel";

######
# web.de pop3 without ssl
# $authhost="{pop3.web.de:110/pop3/notls}";
# $user="kay.marquardt@web.de";

#########
# goggle with pop3 or imap
# $authhost="{pop.gmail.com:995/pop3/ssl/novalidate-cert}";
# $authhost="{imap.gmail.com:993/imap/ssl/novalidate-cert}";
# $user="username@gmail.com";

$user="username like above";
$pass="yourpass";

if ($mbox=imap_open( $authhost, $user, $pass ))
        {
         echo "<h1>Connected</h1>\n";
         imap_close($mbox);
        } else
        {
         echo "<h1>FAIL!</h1>\n";
        }

?>

down

jeff at newscloud dot com ¶

11 years ago

One of the issues with gmail IMAP SSL authentication is related to Google's account security.

Once you get the login error once, sign out of all your google accounts. Then, visit this link:
http://www.google.com/accounts/DisplayUnlockCaptcha

Log in with the account you're attempting to access via imap.

Follow the steps and you'll then be able to login in to gmail with php imap.

It's visually shown here:
http://jeffreifman.com/filtered-open-source-imap-mail-filtering-software-for-php/configuring-gmail/

down

guilherme dot geronimo at gmail dot com ¶

14 years ago

Using: 

<?php

imap_open( "{server.example.com:143}INBOX" , 'login' , 'password' );

?>



Got this error:

"Couldn't open stream {server.example.com:143}INBOX" 



Solved by adding the flag "novalidate-cert":

<?php

imap_open( "{server.example.com:143/novalidate-cert}INBOX" , 'login' , 'password' );

?>



=D

down

hashampel at yahoo dot de ¶

10 years ago

Subfolders of INBOX have to be seperate by dot like this: 'INBOX.test'
$mailbox = '{example.example.com:143/imap/novalidate-cert}INBOX.test'

down

dominic_mayers at yahoo dot com ¶

8 years ago

This code demonstrates features that are not well documented at this time. The main feature is that the selected mailbox in imap_open (or reopen)  and the specified mailbox in other imap functions are unrelated.  It has been tested with Gmail and with a Dovecot IMAP server.  The mailbox separator depends on the server. Gmail: "/"  Dovecot: "."  If you want to test with Gmail, you need to turn on "Access for less secure apps" in your account.
 
<?php
  // Change these.
  $server    = "{imap.gmail.com:993/imap/ssl/novalidate-cert}"; 
  $email     = "example@gmail.com"; 
  $password  = "password";
 
  // The code assumes that the folders Test/Sub1/Sub11, etc. exist. 
  $selected  = "{$server}Test/Sub1/Sub12";
  $conn      = imap_open($selected, $email , $password);

  // This returns the $specified mailbox and its sub mailboxes, 
  // even if the $specified mailbox is outside the $selected mailbox. 
  $specified =  "{$server}Test/Sub1"; 
  $boxes     = imap_list($conn, $specified , '*');
  print_r($boxes);
  
  // This appends the message in the $specified mailbox. 
  // It ignores the $selected mailbox. 
  imap_append($conn, $specified
                     , "From: me@example.com\r\n"
                     . "To: you@example.com\r\n"
                     . "Subject: test\r\n"
                     . "\r\n"
                     . "this is a test message, please ignore\r\n");

  // This changes the $selected mailbox
  $selected = "{$server}Test/Sub1"; 
  imap_reopen($conn, $selected); 

  // This moves a message from the $selected to the $specified mailbox
  // In this case, the specified mailbox does not include the server. 
  imap_mail_move ($conn , "1" ,  "Test"); 
  imap_expunge($conn); 
  imap_close($conn);
  // If you executed this code with a real IMAP server, 
  // the message is now in the Test mailbox !
?>

down

me at achronos dot ca ¶

10 years ago

Do not bother using "/debug" flag in $mailbox or OP_DEBUG in $options. They do not do anything.

When you set either one, the underlying IMAP c-client library will gather protocol debugging data and pass it back to PHP.
However, the debug handler defined by PHP is an empty function, it doesn't do anything.

So unless you're using a customized version of the IMAP extension that does something with that handler (mm_dlog), there is no point using "/debug" or OP_DEBUG.

down

LANGE.LUDO ¶

6 years ago

If you get Kerberos errors like:
« Notice: Unknown: Kerberos error: Credentials cache file '/tmp/krb5cc_0123' not found (try running kinit) ».

Try to add as a $param:
<?php array('DISABLE_AUTHENTICATOR' => 'GSSAPI') ?>

eg.
<?php
$imap_stream = imap_open('{mail.domain.tld:993/imap/ssl}' , 'username' , 'password', null, 1, array('DISABLE_AUTHENTICATOR' => 'GSSAPI'));
?>

down

Lisboa ¶

10 years ago

The error: Unknown: Mailbox is empty (errflg=1) in Unknown on line 0
appears when:

1)  use imap_open to connect 
2) then use imap_search ALL to retrieve emails

but there are no messages available. To avoid this error, check first the number of messages in a mailbox using imap_status. Only if there are messages available then you can use the imap_search.

down

Anonymous ¶

7 years ago

Function to test most of the possible options of a connection:

function imapConfig($options, $i=0, $till = array()) {
        if(sizeof($options)==$i)
            return $till;
        
        if(sizeof($till)==0)
            $till[] = '';
        
        $opt = $options[$i];
        $new = array();
        foreach($till as $t) {
            foreach($opt as $o) {
                if(strlen($o)==0)
                    $new[] = $t;
                else
                    $new[] = $t.'/'.$o;
            }
        }
        return imapConfig($options, $i+1, $new);
    }

function imap_test($server, $port, $dir, $username, $passw) {
        $options = array();
        //$options[] = array('debug');
        $options[] = array('imap', 'imap2', 'imap2bis', 'imap4', 'imap4rev1', 'pop3'); //nntp
        $options[] = array('', 'norsh');
        $options[] = array('', 'ssl');
        $options[] = array('', 'validate-cert', 'novalidate-cert');
        $options[] = array('', 'tls', 'notls');
        
        $configOptions = imapConfig($options);
        foreach($configOptions as $c) {
            $mbox = @imap_open("{".$server.":".$port.$c."}".$dir, $username, $passw);
            echo "<b>{".$server.":".$port.$c."}".$dir."</b> ... ";
            if (false !== $mbox) {
                echo '<span style="color: green"> success</span>';
            }
            else {
                echo '<span style="color: red"> failed</span>';
            }
            echo '<br>';
        }
    }

imap_test('mail.server.de', 143, 'INBOX', 'username', 'pwd');

down

liamr at umich dot edu ¶

20 years ago

To authenticate using kerberos V / GSSAPI, you might need to add "user=" to the connection string.. eg:

$mbox = imap_open( "\{imap.example.com:143/imap/notls/user=" . $user . "}INBOX", $user, $passwd );

Our IMAP servers won't allow a user other than the user specified in the kerberos credentials connect using those credentials unless you specify that extra "user=" in the connection string.  Passing it as an argument to imap_open() doesn't seem to be enough.

down

shaikh_zaid at yahoo dot com ¶

19 years ago

imap_open will not open a stream if your server operates with Transport Layer Security (i.e. TLS) imap_open connects with SSL if its there. So try opening mailbox as 

$mailbox="{mail.domain.com:143/imap/notls}"; 
or
$mailbox="{mail.domain.com:110/pop3/notls}"; This works...

Some mail server requires you to provide username@domain.com so you can always use. user@doamin.com

$conn=imap_open($mailbox, $username, $password);

Some server may ask for username as "user=user@domain.com"

:)

down

frederik at roal dot no ¶

23 years ago

For all imap functions where you specify the mailbox string it is important that you ALWAYS use IP (not hostname) and the portnumber. If you do not do this imap functions will be painfully slow.
Using hostname instead of IP adds 3 seconds to each IMAP call, not using portnumber adds 10 seconds to each imap call. (hint: use gethostbyname() )

down

rvarkelen AT hortimax.nl ¶

21 years ago

In order to make a IMAP connection to a Microsoft Exchange Server 5.5, I used this connection-string :

<?php
if(imap_open ("{192.168.1.6:143/imap}Inbox", "DOMAIN/USERNAME/ALIAS", "PASSWORD"))
{
    echo 'Connection success!';
}
else
{
    echo 'Connection failed';
}
?>

By replacing "Inbox" with, e.g. "Tasks", its possible to see all your tasks. I Hope this helps anybody!

Regards

down

brojann at netscape dot com ¶

23 years ago

You can do



<? $foo = imap_errors(); ?>



to clear unwanted warning messages like 'Mailbox is empty'

down

m dot stoel at cyberkinetic dot nl ¶

19 years ago

a little tip for those who get really frustrated even after reading all the right solutions and implementing them but still get the same errors or none at all..:
after having changed the code.. restart the httpd deamon..

for Fedora or any other Red Hat Linux OS (/etc/init.d/httpd restart).

After this you will be able to make a imap/pop3 stream from apache..

down

jab_creations at yahoo dot com ¶

2 months ago

I was receiving the following error while trying to add the /secure flag and verify that the /ssl flag was using TLS 1.2 instead of the very outdated SSL protocol:

PHP Request Shutdown: Can't do secure authentication with this server (errflg=2)

I ended up having to call my host to get help as there were literally only five pages in the search engines with the error. The mailbox configuration:

Before / incorrect / error:
<?php
$server_folder = '{mail.example.com:993/imap/ssl/secure}';
?>

After / correct / connected:
<?php
$server_folder = '{mail.example.com:993/ssl/imap/secure}';
?>

The /ssl and /imap flags were not in the correct order. Here is the thing, the flags listed above do NOT mention a strict chronological order of flags and are themselves no listed in the chronological order. So that right there is a bug report needed for the documentation though hopefully this comment will spare someone the aggravation for seemingly random errors. Good luck!

down

Stefano ¶

2 years ago

``There is one thing I learned over the years,
if someone says: "it's not possible", prove them wrong.`` ~ Stefano Kocka '99

test date: 2022-11-20
php version: PHP 8.0.10 (cli)
extension=imap
extension=openssl

imap: IMAP c-Client Version => 2007f
SSL Support => enabled

https://support.google.com/accounts/answer/185833?hl=en

<?php
$cnx = '{imap.gmail.com:993/imap/ssl/readonly}';
$mbox = imap_open($cnx, 'user@gmail.com', 'MyAppPassword');
$folders = imap_listmailbox($mbox, $cnx, '*');
print_r($folders);
/*
Array
(
    [0] => {imap.gmail.com:993/imap/ssl/readonly}INBOX
    [1] => {imap.gmail.com:993/imap/ssl/readonly}LABEL1
    [2] => {imap.gmail.com:993/imap/ssl/readonly}LABEL2
    [3] => {imap.gmail.com:993/imap/ssl/readonly}Queue
    [4] => {imap.gmail.com:993/imap/ssl/readonly}[Gmail]/All
    [5] => {imap.gmail.com:993/imap/ssl/readonly}[Gmail]/Drafts
    [6] => {imap.gmail.com:993/imap/ssl/readonly}[Gmail]/Sent
    [7] => {imap.gmail.com:993/imap/ssl/readonly}[Gmail]/Spam
    [8] => {imap.gmail.com:993/imap/ssl/readonly}[Gmail]/Starred
    [9] => {imap.gmail.com:993/imap/ssl/readonly}[Gmail]/Trash
)
*/
?>
Kind regards

＋adicione uma nota