Imprimir

Email

Gestor de envío de correo electrónico.

 

Ejemplo inicial

$email = new Email();
$email->to('to@example.com');
$email->replyTo('reply@example.com');
$email->subject('Test');
$email->message('...', Email::MESSAGE_ONLY_PLAIN);

$result = $email->send();

 

Email::__construct

public Email::__construct( TransportInterface $transport = null )
transport

Un transporte para enviar los correos. Si no se ingrresa un transporte, se utilizará el declarado en las configuraciones.

 

Email::from,

Email::replyTo,

Email::to,

Email::cc,

Email::bcc

Métodos para ingresar direcciones de correo.

public Email::to( string|array $address ): void
address

Acepta formatos del tipo: 

  1. "example@example.com",
  2. "<example@example.com>",
  3. "Example <example@example.com>",
  4. ['name' => 'Example', 'address' => 'example@example.com']

 

Email::$subject, Email::subject

Propiedad y método para ingresar el motivo del mensaje.

public Email::subject( string $subject ): void

 

Email::message

Ingresa el mensaje.

public Email::message ( string $message, mixed $alternative ): void
message

El mensage a enviar, puede ser texto plano o html.

alternative

Puede ser una cadena de texto plano, alternativo al mensaje. También una de las siguientes constantes:

Nombre Tipo Valor Descripción
Email::MESSAGE_IS_PLAIN int -1 El mensaje es sólo texto plano.
Email::MESSAGE_IS_HTML bool false El mensaje es sólo html.
Email::MESSAGE_ALTER_PLAIN bool true Genera un texto plano a partir del mensaje.

 

Email::attachment

Adjunta archivos al correo.

public Email::attachment (
 string $filename,
 string $name = '',
 string $disposition = 'attachment',
 string $cid = '',
 string $encoding = 'base64'
): bool
filename

Ruta al archivo a adjuntar.

name

Nombre del archivo.

disposition

Puede ser 'attachment' o 'inline'

cid

Identificador. Se utiliza sólo en la disposición inline.

encoding

Generalmente será base64.

 

Email::send

Envia el mensaje a las direcciones ingresadas.

public Email::send ( string $transport = '' ): bool
transport

Selecciona un transporte para enviar el mensaje, de no ingresar nada, se enviará a través del transporte predeterminado.

 

Propiedades

La mayoría de las propiedades son configurables desde el sistema. Eso simplifica la utilización.

 

Email::$x_mailer

Agrega el encabezado x-mailer.

public Email::$x_mailer

 

Email::$priority

Agrega el encabezado priority.

public Email::$priority = 0

 

Email::$h_charset

Juego de caracteres del encabezado.

public Email::$h_charset // 'iso-8859-1' or 'utf-8' or ...

 

Email::$h_enconding

Codificación del encabezado.

public Email::$h_enconding // 'Q' or 'B'

 

Email::$m_charset

Juego de caracteres del mensaje.

public Email::$m_charset

 

Email::$m_enconding

Codificación del mensaje.

public Email::$m_enconding

 

Email::$word_wrap

Ajuste de línea del mensaje.

public Email::$word_wrap = 70;

 

Email::$attachment_base

Ruta base para los archivos adjuntos.

public Email::$attachment_base = '';

 

Transportes

Los tranportes deben implementar la interface TransportInterface. También, pueden extender la clase abstracta TransportAbstract, que implementa la depuración.

Los transportes disponibles son:

  1. Mail: internamente, utiliza la función mail.
  2. Smtp: implementación del protocolo smtp.
  3. Null: utilizado para los test y la depuración.

Para utilizar un tranporte o para configurarlo, debe ir a los Ajustes del CMS. En cambio, si por ejemplo, quiere tener una configuración separada del CMS, debe inyectar una instancia del transporte al crear un objeto Email.

use Junco\Email\Transport\MailTransport;

$transport = new MailTransport();
$email = new Email($transport);

 

SmtpTransport

Si desea utilizar el transporte, más allá de los Ajustes del CMS, podrá hacerlo creando una instancia:

use Junco\Email\Transport\SmtpTransport;

$transport = new SmtpTransport();
Para configurar el transporte, se utilizan las siguientes propiedades:
public SmtpTransport::$smtp_host = '...';
public SmtpTransport::$smtp_port = 0;
public SmtpTransport::$smtp_timeout = 30;

public SmtpTransport::$smtp_secure = true;
public SmtpTransport::$smtp_auth = true;
public SmtpTransport::$smtp_user = '...';
public SmtpTransport::$smtp_pwd = '...';