# mail

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

mail — Enviar correo

### Descripción

mail(
string `$to`,
string `$subject`,
string `$message`,
string `$additional_headers` = ?,
string `$additional_parameters` = ?
): bool

Envía un correo electrónico.

### Parámetros

`to`

  Destinatario/s del correo.

  El formato de este string debe cumplir con la » RFC 2822. Algunos ejemplos son:

  - usuario@example.com
  - usuario@example.com, otrousuario@example.com
  - Usuario
  - Usuario , Otro usuario
`subject`

  Título del correo electrónico a enviar.

  Precaución

  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.

  Precaución

  (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 correo.

  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). Si se usan datos externos para componer esta cabecera, los datos deberían ser saneados para que no se inyecten cabeceras no deseadas.

  > Nota:

  > `additional_headers` no posee protección de inyección de cabeceras de correo. Por tanto, los usuarios deben asegurarse de que las cabeceras especificadas son seguras y contienen solamente cabeceras. Es decir, nunca iniciar el cuerpo del correo con varias nuevas líneas.

  > 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 usar solamente 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 que está configurado para usarse 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 del remitente usando sendmail con su opción `-f`.

  Este parámetro es escapado internamente por escapeshellcmd() para prevenir la ejecución del comando. Aunque escapeshellcmd() evita la ejecución del comando, permite añadir parámetros adicionales. Por razones de seguridad, se recomienda que el usuario sanee este parámetro para evitar que se añadan parámetros indeseados al comando.

  Ya que escapeshellcmd() se aplica automáticamente, algunos caracteres que están permitidos como direcciones de correo electrónico por algún RFC no se pueden usar. mail() no puede permitir tales caracteres, por lo que en programas donde el uso de tales caracters sea necesario, se recomienda una vía alternativa de enviar correos (como usar un marco de trabajo o una biblioteca).

  El usuario usado por el servidor web debería 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ñada la dirección de remitente (-f) usando este método. Para los usuarios de sendmail, este fichero es /etc/mail/trusted-users.

### Valores devueltos

Devuelve `true` si el correo ha sido aceptado para su envío, de lo contrario `false`.

Es importante tener en cuenta que si el correo es aceptado para su envío, NO quiere decir que el correo haya alcanzado el destino indicado.

### Historial de cambios

Versión | Descripción
--- | ---
7.2.0 | El parámetro `additional_headers` ahora también acepta array.

### Ejemplos

Ejemplo #1 Enviar un 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");
// Enviarlo
mail('caffeinated@example.com', '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 = 'nobody@example.com';
$titulo = 'El título';
$mensaje = 'Hola';
$cabeceras = 'From: webmaster@example.com' . "\r\n" .
'Reply-To: webmaster@example.com' . "\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.

Se puede usar el parámetro `additional_parameters` para proporcionar parámetros adicicionales al programa configurado para usar en el envío de correo utilizando `sendmail_path`.

`<?php
mail('nadie@example.com', 'El título', 'El mensaje', null,
'-fwebmaster@example.com');
?>`

Ejemplo #4 Envío de un correo HTML

Es posible también enviar correos HTML con mail().

`<?php
// Varios destinatarios
$para = 'aidan@example.com' . ', '; // atención a la coma
$para .= 'wez@example.com';
// título
$título = 'Recordatorio de cumpleaños para Agosto';
// mensaje
$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, debe establecerse la cabecera Content-type
$cabeceras = 'MIME-Version: 1.0' . "\r\n";
$cabeceras .= 'Content-type: text/html; charset=iso-8859-1' . "\r\n";
// Cabeceras adicionales
$cabeceras .= 'To: Mary <mary@example.com>, Kelly <kelly@example.com>' . "\r\n";
$cabeceras .= 'From: Recordatorio <cumples@example.com>' . "\r\n";
$cabeceras .= 'Cc: birthdayarchive@example.com' . "\r\n";
$cabeceras .= 'Bcc: birthdaycheck@example.com' . "\r\n";
// Enviarlo
mail($para, $título, $mensaje, $cabeceras);
?>`

> Nota:

> Si la intención es enviar HTML u otro tipo de correo complejo, es recomendable usar el paquete PEAR » PEAR::Mail_Mime.

### Notas

> Nota:

> La implementación en Windows de mail() difiere bastante de la implementación en Unix. Primero, no usa un binario local para componer mensajes ya que sólo opera en sockets directos, lo que significa que es necesario un `MTA` escuchando en 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:`, de entrada no son interpretadas por el `MTA`, aunque son analizadas por PHP.

> Por esto, el parámetro `to` no debería ser una dirección de correo de la forma "Algo <alguien@example.com>". Es posible que el comando mail no analice esto correctamente mientrasz 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, véanse los paquetes » PEAR::Mail y » PEAR::Mail_Queue.

> Nota:

> Las siguientes RFC pueden ser de utilidad: » RFC 1896, » RFC 2045, » RFC 2046, » RFC 2047, » RFC 2048, » RFC 2049, y » RFC 2822.

### Ver también

- imap_mail() - Send an email message
- » PEAR::Mail
- » PEAR::Mail_Mime