FacturaScripts
Esta clase simplifica el envío de mails. Nos permite enviar comunicaciones electrónicas totalmente personalizables mediante una lista de valores y usando una plantilla de Twig para dar formato visual al contenido del mail. Para el correcto funcionamiento debemos primero establecer la configuración del servidor y la cuenta de correo que usaremos para los envíos, y lo hacemos en la opción del menú menú admin > Panel de Control > Preferencias de aplicación en la pestaña Email.
Para el diseño visual del mail se utiliza una plantilla Twig. FacturaScripts dispone de una plantilla base BasicTemplate.html.twig pero podemos crear nuestras propias plantillas. Las plantillas personalizadas deben situarse dentro de la carpeta View de nuestro plugin en una nueva carpeta que denominaremos Email. El nombre del archivo debe llevar las extensiones .html.twig.
Las plantillas pueden llevar variables o macros que son substituidas por su valor en el momento de renderizar la plantilla. Estas variables deben estar definidas entre doble corchete [[xxx]]. Ejemplo de plantilla con variables: title, company, body, footer
<!DOCTYPE html>
<html>
<head>
<title>[[title]]</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<h3 class="text-center">[[company]]</h3>
<div class="container">[[body]]</div>
<p class="text-center">[[footer]]</p>
</body>
</html>Al usar el componente Twig las plantillas también pueden utilizar la programación propias de este sistema, el sistema de traducción integrado en FacturaScripts y así como una lista de objetos personalizados informados por el desarrollador en la llamada (ver más adelante).
<body>
<h3 class="text-center">[[company]]</h3>
<p>{{ i18n.trans('my-company-info-header') }}</p>
<div class="container">[[body]]</div>
<p class="text-center">[[footer]]</p>
<p>{{ i18n.trans('my-company-info-footer') }}</p>
</body>Existen dos métodos para crear y mandar un mail:
Este método ayuda a envíar un correo de manera totalmente automática simplemente informando el parámetro data, que es un array que contiene la configuración a utilizar en base a las claves y valores:
Este método nos permite realizar el envío de manera manual, configurando nosotros cada uno de los pasos en la creación y envío del correo. Los pasos a seguir son:
Ejemplo:
/// Prepare email object
$emailTools = new EmailTools();
$mail = $emailTools->newMail();
$mail->Subject = 'This is a example of manual mail';
/// Set email list
$emailTools->addEmails($mail, 'myaccount@my-server.com', 'onecopy@to-you.com', '');
/// Set attachment files
$emailTools->addAttachment($mail, 'my-file.doc');
/// Load template and set data.
$body = $emailTools->getTemplateHtml(['company' => 'My Company']);
$mail->msgHTML($body);
/// Send Email
$emailTools->send($mail);
/// Remove upload files
if (!empty('my-file.doc') && file_exists(FS_FOLDER . '/MyFiles/' . 'my-file.doc'])) {
unlink(FS_FOLDER . '/MyFiles/' . 'my-file.doc']);
}Adjunta un archivo o una lista de archivos al correo informado. Los parámetros son:
Añade una dirección de correo o una lista de direcciones (destinatarios) al mail informado. Las listas de direcciones son una relacion de direcciones separadas por una coma entre ellas. Los parámetros son:
Genera y devuelve el mensaje a enviar en formato html. Para crear el mensaje utiliza una plantilla Twig.
Crea y nos retorna un objeto PHPMailer configurado con los datos de conexión informados en las preferencia de la aplicación con el que podemos enviar un correo electrónico.
Envía el correo electrónico indicado en la llamada y nos retorna si se ha completado correctamente o no el envío.
Nos permite realizar una conexión con nuestro servidor de correo para comprobar si los datos de configuración del mail son correctos.