18. Internet Data Handling

This chapter describes modules which support handling data formats commonly used on the Internet.

• 18.1. email — An email and MIME handling package
  • 18.1.1. email.message: Representing an email message
    • Message
      • Message.as_string()
      • Message.__str__()
      • Message.is_multipart()
      • Message.set_unixfrom()
      • Message.get_unixfrom()
      • Message.attach()
      • Message.get_payload()
      • Message.set_payload()
      • Message.set_charset()
      • Message.get_charset()
      • Message.__len__()
      • Message.__contains__()
      • Message.__getitem__()
      • Message.__setitem__()
      • Message.__delitem__()
      • Message.has_key()
      • Message.keys()
      • Message.values()
      • Message.items()
      • Message.get()
      • Message.get_all()
      • Message.add_header()
      • Message.replace_header()
      • Message.get_content_type()
      • Message.get_content_maintype()
      • Message.get_content_subtype()
      • Message.get_default_type()
      • Message.set_default_type()
      • Message.get_params()
      • Message.get_param()
      • Message.set_param()
      • Message.del_param()
      • Message.set_type()
      • Message.get_filename()
      • Message.get_boundary()
      • Message.set_boundary()
      • Message.get_content_charset()
      • Message.get_charsets()
      • Message.walk()
      • Message.preamble
      • Message.epilogue
      • Message.defects
  • 18.1.2. email.parser: Parsing email messages
    • 18.1.2.1. FeedParser API
      • FeedParser
        • FeedParser.feed()
        • FeedParser.close()
    • 18.1.2.2. Parser class API
      • Parser
        • Parser.parse()
        • Parser.parsestr()
      • message_from_string()
      • message_from_file()
    • 18.1.2.3. Additional notes
  • 18.1.3. email.generator: Generating MIME documents
    • Generator
      • Generator.flatten()
      • Generator.clone()
      • Generator.write()
    • DecodedGenerator
  • 18.1.4. email.mime: Creating email and MIME objects from scratch
    • MIMEBase
    • MIMENonMultipart
    • MIMEMultipart
    • MIMEApplication
    • MIMEAudio
    • MIMEImage
    • MIMEMessage
    • MIMEText
  • 18.1.5. email.header: Internationalized headers
    • Header
      • Header.append()
      • Header.encode()
      • Header.__str__()
      • Header.__unicode__()
      • Header.__eq__()
      • Header.__ne__()
    • decode_header()
    • make_header()
  • 18.1.6. email.charset: Representing character sets
    • Charset
      • Charset.input_charset
      • Charset.header_encoding
      • Charset.body_encoding
      • Charset.output_charset
      • Charset.input_codec
      • Charset.output_codec
      • Charset.get_body_encoding()
      • Charset.convert()
      • Charset.to_splittable()
      • Charset.from_splittable()
      • Charset.get_output_charset()
      • Charset.encoded_header_len()
      • Charset.header_encode()
      • Charset.body_encode()
      • Charset.__str__()
      • Charset.__eq__()
      • Charset.__ne__()
    • add_charset()
    • add_alias()
    • add_codec()
  • 18.1.7. email.encoders: Encoders
    • encode_quopri()
    • encode_base64()
    • encode_7or8bit()
    • encode_noop()
  • 18.1.8. email.errors: Exception and Defect classes
    • MessageError
    • MessageParseError
    • HeaderParseError
    • BoundaryError
    • MultipartConversionError
  • 18.1.9. email.utils: Miscellaneous utilities
    • quote()
    • unquote()
    • parseaddr()
    • formataddr()
    • getaddresses()
    • parsedate()
    • parsedate_tz()
    • mktime_tz()
    • formatdate()
    • make_msgid()
    • decode_rfc2231()
    • encode_rfc2231()
    • collapse_rfc2231_value()
    • decode_params()
  • 18.1.10. email.iterators: Iterators
    • body_line_iterator()
    • typed_subpart_iterator()
    • _structure()
  • 18.1.11. email: Examples
  • 18.1.12. Package History
  • 18.1.13. Differences from mimelib
• 18.2. json — JSON encoder and decoder
  • 18.2.1. Basic Usage
    • dump()
    • dumps()
    • load()
    • loads()
  • 18.2.2. Encoders and Decoders
    • JSONDecoder
      • JSONDecoder.decode()
      • JSONDecoder.raw_decode()
    • JSONEncoder
      • JSONEncoder.default()
      • JSONEncoder.encode()
      • JSONEncoder.iterencode()
  • 18.2.3. Standard Compliance and Interoperability
    • 18.2.3.1. Character Encodings
    • 18.2.3.2. Infinite and NaN Number Values
    • 18.2.3.3. Repeated Names Within an Object
    • 18.2.3.4. Top-level Non-Object, Non-Array Values
    • 18.2.3.5. Implementation Limitations
• 18.3. mailcap — Mailcap file handling
  • findmatch()
  • getcaps()
