EmailTools

carlos carlos Noticias Fecha de creación: 10-05-2019 00:00:00 Última actualización: 04-08-2021 Contador de visitas: 3181

NOTA: Esta clase está obsoleta. Sustituida por la clase NewMail.

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 en el apartado Por defecto (menú administrador > panel de control), en la pestaña Email.

Sistema de plantillas

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>

Cómo mandar un mail

Existen dos métodos para crear y mandar un mail:

  • el método estático sendMail que realiza todo el proceso de manera automática en base a los parámetros informados
  • crear una instancia de EmailTools, configurarla y finalmente mandarlo con el método público send.

sendMail

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:

  • subject: (string) Asunto o título del correo. (requerido)
  • body: (string) Texto que conforma el mensaje. Puede ser código html. (requerido si no se informa una plantilla)
  • email: (string) Lista de cuentas de correo destinatarias, separada por comas. (requerido)
  • email-cc: (string) Lista de cuentas de correo donde se mandará una copia de cortesía del correo.
  • email-bcc: (string) Lista de cuentas de correo donde se mandará una copia de manera oculta del correo.
  • files: (string|array) Ruta y nombre de un archivo o lista de archivos que se adjuntarán al correo.
  • template: (string) Plantilla Twig con la que diseñar el correo.
  • template-data: (array) Lista de valores a usar en la plantilla. Ejemplo: [ 'mydate' => '01/01/2019', 'myvalue' => 'custom value' ].
  • template-object: (array) Lista de objetos que se "pasarán" a la plantilla. Estos objetos estarán disponibles en la plantilla Twig. Ejemplo: [ 'fsc' => $this, 'company' => $company ].

send (manualmente)

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:

  1. Crear un objeto EmailTools
  2. Obtener un objeto mail (PHPMailer)
  3. Configurar el mail

3.1 Establecer el asunto del mail 3.2 Asignar la lista de correos a donde enviar el mail 3.3 Asignar, si lo hay, los archivos adjuntos 3.4 Generar el mensaje del correo en base a una plantilla. Si no se indica plantilla se usa la estandar de FacturaScripts.

  1. Enviar el mail
  2. Si hay archivos adjuntos, eliminar los archivos temporales

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']);
 }

Métodos disponibles

addAttachment

Adjunta un archivo o una lista de archivos al correo informado. Los parámetros son:

  • mail: (PHPMailer) Puntero al objeto mail encargado del envío.
  • files: (string|array) Nombre del archivo o lista de nombres de archivos.

addEmails

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:

  • mail: (PHPMailer) Puntero al objeto mail encargado del envío.
  • emails: (string) Dirección de correo o lista de direcciones.
  • emailsCC: (string) Dirección de correo o lista de direcciones con copia de cortesía.
  • emailsBCC: (string) Dirección de correo o lista de direcciones con copia oculta.

getTemplateHtml

Genera y devuelve el mensaje a enviar en formato html. Para crear el mensaje utiliza una plantilla Twig.

  • params: (array) Lista de claves y valores que se aplican a la plantilla. Cada clave se corresponde al nombre de una variable definida en la plantilla. El valor es el valor con el que se reemplazará la variable.
  • template: (string) Nombre de la plantilla Twig a utilizar.
  • objects: (array) Lista de claves y valores que se pasan a la plantilla. Cada clave se corresponde al nombre de una variable que se podrá usar en plantilla. El valor es el la dirección al objeto que se corresponderá al usar la variable.

newMail

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.

send

Envía el correo electrónico indicado en la llamada y nos retorna si se ha completado correctamente o no el envío.

test

Nos permite realizar una conexión con nuestro servidor de correo para comprobar si los datos de configuración del mail son correctos.

Índice


Amplía tus conocimientos con los cursos oficiales

Curso básico de PHP
2 h 59 min
Programación

Curso básico de PHP

¡Aprende a programar en PHP de manera fácil y divertida con nuestro curso básico! En este curso, te enseñaremos los conceptos...

38 lecciones · 63 alumnos

Curso de Amortizaciones
1 h 5 min
Plugin Amortizaciones Nuevo

Curso de Amortizaciones

Aprende a gestionar los inmovilizados de tu empresa y los préstamos bancarios con el plugin Amortizaciones para FacturaScripts,...

8 lecciones

Curso de usuario
3 h 58 min
Empezar

Curso de usuario

Con este curso aprenderás a gestionar el día a día de tu negocio con FacturaScripts: hacer facturas, albaranes, pedidos, presupuestos,...

27 lecciones · 462 alumnos

Patrocinadores

Estas empresas y profesionales apoyan económicamente FacturaScripts y nos ayudan a dedicar más tiempo al desarrollo, las pruebas y la documentación.

