Email¶

Uso Básico¶

Primeiro de tudo, você deve garantir que a classe está carregada:

use Cake\Mailer\Email;

Depois que você carregou Email, you pode enviar um e-mail com o seguinte:

$email = new Email('default');
$email->from(['[email protected]' => 'Meu Site'])
    ->to('[email protected]')
    ->subject('Assunto')
    ->send('Minha mensagem');

Com os métodos construtores da classe Email, você é capaz de definir suas propriedades com o encadeamento de método.

Email tem vários métodos para definir os destinatários - to(), cc(), bcc(), addTo(), addCc() e addBcc(). A diferença é que os três primeiros irão substituir o que já foi definido antes e mais tarde será apenas como adicionar mais destinatários ao seu respectivo campo:

$email = new Email();
$email->to('[email protected]', 'To Example');
$email->addTo('[email protected]', 'To2 Example');
// Os destinatários são: [email protected] and [email protected]
$email->to('[email protected]', 'ToTest Example');
// O destinatário é: [email protected]

$email = new Email();
$email->sender('[email protected]', 'MyApp emailer');

Configuração¶

A configuração de Email padrão é criada usando config() e configTransport(). Você deve colocar as predefinições de e-mail no arquivo config/app.php. O arquivo config/app.default.php é um exemplo deste arquivo. Não é necessário definir a configuração de e-mail em config/app.php. Email pode ser usado sem ele e usar os respectivos métodos para definir todas as configurações separadamente ou carregar uma variedade de configurações.

Ao definir perfis e transportes, você pode manter o código do aplicativo livre dos dados de configuração, e evitar a duplicação que faz manutenção e implantação mais difícil.

Para carregar uma configuração pré-definida, você pode usar o método profile() ou passá-lo para o construtor de Email:

$email = new Email();
$email->profile('default');

// Ou no Construtor
$email = new Email('default');

Em vez de passar uma string que corresponde a um nome de configuração predefinida, você também pode apenas carregar uma variedade de opções:

$email = new Email();
$email->profile(['from' => '[email protected]', 'transport' => 'my_custom']);

// Ou no Construtor
$email = new Email(['from' => '[email protected]', 'transport' => 'my_custom']);

use Cake\Mailer\Email;

// Configuração Simples de Email
Email::configTransport('default', [
    'className' => 'Mail'
]);

// Configuração smtp Simples
Email::configTransport('gmail', [
    'host' => 'ssl://smtp.gmail.com',
    'port' => 465,
    'username' => '[email protected]',
    'password' => 'secret',
    'className' => 'Smtp'
]);

use Cake\Mailer\Email;

Email::configTransport('gmail', [
    'host' => 'smtp.gmail.com',
    'port' => 587,
    'username' => '[email protected]',
    'password' => 'secret',
    'className' => 'Smtp',
    'tls' => true
]);

Email::configTransport('default', [
    'url' => 'smtp://[email protected]:[email protected]:465?tls=true',
]);

Definindo Cabeçalho¶

Em Email você está livre para definir os cabeçalhos que você deseja. Quando migrar usando e-mail, não se esqueça de colocar o prefixo X- em seus cabeçalhos.

Visto como Email::setHeaders() e Email::addHeaders().

Enviando E-mail com Templates¶

E-mails são frequentemente muito mais do que apenas uma simples mensagem de texto. A fim de facilitar, o CakePHP fornece uma maneira de enviar e-mails usando o CakePHP. Veja em view layer.

Os templates para e-mails residir em uma pasta especial em sua aplicação no diretório Template chamado Email. Visualizações de e-mail também pode usar layouts e os elementos assim como vistas normais:

$email = new Email();
$email->template('welcome', 'fancy')
    ->emailFormat('html')
    ->to('[email protected]')
    ->from('[email protected]')
    ->send();

O acima usaria src/Template/Email/html/welcome.ctp para a vista e src/Template/Layout/E-mail/html/fancy.ctp para o layout. Você pode enviar mensagens de e-mail com templates de várias partes, veja:

$email = new Email();
$email->template('welcome', 'fancy')
    ->emailFormat('both')
    ->to('[email protected]')
    ->from('[email protected]')
    ->send();

