Forked from adit98/email_listener & Modified by soranoo.
email_listener is a Python package for listening in an email folder and processing incoming emails by scraping them, and optionally processing them with a custom processing script. Additionally, the EmailResponder class is included as an easy way to send reply emails.
Portal ↠ Installation · Basic Usage ↞
- IMAP must be enabled in the email settings.
- If you are using Gmail as your email service provider then a Google Account app password must be created, which can be done in the 'Security' section of your Google Account page.
Clone the repository and run the setup.py
gh repo clone soranoo/email_listener
import email_listener
# Set your email, password, what folder you want to listen to, and where to save attachments
email = "example@gmail.com"
app_password = "password"
folder = "Inbox"
attachment_dir = "/path/to/attachments"
imap_address = "outlook.office365.com"
imap_port = 993
el = email_listener.EmailListener(email, app_password, folder, attachment_dir, imap_address=imap_address, imap_port=imap_port)
# Log into the IMAP server
el.login()
# Get the emails currently unread in the inbox
messages = el.scrape()
print(messages)
# Start listening to the inbox and timeout after an hour
timeout = 60
#timeout = -1 # Listen forever
el.listen(timeout)
email_listener currently set Gmail(imap.gmail.com) as the default IMAP server, you can switch to another email server with the following tweaks.
email_listener.EmailListener(email, app_password, folder, attachment_dir, logger, imap_address=<IMAP Server Address>, imap_port=<IMAP Server Port>)
The output:
{'227_somebody@gmail.com':
{'Email_Address': 'somebody@gmail.com',
'Email_UID': 227,
'Date': 'Wed, 2 Feb 2022 04:16:44 +0000 <class 'datetime.datetime'>',
'Subject': 'EmailListener Test',
'Plain_Text': 'This is the plain text message.\r\nThis is another line.\r\n',
'Plain_HTML': 'This is the HTML message. \nThis is another line. \n\n',
'HTML': '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r\n
<html xmlns="http://www.w3.org/1999/xhtml">\r\n
<head>\r\n
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r\n
<title>EmailListener Test</title>\r\n
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>\r\n
</head>\r\n
<body>\r\n
<p>This is the HTML message.<br/>This is another line.<br/></p>\r\n
</body>\r\n
</html>',
'attachments': ['/home/pi/email_listener/tests/attachments/EmailListener_test.txt']
}
}
More detailed examples can be found in each module.
Once the unit test requirements are met, run the unit tests with the following command:
python3 -m pytest
Unit tests require a valid gmail account, which requires a few additions:
- A label (or folder) named 'email_listener' must be created
- A filter must be created, which moves any emails sent to
<Your email>+email_listener@gmail.comto the email_listener label/folder
Along with these changes, the following environmental variables must be created:
EL_EMAIL and EL_APW
For example, on the Raspian OS, this can be done by adding the following to /home/pi/.profile:
export EL_EMAIL="[Your Gmail email address]"
export EL_APW="[Your Google Account app password]"
- Function for fetching the latest email only.
- No known issues