Mail List Shield

Welcome! 👋 You found the documentation for the Flask application served on maillistshield.com. Please refer to the GitHub page of this project for details about the microservices.

What is Mail List Shield?

Mail List Shield is a SaaS application, designed to help marketers identify and remove invalid emails from their recipient lists to avoid sending to spam traps and improve their email deliverability.

What is Base SaaS Flask?

The Flask application is built using my Base SaaS Flask template, which provides base features used by all my SaaS projects built with Flask. You can find the source code for this project on my GitHub. When I add a major SaaS feature that is not specific to Mail List Shield, I add it to the Base SaaS Flask template then pull it to this project.

You might see the manually written pages of this documentation refer to Base SaaS instead of Mail List Shield. This is because I copied those pages from my Base SaaS. The auto generated documentation however, is built from the docstrings of this project, so it refers to Mail List Shield code specifically.

– Cansin Acarer

Documentation:

• Features
  • 🧑‍💻 Developer Experience
  • ☁️ Deployment
  • 💳 Stripe Integrations
  • 🔒 Authentication
  • 📧 Transactional Emails with SMTP
  • 🚨 Security
  • 🎨 UI
    • 🔔 Notifications
    • 🌐 Bootstrap HTML templates
• Development
  • Code Quality, Conventional Commits, and Releases
  • Developing in Dev Containers
    • Local Endpoints Served by the Dev Containers
    • Debugging
    • Testing Stripe Webhooks
  • Database Model
    • Updating the Database Model
  • How to Build On Top of This App
    • Adding New Pages
    • Defining More Configuration Variables
    • Updating Dependencies
• Continuous Integration and Continuous Deployment
  • Pre-Commit Hooks
  • Run Tests
  • Semantic Release
  • Build & Deploy
  • Build & Deploy Sphinx Docs
• Deployment to Production
  • A Pitfall for Cloudflare Proxy
• Auto Generated Documentation
  • app
    • Submodules
      • app.config
      • app.decorators
      • app.emails
      • app.forms
      • app.models
      • app.utilities
      • app.views
      • app.views_api
      • app.views_auth
      • app.views_private
    • Attributes
    • Functions
    • Package Contents
      • mail
      • db
      • bc
      • lm
      • csrf
      • create_app()

Additional Resources:

• Contact the Developer