ORO
PLATA
BRONCE
PRO
mililitrosdeperfume_lao
mililitrosdeperfume_lao
eduardo_12367
eduardo_12367
miguel.garcia_l25
miguel.garcia_l25
carlos
carlos
daniel89fg
daniel89fg
yopli2000_5
yopli2000_5
adelantia_8n
adelantia_8n
esteban
esteban
davidpujantelopez_mrf
davidpujantelopez_mrf
luis_12743
luis_12743
gestion_kw4
gestion_kw4
mariano_6807
mariano_6807
juancarlos_ptr
juancarlos_ptr
jmoreno_2610
jmoreno_2610
galonso_12031
galonso_12031
rubaraja_15078
rubaraja_15078
euroviane_qmo
euroviane_qmo
jserrano_qv8
jserrano_qv8
djs2035_pha
djs2035_pha
pedropccribeiro_ppz
pedropccribeiro_ppz
mgila.contabilidad_qw9
mgila.contabilidad_qw9
elimbroda_ohe
elimbroda_ohe
ivancuello_qwj
ivancuello_qwj
urban_qwk
urban_qwk
mariojimenezcruz33_mx3
mariojimenezcruz33_mx3
radiotesla2011.008_qwo
radiotesla2011.008_qwo
rrespaldo430_22233
rrespaldo430_22233
calle.laplata.41_n6s
calle.laplata.41_n6s
marcossanzlatorre_o8v
marcossanzlatorre_o8v
roberto.a.paneque_qx4
roberto.a.paneque_qx4
jurgen_qx2
jurgen_qx2
leivair_qgm
leivair_qgm
victor.exland_7712
victor.exland_7712
bluehservice_18942
bluehservice_18942
jgarrancho_qvi
jgarrancho_qvi
proyecto.ronin49_qxd
proyecto.ronin49_qxd
gesebi_74c
gesebi_74c
supmanagement_qxf
supmanagement_qxf
liliosot_qxq
liliosot_qxq
mariansomesa_qt2
mariansomesa_qt2
andrea.vives_qxe
andrea.vives_qxe
carlosmorenogil_16533
carlosmorenogil_16533
myles_qxy
myles_qxy
jorge849_qy2
jorge849_qy2
compra_q6p
compra_q6p
juanrmoreira371_qw2
juanrmoreira371_qw2
aferinoxidables_oa0
aferinoxidables_oa0
a.useropelaez_qy7
a.useropelaez_qy7
fran.cornide_qyl
fran.cornide_qyl
dwujgnmxwk_qwb
dwujgnmxwk_qwb
clave80detectives_qr6
clave80detectives_qr6
oscarsoler71_k7r
oscarsoler71_k7r
jrodriguezlinar_qyx
jrodriguezlinar_qyx
david_qyz
david_qyz
pescanelasl_qz1
pescanelasl_qz1
vilaboa.angel_qz4
vilaboa.angel_qz4
ferrervicent_89t
ferrervicent_89t
raljopa_851
raljopa_851
eurogaran_nct
eurogaran_nct
hospitalaria_18966
hospitalaria_18966
administracion_qzl
administracion_qzl
it_qzm
it_qzm
ezequieltotoras_4123
ezequieltotoras_4123
hermes6686_oc2
hermes6686_oc2
marcel_qzr
marcel_qzr
rie_17672
rie_17672
maximilianoalameddin_qyp
maximilianoalameddin_qyp
imentsociedadlimitada_qzs
imentsociedadlimitada_qzs
carlos.benitez.hurtado_qzu
carlos.benitez.hurtado_qzu
miquel_qzy
miquel_qzy
danieltorresh2_r01
danieltorresh2_r01
perezvallejoa_qww
perezvallejoa_qww
mbenitezsan_r07
mbenitezsan_r07
alegria_r08
alegria_r08
crismer_r09
crismer_r09
fernandogbj_3fk
fernandogbj_3fk
hola_r0h
hola_r0h
auto-marner_r0g
auto-marner_r0g
it_r0n
it_r0n
salonmanuelafernandez_qgy
salonmanuelafernandez_qgy
tinorubiorollon_r0s
tinorubiorollon_r0s
fegugo1_qs5
fegugo1_qs5
limicompanysrl_qzn
limicompanysrl_qzn
spinardo_qzd
spinardo_qzd
bmg_r11
bmg_r11
raultvmusic_2402
raultvmusic_2402
yeisoncruz01_r13
yeisoncruz01_r13
mis_hierbitas_qvy
mis_hierbitas_qvy
ismasans_r14
ismasans_r14
merabyte_r18
merabyte_r18
cnovas.sanchez_r1b
cnovas.sanchez_r1b
autein_qu9
autein_qu9
paco100416_p0l
paco100416_p0l
r.raul.reinoso_r1m
r.raul.reinoso_r1m
dabos1705_n6y
dabos1705_n6y
davidgf7orellana_qvk
davidgf7orellana_qvk
vyxa.web_r1n
vyxa.web_r1n
radtotalcar_r1p
radtotalcar_r1p
businessgioglobal_qc9
businessgioglobal_qc9
casteret_r1q
casteret_r1q
piratapmc_r23
piratapmc_r23
jekaseo_qbu
jekaseo_qbu
marianomanzanares_19678
marianomanzanares_19678
idee-creatividad_r25
idee-creatividad_r25
fidel.martin_r2b
fidel.martin_r2b
paco_r2c
paco_r2c
crusaiderii_r0p
crusaiderii_r0p
alamas_r2j
alamas_r2j
facturacion_r2k
facturacion_r2k
quimforcada_9738
quimforcada_9738
smyboxfacturas_r2q
smyboxfacturas_r2q
mantenimientoagricolagarcia_r2r
mantenimientoagricolagarcia_r2r

Si quieres impulsar nuevas mejoras y ayudar a que el proyecto siga creciendo, conviértete en patrocinador y forma parte de quienes lo hacen posible.

Patrocinar

Cookies
Usamos cookies necesarias para el funcionamiento del sitio y cookies opcionales para recordar tus preferencias y mejorar tu experiencia. Puedes aceptarlas todas, rechazarlas o configurar tus preferencias

Soporte