Este usaria os seguintes arquivos de template:

• src/Template/Email/text/welcome.ctp

• src/Template/Layout/Email/text/fancy.ctp

• src/Template/Email/html/welcome.ctp

• src/Template/Layout/Email/html/fancy.ctp

Ao enviar e-mails com templates, você tem a opção de enviar qualquer text, html ou both.

Você pode definir as váriaveis da view com Email::viewVars():

$email = new Email('templated');
$email->viewVars(['value' => 12345]);

Em seus templates de e-mail, você pode usar isso com:

<p>Aqui está o seu valor: <b><?= $value ?></b></p>

Você pode usar helpers em e-mails, bem como você pode em arquivos de modelo normais. Por padrão, somente o HtmlHelper é carregado. Você pode carregar helpers adicionais usando os métodos helpers():

$email->helpers(['Html', 'Custom', 'Text']);

Ao definir ajudantes se esqueça de incluir ‘Html’ ou ele será removido do helpers carregado no seu template de e-mail.

Se você quiser enviar e-mail usando templates em um plugin, você pode usar o familiar Sintaxe Plugin para faze-lô:

$email = new Email();
$email->template('Blog.new_comment', 'Blog.auto_message');

O acima usaria templates a partir do plug-in Blog como um exemplo.

Em alguns casos, pode ser necessário substituir o template padrão fornecido pelo plugins. Você pode fazer isso usando temas, dizendo par ao E-mail usar o tema apropriado usando o método Email::theme():

$email = new Email();
$email->template('Blog.new_comment', 'Blog.auto_message');
$email->theme('TestTheme');

Isso permite que você substituir o new_comment em seu tema, sem modificar o plug-in Blog. O arquivo de template precisa ser criado no seguinte caminho: src/Template/Plugin/TestTheme/Blog/Email/text/new_comment.ctp.

Envio de Anexos¶

Cake\Mailer\Email::attachments($attachments = null)¶

Você pode anexar arquivos a mensagens de email também. Há alguns diferentes formatos, dependendo do tipo de arquivos que você tem, e como você quer os nomes dos arquivos para aparecer no email do destinatário:

1. String: $email->attachments('/full/file/path/file.png') irá anexar este arquivo com o nome file.png.

2. Array: $email->attachments(['/full/file/path/file.png']) tem o mesmo comportamento como o uso de uma String.

3. Array com chave: $email->attachments(['photo.png' => '/full/some_hash.png']) irá anexar alguns hash.png com o nome photo.png. O destinatário verá photo.png, não hash.png.

4. Arrays aninhados:

   $email->attachments([
       'photo.png' => [
           'file' => '/full/some_hash.png',
           'mimetype' => 'image/png',
           'contentId' => 'my-unique-id'
       ]
   ]);
   

   O acima irá anexar o arquivo com diferentes mimetypes e com identificação de conteúdo personalizado (quando definir o ID de conteúdo do anexo é transformado para linha). O mimetype e contentId são opcionais nessa forma.

   4.1. Quando você estiver usando o contentId, você pode usar o arquivo no corpo HTML como <img src="cid:my-content-id">.

   4.2. Você pode usar a opção contentDisposition conteúdo para desativar cabeçalho Content-Disposition para um anexo. Isso é útil quando é feito o envio de convites para o iCal para clientes usando o Outlook.

   4.3 Em vez de a opção file você pode fornecer o conteúdo do arquivo como uma string usando a opção data. Que lhe permite anexar arquivos sem a necessidade de caminhos de arquivo para eles.

Usando Transportes¶

Transportes são classes atribuídas a enviar o e-mail sobre algum protocolo ou método. CakePHP suporta o o transporte de Mail (padrão), Debug e SMTP.

Para configurar o método, você deve usar o método Cake\Mailer\Email::transport() ou ter o transporte em sua configuração:

$email = new Email();

// Usar um transporte chamado já configurado usando Email::configTransport()
$email->transport('gmail');

 // Usando um método Construtor
$transport = new DebugTransport();
$email->transport($transport);