imap_open
Ouvre un flux IMAP vers une boîte aux lettres
&reftitle.description;
IMAP\Connectionfalseimap_open
stringmailbox
stringuser
stringpassword
intflags0
intretries0
arrayoptions[]
Ouvre un flux IMAP vers la boîte aux lettres
mailbox.
Cette fonction peut aussi être utilisée pour ouvrir des flots sur des
serveurs POP3 et NNTP
mais quelques fonctions et fonctionnalités ne sont disponibles qu'avec
les serveurs IMAP.
&reftitle.parameters;
mailbox
Un nom de boîte aux lettres est constitué d'une adresse de serveur,
et d'une adresse de boîte sur ce serveur. Le mot réservé
INBOX représente la boîte aux lettres de
l'utilisateur courant. Les noms de boîtes aux lettres qui contiennent
des caractères spéciaux (en dehors de l'espace ASCII) doivent être
encodés avec imap_utf7_encode.
&imap.mailboxname.insecure;
L'adresse du serveur, mise entre accolades '{' et '}', est constituée
du nom du serveur ou de son adresse IP, d'une spécification de protocole
(commençant par '/') et d'un port optionnel (spécifié avec ':').
Cette partie est obligatoire dans les paramètres de la boîte aux
lettres.
Tous les noms commençant par { sont des noms distants et sont sous
la forme "{" nom_systeme_distant [":" port] [flags] "}"
[nom_mailbox] où :
remote_system_name : Nom de domaine Internet ou une
adresse IP de serveur entouré de guillemets.
port : numéro de port TCP (optionnel),
la valeur par défaut est la valeur du port pour ce service.
flags : options, voir la table suivante.
mailbox_name : nom de la mailbox distante, par défaut : INBOX
Flags optionnels pour les noms
Flag
Description
/service=service
service pour l'accès à la mailbox, par défaut : "imap"
/user=user
nom de l'utilisateur distant pour l'identification sur le serveur
/authuser=user
utilisateur distance d'identification ; si spécifié, ce sera le nom de l'utilisateur
dont le mot de passe est utilisé (e.g. administrator)
/anonymous
accès distant en anonyme
/debug
la télémétrie d'enregistrement du protocole dans les logs de déboguage de
l'application
/secure
ne transmet pas un mot de passe en clair à travers le réseau
/imap, /imap2,
/imap2bis, /imap4,
/imap4rev1
équivalent de /service=imap
/pop3
équivalent de /service=pop3
/nntp
équivalent de /service=nntp
/norsh
ne pas utiliser rsh ou ssh pour établir une session de pré identification
IMAP
/ssl
utilise Secure Socket Layer pour crypter la
session
/validate-cert
valide les certificats depuis le serveur TLS/SSL (c'est le comportement par
défaut)
/novalidate-cert
ne pas valider les certificats depuis le serveur TLS/SSL, nécessaire si
le serveur utilise des certificats autosignés
/tls
force l'utilisation de start-TLS pour chiffrer la session et
rejette les connexions aux serveurs qui ne le supporte pas
/notls
n'utilise pas start-TLS pour chiffrer la session,
y compris avec les serveurs qui le supporte
/readonly
demande un accès en lecture seule sur mailbox (IMAP uniquement ; ignoré sous
NNTP, et une erreur avec SMTP et POP3)
user
Le nom d'utilisateur
password
Le mot de passe associé avec l'utilisateur user
flags
flags est un masque de bit, qui peut prendre une ou
plusieurs des valeurs suivantes :
OP_READONLY : Ouvre une boîte aux lettres en lecture seule
OP_ANONYMOUS : Ne pas utiliser, ou modifier le fichier
.newsrc pour les news (NNTP uniquement)
OP_HALFOPEN : Pour les noms IMAP et NNTP,
ouvre une connexion mais n'ouvre pas une boîte aux lettres.
CL_EXPUNGE : Supprime automatiquement la boîte aux lettres
de la liste, lors de la terminaison du flux (voir aussi
imap_delete and
imap_expunge)
OP_DEBUG : négociations de débogage du protocole
OP_SHORTCACHE : Cache court (elt uniquement)
OP_SILENT : Ne pas transmettre les événements (utilisation
interne)
OP_PROTOTYPE : Retourne le prototype du driver
OP_SECURE : Ne pas effectuer des identifications non sécurisées
retries
Le nombre maximal de tentatives de connexion.
options
Paramètres de connexion ; les clés peuvent être utilisées pour
définir un ou plusieurs paramètres de connexion :
DISABLE_AUTHENTICATOR - Désactive les propriétés d'authentification
&reftitle.returnvalues;
Retourne une instance de IMAP\Connection
en cas de succès,&return.falseforfailure;.
&reftitle.changelog;
&Version;
&Description;
8.1.0
Retourne désormais une instance de IMAP\Connection ;
auparavant, une &resource; était retournée.
&reftitle.examples;
Différentes utilisations de <function>imap_open</function>
]]>
Exemple avec <function>imap_open</function>
Mailboxes\n";
$folders = imap_listmailbox($mbox, "{imap.example.org:143}", "*");
if ($folders == false) {
echo "Appel échoué
\n";
} else {
foreach ($folders as $val) {
echo $val . "
\n";
}
}
echo "en-têtes dans INBOX
\n";
$headers = imap_headers($mbox);
if ($headers == false) {
echo "Appel échoué
\n";
} else {
foreach ($headers as $val) {
echo $val . "
\n";
}
}
imap_close($mbox);
?>
]]>
&reftitle.seealso;
imap_close