Skip to main content

Getting Started

This guide will help you quickly set up Zyntra and start receiving emails in minutes. Whether you're integrating the API into an automated test suite or using the web UI for manual testing, this section covers everything you need to know.

1️⃣ Understanding Mailbox Types​

Zyntra provides two types of mailboxes, each designed for different use cases:

📌 Persistent Mailboxes (Best for Manual Testing)​

  • Created via the web UI.
  • Emails are stored for an extended period.
  • Ideal for manual testing when you need to reuse the same email multiple times and maintain email history.
  • Appears in the web UI for easy access.

How to Use:

  1. Log in to the Zyntra Dashboard.
  2. Navigate to the Mailboxes section.
  3. Click Create Mailbox and define a custom email identifier.
  4. Use this email for testing, and access messages anytime via the web UI or API.

⚡ Ephemeral Mailboxes (Best for Automated Testing)​

  • No manual creation needed.
  • Emails are accessible via API immediately upon receipt.
  • Messages do not appear in the web UI.
  • Perfect for test isolation, allowing unique email addresses for each test run.

How to Use:

  • Simply send an email to: [email protected]
  • Replace teamId with your actual team ID.
  • anytext can be any unique identifier for your test.
  • The email will be instantly available via the API.

💡 Example Use Case:
In automated tests, you can dynamically generate email addresses per test execution:

[email protected]
[email protected]

This ensures complete test isolation, avoiding conflicts between runs.

2️⃣ Create an API Key​

To access Zyntra programmatically, you need an API key.

🔑 How to generate an API key:

  1. Log in to the Zyntra Dashboard.
  2. Navigate to API Keys.
  3. Click Generate New Key.
  4. Copy and store the key securely. It will not be shown again!

Security Reminder: Never expose your API key in public repositories or client-side code.

3️⃣ Get Your Team ID​

You’ll need your Team ID to create or access any mailbox.

📍 Where to find it:​

  1. Go to https://app.zyntra.app
  2. Look in the bottom-left corner of the sidebar
  3. Copy the Team ID using the clipboard icon next to it

It will look like this:

f72c2547

You’ll use it when constructing mailbox addresses like:

[email protected]

4️⃣ Receive Emails​

Now that you have a mailbox, you can start retrieving emails via the web UI (for persistent mailboxes) or via the API (for both persistent and ephemeral mailboxes).

🔹 Option 1: Using the Web UI​

  1. Navigate to the Mailboxes section.
  2. Click on your persistent mailbox.
  3. View incoming emails and their contents.

🔹 Option 2: Fetching Emails via API​

To retrieve emails programmatically, use:

curl -X GET "https://api.zyntra.app/[email protected]" \
  -H "X-API-Key: YOUR_API_KEY"

🔹 Fetch Specific Email via API​

To fetch a specific email, use:

curl -X GET "https://api.zyntra.app/emails/message?message_uuid=550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: YOUR_API_KEY"

🔹 Fetch Last Email via API​

To fetch the last email, use:

curl -X GET "https://api.zyntra.app/emails/[email protected]" \
  -H "X-API-Key: YOUR_API_KEY"

🔹 Delete an Email via API​

To delete an email, use:

curl -X DELETE "https://api.zyntra.app/emails/message?message_uuid=550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: YOUR_API_KEY"

🔹 Fetch Attachments via API​

To fetch attachments, use:

curl -X GET "https://api.zyntra.app/emails/attachments?message_uuid=abcd1234-5678-90ef-ghij-klmnopqrstuv" \
  -H "X-API-Key: YOUR_API_KEY"

🔹 Download an Attachment via API​

To download an attachment, use:

curl -X GET "https://api.zyntra.app/emails/attachment/abcd1234-5678-90ef-ghij-klmnopqrstuv" \
  -H "X-API-Key: YOUR_API_KEY"

📚 Full API Reference​

Want to see all available endpoints and response formats?

👉 Check out the full API schema here.