Keplars

Sandbox Mode

Test your email workflows safely with a dedicated sandbox email address

Sandbox Mode provides you with a dedicated sandbox email address for testing your email integration without affecting real users.

Key Benefits:

  • Dedicated sandbox email address for testing
  • Real emails sent normally
  • View captured test emails in Sandbox Inbox
  • Auto-expiration after 7 days

How It Works

When you enable Sandbox Mode, you receive a unique sandbox email address (e.g., [email protected]). Any emails sent to this address are captured in your Sandbox Inbox for testing, while all other emails are sent normally to their recipients.

Quick Start

Get Your Sandbox Email Address

  1. Go to Dashboard → Settings → Sandbox
  2. Toggle Enable Sandbox Mode
  3. Copy your unique Sandbox Email Address
  4. Click Save Changes

Send Test Email

Use your sandbox email address as the recipient:

curl -X POST https://api.keplars.com/api/v1/send-email/instant \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": ["[email protected]"],
    "subject": "Test Email",
    "body": "This email will be captured in Sandbox Inbox"
  }'

Response:

{
  "success": true,
  "data": {
    "id": "sandbox-019c2a86-8759-71c5-8841-428ed394c598",
    "sandbox": true,
    "status": "captured",
    "priority": "instant",
    "recipients": 1,
    "message": "Email captured in sandbox mode. View in Test Inbox."
  }
}

View in Sandbox Inbox

  1. Go to Dashboard → Sandbox Inbox
  2. View all captured test emails with full content
  3. Inspect recipients, subject, body, and metadata

Sandbox Inbox

Viewing Captured Emails

Navigate to Dashboard → Sandbox Inbox to view all emails sent to your sandbox address. Each email shows:

  • Recipients (To addresses)
  • From address
  • Subject line
  • HTML body content
  • Priority level
  • Capture timestamp
  • Expiration date (7 days from capture)

Sandbox emails are automatically deleted after 7 days.

Template Emails in Sandbox

Sandbox mode works with template-based emails:

curl -X POST https://api.keplars.com/api/v1/send-email/instant \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": ["[email protected]"],
    "template_id": "019ba4a2-3374-7241-8c83-fb4ec1b1d859",
    "params": {
      "userName": "Test User",
      "orderNumber": "12345"
    }
  }'

The template will be rendered and captured in the sandbox inbox with all variables populated.

Dashboard UI

Sandbox Settings Page

Access at Settings → Sandbox:

  • Enable/Disable Sandbox Mode toggle
  • Sandbox Email Address - Your unique testing address
  • Copy button to easily copy the sandbox email
  • Save Changes button

Sandbox Inbox Page

Access at Sandbox Inbox:

  • List of all captured emails
  • View email details
  • Sandbox statistics (total, unviewed, today)

Sandbox Banner

When viewing the Sandbox Inbox, you'll see information about your sandbox email address and captured emails.

Best Practices

Testing Strategy

Use your sandbox email address for:

  • Testing email templates and rendering
  • Verifying email content and formatting
  • Load testing your integration
  • Running automated tests
  • Development and QA workflows

Production Use

Real emails to actual recipients are sent normally. Only emails sent to your sandbox email address are captured for testing.

Troubleshooting

Emails Not Being Captured

  1. Verify Sandbox Mode is enabled in Settings → Sandbox
  2. Ensure you're sending to the correct sandbox email address
  3. Check you're using the correct workspace/API key
  4. Copy the sandbox email address directly from settings to avoid typos

Sandbox Inbox Empty

  • Check you're viewing the correct workspace
  • Verify you sent emails to your sandbox email address
  • Emails expire after 7 days

Cannot Find Sandbox Email Address

  • Go to Settings → Sandbox
  • Toggle Enable Sandbox Mode if not already enabled
  • Your unique sandbox email address will be displayed
  • Use the Copy button to copy it accurately

Coming Soon

More sandbox features are being added to enhance your testing workflow. Stay tuned for updates!

Next Steps

On this page