easyimap

About this module

Simple imap wrapper.

Example to use

connect function create IMAP4_SSL instance by default:

>>> import easyimap
>>> host = "imap.gmail.com"
>>> user = "me@example.com"
>>> password = "hogehogehogehoge"
>>> mailbox = "secret"
>>> imapper = easyimap.connect(host, user, password, mailbox)

connect function also create IMAP4 instance by passing ssl argument:

>>> import easyimap
>>> host = "imap.gmail.com"
>>> user = "me@example.com"
>>> password = "hogehogehogehoge"
>>> mailbox = "secret"
>>> imapper = easyimap.connect(host, user, password, mailbox, ssl=False, port=143)

This imapper can list up latest n mail by listup method. By default, This invoke fetch from IMAP4_SSL instance with ‘(UID RFC822)’.:

>>> mail1, mail2 = imapper.listup(2)
>>> mail1.uid
80
>>> mail1
<easyimap.easyimap.MailObj object at 0x...>
>>> type(mail1.body)
<type 'unicode'>
>>> type(mail1.title)
<type 'unicode'>
>>> type(mail1.date)
<type 'unicode'>
>>> type(mail1.sender)
<type 'unicode'>

You can check latest unseen mail by unseen method:

>>> imapper.unseen(2)
[(82, <easyimap.easyimap.MailObj object at 0x...>), (81, <easyimap.easyimap.MailObj object at 0x...)]

You can directly fetch email object with specific id:

>>> imapper.mail(80)
<easyimap.easyimap.MailObj object at 0x...>

You can download attachments:

>>> imapper.mail(80)
>>> (id, mail) = imapper.mail(80)
>>> for attachment in mail.attachment:
>>>     print attachment[0], attachment[1]

Finally, call quit method:

>>> imapper.quit()

Basic API

easyimap.connect(host, user, password, mailbox=’INBOX’, timeout=15, ssl=True, port=993, **kwargs)

Create IMAP4(_SSL) wrapper.

If you want to keep read/unread status, Please pass optional read_only=True argument.

kwargs are read from Imapper’s constructor. Plz read source code.

Imapper

listids(limit=10, criterion=None)

Returns list of available email ids.
listup(limit=10, criterion=None, include_raw=False)

Returns list of mail_object.
unseen(limit=10)

Returns list of mail_object.
mail(uid, include_raw=False)

Returns MailObj.
change_mailbox(mailbox)

Change mailbox.
quit()

Close and Logout.

MailObject

uid

Returns UID(type: int).

raw

if you fetched email with include_raw option, this returns raw Data:

>>> [(id1, mail1), (id2, mail2)] = imapper.listup(2, include_raw)
>>> data = mail1.raw

title

Returns string of ‘Subject’ header.
sender

Returns string of ‘Sender’ header.
from_addr

Returns string of ‘From’ header.
to

Returns string of ‘To’ header.
date

Returns string of ‘Date’ header.
body

Returns string of Body.
content_type

Returns string of ‘Content-Type’ header.
content_transfer_encoding

Returns string of ‘Content-Transfer-Encoding’ header.
references

Returns string of ‘References’ header.
in_reply_to

Returns string of ‘In-Reply-To’ header.
reply_to

Returns string of ‘Reply-To’ header.
return_path

Returns string of ‘Return-Path’ header.
mime_version

Returns string of ‘MIME-Version’ header.
message_id

Returns string of ‘Message-ID’ header.
attachments

Returns list of tuples(‘attached file name’, MailObj).

Recent Change

0.6.3
- Add support for python-3.5.
- Fixed a bug in decoding an attached plain text.
0.6.2
- Fixed a bug in header/body encoding
0.6.1
- Fixed a bug in _decode_header function
0.6.0
- Add support for Python-3.4.
- Backward incompatible changes
  
  Modify listup to return list of mailobj.
  
  Rename many properties to underbar separated format.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easyimap-0.7.0.tar.gz (6.3 kB view details)

Uploaded Apr 30, 2021 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

easyimap-0.7.0-py3-none-any.whl (6.2 kB view details)

Uploaded Apr 30, 2021 Python 3

File details

Details for the file easyimap-0.7.0.tar.gz.

File metadata

Download URL: easyimap-0.7.0.tar.gz
Upload date: Apr 30, 2021
Size: 6.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for easyimap-0.7.0.tar.gz
Algorithm	Hash digest
SHA256	`6c2700d92d830de41c7012a0c76ac5ed9b46a04b929a6f7f9b578dd9dea8f725`
MD5	`5cc16796b28fbc493aa7c811ba16b997`
BLAKE2b-256	`48090921c7411d55c7e1defbbf00dbf009d78ed382e277e54505058f4fe3d1ee`

See more details on using hashes here.

File details

Details for the file easyimap-0.7.0-py3-none-any.whl.

File metadata

Download URL: easyimap-0.7.0-py3-none-any.whl
Upload date: Apr 30, 2021
Size: 6.2 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.2

File hashes

Hashes for easyimap-0.7.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9898a5c63dec32ac7b63cb111fed62ad47bb5aa6245f70285e3f6194e3e9adaf`
MD5	`9254943c12fbad42e1c70cdb40a564e4`
BLAKE2b-256	`3f2deb58f09ad7d4d9d9604d741366c7b734a69a1e7ce372b60cb149009defd9`