(PHP 4, PHP 5)
mail — Enviar correo
$to
, string $subject
, string $message
[, string $additional_headers
[, string $additional_parameters
]] )Envía un email.
to
Destinatario/s del correo.
Es formato de este string debe cumplir con la » RFC 2822. Algunos ejemplos son:
subject
Título del email a enviar.
El título debe cumplir con la » RFC 2047.
message
Mensaje a enviar.
Cada línea debería separarse con un CRLF (\r\n). Las líneas no deberían ocupar más de 70 caracteres.
(Sólo en Windows) Cuando PHP se comunica directamente con un servidor SMTP, si encuentra un punto al principio de la línea, éste se elimina. Para evitar esto es necesario reemplazar estas apariciones con un doble punto.
<?php
$texto = str_replace("\n.", "\n..", $texto);
?>
additional_headers
(opcional)String a insertar al final de la cabecera del email.
Se usa normalmente para añadir cabeceras extra (From, Cc y Bcc). Las cabeceras múltiples adicionales deberían separarse con un CRLF(\r\n). Se ha de validar el parámetro para evitar que algún atacante inyecte cabeceras no deseadas.
Nota:
Cuando se envía un correo, este debe contener una cabecera From. Puede establecerse con el parámetro
additional_headers
, o puede definirse un valor predeterminaro en php.ini.Si no se realiza esta acción se obtendrá un mensaje de error similar a Warning: mail(): "sendmail_from" not set in php.ini or custom "From:" header missing (Advertencia: mail(): "sendmail_from" no establecido en php.ini o falta la cabecera personalizada "From:"). La cabecera From también establece Return-Path bajo Windows.
Nota:
Si no se reciben los mensajes enviados, intente el uso de sólo LF (\n). Algunos agentes de transferencia de correo de Unix (como » qmail) reemplzan LF por CRLF automáticamente (lo que conlleva doblar CR si se usa CRLF). Esto debería ser el último recurso, pues no cumple con la » RFC 2822.
additional_parameters
(opcional)
El parámetro additional_parameters
puede
usarse para indicar opciones adicionales como opciones de línea de comandos
al programa configurado para ser usado cuando se envía correo, definido
por la opción de configuración sendmail_path. Por
ejemplo, puede usarse para establecer la dirección de correo de
remitente usado por sendmail con la opción -f.
This parameter is escaped by escapeshellcmd() internally to prevent command execution. escapeshellcmd() prevents command execution, but allows to add addtional parameters. For security reason, this parameter should be validated.
Since escapeshellcmd() is applied automatically, some characters that are allowed as email addresses by internet RFCs cannot be used. Programs that are required to use these characters mail() cannot be used.
El usuario usado por el servidor web debe ser añadido como usuario de confianza en la configuración de sendmail para evitar que se añada la cabecera 'X-Warning' al mensaje cuando se añade la dirección de remitente (-f) usando este método. Para los usuarios de sendmail, este fichero es /etc/mail/trusted-users.
Devuelve TRUE
si el correo ha sido aceptado con éxito para su envío, o, de lo contrario FALSE
.
Es importante tener en cuenta que si el correo es aceptado para reparto, NO quiere decir que el correo haya alcanzado el destino indicado.
Versión | Descripción |
---|---|
4.3.0 (sólo Windows) | Se aceptan todas las cabeceras personalizadas (como From, Cc, Bcc y Date) y no distinguen entre mayúsculas y minúsculas. (Como las cabeceras personaliazadas no son interpretadas por el MTA en primer lugar pero son analizadas por PHP, PHP < 4.3 sólo soportaba el elemento de cabecera Cc y distinguía entre mayúsculas y minúsculas). |
4.2.3 |
El parámetro additional_parameters es
deshabilitado en safe_mode y la
función mail() mostrará un mensaje de aviso,
retornando FALSE cuando se usa.
|
4.0.5 |
Se añade el parámetro additional_parameters .
|
Ejemplo #1 Enviar correo
Usando mail() para enviar un correo simple:
<?php
// El mensaje
$mensaje = "Línea 1\r\nLínea 2\r\nLínea 3";
// Si cualquier línea es más larga de 70 caracteres, se debería usar wordwrap()
$mensaje = wordwrap($mensaje, 70, "\r\n");
// Send
mail('[email protected]', 'Mi título', $mensaje);
?>
Ejemplo #2 Enviar un correo con cabeceras extra.
Adición de cabeceras básicas, diciendo al MUA las direcciones From y Reply-To:
<?php
$para = '[email protected]';
$titulo = 'El título';
$mensaje = 'Hola';
$cabeceras = 'From: [email protected]' . "\r\n" .
'Reply-To: [email protected]' . "\r\n" .
'X-Mailer: PHP/' . phpversion();
mail($para, $titulo, $mensaje, $cabeceras);
?>
Ejemplo #3 Enviar un correo con parámetros de línea de comando adicionales.
El parámetro additional_parameters
puede ser
usado para indicar parámetros adicicionales al programa configurado para
usar en el envío de correo configurado en sendmail_path.
<?php
mail('[email protected]', 'El título', 'El mensaje', null,
'[email protected]');
?>
Ejemplo #4 Envío de un correo HTML
Es posible también enviar correos HTML con mail().
<?php
// Varios destinatarios
$para = '[email protected]' . ', '; // atención a la coma
$para .= '[email protected]';
// subject
$titulo = 'Recordatorio de cumpleaños para Agosto';
// message
$mensaje = '
<html>
<head>
<title>Recordatorio de cumpleaños para Agosto</title>
</head>
<body>
<p>¡Estos son los cumpleaños para Agosto!</p>
<table>
<tr>
<th>Quien</th><th>Día</th><th>Mes</th><th>Año</th>
</tr>
<tr>
<td>Joe</td><td>3</td><td>Agosto</td><td>1970</td>
</tr>
<tr>
<td>Sally</td><td>17</td><td>Agosto</td><td>1973</td>
</tr>
</table>
</body>
</html>
';
// Para enviar un correo HTML mail, la cabecera Content-type debe fijarse
$cabeceras = 'MIME-Version: 1.0' . "\r\n";
$cabeceras .= 'Content-type: text/html; charset=iso-8859-1' . "\r\n";
// Cabeceras adicionales
$cabeceras .= 'To: Mary <[email protected]>, Kelly <[email protected]>' . "\r\n";
$cabeceras .= 'From: Recordatorio <[email protected]>' . "\r\n";
$cabeceras .= 'Cc: [email protected]' . "\r\n";
$cabeceras .= 'Bcc: [email protected]' . "\r\n";
// Mail it
mail($para, $titulo, $mensaje, $cabeceras);
?>
Nota:
Si la intención es enviar HTML u otro tipo de correos complejos, es recomendable usar el paquete PEAR » PEAR::Mail_Mime.
Nota:
La implementación Windows de mail() difiere en muchas formas de la implementación Unix. Primero, no usa un ejecutable local para componer mensajes ya que sólo opera en sockets directos, lo que significa que se necesita un MTA escuchando en un un socket de red (que puede estar tanto en localhost como en una máquina remota).
Segundo, las cabeceras personalizadas como From:, Cc:, Bcc: y Date: no son interpretadas por el MTA en primer lugar, pero son analizadas por PHP.
Por esto, el parámetro
to
no debería ser una dirección de correo de la forma "Algo <[email protected]>". Es posible que el comando mail no analice esto correctamente cuando dialoga con el MTA.
Nota:
Es importante indicar que la función mail() no es conveniente para grandes volúmenes de correo en bucle. Esta función abre y cierra un socket SMTP para cada correo, algo que no es muy eficiente.
Para enviar una gran cantidad de correo, ver los paquetes » PEAR::Mail y » PEAR::Mail_Queue.
Nota:
Las siguientes RFCs pueden ser de utilidad: » RFC 1896, » RFC 2045, » RFC 2046, » RFC 2047, » RFC 2048, » RFC 2049, y » RFC 2822.