• 18.4. mailbox — Manipulate mailboxes in various formats
  • 18.4.1. Mailbox objects
    • Mailbox
      • Mailbox.add()
      • Mailbox.remove()
      • Mailbox.__delitem__()
      • Mailbox.discard()
      • Mailbox.__setitem__()
      • Mailbox.iterkeys()
      • Mailbox.keys()
      • Mailbox.itervalues()
      • Mailbox.__iter__()
      • Mailbox.values()
      • Mailbox.iteritems()
      • Mailbox.items()
      • Mailbox.get()
      • Mailbox.__getitem__()
      • Mailbox.get_message()
      • Mailbox.get_string()
      • Mailbox.get_file()
      • Mailbox.has_key()
      • Mailbox.__contains__()
      • Mailbox.__len__()
      • Mailbox.clear()
      • Mailbox.pop()
      • Mailbox.popitem()
      • Mailbox.update()
      • Mailbox.flush()
      • Mailbox.lock()
      • Mailbox.unlock()
      • Mailbox.close()
    • 18.4.1.1. Maildir
      • Maildir
        • Maildir.list_folders()
        • Maildir.get_folder()
        • Maildir.add_folder()
        • Maildir.remove_folder()
        • Maildir.clean()
        • Maildir.add()
        • Maildir.__setitem__()
        • Maildir.update()
        • Maildir.flush()
        • Maildir.lock()
        • Maildir.unlock()
        • Maildir.close()
        • Maildir.get_file()
    • 18.4.1.2. mbox
      • mbox
        • mbox.get_file()
        • mbox.lock()
        • mbox.unlock()
    • 18.4.1.3. MH
      • MH
        • MH.list_folders()
        • MH.get_folder()
        • MH.add_folder()
        • MH.remove_folder()
        • MH.get_sequences()
        • MH.set_sequences()
        • MH.pack()
        • MH.remove()
        • MH.__delitem__()
        • MH.discard()
        • MH.lock()
        • MH.unlock()
        • MH.get_file()
        • MH.flush()
        • MH.close()
    • 18.4.1.4. Babyl
      • Babyl
        • Babyl.get_labels()
        • Babyl.get_file()
        • Babyl.lock()
        • Babyl.unlock()
    • 18.4.1.5. MMDF
      • MMDF
        • MMDF.get_file()
        • MMDF.lock()
        • MMDF.unlock()
  • 18.4.2. Message objects
    • Message
    • 18.4.2.1. MaildirMessage
      • MaildirMessage
        • MaildirMessage.get_subdir()
        • MaildirMessage.set_subdir()
        • MaildirMessage.get_flags()
        • MaildirMessage.set_flags()
        • MaildirMessage.add_flag()
        • MaildirMessage.remove_flag()
        • MaildirMessage.get_date()
        • MaildirMessage.set_date()
        • MaildirMessage.get_info()
        • MaildirMessage.set_info()
    • 18.4.2.2. mboxMessage
      • mboxMessage
        • mboxMessage.get_from()
        • mboxMessage.set_from()
        • mboxMessage.get_flags()
        • mboxMessage.set_flags()
        • mboxMessage.add_flag()
        • mboxMessage.remove_flag()
    • 18.4.2.3. MHMessage
      • MHMessage
        • MHMessage.get_sequences()
        • MHMessage.set_sequences()
        • MHMessage.add_sequence()
        • MHMessage.remove_sequence()
    • 18.4.2.4. BabylMessage
      • BabylMessage
        • BabylMessage.get_labels()
        • BabylMessage.set_labels()
        • BabylMessage.add_label()
        • BabylMessage.remove_label()
        • BabylMessage.get_visible()
        • BabylMessage.set_visible()
        • BabylMessage.update_visible()
    • 18.4.2.5. MMDFMessage
      • MMDFMessage
        • MMDFMessage.get_from()
        • MMDFMessage.set_from()
        • MMDFMessage.get_flags()
        • MMDFMessage.set_flags()
        • MMDFMessage.add_flag()
        • MMDFMessage.remove_flag()
  • 18.4.3. Exceptions
    • Error
    • NoSuchMailboxError
    • NotEmptyError
    • ExternalClashError
    • FormatError
  • 18.4.4. Deprecated classes and methods
    • oldmailbox.next()
    • UnixMailbox
    • PortableUnixMailbox
    • MmdfMailbox
    • MHMailbox
    • BabylMailbox
  • 18.4.5. Examples
• 18.5. mhlib — Access to MH mailboxes
  • MH
  • Folder
  • Message
  • 18.5.1. MH Objects
    • MH.error()
    • MH.getprofile()
    • MH.getpath()
    • MH.getcontext()
    • MH.setcontext()
    • MH.listfolders()
    • MH.listallfolders()
    • MH.listsubfolders()
    • MH.listallsubfolders()
    • MH.makefolder()
    • MH.deletefolder()
    • MH.openfolder()
  • 18.5.2. Folder Objects
    • Folder.error()
    • Folder.getfullname()
    • Folder.getsequencesfilename()
    • Folder.getmessagefilename()
    • Folder.listmessages()
    • Folder.getcurrent()
    • Folder.setcurrent()
    • Folder.parsesequence()
    • Folder.getlast()
    • Folder.setlast()
    • Folder.getsequences()
    • Folder.putsequences()
    • Folder.removemessages()
    • Folder.refilemessages()
    • Folder.movemessage()
    • Folder.copymessage()
  • 18.5.3. Message Objects
    • Message.openmessage()
