Cookbook¶

The basic use of Flask Red Mail was introduced in Tutorial. This section covers some typical use cases of the extension.

Verification Email¶

Pre-requisites:

pyjwt
Suggested:

First, we create a verification email template templates/email/verify.html:

<h1>Hi,</h1>
<p>
    in order to use our services, please click the link below:
    <br>
    <a href={{ url_for('verify_email', token=token, _external=True) }}>verify email</a>
</p>
<p>If you did not create an account, you may ignore this message.</p>

Next, we will create a route that will handle the user creation:

from flask import Flask, render_template, request
from flask_redmail import RedMail
import jwt

app = Flask(__name__)
email = RedMail(app)

...

@app.route("/create-user", methods=["GET", "POST"])
def create_user():
    if request.method == "GET":
        return render_template("create_user.html")
    elif request.method == "POST":
        form = request.form.to_dict()

        ... # Validate the form and the user doesn't exists

        email_address = form["email_address"]
        password = form["password"]
        token = jwt.encode(
            {
                "email_address": email_address,
                "password": password,
            }, current_app.config["SECRET_KEY"]
        )
        email.send(
            subject="Verify email",
            receivers=email_address,
            html_template="email/verify.html",
            body_params={
                "token": token
            }
        )
        return render_template("verify_email.html")

Note that you also need to create create_user.html and verify_email.html templates. It may also help to use Flask-WTF to create needed HTML forms.

Next, we will create a route to finalize the creation of the user when the user has verified the email:

@app.route("/verify-email/<token>")
def verify_email(token):
    data = jwt.decode(token, current_app.config["SECRET_KEY"])
    email_address = data["email_address"]
    password = data["password"]
    ... # Create the user

Note

You may also pass other information using the secure tokens. Alternatively, you may also create the user in the route create_user and create, for example, a column verified_email that is false until the user has visited verify_email route.

Send emails from Gmail or Outlook¶

If you wish to send emails from Gmail or Outlook, you may pass the appropriate host and port to the configuration:

from redmail import gmail, outlook

# Gmail
app.config["EMAIL_HOST"] = gmail.host
app.config["EMAIL_PORT"] = gmail.port

# Or outlook
app.config["EMAIL_HOST"] = outlook.host
app.config["EMAIL_PORT"] = outlook.port

Cookbook¶

Verification Email¶

Send emails from Gmail or Outlook¶

Contents

Navigation