Imapy is a python imap package on top of imaplib with the intention to keep things simple but flexible.
Therefor, dealing with imap stuff and parsing messages got a simplified API but by default messages are only parsed in a minimal way. They are returned as email.message.Message objects created by the python standard email module in the form of a generator.
>>> uids, msgs = mbox["INBOX"](UNSEEN)
>>> len(uids)
5
>>> uids
['845', '846', '847', '848', '849']
>>> msgs
<generator object <genexpr> at 0x9427eb4>So you can iterate over found messages and apply several parsing functions to them suitable to your needs.
The included utility module imapy.utils already contains a lot of such functions. Hence, also parsing or rather extracting needed information can be simply done with a few lines of code ...
from imapy import utils
[...]
for msg in msgs:
content = utils.parse_content(msg)["plain"]
utils.save_raw_msg(msg, folder="backup")
[...]This modular approach (more function than class based) allows adding needed parsing functions not already included in imapy.utils or combining functions to a new one in an easy way. Extend the lib to your needs!
from imapy import Imapy
# fetch latest messages and print header to terminal
with Imapy(host) as mbox:
mbox.login(user, password)
uids, msgs = mbox(count=5)
for msg in msgs:
print msg["Subject"], msg["From"], msg["Date"]
# ==========
from imapy import create_engine, criteria
from imapy.utils import load_config
# read account data from JSON-config file
account_data = load_config("config.json")["accounts"]["default"]
mbox = create_engine(**account_data)
uids, msgs = mbox(criteria.UNSEEN)
[...]
mbox.kill()
# ==========
# using encoded password
from base64 import b64decode
mbox = create_engine(decoder=b64decode, **account_data)
# ==========
#change mailbox and parse header from fetched messages
from imapy.utils import parse_header
uids, msgs = mbox["INBOX.Sent"](count=10)
for uid, msg in zip(uids, msgs):
print uid, parse_header(msg)
to be continued [...]