• 18.6. mimetools — Tools for parsing MIME messages
  • Message
  • choose_boundary()
  • decode()
  • encode()
  • copyliteral()
  • copybinary()
  • 18.6.1. Additional Methods of Message Objects
    • Message.getplist()
    • Message.getparam()
    • Message.getencoding()
    • Message.gettype()
    • Message.getmaintype()
    • Message.getsubtype()
• 18.7. mimetypes — Map filenames to MIME types
  • guess_type()
  • guess_all_extensions()
  • guess_extension()
  • init()
  • read_mime_types()
  • add_type()
  • inited
  • knownfiles
  • suffix_map
  • encodings_map
  • types_map
  • common_types
  • 18.7.1. MimeTypes Objects
    • MimeTypes
      • MimeTypes.suffix_map
      • MimeTypes.encodings_map
      • MimeTypes.types_map
      • MimeTypes.types_map_inv
      • MimeTypes.guess_extension()
      • MimeTypes.guess_type()
      • MimeTypes.guess_all_extensions()
      • MimeTypes.read()
      • MimeTypes.readfp()
      • MimeTypes.read_windows_registry()
• 18.8. MimeWriter — Generic MIME file writer
  • MimeWriter
  • 18.8.1. MimeWriter Objects
    • MimeWriter.addheader()
    • MimeWriter.flushheaders()
    • MimeWriter.startbody()
    • MimeWriter.startmultipartbody()
    • MimeWriter.nextpart()
    • MimeWriter.lastpart()
• 18.9. mimify — MIME processing of mail messages
  • mimify()
  • unmimify()
  • mime_decode_header()
  • mime_encode_header()
  • MAXLEN
  • CHARSET
• 18.10. multifile — Support for files containing distinct parts
  • MultiFile
  • 18.10.1. MultiFile Objects
    • MultiFile.readline()
    • MultiFile.readlines()
    • MultiFile.read()
    • MultiFile.seek()
    • MultiFile.tell()
    • MultiFile.next()
    • MultiFile.is_data()
    • MultiFile.push()
    • MultiFile.pop()
    • MultiFile.section_divider()
    • MultiFile.end_marker()
    • MultiFile.level
    • MultiFile.last
  • 18.10.2. MultiFile Example
• 18.11. rfc822 — Parse RFC 2822 mail headers
  • Message
  • AddressList
  • quote()
  • unquote()
  • parseaddr()
  • dump_address_pair()
  • parsedate()
  • parsedate_tz()
  • mktime_tz()
  • 18.11.1. Message Objects
    • Message.rewindbody()
    • Message.isheader()
    • Message.islast()
    • Message.iscomment()
    • Message.getallmatchingheaders()
    • Message.getfirstmatchingheader()
    • Message.getrawheader()
    • Message.getheader()
    • Message.get()
    • Message.getaddr()
    • Message.getaddrlist()
    • Message.getdate()
    • Message.getdate_tz()
    • Message.headers
    • Message.fp
    • Message.unixfrom
  • 18.11.2. AddressList Objects
    • AddressList.__len__()
    • AddressList.__str__()
    • AddressList.__add__()
    • AddressList.__iadd__()
    • AddressList.__sub__()
    • AddressList.__isub__()
    • AddressList.addresslist
• 18.12. base64 — RFC 3548: Base16, Base32, Base64 Data Encodings
  • b64encode()
  • b64decode()
  • standard_b64encode()
  • standard_b64decode()
  • urlsafe_b64encode()
  • urlsafe_b64decode()
  • b32encode()
  • b32decode()
  • b16encode()
  • b16decode()
  • decode()
  • decodestring()
  • encode()
  • encodestring()
• 18.13. binhex — Encode and decode binhex4 files
  • binhex()
  • hexbin()
  • Error
  • 18.13.1. Notes
• 18.14. binascii — Convert between binary and ASCII
  • a2b_uu()
  • b2a_uu()
  • a2b_base64()
  • b2a_base64()
  • a2b_qp()
  • b2a_qp()
  • a2b_hqx()
  • rledecode_hqx()
  • rlecode_hqx()
  • b2a_hqx()
  • crc_hqx()
  • crc32()
  • b2a_hex()
  • hexlify()
  • a2b_hex()
  • unhexlify()
  • Error
  • Incomplete
• 18.15. quopri — Encode and decode MIME quoted-printable data
  • decode()
  • encode()
  • decodestring()
  • encodestring()
• 18.16. uu — Encode and decode uuencode files
  • encode()
  • decode()
  • Error