The Flask Mega-Tutorial Part X: Email Support

This is the tenth installment of the Flask Mega-Tutorial series, in which I'm going to tell you how your application can send emails to your users, and how to build a password recovery feature on top of the email support.

For your reference, below is a list of the articles in this series.

Note 1: If you are looking for the legacy version of this tutorial, it's here.

Note 2: If you would like to support my work on this blog, or just don't have patience to wait for weekly articles, I am offering the complete version of this tutorial packaged as an ebook or a set of videos. For more information, visit courses.miguelgrinberg.com.

The application is doing pretty well on the database front now, so in this chapter I want to depart from that topic and add another important piece that most web applications need, which is the sending of emails.

Why does an application need to email its users? There are many reasons, but one common one is to solve authentication related problems. In this chapter I'm going to add a password reset feature for users that forget their password. When a user requests a password reset, the application will send an email with a specially crafted link. The user then needs to click that link to have access to a form in which to set a new password.

The GitHub links for this chapter are: Browse, Zip, Diff.

Introduction to Flask-Mail

As far as the actual sending of emails, Flask has a popular extension called Flask-Mail that can make the task very easy. As always, this extension is installed with pip:

(venv) $ pip install flask-mail

The password reset links will have a secure token in them. To generate these tokens, I'm going to use JSON Web Tokens, which also have a popular Python package:

(venv) $ pip install pyjwt

The Flask-Mail extension is configured from the app.config object. Remember when in Chapter 7 I added the email configuration for sending yourself an email whenever an error occurred in production? I did not tell you this then, but my choice of configuration variables was modeled after Flask-Mail's requirements, so there isn't really any additional work that is needed, the configuration variables are already in the application.

Like most Flask extensions, you need to create an instance right after the Flask application is created. In this case this is an object of class Mail:

app/__init__.py: Flask-Mail instance.

# ...
from flask_mail import Mail

app = Flask(__name__)
# ...
mail = Mail(app)

If you are planning to test sending of emails you have the same two options I mentioned in Chapter 7. If you want to use an emulated email server, Python provides one that is very handy that you can start in a second terminal with the following command:

(venv) $ python -m smtpd -n -c DebuggingServer localhost:8025

To configure for this server you will need to set two environment variables:

(venv) $ export MAIL_SERVER=localhost
(venv) $ export MAIL_PORT=8025

If you prefer to have emails sent for real, you need to use a real email server. If you have one, then you just need to set the MAIL_SERVER, MAIL_PORT, MAIL_USE_TLS, MAIL_USERNAME and MAIL_PASSWORD environment variables for it. If you want a quick solution, you can use a Gmail account to send email, with the following settings:

(venv) $ export MAIL_SERVER=smtp.googlemail.com
(venv) $ export MAIL_PORT=587
(venv) $ export MAIL_USE_TLS=1
(venv) $ export MAIL_USERNAME=<your-gmail-username>
(venv) $ export MAIL_PASSWORD=<your-gmail-password>

If you are using Microsoft Windows, you need to replace export with set in each of the export statements above.

Remember that the security features in your Gmail account may prevent the application from sending emails through it unless you explicitly allow "less secure apps" access to your Gmail account. You can read about this here, and if you are concerned about the security of your account, you can create a secondary account that you configure just for testing emails, or you can enable less secure apps only temporarily to run your tests and then revert back to the more secure default.

Flask-Mail Usage

To learn how Flask-Mail works, I'll show you how to send an email from a Python shell. So fire up Python with flask shell, and then run the following commands:

>>> from flask_mail import Message
>>> from app import mail
>>> msg = Message('test subject', sender=app.config['ADMINS'][0],
... recipients=['your-email@example.com'])
>>> msg.body = 'text body'
>>> msg.html = '<h1>HTML body</h1>'
>>> mail.send(msg)

