Email Integration (Maileroo)#

Connect Maileroo to Outeract for transactional email messaging with delivery tracking.

Overview#

Prerequisites#

• Maileroo account (sign up)
• Verified sending domain
• API key

Setup Guide#

Step 1: Get Maileroo API Key#

1. Log in to Maileroo Dashboard
2. Go to API Keys
3. Create a new API key
4. Copy the key

Step 2: Verify Your Domain#

1. In Maileroo, go to Domains
2. Add your sending domain
3. Add the DNS records:
   • SPF record
   • DKIM record
   • DMARC record (optional but recommended)
4. Verify the domain

Step 3: Create Platform Connection#

mutation {
  createPlatformConnection(
    platformName: EMAIL
    name: "Maileroo Email"
    config: {
      api_key: "your-api-key"
      from_email: "noreply@yourdomain.com"
      from_name: "Your Company"
    }
  ) {
    id
    webhookUrl
  }
}

Step 4: Configure Maileroo Webhook#

1. In Maileroo Dashboard, go to Webhooks
2. Add a new webhook
3. Enter your Outeract webhook URL
4. Select events to receive:
   • Delivered
   • Bounced
   • Opened
   • Clicked
5. Save the webhook

Step 5: Test the Connection#

mutation {
  testPlatformConnection(id: "pc_email_123") {
    success
    message
  }
}

Supported Features#

Message Types#

Capabilities#

• Transactional emails
• HTML templates
• Attachment support
• Delivery tracking
• Open/click tracking

Sending Messages#

Basic Email#

mutation {
  sendMessage(
    platformConnectionId: "pc_email_123"
    toExternalId: "user@example.com"
    message: "Hello from Outeract!"
    metadata: {
      subject: "Welcome to Our Service"
    }
  ) {
    id
    status {
      success
    }
  }
}

HTML Email#

mutation {
  sendMessage(
    platformConnectionId: "pc_email_123"
    toExternalId: "user@example.com"
    message: "<h1>Welcome!</h1><p>Thanks for signing up.</p>"
    metadata: {
      subject: "Welcome",
      content_type: "text/html"
    }
  ) {
    id
  }
}

Email with Attachment#

mutation {
  sendMessage(
    platformConnectionId: "pc_email_123"
    toExternalId: "user@example.com"
    message: "Please find the report attached."
    fileIds: ["file_xyz789"]
    metadata: {
      subject: "Monthly Report"
    }
  ) {
    id
  }
}

External ID Format#

Email addresses in standard format:

Webhook Events#

Inbound Email#

{
  "event_id": "evt_abc123",
  "event_type": "message.inbound",
  "payload": {
    "message": {
      "text": "Hello!",
      "html": "<p>Hello!</p>",
      "subject": "Question"
    },
    "platform": "email"
  },
  "edges": {
    "sent_by": {
      "external_id": "sender@example.com"
    }
  }
}

Delivery Status#

{
  "event_id": "evt_xyz789",
  "event_type": "message.status",
  "payload": {
    "status": "delivered",
    "external_message_id": "msg_123"
  }
}

Email Deliverability#

Authentication Records#

For best deliverability, configure:

Best Practices#

1. Use a consistent From address
2. Include unsubscribe links for marketing emails
3. Monitor bounce rates and remove invalid addresses
4. Warm up new domains gradually
5. Avoid spam triggers in subject lines and content

Troubleshooting#

“Email not delivered”#

• Check Maileroo dashboard for delivery status
• Verify recipient email is valid
• Check spam folders
• Review bounce messages

“Authentication failed”#

• Verify API key is correct
• Check API key has send permissions
• Ensure key isn’t expired

“Domain not verified”#

• Check DNS records are properly configured
• Wait for DNS propagation (up to 48 hours)
• Re-verify in Maileroo dashboard

“High bounce rate”#

• Clean your email list
• Use double opt-in for subscriptions
• Remove addresses that bounce

Rate Limits#

Rate limits depend on your Maileroo plan:

Security#

• API keys are stored encrypted
• Webhook signatures are validated
• TLS encryption for all API calls

Resources#

• Maileroo Dashboard
• Maileroo API Documentation
• Email Authentication Guide