Tutorial
Enviar e-mails com PHP
Envie e-mails de qualquer aplicação PHP com o SDK emailit/emailit-php, com cURL puro ou com o PHPMailer por SMTP, e verifique as assinaturas dos webhooks do Emailit.
Este guia aborda o envio de e-mails de uma aplicação PHP sem framework: com o SDK oficial emailit/emailit-php, com cURL puro ou por SMTP com o PHPMailer. Ele também mostra um endpoint de webhook que verifica as assinaturas. Usa Laravel? Siga o guia de Laravel.
Pré-requisitos
- PHP 8.1 ou mais recente e Composer.
- Um domínio de envio verificado, por exemplo,
acme.com. - Uma chave de API. Uma chave Sending Only restrita ao seu domínio é suficiente.
- Até o seu workspace ter acesso de produção, você só pode enviar para os e-mails das contas dos membros do workspace.
Instalar o SDK
composer require emailit/emailit-phpO SDK usa o Guzzle para HTTP, que o Composer instala para você.
Configurar a chave de API
Defina a chave como uma variável de ambiente no seu servidor web, no pool do PHP-FPM ou no painel da hospedagem e leia-a em tempo de execução:
export EMAILIT_API_KEY=secret_••••••••••••••••••••••••••••••••$apiKey = getenv('EMAILIT_API_KEY');Se você carrega um arquivo .env com um pacote como o vlucas/phpdotenv, mantenha esse arquivo fora da raiz web e fora do controle de versão.
Enviar um e-mail
require __DIR__.'/vendor/autoload.php';
$emailit = Emailit::client(getenv('EMAILIT_API_KEY'));
$email = $emailit->emails()->send([
'from' => 'Acme <hello@acme.com>',
'to' => 'ada@example.com',
'subject' => 'Your receipt from Acme',
'html' => '<p>Thanks for your order.</p>',
'text' => 'Thanks for your order.',
]);
echo $email->id; // em_…A mesma chamada aceita cc, bcc, reply_to, attachments, template com variables, scheduled_at e tracking. Para anexar um arquivo, codifique-o em Base64:
$email = $emailit->emails()->send([
'from' => 'Acme Billing <billing@acme.com>',
'to' => 'ada@example.com',
'subject' => 'Invoice INV-1042',
'html' => '<p>Your invoice is attached.</p>',
'attachments' => [[
'filename' => 'INV-1042.pdf',
'content' => base64_encode(file_get_contents(__DIR__.'/INV-1042.pdf')),
'content_type' => 'application/pdf',
]],
]);Consulte Enviar um e-mail para ver todos os campos e Anexos para os limites.
Tratar erros
use Emailit\Exceptions\ApiErrorException;
use Emailit\Exceptions\AuthenticationException;
use Emailit\Exceptions\RateLimitException;
use Emailit\Exceptions\UnprocessableEntityException;
try {
$emailit->emails()->send($message);
} catch (AuthenticationException $e) {
// 401: the API key is missing or invalid
} catch (RateLimitException $e) {
// 429: wait and retry
} catch (UnprocessableEntityException $e) {
// 422: for example, the from domain isn't verified
} catch (ApiErrorException $e) {
error_log('Emailit error '.$e->getHttpStatus().': '.$e->getMessage());
}Enviar sem o SDK
Se você não pode usar o Composer, chame a API com cURL:
$ch = curl_init('https://api.emailit.com/v2/emails');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer '.getenv('EMAILIT_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'from' => 'Acme <hello@acme.com>',
'to' => 'ada@example.com',
'subject' => 'Your receipt from Acme',
'html' => '<p>Thanks for your order.</p>',
]),
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
if ($status >= 400) {
throw new RuntimeException("Emailit returned $status: $body");
}
$email = json_decode($body, true); // $email['id'] is the em_ IDEnviar por SMTP como alternativa
Qualquer biblioteca de e-mail PHP com suporte a SMTP funciona. Com o PHPMailer (composer require phpmailer/phpmailer):
use PHPMailer\PHPMailer\PHPMailer;
require __DIR__.'/vendor/autoload.php';
$mail = new PHPMailer(true);
$mail->isSMTP();
$mail->Host = 'smtp.emailit.com';
$mail->Port = 587;
$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
$mail->SMTPAuth = true;
$mail->Username = 'emailit';
$mail->Password = getenv('EMAILIT_API_KEY');
$mail->setFrom('hello@acme.com', 'Acme');
$mail->addAddress('ada@example.com');
$mail->Subject = 'Your receipt from Acme';
$mail->isHTML(true);
$mail->Body = '<p>Thanks for your order.</p>';
$mail->AltBody = 'Thanks for your order.';
$mail->send();Com o Symfony Mailer, use o DSN smtp://emailit:API_KEY@smtp.emailit.com:587. Para TLS implícito, use a porta 465 (PHPMailer::ENCRYPTION_SMTPS); se o seu host bloquear a 587, tente 2525 ou 2587. Consulte Configurações de SMTP.
Receber webhooks
Crie um webhook que aponte para o seu endpoint e guarde o segredo de assinatura dele em EMAILIT_WEBHOOK_SECRET. Leia o corpo bruto de php://input e verifique-o antes de confiar nele:
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_EMAILIT_SIGNATURE'] ?? '';
$timestamp = $_SERVER['HTTP_X_EMAILIT_TIMESTAMP'] ?? '';
$secret = getenv('EMAILIT_WEBHOOK_SECRET');
$expected = hash_hmac('sha256', $timestamp.'.'.$payload, $secret);
if (abs(time() - (int) $timestamp) > 300 || ! hash_equals($expected, $signature)) {
http_response_code(401);
exit('Invalid signature');
}
// The body is a JSON array of up to 100 events.
foreach (json_decode($payload, true) as $event) {
if ($event['type'] === 'email.bounced') {
$address = $event['data']['object']['to'];
// Stop emailing $address.
}
}
http_response_code(200);Responda em até 30 segundos com um 2xx; qualquer outra resposta recebe novas tentativas. Consulte Assinatura das requisições.
Dicas para produção
- Reutilize um único cliente por requisição ou worker em vez de criar um por e-mail.
- Envie em segundo plano. Para envios em massa, coloque as mensagens em uma fila e envie a partir de um worker, para que as páginas continuem rápidas e você fique dentro dos seus limites de envio (2 e-mails por segundo por padrão).
- Torne as novas tentativas seguras. Se você tentar de novo depois de um timeout, envie um cabeçalho
Idempotency-Keycom o cURL para que o e-mail não seja enviado duas vezes. Consulte Idempotência. - Mantenha as chaves fora da raiz web. Nunca faça commit de chaves nem de arquivos
.enve use uma chave separada por aplicação.