📚Документация Flask Mail: подробное руководство для настройки почты в Flask

Flask Mail Documentation

Flask Mail is an extension for Flask that allows you to easily send emails from your Flask application.

To use Flask Mail, you will need to install it first. You can install Flask Mail by running the following command:

pip install Flask-Mail

Once Flask Mail is installed, you can import it in your Flask application:

from flask_mail import Mail

Next, you will need to configure Flask Mail with your email service provider's settings. Here's an example of how to configure Flask Mail with Gmail:

app.config['MAIL_SERVER'] = 'smtp.gmail.com'
app.config['MAIL_PORT'] = 587
app.config['MAIL_USE_TLS'] = True
app.config['MAIL_USERNAME'] = 'your-email@gmail.com'
app.config['MAIL_PASSWORD'] = 'your-email-password'

Once Flask Mail is configured, you can create an instance of the Mail class:

mail = Mail(app)

Now, you can use Flask Mail to send emails. Here's an example of how to send an email:

from flask_mail import Message

@app.route('/send-email')
def send_email():
    message = Message('Hello', recipients=['recipient@example.com'])
    message.body = 'This is a test email'
    mail.send(message)
    return 'Email sent!'

In this example, we create a Message object with the subject and recipient email address. We set the body of the message and then use the mail.send() function to send the email.

You can find more information about Flask Mail in the official Flask Mail documentation.

Flask Mail Documentation: The Complete Guide

Flask is a popular web development framework in Python that allows you to build powerful and scalable web applications. One of the essential features of any web application is the ability to send emails. In this article, we will explore the Flask Mail extension, which provides an easy way to integrate email functionality into your Flask applications.

Setting Up Flask Mail

In order to use Flask Mail, you need to install it first. Open your terminal and run the following command:

pip install Flask-Mail

Once Flask Mail is installed, you can import it into your Flask application by adding the following lines of code:

from flask import Flask
from flask_mail import Mail, Message

app = Flask(__name__)
app.config['MAIL_SERVER'] = 'smtp.gmail.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USE_SSL'] = True
app.config['MAIL_USERNAME'] = 'your-email@gmail.com'
app.config['MAIL_PASSWORD'] = 'your-password'

mail = Mail(app)

In the code above, we import the necessary modules from Flask Mail and create an instance of the Flask application. We then configure the mail server, port, SSL settings, and provide the email credentials for authentication. Finally, we create an instance of the Mail class using the Flask application.

Sending Emails with Flask Mail

With Flask Mail set up, we can now send emails from our Flask application. To send an email, we need to create a Message object, set the necessary attributes such as sender, recipients, subject, and body, and then send the email using the Mail instance.

from flask import Flask, render_template
from flask_mail import Mail, Message

app = Flask(__name__)
app.config['MAIL_SERVER'] = 'smtp.gmail.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USE_SSL'] = True
app.config['MAIL_USERNAME'] = 'your-email@gmail.com'
app.config['MAIL_PASSWORD'] = 'your-password'

mail = Mail(app)

@app.route('/')
def index():
    # Create a Message object
    msg = Message('Hello', sender='your-email@gmail.com', recipients=['recipient@example.com'])

    # Set the attributes of the message
    msg.body = render_template('email.txt', name='John')

    # Send the email
    mail.send(msg)

    return 'Email Sent'

if __name__ == '__main__':
    app.run()

In the example above, we create a Flask route called '/' which sends an email when accessed. Within the route, we create a Message object with a subject and set the sender and recipients. We can also use the `render_template` function to generate the email body from an HTML template file. Finally, we use the `mail.send()` method to send the email and return a response indicating that the email has been sent.

Configuring SMTP Servers

By default, Flask Mail uses the SMTP server provided by your operating system. However, you can also specify a different SMTP server to use. To configure a custom SMTP server, you can add the following lines of code:

app.config['MAIL_SERVER'] = 'smtp.example.com'
app.config['MAIL_PORT'] = 587
app.config['MAIL_USE_TLS'] = True
app.config['MAIL_USERNAME'] = 'your-email@example.com'
app.config['MAIL_PASSWORD'] = 'your-password'

In the code above, we configure the MAIL_SERVER to use 'smtp.example.com' and set the MAIL_PORT to '587'. We also enable TLS encryption by setting MAIL_USE_TLS to True. Finally, we provide the email credentials for authentication.

Handling Email Attachments

Flask Mail also allows you to send email attachments. To send an attachment, you can use the `msg.attach()` method and pass in a file object. Here's an example:

from flask import Flask
from flask_mail import Mail, Message
from werkzeug.datastructures import FileStorage

app = Flask(__name__)
app.config['MAIL_SERVER'] = 'smtp.gmail.com'
app.config['MAIL_PORT'] = 465
app.config['MAIL_USE_SSL'] = True
app.config['MAIL_USERNAME'] = 'your-email@gmail.com'
app.config['MAIL_PASSWORD'] = 'your-password'

mail = Mail(app)

@app.route('/')
def index():
    # Create a Message object
    msg = Message('Hello', sender='your-email@gmail.com', recipients=['recipient@example.com'])

    # Attach a file
    with app.open_resource('path/to/file.pdf') as fp:
        msg.attach("file.pdf", "application/pdf", fp.read())

    # Send the email
    mail.send(msg)

    return 'Email Sent'

if __name__ == '__main__':
    app.run()

In the example above, we use the `msg.attach()` method to attach a file to the email. We use the `app.open_resource()` method to open the file in binary mode and read its contents. We then pass the file name, content type, and contents to the `msg.attach()` method.

Conclusion

Flask Mail is a powerful extension that simplifies the process of sending emails in Flask applications. In this article, we have covered the basics of setting up Flask Mail, sending emails, configuring SMTP servers, and handling email attachments. With this knowledge, you can enhance the functionality of your Flask applications by integrating email functionality.