Mail List Shield
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
Mail List Shield
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
accepted_file (app.models.BatchJobs attribute)
,
[1]
account() (in module app.views_private)
add_credits() (app.models.Users method)
admin() (in module app.views_private)
api_bp (in module app.views_api)
api_keys (app.models.Users attribute)
,
[1]
api_keys() (in module app.views_private)
api_test() (in module app.views_api)
APIKeys (class in app.models)
app
module
app.config
module
app.decorators
module
app.emails
module
app.forms
module
app.models
module
app.utilities
module
app.utilities.error_handlers
module
app.utilities.helpers
module
app.utilities.object_storage
module
app.utilities.qr
module
app.utilities.recaptcha
module
app.utilities.stripe_event_handler
module
app.utilities.user_registration_actions
module
app.utilities.validation
module
app.views
module
app.views_api
module
app.views_auth
module
app.views_private
module
APP_NAME (app.config.Config attribute)
APP_ROOT_URL (app.config.Config attribute)
appTimezone (in module app.config)
appTimezoneStr (in module app.config)
asyncr() (in module app.decorators)
auth_bp (in module app.views_auth)
avatar() (app.models.Users method)
avatar_uploaded (app.models.Users attribute)
,
[1]
B
BASEDIR (app.config.Config attribute)
BatchJobs (class in app.models)
bc (in module app)
billing() (in module app.views_private)
C
cancel_at (app.models.Users attribute)
,
[1]
check_key() (app.models.APIKeys method)
code0 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code1 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code2 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code3 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code4 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
code5 (app.forms.EmailConfirmationForm attribute)
(app.forms.TwoFactorAuthenticationForm attribute)
Config (class in app.config)
copy_file() (in module app.utilities.object_storage)
create_app() (in module app)
create_bucket() (in module app.utilities.object_storage)
CreateAPIKeyForm (class in app.forms)
created_at (app.models.APIKeys attribute)
,
[1]
credits (app.models.Users attribute)
,
[1]
csrf (in module app)
CSRF_ENABLED (app.config.Config attribute)
D
db (in module app)
deduct_credits() (app.models.Users method)
delete_file() (in module app.utilities.object_storage)
delete_key() (app.models.APIKeys method)
download_file() (in module app.utilities.object_storage)
download_results() (in module app.views_private)
E
email (app.forms.LoginForm attribute)
,
[1]
(app.forms.RegisterForm attribute)
,
[1]
(app.forms.ResetPassword attribute)
,
[1]
(app.models.Users attribute)
,
[1]
email_column (app.models.BatchJobs attribute)
,
[1]
email_confirmation_by_code() (in module app.views_auth)
email_confirmation_code (app.models.Users attribute)
,
[1]
email_confirmed (app.models.Users attribute)
,
[1]
EmailConfirmationForm (class in app.forms)
error_page() (in module app.utilities.error_handlers)
expires_at (app.forms.CreateAPIKeyForm attribute)
,
[1]
(app.models.APIKeys attribute)
,
[1]
F
favicon() (in module app.views)
finished (app.models.BatchJobs attribute)
,
[1]
firstName (app.forms.ProfileDetailsForm attribute)
,
[1]
(app.forms.RegisterForm attribute)
,
[1]
(app.models.Users attribute)
,
[1]
FLASK_DEBUG (app.config.Config attribute)
FLASK_RUN_CERT (app.config.Config attribute)
folder_quota() (app.models.Users method)
folder_size() (app.models.Users method)
(in module app.utilities.object_storage)
folder_usage_percentage() (app.models.Users method)
forbidden_error() (in module app.views)
G
generate_api_key_and_hash() (in module app.utilities.helpers)
generate_download_link() (in module app.utilities.object_storage)
generate_job_uid() (app.models.BatchJobs method)
generate_n_digit_code() (in module app.utilities.helpers)
generate_remote_file() (in module app.utilities.object_storage)
generate_results_download_link() (app.models.BatchJobs method)
generate_upload_link() (in module app.utilities.object_storage)
generate_upload_link_profile_picture() (in module app.utilities.object_storage)
generate_upload_link_validation_file() (in module app.utilities.object_storage)
generate_user_folder() (in module app.utilities.object_storage)
get_credit_balance() (in module app.views_api)
get_google_sso_config() (in module app.views_auth)
get_user_from_api_key() (in module app.views_api)
google_avatar_url (app.models.Users attribute)
,
[1]
GOOGLE_CLIENT_ID (app.config.Config attribute)
GOOGLE_CLIENT_SECRET (app.config.Config attribute)
H
handle_stripe_event() (in module app.utilities.stripe_event_handler)
header_row (app.models.BatchJobs attribute)
,
[1]
I
id (app.models.APIKeys attribute)
,
[1]
(app.models.BatchJobs attribute)
,
[1]
(app.models.Tiers attribute)
,
[1]
(app.models.Users attribute)
,
[1]
index() (in module app.views)
insufficient_credit_response() (in module app.views_api)
invalid_api_key_response() (in module app.views_api)
is_active (app.models.APIKeys attribute)
,
[1]
is_checkout_completed_event() (in module app.utilities.stripe_event_handler)
is_connected_google() (app.models.Users method)
is_subscription_event() (in module app.utilities.stripe_event_handler)
is_user_logged_in() (in module app.views)
K
key_hash (app.models.APIKeys attribute)
,
[1]
L
label (app.forms.CreateAPIKeyForm attribute)
,
[1]
(app.models.APIKeys attribute)
,
[1]
(app.models.Tiers attribute)
,
[1]
last_confirmation_codes_sent (app.models.Users attribute)
,
[1]
last_login (app.models.Users attribute)
,
[1]
last_pick_row (app.models.BatchJobs attribute)
,
[1]
last_pick_time (app.models.BatchJobs attribute)
,
[1]
last_used (app.models.APIKeys attribute)
,
[1]
lastName (app.forms.ProfileDetailsForm attribute)
,
[1]
(app.forms.RegisterForm attribute)
,
[1]
(app.models.Users attribute)
,
[1]
limiter (in module app.views)
list_objects() (in module app.utilities.object_storage)
lm (in module app)
load_user() (in module app.views)
(in module app.views_auth)
login() (in module app.views_auth)
login_callback_google() (in module app.views_auth)
LoginForm (class in app.forms)
logout() (in module app.views_auth)
M
mail (in module app)
MAIL_DEBUG (app.config.Config attribute)
MAIL_FROM (app.config.Config attribute)
MAIL_PASSWORD (app.config.Config attribute)
MAIL_PORT (app.config.Config attribute)
MAIL_SERVER (app.config.Config attribute)
MAIL_USE_SSL (app.config.Config attribute)
MAIL_USE_TLS (app.config.Config attribute)
MAIL_USERNAME (app.config.Config attribute)
member_since (app.models.Users attribute)
,
[1]
method_not_allowed_error() (in module app.views)
missing_key_in_json_response() (in module app.views_api)
MLS_FREE_CREDITS_FOR_NEW_ACCOUNTS (app.config.Config attribute)
MLS_WORKER_API_KEY (app.config.Config attribute)
MLS_WORKERS (app.config.Config attribute)
module
app
app.config
app.decorators
app.emails
app.forms
app.models
app.utilities
app.utilities.error_handlers
app.utilities.helpers
app.utilities.object_storage
app.utilities.qr
app.utilities.recaptcha
app.utilities.stripe_event_handler
app.utilities.user_registration_actions
app.utilities.validation
app.views
app.views_api
app.views_auth
app.views_private
N
name (app.models.Tiers attribute)
,
[1]
new_user_actions_for_email_confirmed() (in module app.utilities.user_registration_actions)
newsletter (app.forms.ProfileDetailsForm attribute)
,
[1]
(app.forms.RegisterForm attribute)
,
[1]
(app.models.Users attribute)
,
[1]
NEXT_WORKER (app.config.Config attribute)
no_api_key_response() (in module app.views_api)
no_json_body_response() (in module app.views_api)
not_found_error() (in module app.views)
number_of_email_confirmation_codes_sent (app.models.Users attribute)
,
[1]
O
original_file_name (app.models.BatchJobs attribute)
,
[1]
P
password (app.forms.LoginForm attribute)
,
[1]
(app.forms.RegisterForm attribute)
,
[1]
(app.forms.SetNewPassword attribute)
,
[1]
(app.models.Users attribute)
,
[1]
password_reset() (in module app.views_auth)
password_reset_requested() (in module app.views_auth)
prevent_public_access() (in module app.utilities.object_storage)
private_bp (in module app.views_private)
private_index() (in module app.views_private)
ProfileDetailsForm (class in app.forms)
public_bp (in module app.views)
Q
qrcode_img_src() (in module app.utilities.qr)
R
rate_limited() (in module app.views)
readable_file_size() (in module app.utilities.helpers)
RECAPTCHA_SECRET_KEY (app.config.Config attribute)
RECAPTCHA_SITE_KEY (app.config.Config attribute)
register() (in module app.views_auth)
RegisterForm (class in app.forms)
request_validation() (in module app.utilities.validation)
ResetPassword (class in app.forms)
result (app.models.BatchJobs attribute)
,
[1]
results_file (app.models.BatchJobs attribute)
,
[1]
robots() (in module app.views)
role (app.models.Users attribute)
,
[1]
row_count (app.models.BatchJobs attribute)
,
[1]
S
s3 (in module app.config)
S3_BUCKET_NAME (app.config.Config attribute)
S3_ENDPOINT (app.config.Config attribute)
S3_KEY (app.config.Config attribute)
S3_SECRET (app.config.Config attribute)
save() (app.models.APIKeys method)
(app.models.Users method)
SECRET_KEY (app.config.Config attribute)
send_async_email() (in module app.emails)
send_email_about_subscription_cancellation() (in module app.emails)
send_email_about_subscription_confirmation() (in module app.emails)
send_email_about_subscription_deletion() (in module app.emails)
send_email_to_reset_password() (in module app.emails)
send_email_with_code() (in module app.emails)
server_error() (in module app.views)
set_new_password() (in module app.views_auth)
SetNewPassword (class in app.forms)
source (app.models.BatchJobs attribute)
,
[1]
SQLALCHEMY_DATABASE_URI (app.config.Config attribute)
SQLALCHEMY_ENGINE_OPTIONS (app.config.Config attribute)
SQLALCHEMY_TRACK_MODIFICATIONS (app.config.Config attribute)
started (app.models.BatchJobs attribute)
,
[1]
status (app.models.BatchJobs attribute)
,
[1]
STRIPE_CREDIT_UNIT_COST (app.config.Config attribute)
stripe_customer_id (app.models.Users attribute)
,
[1]
stripe_price_id (app.models.Tiers attribute)
,
[1]
STRIPE_PRODUCT_ID_FOR_CREDITS (app.config.Config attribute)
STRIPE_PUBLISHABLE_KEY (app.config.Config attribute)
STRIPE_SECRET_KEY (app.config.Config attribute)
STRIPE_WEBHOOK_SECRET (app.config.Config attribute)
submit (app.forms.CreateAPIKeyForm attribute)
,
[1]
successful_validation_response() (in module app.views_api)
T
tier (app.models.Users attribute)
,
[1]
tier_from_stripe_price_id() (in module app.utilities.stripe_event_handler)
tier_id (app.models.Users attribute)
,
[1]
Tiers (class in app.models)
timestamp() (in module app.utilities.object_storage)
TIMEZONE (app.config.Config attribute)
totp() (app.models.Users method)
totp_enabled (app.models.Users attribute)
,
[1]
totp_match() (app.models.Users method)
totp_reset_secret() (app.models.Users method)
totp_secret (app.models.Users attribute)
,
[1]
two_factor() (in module app.views_auth)
TwoFactorAuthenticationForm (class in app.forms)
U
uid (app.models.BatchJobs attribute)
,
[1]
unauthorized_callback() (in module app.views_auth)
update_last_used() (app.models.APIKeys method)
upload_file() (in module app.utilities.object_storage)
uploaded (app.models.BatchJobs attribute)
,
[1]
uploaded_file (app.models.BatchJobs attribute)
,
[1]
user (app.models.BatchJobs attribute)
,
[1]
user_folder_size() (in module app.utilities.object_storage)
user_from_stripe_customer_id() (in module app.utilities.stripe_event_handler)
user_id (app.models.APIKeys attribute)
,
[1]
(app.models.BatchJobs attribute)
,
[1]
users (app.models.Tiers attribute)
,
[1]
Users (class in app.models)
V
validate() (in module app.views)
validate_email() (in module app.utilities.validation)
validate_file() (in module app.views)
validate_request_json() (in module app.views_api)
validate_single() (in module app.views_api)
verify_recaptcha() (in module app.utilities.recaptcha)
W
webhook() (in module app.views_private)