Python smtplib Module: How to Install and Explore Advanced Features

Python Modules › Email Handling
, , ,

Python smtplib Module

The smtplib module is a built-in Python library used for sending emails using the SMTP protocol. This module helps developers create applications that can send email alerts, notifications, or any type of information directly through an email service provider. It is compatible with Python 3 and supports various features to handle different email sending scenarios efficiently.

Python version compatibility: The smtplib module is available by default in Python 3.x environments, which means you don’t need to install any additional packages to use it.

Application Scenario

The smtplib module is widely used in numerous applications, including:

  1. Automated Notification Systems: Send automated alerts or reminders when certain events occur.
  2. User Registration Confirmation Emails: Email users after they register on a platform to confirm their email addresses.
  3. Password Reset Emails: Facilitate user account management by sending password reset links or codes.
  4. Monitoring Systems: Use emails to notify admins or users about system metrics, failures, or alerts.

This versatility makes smtplib a valuable tool in any developer’s toolkit, especially when dealing with communication features.

Installation Instructions

The smtplib module is included with Python’s standard library and does not require separate installation. To check if you have Python 3.x installed and ready to use smtplib, simply run the following command in your terminal:

1
python --version

If you see a version number that starts with ‘3’, you’re set to use smtplib directly.

Usage Examples

Example 1: Sending a Basic Email

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import smtplib  # Import the smtplib module for email sending

# Define email sender and recipient
sender_email = "your_email@example.com"  # Replace with your email
recipient_email = "recipient@example.com"  # Replace with recipient's email

# Create a connection to the SMTP server (Gmail in this case)
with smtplib.SMTP('smtp.gmail.com', 587) as server:
    server.starttls()  # Upgrade the connection to a secure encrypted SSL/TLS connection
    server.login(sender_email, 'your_password')  # Log in to the SMTP server

    # Define the email content
    subject = "Hello from Python"
    message = f"Subject: {subject}\n\nThis is a test email sent from Python!"

    # Send the email
    server.sendmail(sender_email, recipient_email, message)  # Send the email

In this example, we establish a connection to the Gmail SMTP server, log in using your credentials, and send a basic email message.

Example 2: Sending an Email with HTML Content

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
import smtplib  # Import the smtplib module for email sending
from email.mime.multipart import MIMEMultipart  # For handling multipart emails
from email.mime.text import MIMEText  # For sending text emails

# Define email sender and recipient
sender_email = "your_email@example.com"  # Replace with your email
recipient_email = "recipient@example.com"  # Replace with recipient's email

# Create a MIMEMultipart email message
msg = MIMEMultipart()  # Create a multipart message
msg['From'] = sender_email  # Set the sender email
msg['To'] = recipient_email  # Set the recipient email
msg['Subject'] = "Hello with HTML!"  # Email subjectline

# HTML content
html_content = """
<!DOCTYPE html>
<html>
<body>
    <h1>This is a Test Email!</h1>
    <p>Hello, this email contains HTML content!</p>
</body>
</html>
"""
msg.attach(MIMEText(html_content, 'html'))  # Attach the HTML content to the email

# Create a connection to the SMTP server (Gmail in this case)
with smtplib.SMTP('smtp.gmail.com', 587) as server:
    server.starttls()  # Secure the connection
    server.login(sender_email, 'your_password')  # Log in to SMTP server

    # Send the email
    server.send_message(msg)  # Send the composed email

In this example, we create an HTML email body using the MIMEMultipart and MIMEText classes to compose and send an HTML formatted email.

Example 3: Sending Email with Attachments

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import smtplib  # Importing the smtplib module
from email.mime.multipart import MIMEMultipart  # For multipart emails
from email.mime.text import MIMEText  # For email body
from email.mime.base import MIMEBase  # For attachments
from email import encoders  # Encode attachments

# Define email sender and recipient
sender_email = "your_email@example.com"  # Replace with your email
recipient_email = "recipient@example.com"  # Replace with recipient's email

# Create a MIMEMultipart email message
msg = MIMEMultipart()  # Create a multipart message
msg['From'] = sender_email  # Set the sender email
msg['To'] = recipient_email  # Set the recipient email
msg['Subject'] = "Email with Attachment"  # Email subject

# Attach the body of the email
body = "This email contains an attachment."
msg.attach(MIMEText(body, 'plain'))  # Attach plain text to the email

# Define the attachment file path
file_path = "document.pdf"  # Replace with your file path
attachment = open(file_path, "rb")  # Open the file in read-binary mode

# Create the MIMEBase object
part = MIMEBase('application', 'octet-stream')  # Set the type of the attachment
part.set_payload(attachment.read())  # Read the attachment
encoders.encode_base64(part)  # Encode into base64
part.add_header('Content-Disposition', f'attachment; filename={file_path}')  # Add header to the part

# Attach the file to the message
msg.attach(part)  # Attach the File to the email

# Create a connection to the SMTP server
with smtplib.SMTP('smtp.gmail.com', 587) as server:
    server.starttls()  # Secure the connection
    server.login(sender_email, 'your_password')  # Log in to the SMTP server

    # Send the email
    server.send_message(msg)  # Send the email with the attachment

In this last example, we create a multipart message that sends a plain text body along with a specified attachment, using the MIMEBase class to handle the file attachment.

I highly recommend that everyone check out my blog, EVZS Blog. It contains a comprehensive collection of tutorials on how to use all Python standard libraries, making it convenient for you to reference and learn. By following my blog, you’ll gain access to valuable insights, best practices, and examples that can significantly enhance your programming skills. Don’t miss out on this opportunity to expand your knowledge and become a more proficient developer.

SOFTWARE VERSION MAY CHANG

If this document is no longer applicable or incorrect, please leave a message or contact me for update. Let's create a good learning atmosphere together. Thank you for your support! - Travis Tang