Welcome to Smailander Documentation¶

Smailander is an advanced email honeypot and security monitoring platform designed to protect organizations from email-based threats, data breaches, and malicious actors.

What is Smailander?¶

Smailander provides a comprehensive solution for email security by leveraging honeypot technology. A honeypot is a decoy system designed to attract and detect unauthorized access attempts. In the context of email, honeypot email addresses are strategically deployed to:

Detect Data Breaches: Identify which companies have leaked your email address
Monitor Threats: Capture phishing attempts, spam campaigns, and malware in real-time
Build Intelligence: Analyze attack patterns and build threat intelligence databases
Train Teams: Use captured threats to educate employees about security best practices

Key Features¶

Powerful Protection

Smailander combines advanced threat detection with intuitive analytics to provide comprehensive email security.

Core Capabilities¶

Feature	Description
Honeypot Management	Create and manage unlimited honeypot email addresses
Threat Detection	Automated phishing, spam, and malware detection using ClamAV and SpamScanner
Real-time Analytics	Live dashboard with threat statistics and pattern detection
Webhook Integration	Instant notifications for threats and email events
GDPR Compliance	Built-in data anonymization and retention policies
RESTful API	Full API access with OpenAPI 3.0 specification

Use Cases¶

Data Breach Detection
Deploy unique honeypot addresses for each service
Detect exactly which company leaked your data when emails arrive
Security Research
Analyze phishing campaigns and spam patterns
Build domain and sender threat intelligence
Employee Training
Use captured phishing emails for security awareness training
Test employees with simulated attacks
Compliance Monitoring
Track email communications for GDPR/HIPAA compliance
Generate automated reports with audit trails
Threat Intelligence
Correlate emails, domains, senders, and IPs
Identify coordinated attacks and patterns

Getting Started¶

New to Smailander?

Start with our Quick Start guide to get up and running in minutes.

Quick Links¶

Installation Guide - Set up Smailander in your environment
Core Concepts - Understand how honeypots work
API Documentation - Integrate Smailander with your systems
User Guide - Learn to use the dashboard effectively

Architecture Overview¶

Smailander is built on a modern microservices architecture:

graph TB
    A[Emails] -->|SMTP| B[Forward Email API]
    B -->|Webhooks| C[Smailander API]
    C --> D[(PostgreSQL)]
    C --> E[(Redis)]
    C --> F[ClamAV]
    C --> G[SpamScanner]
    C --> H[Analytics Engine]
    C --> I[Webhook Notifier]
    J[Dashboard] -->|REST API| C
    K[External Apps] -->|REST API| C

Security & Privacy¶

Security First

Smailander is designed with security and privacy at its core.

Passwordless Authentication: Magic link-based authentication
API Key Security: Role-based access control with scoped permissions
Data Anonymization: Automatic PII redaction and encryption
GDPR Compliant: Built-in data retention and right-to-be-forgotten support
Audit Logging: Complete audit trail for compliance requirements

Support & Community¶

Documentation: You're here! Comprehensive guides and API reference
Demo Dashboard: Live demo showcasing platform capabilities
Contact: Get in touch for support and enterprise inquiries

License¶

Smailander is available under the MIT License. See the repository for details.

Ready to secure your emails? Start with the Quick Start guide or explore the User Guide.