Posts Tagged ‘imaplib’

Playing With Python And Gmail – Part 2

August 19th, 2010 4 comments

This is the second part of the article series ‘Playing With Python And Gmail’. If you didn’t read the first part I would recomend you to read it.

This time we will see how to fetch mails from Gmail using Python.

Reading Mails

The IMAP4.fetch method fetch (parts of) messages. message_parts should be a string of message part names enclosed within parentheses, eg: “(UID BODY[TEXT])”. Returned data are tuples of message part envelope and data.

Here is a minimal example (without error checking) that opens a mailbox and retrieves and prints all messages:

import imaplib
M = imaplib.IMAP4('', 993)
M.login('', 'pa$$word')
typ, data =, 'ALL')
for num in data[0].split():
    typ, data = M.fetch(num, '(RFC822)')
    print 'Message %s\n%s\n' % (num, data[0][1])

The email package provides a standard parser that understands most email document structures, including MIME documents. You can pass the parser a string or a file object, and the parser will return to you the root Message instance of the object structure. For simple, non-MIME messages the payload of this root object will likely be a string containing the text of the message. For MIME messages, the root object will return True from its is_multipart() method, and the subparts can be accessed via the get_payload() and walk() methods.

Extract Mail Headers
Here is method to retrieve from, to and subject from from an email message:

from email.parser import HeaderParser
resp, data = M.FETCH(1, '(RFC822)')
msg = HeaderParser().parsestr(data[0][1])
print msg['From']
print msg['To']
print msg['Subject']

Output will be something like.

Gmail Team
My Name
Gmail is different. Here's what you need to know.

Identifying the content type
The Content-Type header indicates the Internet media type of the message content, consisting of a type and subtype, for example text/plain is the default value for “Content-Type:”
Gmail uses alternative content, such as a message sent in both plain text and another format such as HTML (multipart/alternative with the same content in text/plain and text/html forms).

import email
resp, data = M.FETCH(1, '(RFC822)')
mail = email.message_from_string(data[0][1])
for part in mail.walk():
  print 'Content-Type:',part.get_content_type()
  print 'Main Content:',part.get_content_maintype()
  print 'Sub Content:',part.get_content_subtype()

Out put will be

Content-Type: multipart/alternative
Main Content: multipart
Sub Content: alternative
Content-Type: text/plain
Main Content: text
Sub Content: plain
Content-Type: text/html
Main Content: text
Sub Content: html

Extract Message Body.
Using the walk() method we can iterate through Message parts. The get_payload() method will return the current payload, which will be a list of Message objects when is_multipart() is True, or a string when is_multipart() is False.

import email
resp, data = M.FETCH(1, '(RFC822)')
mail = email.message_from_string(data[0][1])
for part in mail.walk():
  # multipart are just containers, so we skip them
  if part.get_content_maintype() == 'multipart':
  # we are interested only in the simple text messages
  if part.get_content_subtype() != 'plain':
  payload = part.get_payload()
  print payload

Extracting Attachmets
The below code will extract and save attached images to disk.

import re
name_pat = re.compile('name=\".*\"')
for part in mail.walk():
  if part.get_content_maintype() != 'image':
  file_type = part.get_content_type().split('/')[1]
  if not file_type:
    file_type = 'jpg'
  filename = part.get_filename()
  if not filename:
    filename = name_pat.findall(part.get('Content-Type'))[0][6:-1]
  counter = 1
  if not filename:
    filename = 'img-%03d%s' % (counter, file_type)
    counter += 1
  payload = part.get_payload(decode=True)
  if not os.path.isfile(filename) :
      # finally write the stuff
      fp = open(filename, 'wb')

That’s it. In the next part I will explain searching and moving your mails using Python. Dont forget to subscribe¬†:-)

Categories: PYTHON Tags: , , ,

Check Your IMAP Quota Using Python Imaplib

July 16th, 2010 No comments

pythonThe python-imaplib module defines three classes, IMAP4, IMAP4_SSL and IMAP4_stream, which encapsulate a connection to an IMAP4 server and implement a large subset of the IMAP4rev1 client protocol as defined in RFC 2060.

Here’s a code sample that returns your gmail quota details.

import getpass, imaplib, re
p = re.compile('\d+')
M.login(IMAP_USERNAME, getpass.getpass())
quotaStr = M.getquotaroot("INBOX")[1][1][0]
r = p.findall(quotaStr)
if r == []:
  print "Unlimited Quota Account"
print 'Allotted = %f MB'%(float(r[1])/1024)
print 'Used = %f MB'%(float(r[0])/1024)

The script will ask your gmail password and the output will be something like this:

Allotted = 7476.760000 MB
Used = 961.390000 MB
Categories: PYTHON Tags: , , ,