PHP - Función imap_delete ()
Las funciones PHP − IMAP le ayudan a acceder a las cuentas de correo electrónico, IMAP significa IInternet Mafligir Aacceso Protocol al utilizar estas funciones también puede trabajar con protocolos NNTP, POP3 y métodos de acceso al buzón local.
los imap_delete() La función acepta un valor de recurso que representa un flujo IMAP, un valor entero que representa un mensaje en el buzón como parámetros y marca los mensajes especificados para su eliminación.
Una vez que marque los mensajes deseados con esta función, se eliminarán del buzón siempre que la función imap_expunge() se invoca o, siempre que el close() La función se invoca utilizando CL_EXPLUNGE como parámetro.
Sintaxis
imap_delete($imap_stream, $msg [, $options]);
Parámetros
No Señor | Descripción de parámetros |
---|---|
1 | imap_stream (Mandatory) Este es un valor de cadena que representa un flujo IMAP, valor de retorno del imap_open() función. |
2 | msg (Mandatory) Este es un valor entero que representa el mensaje / número de correo, que se marcará para su eliminación. |
3 | options(Optional) Este es un valor entero que representa un valor opcional FT_UID, si se especifica, el valor pasado como argumento de mensaje se trata como UID. |
Valores devueltos
Esta función devuelve un valor booleano que es VERDADERO en caso de éxito y FALSO en caso de falla.
Versión PHP
Esta función se introdujo por primera vez en PHP versión 4 y funciona en todas las versiones posteriores.
Ejemplo
El siguiente ejemplo demuestra el uso de imap_delete() función -
<html>
<body>
<?php
//Establishing connection
$url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
$id = "[email protected]";
$pwd = "cohondob_123";
$imap = imap_open($url, $id, $pwd);
print("Connection established...."."<br>");
//Marking message for deletion
$res = imap_delete($imap, 5);
if($res){
print("Message marked for deletion"."<br>");
}
//Deleting messages
$res = imap_expunge($imap);
if($res){
print("Message deleted");
}
//Closing the connection
imap_close($imap);
?>
</body>
</html>
Salida
Esto generará la siguiente salida:
Connection established....
Message marked for deletion
Message deleted
Ejemplo
A continuación se muestra otro ejemplo de la función anterior:
<html>
<body>
<?php
//Establishing connection
$url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
$id = "[email protected]";
$pwd = "cohondob_123";
$imap = imap_open($url, $id, $pwd);
print("Connection established...."."<br>");
print("Contents of inbox: "."<br>");
$emailData = imap_search($imap, '');
foreach ($emailData as $msg) {
$msg = imap_fetchbody($imap, $msg, "1");
print(quoted_printable_decode($msg)."<br>");
}
//Marking message for deletion
imap_delete($imap, 5);
//Deleting messages
imap_expunge($imap);
print("Contents of inbox after deletion: "."<br>");
$emailData = imap_search($imap, '');
foreach ($emailData as $msg) {
$msg = imap_fetchbody($imap, $msg, "1");
print(quoted_printable_decode($msg)."<br>");
}
//Closing the connection
imap_close($imap);
?>
</body>
</html>
Salida
Esto generará la siguiente salida:
Connection established....
Contents of inbox:
#sample_mail1
#sample_mail2
#sample_mail3
#sample_mail4
#sample_mail5
Contents of inbox after deletion:
#sample_mail1
#sample_mail2
#sample_mail3
#sample_mail4
Ejemplo
A continuación se muestra un ejemplo de la función anterior con parámetros opcionales:
<html>
<body>
<?php
//Establishing connection
$url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
$id = "[email protected]";
$pwd = "cohondob_123";
$imap = imap_open($url, $id, $pwd);
print("Connection established...."."<br>");
//Marking message for deletion
$res = imap_delete($imap, imap_uid($imap, 5), FT_UID );
if($res){
print("Message marked for deletion"."<br>");
}
//Deleting messages
$res = imap_expunge($imap);
if($res){
print("Message deleted");
}
//Closing the connection
imap_close($imap);
?>
</body>
</html>
Salida
Esto generará la siguiente salida:
Connection established....
Message marked for deletion
Message deleted