The snippet of code above will send an email to a list of email addresses that you put in the recipients argument. I put the sender as the first configured admin (I've added the ADMINS configuration variable in Chapter 7). The email will have plain text and HTML versions, so depending on how your email client is configured you may see one or the other.

So as you see, this is pretty simple. Now let's integrate emails into the application.

A Simple Email Framework

I will begin by writing a helper function that sends an email, which is basically a generic version of the shell exercise from the previous section. I will put this function in a new module called app/email.py:

app/email.py: Email sending wrapper function.

from flask_mail import Message
from app import mail

def send_email(subject, sender, recipients, text_body, html_body):
    msg = Message(subject, sender=sender, recipients=recipients)
    msg.body = text_body
    msg.html = html_body

Flask-Mail supports some features that I'm not utilizing here such as Cc and Bcc lists. Be sure to check the Flask-Mail Documentation if you are interested in those options.

Requesting a Password Reset

As I mentioned above, I want users to have the option to request their password to be reset. For this purpose I'm going to add a link in the login page:

app/templates/login.html: Password reset link in login form.

        Forgot Your Password?
        <a href="{{ url_for('reset_password_request') }}">Click to Reset It</a>

When the user clicks the link, a new web form will appear that requests the user's email address as a way to initiate the password reset process. Here is the form class:

app/forms.py: Reset password request form.

class ResetPasswordRequestForm(FlaskForm):
    email = StringField('Email', validators=[DataRequired(), Email()])
    submit = SubmitField('Request Password Reset')

And here is the corresponding HTML template:

app/templates/reset_password_request.html: Reset password request template.

{% extends "base.html" %}

{% block content %}
    <h1>Reset Password</h1>
    <form action="" method="post">
        {{ form.hidden_tag() }}
            {{ form.email.label }}<br>
            {{ form.email(size=64) }}<br>
            {% for error in form.email.errors %}
            <span style="color: red;">[{{ error }}]</span>
            {% endfor %}
        <p>{{ form.submit() }}</p>
{% endblock %}

I also need a view function to handle this form:

app/routes.py: Reset password request view function.

from app.forms import ResetPasswordRequestForm
from app.email import send_password_reset_email

@app.route('/reset_password_request', methods=['GET', 'POST'])
def reset_password_request():
    if current_user.is_authenticated:
        return redirect(url_for('index'))
    form = ResetPasswordRequestForm()
    if form.validate_on_submit():
        user = User.query.filter_by(email=form.email.data).first()
        if user:
        flash('Check your email for the instructions to reset your password')
        return redirect(url_for('login'))
    return render_template('reset_password_request.html',
                           title='Reset Password', form=form)

This view function is fairly similar to others that process a form. I start by making sure the user is not logged in. If the user is logged in, then there is no point in using the password reset functionality, so I redirect to the index page.

When the form is submitted and valid, I look up the user by the email provided by the user in the form. If I find the user, I send a password reset email. I'm using a send_password_reset_email() helper function to do this. I will show you this function below.

After the email is sent, I flash a message directing the user to look for the email for further instructions, and then redirect back to the login page. You may notice that the flashed message is displayed even if the email provided by the user is unknown. This is so that clients cannot use this form to figure out if a given user is a member or not.

Password Reset Tokens

Before I implement the send_password_reset_email() function, I need to have a way to generate a password request link. This is going to be the link that is sent to the user via email. When the link is clicked, a page where a new password can be set is presented to the user. The tricky part of this plan is to make sure that only valid reset links can be used to reset an account's password.

The links are going to be provisioned with a token, and this token will be validated before allowing the password change, as proof that the user that requested the email has access to the email address on the account. A very popular token standard for this type of process is the JSON Web Token, or JWT. The nice thing about JWTs is that they are self contained. You can send a token to a user in an email, and when the user clicks the link that feeds the token back into the application, it can be verified on its own.

How do JWTs work? Nothing better than a quick Python shell session to understand them:

>>> import jwt
>>> token = jwt.encode({'a': 'b'}, 'my-secret', algorithm='HS256')
>>> token
>>> jwt.decode(token, 'my-secret', algorithms=['HS256'])
{'a': 'b'}

The {'a': 'b'} dictionary is an example payload that is going to be written into the token. To make the token secure, a secret key needs to be provided to be used in creating a cryptographic signature. For this example I have used the string 'my-secret', but with the application I'm going to use the SECRET_KEY from the configuration. The algorithm argument specifies how the token is to be generated. The HS256 algorithm is the most widely used.

As you can see the resulting token is a long sequence of characters. But do not think that this is an encrypted token. The contents of the token, including the payload, can be decoded easily by anyone (don't believe me? Copy the above token and then enter it in the JWT debugger to see its contents). What makes the token secure is that the payload is signed. If somebody tried to forge or tamper with the payload in a token, then the signature would be invalidated, and to generate a new signature the secret key is needed. When a token is verified, the contents of the payload are decoded and returned back to the caller. If the token's signature was validated, then the payload can be trusted as authentic.

The payload that I'm going to use for the password reset tokens is going to have the format {'reset_password': user_id, 'exp': token_expiration}. The exp field is standard for JWTs and if present it indicates an expiration time for the token. If a token has a valid signature, but it is past its expiration timestamp, then it will also be considered invalid. For the password reset feature, I'm going to give these tokens 10 minutes of life.

When the user clicks on the emailed link, the token is going to be sent back to the application as part of the URL, and the first thing the view function that handles this URL will do is to verify it. If the signature is valid, then the user can be identified by the ID stored in the payload. Once the user's identity is known, the application can ask for a new password and set it on the user's account.

Since these tokens belong to users, I'm going to write the token generation and verification functions as methods in the User model:

app/models.py: Reset password token methods.

from time import time
import jwt
from app import app

class User(UserMixin, db.Model):
    # ...

    def get_reset_password_token(self, expires_in=600):
        return jwt.encode(
            {'reset_password': self.id, 'exp': time() + expires_in},
            app.config['SECRET_KEY'], algorithm='HS256')

    def verify_reset_password_token(token):
            id = jwt.decode(token, app.config['SECRET_KEY'],
        return User.query.get(id)

The get_reset_password_token() function returns a JWT token as a string, which is generated directly by the jwt.encode() function.

The verify_reset_password_token() is a static method, which means that it can be invoked directly from the class. A static method is similar to a class method, with the only difference that static methods do not receive the class as a first argument. This method takes a token and attempts to decode it by invoking PyJWT's jwt.decode() function. If the token cannot be validated or is expired, an exception will be raised, and in that case I catch it to prevent the error, and then return None to the caller. If the token is valid, then the value of the reset_password key from the token's payload is the ID of the user, so I can load the user and return it.

Sending a Password Reset Email

Now that I have the tokens, I can generate the password reset emails. The send_password_reset_email() function relies on the send_email() function I wrote above.

app/email.py: Send password reset email function.

from flask import render_template
from app import app

# ...

def send_password_reset_email(user):
    token = user.get_reset_password_token()
    send_email('[Microblog] Reset Your Password',
                                         user=user, token=token),
                                         user=user, token=token))

The interesting part in this function is that the text and HTML content for the emails is generated from templates using the familiar render_template() function. The templates receive the user and the token as arguments, so that a personalized email message can be generated. Here is the text template for the reset password email:

app/templates/email/reset_password.txt: Text for password reset email.

Dear {{ user.username }},

To reset your password click on the following link:

{{ url_for('reset_password', token=token, _external=True) }}

If you have not requested a password reset simply ignore this message.


The Microblog Team

And here is the nicer HTML version of the same email:

app/templates/email/reset_password.html: HTML for password reset email.

<p>Dear {{ user.username }},</p>
    To reset your password
    <a href="{{ url_for('reset_password', token=token, _external=True) }}">
        click here
<p>Alternatively, you can paste the following link in your browser's address bar:</p>
<p>{{ url_for('reset_password', token=token, _external=True) }}</p>
<p>If you have not requested a password reset simply ignore this message.</p>
<p>The Microblog Team</p>

The reset_password route that is referenced in the url_for() call in these two email templates does not exist yet, this will be added in the next section. The _external=True argument that I included in the url_for() calls in both templates is also new. The URLs that are generated by url_for() by default are relative URLs, so for example, the url_for('user', username='susan') call would return /user/susan. This is normally sufficient for links that are generated in web pages, because the web browser takes the remaining parts of the URL from the current page. When sending a URL by email however, that context does not exist, so fully qualified URLs need to be used. When _external=True is passed as an argument, complete URLs are generated, so the previous example would return http://localhost:5000/user/susan, or the appropriate URL when the application is deployed on a domain name.

Resetting a User Password

When the user clicks on the email link, a second route associated with this feature is triggered. Here is the password request view function:

app/routes.py: Password reset view function.

from app.forms import ResetPasswordForm

@app.route('/reset_password/<token>', methods=['GET', 'POST'])
def reset_password(token):
    if current_user.is_authenticated:
        return redirect(url_for('index'))
    user = User.verify_reset_password_token(token)
    if not user:
        return redirect(url_for('index'))
    form = ResetPasswordForm()
    if form.validate_on_submit():
        flash('Your password has been reset.')
        return redirect(url_for('login'))
    return render_template('reset_password.html', form=form)

In this view function I first make sure the user is not logged in, and then I determine who the user is by invoking the token verification method in the User class. This method returns the user if the token is valid, or None if not. If the token is invalid I redirect to the home page.

If the token is valid, then I present the user with a second form, in which the new password is requested. This form is processed in a way similar to previous forms, and as a result of a valid form submission, I invoke the set_password() method of User to change the password, and then redirect to the login page, where the user can now login.

Here is the ResetPasswordForm class:

app/forms.py: Password reset form.

class ResetPasswordForm(FlaskForm):
    password = PasswordField('Password', validators=[DataRequired()])
    password2 = PasswordField(
        'Repeat Password', validators=[DataRequired(), EqualTo('password')])
    submit = SubmitField('Request Password Reset')

And here is the corresponding HTML template:

app/templates/reset_password.html: Password reset form template.

{% extends "base.html" %}

{% block content %}
    <h1>Reset Your Password</h1>
    <form action="" method="post">
        {{ form.hidden_tag() }}
            {{ form.password.label }}<br>
            {{ form.password(size=32) }}<br>
            {% for error in form.password.errors %}
            <span style="color: red;">[{{ error }}]</span>
            {% endfor %}
            {{ form.password2.label }}<br>
            {{ form.password2(size=32) }}<br>
            {% for error in form.password2.errors %}
            <span style="color: red;">[{{ error }}]</span>
            {% endfor %}
        <p>{{ form.submit() }}</p>
{% endblock %}

The password reset feature is now complete, so make sure you try it.

Asynchronous Emails

If you are using the simulated email server that Python provides you may not have noticed this, but sending an email slows the application down considerably. All the interactions that need to happen when sending an email make the task slow, it usually takes a few seconds to get an email out, and maybe more if the email server of the addressee is slow, or if there are multiple addressees.

What I really want is for the send_email() function to be asynchronous. What does that mean? It means that when this function is called, the task of sending the email is scheduled to happen in the background, freeing the send_email() to return immediately so that the application can continue running concurrently with the email being sent.

Python has support for running asynchronous tasks, actually in more than one way. The threading and multiprocessing modules can both do this. Starting a background thread for email being sent is much less resource intensive than starting a brand new process, so I'm going to go with that approach:

app/email.py: Send emails asynchronously.

from threading import Thread
# ...

def send_async_email(app, msg):
    with app.app_context():

def send_email(subject, sender, recipients, text_body, html_body):
    msg = Message(subject, sender=sender, recipients=recipients)
    msg.body = text_body
    msg.html = html_body
    Thread(target=send_async_email, args=(app, msg)).start()

The send_async_email function now runs in a background thread, invoked via the Thread() class in the last line of send_email(). With this change, the sending of the email will run in the thread, and when the process completes the thread will end and clean itself up. If you have configured a real email server, you will definitely notice a speed improvement when you press the submit button on the password reset request form.

You probably expected that only the msg argument would be sent to the thread, but as you can see in the code, I'm also sending the application instance. When working with threads there is an important design aspect of Flask that needs to be kept in mind. Flask uses contexts to avoid having to pass arguments across functions. I'm not going to go into a lot of detail on this, but know that there are two types of contexts, the application context and the request context. In most cases, these contexts are automatically managed by the framework, but when the application starts custom threads, contexts for those threads may need to be manually created.

There are many extensions that require an application context to be in place to work, because that allows them to find the Flask application instance without it being passed as an argument. The reason many extensions need to know the application instance is because they have their configuration stored in the app.config object. This is exactly the situation with Flask-Mail. The mail.send() method needs to access the configuration values for the email server, and that can only be done by knowing what the application is. The application context that is created with the with app.app_context() call makes the application instance accessible via the current_app variable from Flask.


  • #76 Krishan Kumar said 2018-09-23T08:30:09Z

    Dear Sir

    I have been facing problems in sending mail through flask application. I faced the same problem in Chapter 7 also. I have allowed the 'less secure app' feature in my gmail account. I have set the environment variables: set MAIL_SERVER=smtp.googlemail.com set MAIL_PORT=587 set MAIL_USE_TLS=1 set MAIL_USERNAME=ice.effort set MAIL_PASSWORD=**

    I have also used this one: set MAIL_USERNAME=ice.effort@gmail.com

    My code is same as your code.

    Every time, I get this error:

    File "", line 1, in File "c:\users\krishan_kumar2\desktop\flask mega\megap\2\microblog\venv\lib\site-packages\flask_mail.py", line 491, in send with self.connect() as connection: File "c:\users\krishan_kumar2\desktop\flask mega\megap\2\microblog\venv\lib\site-packages\flask_mail.py", line 144, in enter self.host = self.configure_host() File "c:\users\krishan_kumar2\desktop\flask mega\megap\2\microblog\venv\lib\site-packages\flask_mail.py", line 158, in configure_host host = smtplib.SMTP(self.mail.server, self.mail.port) File "C:\Users\krishan_kumar2\AppData\Local\Programs\Python\Python37-32\lib\smtplib.py", line 251, in init (code, msg) = self.connect(host, port) File "C:\Users\krishan_kumar2\AppData\Local\Programs\Python\Python37-32\lib\smtplib.py", line 336, in connect self.sock = self._get_socket(host, port, self.timeout) File "C:\Users\krishan_kumar2\AppData\Local\Programs\Python\Python37-32\lib\smtplib.py", line 307, in _get_socket self.source_address) File "C:\Users\krishan_kumar2\AppData\Local\Programs\Python\Python37-32\lib\socket.py", line 727, in create_connection raise err File "C:\Users\krishan_kumar2\AppData\Local\Programs\Python\Python37-32\lib\socket.py", line 716, in create_connection sock.connect(sa) OSError: [WinError 10013] An attempt was made to access a socket in a way forbidden by its access permissions

    Please help me with the solution.

  • #77 Miguel Grinberg said 2018-09-25T18:02:39Z

    @Krishan: Do you have an antivirus installed? Try disabling it.

  • #78 john salzmann said 2018-09-27T05:19:21Z

    Mr. Grinberg,

    In my eighteen month self-guided journey to learn programming in it's abstract, I have come across multitudes of error-ridden, incomplete, shallow and extraneous tutorials related to web applications. I have seen dead-ends, deprecated syntax, disheveled expressions, and dismal stack traces. Too often have I felt the need to distrust the exposition because careful comparison and execution would not emit the expected result.

    ...Quite frankly, this is in relation to the JavaScript front-end community, which in fairness - is an endless wealth of knowledge and communication, but is drowned by relentless revisions and tumultuous reverberations, cast as layers of sand in a morphing geography.

    I'm not sure if you maintain this frequently, or have chosen the most carefully and substantive pathway possible, yet I feel as though this is the first guide that has me appropriately question myself when errors arise. I feel confidence, when long I had felt doubt, that mistakes are lain by my hands, and that cared attention will carry me to the expectations of your prose.

    Seriously though, thank you for this piece of art. I've enjoyed every entry so far, and I'm blown away by what can be done with Python on the back-end.


  • #79 Oleg Kovalenko said 2018-10-02T08:15:42Z

    Sorry, I had accidentally first posted this comment on your legacy version of this post. Here is that message again.

    I've set up my Microblog's web host as a send only mail server to send authenticated (spf / dkim / dmarc) emails through Postfix + Mailx. Do you have any advice for replicating that configuration in Flask-Mail? I haven't found any useful documentation on the use of Flask-Mail on a mail server, let alone for integrating it with an MTA (in the source, it appears to use Python's smtplib directly, so is it essentially its own MTA?). I am starting to think that it is wiser to call mailx through Python and send mail that way. What do you think is best? I suppose the idea you had in mind with this section is that there would be a web host and a web server on different machines, and the web host would relay to the mail server using Flask-Mail.

    Thanks for taking the time to read and reply to us all (:

  • #80 James said 2018-10-02T18:37:48Z

    Miguel, thanks so much for this outstanding tutorial. As many other comments have noted, you've done a tremendous job introducing readers to the impressive capabilities of Flask. I often skip tutorials, but I'm doing this one line by line because everything you've included adds to my understanding.

    I notice that you specify the MAIL_SERVER as 'smtp.googlemail.com'. I use a hosted Google Apps email address, not a Gmail.com address, so I set my mail server to 'smtp.gmail.com' instead. Just leaving a note here in case anyone else runs into this issue—'smtp.googlemail.com' won't work for a Google Apps email account.


  • #81 Miguel Grinberg said 2018-10-02T22:06:31Z

    @Oleg: Your mail server is a regular SMTP server. The configuration in Flask-Mail depends on how you configured this email server. The MAIL_SERVER variable is going to be localhost if you have the email server in the same machine as the application. The SERVER_PORT depends on your set up, could be 25, 465 or 587. You have to use the one that you configured. The SSL and credentials also needs to be configured to match your server.

  • #82 Oleg Kovalenko said 2018-10-05T01:49:54Z

    @Miguel: I have set up Flask-Mail to send mail from the web host by setting the server and port. I assumed that if Postfix is running on the port I tell Flask-Mail to use, then Flask-Mail will send mail using my Postfix configuration. This is not the case, and it looks like I'd have to configure Flask-Mail itself to get my outgoing mail authenticated. There is no documentation on using Flask-Mail like that, and no packages with that use case. It looks like the only robust solution is to send mail using the environment instead of Flask-Mail if the web host is running the mail server. How did you do it?

  • #83 Miguel Grinberg said 2018-10-06T09:31:43Z

    @Oleg: Not sure what you mean with regards to missing documentation. As I said above, Postfix is an SMTP server. Once you know how to connect to the server, all you need to do is set the Flask-Mail configuration variables appropriately. It looks like your Postfix server requires authentication, so you have to set those credentials, there is no way around that. If you want something simpler, install your own Postfix server and configure it to accept email without authentication. This is not a secure solution, but if you want to do it for testing it should be fine.

  • #84 Oleg Kovalenko said 2018-10-06T23:10:21Z

    @Miguel: Thanks for clearing up that Flask-Mail does use an external SMTP server instead of implementing an SMTP server on the app level. I was sorely confused about that.

    I have Postfix running on port 25 and Flask-Mail sends mail through that successfully; however, the reason I thought Postfix is being bypassed, is because none of my Postfix configuration seems to be in effect when I send mail using Flask-Mail. This is extremely confusing. Specifically, none of Postfix's address rewriting is triggered, and opendkim doesn't sign the outgoing mail. As a result, the outgoing mail fails all authentication.

    Because of this, what I'm doing right now is executing a shell command to send mail. This seems safe because the user doesn't supply any of the input to the command. The fields are filled directly from the database, which is responsible for making sure the fields are secure before committing them.

    This seems better than implementing address rewriting and dkim signing on the application level. However, if I could get Flask-Mail to send mail without ignoring my Postfix configuration and opendkim, then that would be a preferable solution.

    I haven't found any documentation on getting Flask-Mail to play nice with address rewriting and authentication. If you know of any resources on that topic, I would really appreciate a link.

    Thank you for engaging with me in this discussion.

  • #85 Miguel Grinberg said 2018-10-06T23:15:57Z

    @Oleg: Flask-Mail has nothing to do with address rewriting or any other features of your MTA. I'm not sure I can help you with this, my opinion is that your problem is a faulty Postfix configuration.

  • #86 Oleg Kovalenko said 2018-10-07T03:29:55Z

    @Miguel: Well, Postfix works perfectly when I send mail using the mailx command. Certainly something is wrong with how I was trying to use Flask-Mail. If my Postfix configuration were faulty, then surely I would have the same problems with mailx that I have with Flask-Mail.

    Thank you for talking me through my issue because I ended up learning about the distinction between MSAs and MTAs and other key concepts. I will continue to use an os.system call to mailx to send my emails successfully.

    In general I have never heard of, or managed to find any examples of, anybody using Flask-Mail as the MSA on a mail server. If anyone else goes through the DigitalOcean links in this tutorial and sets up Postfix with opendkim only to find that nothing they send through Flask-Mail is authenticated, then try:

    def send_async_email(subject, recipients, body, html): os.system("echo '{}' | mailx -s '{}' {}".format(body, subject, ",".join(recipients)))

    as a replacement for Flask-Mail.

  • #87 Miguel Grinberg said 2018-10-07T07:41:43Z

    @Oleg: I have used Postfix with Flask-Mail for years, so 100% sure it works. This blog uses it.

  • #88 Danny G said 2018-10-15T02:23:44Z

    Hi Miguel, thanks so much for this tutorial!

    I don't know if I missed something, but when trying to send an email using python's debugging server and some previous configurations, the mail.send(msg) call would fail because under the hood, smtplib is expecting credentials for the server (which doesn't use any) and it's expecting credentials because in config.py, we set them to the environment variables (if set) or a made up string if not as follows:

    MAIL_USERNAME = os.environ.get('MAIL_USERNAME') or 'danny' MAIL_PASSWORD = os.environ.get('MAIL_PASSWORD') or 'password'

    For me, the solution was changing the strings to None so that smtplib would no longer require authentication with the server. (I don't have the environment variable set)

    Again, I'm not sure if I messed something up while following your tutorial, but just in case this was an omission, I thought you would like to know.

  • #89 Miguel Grinberg said 2018-10-15T21:12:00Z

    @Danny: the problem is that with the "or" values that you added in the username and password settings it is impossible to have those set to None. What did you add those defaults? For credentials it is best to not have defaults. If the environment variables aren't defined you want those configuration variables to be set to None.

  • #90 AR said 2018-10-23T03:45:45Z

    Hi Miguel,

    If i send email using address -- noreply@domain.com, then in the user's gmail inbox the email is shown as coming from 'noreply' [in the gamil inbox, first column displays 'noreply' , second column displays the subject of email]. What I would rather want is to display the brand name 'Domain' instead of noreply. How can i do this?

  • #91 Miguel Grinberg said 2018-10-23T17:56:34Z

    @AR: not much you can do from your side to control how an email application displays incoming emails. The "from" field in an email needs to be an email address, so the best you can do is use something other than "noreply" as the email username.

  • #92 zhoujj said 2018-10-24T08:13:53Z

    Hi Miguel. Thanks for the wonderful flask tutorial. I test email functionality as you described in my MACS. I run STMP server as "python -m smtpd -n -c DebuggingServer localhost:8025 ". I came to up an error "SMTPException: STARTTLS extension not supported by server."

    Do you have any idea for this error?

    Thanks a lot.

    Best regards, zhoujj

    More message: Exception in thread Thread-3: Traceback (most recent call last): File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/threading.py", line 810, in bootstrap_inner self.run() File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/threading.py", line 763, in run self.target(*self.args, **self.kwargs) File "/Users/zhoujj/project/microblog/app/email.py", line 10, in send_async_email mail.send(msg) File "/Users/zhoujj/project/microblog/venv/lib/python2.7/site-packages/flask_mail.py", line 491, in send with self.connect() as connection: File "/Users/zhoujj/project/microblog/venv/lib/python2.7/site-packages/flask_mail.py", line 144, in enter self.host = self.configure_host() File "/Users/zhoujj/project/microblog/venv/lib/python2.7/site-packages/flask_mail.py", line 163, in configure_host host.starttls() File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/smtplib.py", line 644, in starttls raise SMTPException("STARTTLS extension not supported by server.") SMTPException: STARTTLS extension not supported by server.

  • #93 Miguel Grinberg said 2018-10-24T11:38:43Z

    @zhoujj: the debugging SMTP server does not support TLS. You probably have the MAIL_USE_TLS environment variable set. Try deleting this variable from your environment.

  • #94 Ankur Tiwari said 2018-10-24T12:37:33Z


    I got it working, gmail inbox now shows my brand name instead of 'noreply', Used the tuple -- sender=("Me", "me@example.com"))

    Do you think, it comes with any security vulnerability?

    Another issue i have is to be able to select sender email address i.e. currently I have configured MAIL SERVER, USER Name Etc for noreply@domain.com, but there will be some emails that I want to send from other emails, say.. contact@domain.com or support@domain.com... For this I will have to configure MAIL server for these to. Since I already have MAIL_USERNAME = noreply@domain.com, how can i configure it for other emails?

    Will making MAIL_USERNAME a list be a solution?

  • #95 Miguel Grinberg said 2018-10-24T22:22:15Z

    @Ankur: the sender email address has nothing to do with the authenticated user. The same authenticated user can send emails that all have different "from" email addresses.

  • #96 David said 2018-10-31T19:54:26Z

    Hi Miguel,

    Thanks for this is a great tutorial! I have followed it however I am having trouble sending password reset emails. My issue is pretty similar to the one posted by #AnthonyBrown and I wonder you ever found out what the problem is.

    I keep getting this error. - - [31/Oct/2018 15:45:46] "GET /auth/login HTTP/1.1" 200 - Exception in thread Thread-3: Traceback (most recent call last): File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/threading.py", line 810, in bootstrap_inner self.run() File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/threading.py", line 763, in run self.target(*self.args, **self.kwargs) File "/Users/davidjonathan/Desktop/med-water/app/email.py", line 9, in send_async_email mail.send(msg) File "/Library/Python/2.7/site-packages/flask_mail.py", line 492, in send message.send(connection) File "/Library/Python/2.7/site-packages/flask_mail.py", line 152, in exit self.host.quit() File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/smtplib.py", line 767, in quit res = self.docmd("quit") File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/smtplib.py", line 393, in docmd self.putcmd(cmd, args) File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/smtplib.py", line 341, in putcmd self.send(str) File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/smtplib.py", line 333, in send raise SMTPServerDisconnected('please run connect() first') SMTPServerDisconnected: please run connect() first

  • #97 Miguel Grinberg said 2018-11-03T10:25:20Z

    @David: I would be inclined to think this is a problem with the SMTP server that you are using. Does this problem occur if you use the debugging SMTP server, or gmail?

  • #98 Dawson said 2018-11-05T17:21:51Z

    At least for me, these SMTPServerDisconnected: please run connect() first errors seem to be caused by not setting the MAIL_SERVER and MAIL_PORT environment variables in the terminal/venv that the sending of the mails are being done from.

  • #99 AR said 2018-11-14T03:08:31Z

    Hi Miguel,

    This might be related to comment #49

    In reset_password_request.html, how can i link a custom css or even bootstrap.css which is otherwise already linked in base.html for rest of the pages?

  • #100 Miguel Grinberg said 2018-11-15T12:06:38Z

    @AR: you can add any custom CSS in the "head" block. See the Flask-Bootstrap documentation for details.

Leave a Comment