sendfn 0.0.1

Self-hosted communications platform SDK for email, push notifications, and SMS

SendFn Python SDK

Self-hosted communications platform SDK for email, push notifications, and SMS.

Installation

pip install sendfn

For email support (AWS SES):

pip install sendfn[email]

For push notification support:

pip install sendfn[push]

For all features:

pip install sendfn[all]

Quick Start

Email Sending

from sendfn import create_sendfn, SendfnConfig
from sendfn.models import EmailConfig, AwsSesConfig, SendEmailParams
from sendfn.database import MemoryAdapter

# Create configuration
config = SendfnConfig(
    database=MemoryAdapter(),
    email=EmailConfig(
        from_email="[e-mail]",
        from_name="My App",
        aws_ses=AwsSesConfig(
            access_key_id="YOUR_ACCESS_KEY",
            secret_access_key="YOUR_SECRET_KEY",
            region="us-east-1",
        ),
    ),
)

# Create client
sendfn = create_sendfn(config)

# Send an email
transaction = await sendfn.send_email(
    SendEmailParams(
        user_id="user-123",
        to="[e-mail]",
        subject="Welcome!",
        html="<h1>Welcome to our app!</h1>",
        text="Welcome to our app!",
    )
)

print(f"Email sent! Transaction ID: {transaction.id}")

Using Templates

from sendfn.models import EmailTemplate

# Register a custom template
template = EmailTemplate(
    id="welcome",
    name="Welcome Email",
    subject="Welcome to {{appName}}!",
    html="<h1>Hi {{userName}}!</h1><p>Welcome to {{appName}}.</p>",
    variables=["userName", "appName"],
)

await sendfn.register_template(template)

# Send email using template
transaction = await sendfn.send_email(
    SendEmailParams(
        user_id="user-123",
        to="[e-mail]",
        template_id="welcome",
        template_data={
            "userName": "John",
            "appName": "My App",
        },
    )
)

Suppression List

# Check if email is suppressed
result = await sendfn.check_suppression_list("[e-mail]")
if result["suppressed"]:
    print(f"Email is suppressed: {result['entry'].reason}")

# Add to suppression list
await sendfn.add_to_suppression_list(
    email="[e-mail]",
    reason="manual",
    source="admin-action",
)

# Remove from suppression list
await sendfn.remove_from_suppression_list("[e-mail]")

Event Tracking

# Get events for an email transaction
events = await sendfn.get_email_events(transaction_id="...")

for event in events:
    print(f"{event.event_type} at {event.event_timestamp}")

Features

• ✅ Email Sending - AWS SES support with attachments
• ✅ Template Engine - Variable interpolation, conditionals, loops
• ✅ Suppression Lists - Automatic bounce and complaint handling
• ✅ Event Tracking - Track delivery, bounces, opens, clicks
• ✅ Database Agnostic - Works with any database via adapters
• ⏳ Push Notifications - FCM and APNS support (coming soon)
• ⏳ SMS - SMS sending support (coming soon)

Configuration

Email Configuration

EmailConfig(
    from_email="[e-mail]",  # Required
    from_name="My App",  # Optional
    reply_to="[e-mail]",  # Optional
    aws_ses=AwsSesConfig(
        access_key_id="...",
        secret_access_key="...",
        region="us-east-1",
        configuration_set_name="my-config-set",  # Optional
    ),
)

Options

SendfnOptions(
    suppression_enabled=True,  # Enable suppression list checking
    retry_attempts=3,  # Number of retry attempts
    retry_delay=1000,  # Delay between retries (ms)
    event_tracking=True,  # Enable event tracking
)

Database Adapters

Memory Adapter (for testing)

from sendfn.database import MemoryAdapter

adapter = MemoryAdapter()

With Superfunctions DB

from superfunctions.db import create_adapter

adapter = create_adapter({
    "type": "postgres",
    "connection_string": "postgresql://...",
})

Development

# Install dependencies
make install

# Run tests
make test

# Lint code
make lint

# Format code
make format

License

MIT License - see LICENSE file for details.

Links

• Documentation
• GitHub
• Issues