Přílohy

Tato stránka ukazuje, jak k e-mailům odesílaným přes POST /emails přiložit soubory, buď jako obsah zakódovaný v base64, nebo tak, že je Emailit stáhne z URL. Popisuje také vložené obrázky, povolené typy souborů a limity velikosti.

Pole přílohy

Předejte pole attachments. Každá položka je objekt s těmito poli:

Přiložte soubor v base64

Načtěte soubor, zakódujte ho do base64 a odešlete ho s jeho typem MIME.

curl https://api.emailit.com/v2/emails \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"from\": \"Acme Billing <billing@acme.com>\",
    \"to\": \"ada@example.com\",
    \"subject\": \"Invoice INV-1042\",
    \"text\": \"Your invoice is attached.\",
    \"attachments\": [{
      \"filename\": \"INV-1042.pdf\",
      \"content\": \"$(base64 < INV-1042.pdf | tr -d '\n')\",
      \"content_type\": \"application/pdf\"
    }]
  }"

import { readFile } from 'node:fs/promises';
import { Emailit } from '@emailit/node';

const emailit = new Emailit(process.env.EMAILIT_API_KEY);
const pdf = await readFile('INV-1042.pdf');

await emailit.emails.send({
  from: 'Acme Billing <billing@acme.com>',
  to: 'ada@example.com',
  subject: 'Invoice INV-1042',
  text: 'Your invoice is attached.',
  attachments: [
    {
      filename: 'INV-1042.pdf',
      content: pdf.toString('base64'),
      content_type: 'application/pdf',
    },
  ],
});

import base64
import os
from emailit import EmailitClient

client = EmailitClient(os.environ["EMAILIT_API_KEY"])

with open("INV-1042.pdf", "rb") as f:
    pdf = base64.b64encode(f.read()).decode("ascii")

client.emails.send({
    "from": "Acme Billing <billing@acme.com>",
    "to": "ada@example.com",
    "subject": "Invoice INV-1042",
    "text": "Your invoice is attached.",
    "attachments": [{
        "filename": "INV-1042.pdf",
        "content": pdf,
        "content_type": "application/pdf",
    }],
})

$emailit = Emailit::client(getenv('EMAILIT_API_KEY'));

$emailit->emails()->send([
    'from' => 'Acme Billing <billing@acme.com>',
    'to' => 'ada@example.com',
    'subject' => 'Invoice INV-1042',
    'text' => 'Your invoice is attached.',
    'attachments' => [[
        'filename' => 'INV-1042.pdf',
        'content' => base64_encode(file_get_contents('INV-1042.pdf')),
        'content_type' => 'application/pdf',
    ]],
]);

Přiložte soubor z URL

Místo toho, abyste soubor kódovali sami, předejte Emailitu url. Emailit soubor stáhne při sestavování zprávy, takže požadavek trvá tak dlouho jako stahování.

{
  "from": "Acme Billing <billing@acme.com>",
  "to": "ada@example.com",
  "subject": "Invoice INV-1042",
  "text": "Your invoice is attached.",
  "attachments": [
    {
      "filename": "INV-1042.pdf",
      "url": "https://files.acme.com/invoices/INV-1042.pdf"
    }
  ]
}

URL musí splňovat tato pravidla, jinak požadavek selže s 422 a Attachment error:

• Používá http nebo https a vede na veřejný server. Privátní a interní adresy se odmítají.
• Vrací soubor přímo se stavem 2xx. Přesměrování se nenásledují.
• Stahování skončí do 30 sekund.
• Soubor není větší než 25 MB podle své hlavičky Content-Length.

Emailit sestavuje pro každého příjemce samostatnou kopii zprávy a přílohy z URL stahuje pro každou kopii. Zajistěte, aby podepsané nebo časově omezené URL zůstaly platné po celou dobu zpracování požadavku a aby server se soubory zvládl jedno stažení na každého příjemce.

Vložte obrázky do textu

Pokud chcete obrázek zobrazit přímo v těle HTML, a ne jako samostatnou přílohu, dejte mu content_id a odkažte na toto ID přes cid: ve značce img.

{
  "from": "Acme <hello@acme.com>",
  "to": "ada@example.com",
  "subject": "Your weekly report",
  "html": "<p><img src=\"cid:chart-week-40\" alt=\"Weekly signups\" width=\"600\"></p>",
  "attachments": [
    {
      "filename": "chart.png",
      "content": "iVBORw0KGgoAAAANSUhEUgAA...",
      "content_type": "image/png",
      "content_id": "chart-week-40"
    }
  ]
}

content_id v příloze a hodnota za cid: se musí přesně shodovat. Vložené obrázky zvětšují zprávu pro každého příjemce, takže pro loga a další sdílené obrázky je obvykle lepší volbou URL hostovaného obrázku v HTML.

Limity velikosti

Kódování base64 zvětší soubory přibližně o třetinu a limit 40 MB platí pro zakódovanou zprávu. V praxi udržujte celkovou velikost souborů pod přibližně 29 MB. Cokoli většího nahrajte do vlastního úložiště a pošlete odkaz.

Povolené typy souborů

filename musí končit jednou z těchto přípon. Jakákoli jiná přípona nebo název bez přípony neprojde validací a požadavek vrátí 400.

Spustitelné soubory a skripty na seznamu nejsou a přiložit je nelze.

Načtěte přílohy odeslaného e-mailu

Výpis příloh (GET /emails/{id}/attachments) vrací každou přílohu s poli filename, content_type, size, content_id, content_disposition (attachment, nebo inline) a content v base64. Potřebuje klíč s oprávněním Full Access. Přílohy se smažou spolu s obsahem zprávy, když skončí doba uchovávání dat.

Řešení problémů

Související

• Odeslání e-mailu
• Odeslání e-mailu v referenci API
• Uchovávání dat