Thanks for signing up.
', senderName: 'Acme Team', senderEmail: 'hello@acme.com', previewText: 'Thanks for signing up' } }); ``` **Note:** The `id` field in `to` is optional. If your system tracks users by ID, include it. Otherwise, `email` alone is sufficient and will also serve as the user identifier. **Debugging:** Check the API response for errors. For delivery issues, use **Dashboard > Logs** to see the full message lifecycle. ### Email Options ```typescript await client.send({ type: 'invoice', to: { email: 'user@example.com' }, email: { subject: 'Your Invoice', html: 'Please find your invoice attached.
', senderName: 'Billing Team', senderEmail: 'billing@yourcompany.com' }, options: { email: { replyToAddresses: ['support@yourcompany.com'], ccAddresses: ['manager@yourcompany.com'], bccAddresses: ['archive@yourcompany.com'], attachments: [ { filename: 'invoice.pdf', url: 'https://storage.example.com/invoice.pdf' }, { filename: 'terms.txt', content: 'base64content...', contentType: 'text/plain' } ] } } }); ``` ### Attachment Options **URL-based attachments:** ```typescript attachments: [ { filename: 'report.pdf', url: 'https://example.com/report.pdf' } ]; ``` **Content-based attachments:** ```typescript attachments: [ { filename: 'data.csv', content: 'base64encodedcontent', contentType: 'text/csv' } ]; ``` ### Size limits - **Inline (`content`):** ~4 MB raw per attachment (~6 MB total request payload after base64 and JSON overhead). Returns 413 when exceeded. Works via API and SMTP. - **URL (`url`):** Up to 20 MB per attachment. API only — not available via SMTP. - For files over ~4 MB, use a URL attachment via the API. ## Custom Domains ### Why Use a Custom Domain? - **Better deliverability:** Emails from your domain are less likely to be marked as spam - **Brand consistency:** Send from `notifications@yourcompany.com` instead of a shared domain - **Inbound email:** Receive replies at your domain ### Setting Up a Custom Domain 1. Go to **Settings > Domains** in the Pingram dashboard 2. Add your domain (e.g., `yourcompany.com`) 3. Copy the DNS records shown in the dashboard and add them to your DNS provider ### Adding Email Senders After domain verification, add sender addresses: 1. Go to **Settings > Senders** 2. Click **Add Sender** 3. Enter the email address (e.g., `notifications@yourcompany.com`) 4. Set as default if desired ## Inbound Email Pingram can receive emails and forward them to your application via webhooks. ### Default Inbox Every account gets an inbox at `yourcompany@mail.pingram.io`. Configure a webhook to receive inbound emails. ### Custom Domain Inbound To receive emails at your custom domain: 1. Verify your domain (see above) 2. Go to **Settings > Domains** and enable inbound for your domain 3. Add the MX record shown in the dashboard to your DNS provider 4. Configure your inbound webhook in **Settings > Webhooks** ### Inbound Webhook Payload ```json { "eventType": "EMAIL_INBOUND", "from": "customer@example.com", "fromName": "John Doe", "to": "support@yourcompany.com", "cc": ["manager@yourcompany.com"], "replyTo": "customer@example.com", "subject": "Help needed", "bodyText": "Plain text body", "bodyHtml": "HTML body
", "attachments": [ { "filename": "document.pdf", "contentType": "application/pdf", "size": 12345, "content": "base64-encoded-content" } ], "messageId": "