Maileroo

Maileroo

Skill pro práci s Maileroo – SMTP relay, Email API, sending keys a oficiální SDK.

Kdy použít

Použij při:

• konfiguraci nebo změně odesílání e-mailů přes Maileroo (SMTP, API nebo SDK)
• integraci pomocí oficiálního SDK (Node.js, PHP, Python, Go, .NET, Java, Laravel)
• dotazech na sending keys, API klíče nebo SMTP credentials
• integraci transakčních e-mailů (potvrzení objednávek, notifikace)
• řešení problémů s doručováním nebo chybějící konfigurací

Trigger výrazy: Maileroo, SMTP Maileroo, Email API Maileroo, Maileroo SDK, sending key, odesílání e-mailů, transakční e-maily, konfigurace SMTP, maileroo-sdk.

SMTP Relay

• Host: smtp.maileroo.com
• Porty: 465 (SSL), 587 (STARTTLS), 2525
• Autentizace: povinná (uživatel + heslo)
• Max velikost zprávy: 24 MB

Env proměnné

Příklad (nodemailer)

V projektu je SMTP nastavení v server/utils/email.ts – transporter se vytváří z env a používá se pro odeslání (např. sendOrderConfirmationEmail). Referenční env viz .env.example.

// Zjednodušeně podle server/utils/email.ts
const transporter = nodemailer.createTransport({
  host: process.env.MAILEROO_SMTP_HOST,
  port: parseInt(process.env.MAILEROO_SMTP_PORT!, 10),
  secure: port === 465,
  requireTLS: port === 587,
  auth: {
    user: process.env.MAILEROO_SMTP_USER,
    pass: process.env.MAILEROO_SMTP_PASSWORD,
  },
});
await transporter.sendMail({ from, to, subject, html });

Email API

• Base URL: https://smtp.maileroo.com/api/v2
• Autentizace: sending key (API key) v hlavičce

Autentizace

Sending key lze poslat jedním z:

• Authorization: Bearer YOUR_SENDING_KEY
• X-Api-Key: YOUR_SENDING_KEY

Odeslání e-mailu

POST /emails
Content-Type: application/json

Povinná pole:

Volitelná pole: cc, bcc, reply_to, tracking, tags, headers, attachments, scheduled_at, reference_id. Detail v reference.md.

Příklad těla:

{
  "from": { "address": "info@example.com", "display_name": "Example" },
  "to": [{ "address": "recipient@example.com" }],
  "subject": "Potvrzení objednávky",
  "html": "<p>Děkujeme za objednávku.</p>"
}

Sending keys (API keys)

• Kde vytvořit: Maileroo dashboard → Domains → vybrat doménu → v levém menu Sending Keys → vytvořit nový klíč.
• Použití: Pouze pro Email API (REST) a SDK. Pro SMTP se používají SMTP credentials (uživatel/heslo), ne sending key.
• V hlavičce requestu: Authorization: Bearer <sending_key> nebo X-Api-Key: <sending_key>.

Oficiální SDK

Maileroo nabízí oficiální SDK pro více jazyků. Všechny používají sending key (API key), ne SMTP credentials. Přehled a detaily v reference.md.

Node.js (maileroo-sdk)

npm i maileroo-sdk

import { MailerooClient, EmailAddress } from "maileroo-sdk";

const client = new MailerooClient(process.env.MAILEROO_SENDING_KEY!);

const referenceId = await client.sendBasicEmail({
  from: new EmailAddress("info@example.com", "Sender Name"),
  to: [new EmailAddress("recipient@example.com", "Recipient")],
  subject: "Potvrzení",
  html: "<p>Obsah</p>",
  plain: "Obsah",
});

SDK dále nabízí: sendTemplatedEmail, sendBulkEmails, getScheduledEmails, deleteScheduledEmail, přílohy (Attachment.fromFile, Attachment.fromContent). Viz reference.md a npm.

PHP

composer require maileroo/maileroo-php-sdk

use Maileroo\MailerooClient;
use Maileroo\EmailAddress;

$client = new MailerooClient('your-api-key');
$referenceId = $client->sendBasicEmail([
    'from' => new EmailAddress('sender@example.com', 'Sender Name'),
    'to' => [new EmailAddress('recipient@example.com', 'Recipient')],
    'subject' => 'Hello from Maileroo!',
    'html' => '<h1>Hello</h1>',
    'plain' => 'Hello',
]);

Ostatní jazyky: instalace a příklady v Libraries and SDKs a na GitHubu (github.com/maileroo/maileroo-*-sdk).

Odkazy

• Maileroo Docs – Introduction
• SMTP Relay – Server Configuration
• Email API – Introduction
• Libraries and SDKs (všechna oficiální SDK)
• Send Basic Email (příklady requestů)
• V projektu: server/utils/email.ts (SMTP), .env.example (env proměnné)
• Rozšířené detaily API a SDK (response kódy, rate limit, Node.js API, ostatní jazyky): reference.md