The Project | About Us | Contribute | Donations | License
HOME My courses Completed
◄ Previous
◄

Using Flask-Mail for Email

Next ►
►

Introduction

Flask-Mail is an extension for Flask that makes it easy to send emails from your Flask application. This module will guide you through the process of setting up Flask-Mail, configuring it, and sending emails.

Key Concepts

  1. Flask-Mail: An extension that integrates email sending capabilities into your Flask application.
  2. SMTP Server: A server that handles the sending of emails.
  3. Email Configuration: Setting up the necessary configurations to connect to an SMTP server.
  4. Email Templates: Using Jinja2 templates to create dynamic email content.

Setting Up Flask-Mail

Step 1: Install Flask-Mail

First, you need to install Flask-Mail. You can do this using pip:

pip install Flask-Mail

Step 2: Configure Flask-Mail

Next, you need to configure Flask-Mail in your Flask application. Add the following configuration settings to your config.py or directly in your application setup:

# config.py
MAIL_SERVER = 'smtp.example.com'
MAIL_PORT = 587
MAIL_USE_TLS = True
MAIL_USE_SSL = False
MAIL_USERNAME = '[email protected]'
MAIL_PASSWORD = 'your-email-password'
MAIL_DEFAULT_SENDER = '[email protected]'

Step 3: Initialize Flask-Mail

Now, initialize Flask-Mail in your Flask application:

# app.py
from flask import Flask
from flask_mail import Mail

app = Flask(__name__)
app.config.from_pyfile('config.py')

mail = Mail(app)

Sending Emails

Basic Email Sending

To send a basic email, you can use the Message class from Flask-Mail and the send method:

# app.py
from flask_mail import Message

@app.route('/send-email')
def send_email():
    msg = Message('Hello from Flask-Mail',
                  recipients=['[email protected]'])
    msg.body = 'This is a test email sent from a Flask application!'
    mail.send(msg)
    return 'Email sent!'

Using Email Templates

You can use Jinja2 templates to create dynamic email content. First, create an email template in your templates directory:

<!-- templates/email.html -->
<!DOCTYPE html>
<html>
<head>
    <title>{{ subject }}</title>
</head>
<body>
    <p>{{ body }}</p>
</body>
</html>

Then, render the template and send the email:

# app.py
from flask import render_template

@app.route('/send-email')
def send_email():
    subject = 'Hello from Flask-Mail'
    recipients = ['[email protected]']
    body = 'This is a test email sent from a Flask application!'
    
    msg = Message(subject, recipients=recipients)
    msg.html = render_template('email.html', subject=subject, body=body)
    mail.send(msg)
    return 'Email sent!'

Practical Exercise

Exercise: Send a Welcome Email

Create a route that sends a welcome email to a new user when they register.

  1. Create a registration form:

    # forms.py
from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField
from wtforms.validators import DataRequired, Email

class RegistrationForm(FlaskForm):
    email = StringField('Email', validators=[DataRequired(), Email()])
    submit = SubmitField('Register')

  2. Create a registration route:

    # app.py
from flask import render_template, redirect, url_for, flash
from forms import RegistrationForm

@app.route('/register', methods=['GET', 'POST'])
def register():
    form = RegistrationForm()
    if form.validate_on_submit():
        email = form.email.data
        send_welcome_email(email)
        flash('Registration successful! A welcome email has been sent.', 'success')
        return redirect(url_for('index'))
    return render_template('register.html', form=form)

  3. Create the send_welcome_email function:

    # app.py
def send_welcome_email(email):
    subject = 'Welcome to Our Service'
    body = 'Thank you for registering with our service!'

    msg = Message(subject, recipients=[email])
    msg.html = render_template('email.html', subject=subject, body=body)
    mail.send(msg)

  4. Create the registration template:

    <!-- templates/register.html -->
<!DOCTYPE html>
<html>
<head>
    <title>Register</title>
</head>
<body>
    <h1>Register</h1>
    <form method="POST">
        {{ form.hidden_tag() }}
        {{ form.email.label }} {{ form.email() }}<br>
        {{ form.submit() }}
    </form>
</body>
</html>

Solution

The solution involves integrating the form, route, and email sending function as shown in the steps above. Ensure that the email template is correctly placed in the templates directory.

Common Mistakes and Tips

  • Incorrect SMTP Configuration: Ensure that your SMTP server settings are correct. Double-check the server address, port, and authentication details.
  • Email Blocking: Some email providers may block emails sent from untrusted sources. Use a reputable SMTP service.
  • Testing: Use a testing email account to avoid spamming real users during development.

Conclusion

In this section, you learned how to set up and use Flask-Mail to send emails from your Flask application. You configured the necessary settings, sent basic emails, and used templates to create dynamic email content. You also completed a practical exercise to reinforce these concepts. In the next module, you will explore using Flask-Admin for creating admin interfaces.

◄ Previous
◄
Next ►
►
The Project | About Us | Contribute | Donations | License
© Copyright 2024. All rights reserved