​
1. Create your Shoutbox account

To get started with Shoutbox, you’ll need to create an account. Visit shoutbox.net and navigate to /auth/sign-up to create your account. If you already have an account, you can sign in at /auth/sign-in.

​
2. Set up your domain

Before you can start sending emails, you’ll need to configure your sending domain. Head over to /domains and click on “Add Domain” to begin the process.

Follow these steps to verify your domain:

  1. Add your domain name
  2. Configure the DNS records provided
  3. Wait for DNS verification to complete

This step is crucial for ensuring reliable email delivery and maintaining a good sender reputation.

​
3. Create an API key

Once your domain is verified, you’ll need an API key to start sending emails. Navigate to /app/api-keys and create a new API key.

Make sure to store your API key securely - you won’t be able to see it again after creation. This key will be used to authenticate your requests to both the REST API and SMTP server.

​
4. Send your first email

You can send emails using either our REST API or SMTP server. Here’s how to use both:

​
Using the REST API

curl -X POST https://api.shoutbox.net/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Hello from Shoutbox",
    "html": "<h1>This is a test email</h1>"
  }'

​
Using SMTP

Connect to our SMTP server using these details:

  • Host: smtp.shoutbox.net
  • Ports:
    • 587 (TLS)
    • 465 (SSL)
  • Username: shoutbox
  • Password: Your API key
  • Authentication: Required
  • TLS: Required

Here’s an example using the swaks command-line tool:

swaks --server smtp.shoutbox.net \
  --port 587 \
  --tls \
  --auth LOGIN \
  --auth-user shoutbox \
  --auth-password YOUR_API_KEY \
  --from [email protected] \
  --to [email protected] \
  --header "Subject: Test Email" \
  --body "This is a test email from Shoutbox"
Congratulations! You’re now ready to send emails with Shoutbox

​
Rate Limits

  • 60 requests per minute per API key
  • Same limit applies to both REST API and SMTP
  • Contact support if you need higher limits

​
Next Steps

  • Dive into our API Reference to learn about all available endpoints
  • Check out our Examples for code samples in your preferred language
  • Learn about our advanced features and best practices for email delivery