Using the Django Package

The django-notifiedby package provides a Python interface for the NotifiedBy API, including full support for email flows, recipients, and flags. This page covers how to set up the package and use it to manage email flows from your Django application.

Contents:

• Introduction
  • Installation
  • Configuration
• Sending Emails
  • Using the Email Backend
  • Direct API Sending
  • Querying Sent Emails
  • Delivery Status Values
  • Example: Send Email and Check Delivery
• Working with Email Flows
  • Subscribing to a Flow
  • Unsubscribing from a Flow
  • Listing Flow Subscriptions
  • Deleting All Subscriptions
  • Managing Recipients
  • Managing Recipient Flags
• Error Handling
  • Exception Types
  • Exception Hierarchy
  • Common Error Scenarios
• Using a Custom Client
  • Creating a Custom Client
  • Use Cases
  • Client Configuration Options
• Complete Examples
  • User Lifecycle Management
  • E-commerce Order Notifications
  • Newsletter Management
  • Transactional Email Integration
  • Admin Integration

Overview

The django-notifiedby package offers:

• Email Backend: Drop-in replacement for Django’s email backend

• Flow Management: Subscribe users to automated email sequences

• Recipient Management: Create and manage recipients with metadata and flags

• Email Querying: Check delivery status and query email history

• Error Handling: Comprehensive exception handling for all operations

• Custom Clients: Support for multi-tenant applications and testing

Quick Start

1. Install the package

2. Configure your Django settings with an API key

3. Start sending emails or managing flows

# Install
pip install django-notifiedby

# Configure settings.py
EMAIL_BACKEND = "notifiedby.NotifiedByEmailBackend"
NOTIFIEDBY_API_KEY = "your-api-key-here"

# Send an email
from django.core.mail import send_mail
send_mail('Subject', 'Message', 'from@example.com', ['to@example.com'])

# Subscribe to a flow
from notifiedby import subscribe_to_flow
subscribe_to_flow('welcome', 'user@example.com')

For detailed instructions and examples, see the sections below.