doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
get_string(key)
Return a string representation of the message corresponding to key, or raise a KeyError exception if no such message exists. The message is processed through email.message.Message to convert it to a 7bit clean representation. | python.library.mailbox#mailbox.Mailbox.get_string |
iteritems()
items()
Return an iterator over (key, message) pairs, where key is a key and message is a message representation, if called as iteritems() or return a list of such pairs if called as items(). The messages are represented as instances of the appropriate format-specific Message subclass unless a custom me... | python.library.mailbox#mailbox.Mailbox.items |
iteritems()
items()
Return an iterator over (key, message) pairs, where key is a key and message is a message representation, if called as iteritems() or return a list of such pairs if called as items(). The messages are represented as instances of the appropriate format-specific Message subclass unless a custom me... | python.library.mailbox#mailbox.Mailbox.iteritems |
iterkeys()
keys()
Return an iterator over all keys if called as iterkeys() or return a list of keys if called as keys(). | python.library.mailbox#mailbox.Mailbox.iterkeys |
itervalues()
__iter__()
values()
Return an iterator over representations of all messages if called as itervalues() or __iter__() or return a list of such representations if called as values(). The messages are represented as instances of the appropriate format-specific Message subclass unless a custom message fac... | python.library.mailbox#mailbox.Mailbox.itervalues |
iterkeys()
keys()
Return an iterator over all keys if called as iterkeys() or return a list of keys if called as keys(). | python.library.mailbox#mailbox.Mailbox.keys |
lock()
Acquire an exclusive advisory lock on the mailbox so that other processes know not to modify it. An ExternalClashError is raised if the lock is not available. The particular locking mechanisms used depend upon the mailbox format. You should always lock the mailbox before making any modifications to its content... | python.library.mailbox#mailbox.Mailbox.lock |
pop(key, default=None)
Return a representation of the message corresponding to key and delete the message. If no such message exists, return default. The message is represented as an instance of the appropriate format-specific Message subclass unless a custom message factory was specified when the Mailbox instance wa... | python.library.mailbox#mailbox.Mailbox.pop |
popitem()
Return an arbitrary (key, message) pair, where key is a key and message is a message representation, and delete the corresponding message. If the mailbox is empty, raise a KeyError exception. The message is represented as an instance of the appropriate format-specific Message subclass unless a custom messag... | python.library.mailbox#mailbox.Mailbox.popitem |
remove(key)
__delitem__(key)
discard(key)
Delete the message corresponding to key from the mailbox. If no such message exists, a KeyError exception is raised if the method was called as remove() or __delitem__() but no exception is raised if the method was called as discard(). The behavior of discard() may be pre... | python.library.mailbox#mailbox.Mailbox.remove |
unlock()
Release the lock on the mailbox, if any. | python.library.mailbox#mailbox.Mailbox.unlock |
update(arg)
Parameter arg should be a key-to-message mapping or an iterable of (key, message) pairs. Updates the mailbox so that, for each given key and message, the message corresponding to key is set to message as if by using __setitem__(). As with __setitem__(), each key must already correspond to a message in the... | python.library.mailbox#mailbox.Mailbox.update |
itervalues()
__iter__()
values()
Return an iterator over representations of all messages if called as itervalues() or __iter__() or return a list of such representations if called as values(). The messages are represented as instances of the appropriate format-specific Message subclass unless a custom message fac... | python.library.mailbox#mailbox.Mailbox.values |
__contains__(key)
Return True if key corresponds to a message, False otherwise. | python.library.mailbox#mailbox.Mailbox.__contains__ |
remove(key)
__delitem__(key)
discard(key)
Delete the message corresponding to key from the mailbox. If no such message exists, a KeyError exception is raised if the method was called as remove() or __delitem__() but no exception is raised if the method was called as discard(). The behavior of discard() may be pre... | python.library.mailbox#mailbox.Mailbox.__delitem__ |
get(key, default=None)
__getitem__(key)
Return a representation of the message corresponding to key. If no such message exists, default is returned if the method was called as get() and a KeyError exception is raised if the method was called as __getitem__(). The message is represented as an instance of the appropr... | python.library.mailbox#mailbox.Mailbox.__getitem__ |
itervalues()
__iter__()
values()
Return an iterator over representations of all messages if called as itervalues() or __iter__() or return a list of such representations if called as values(). The messages are represented as instances of the appropriate format-specific Message subclass unless a custom message fac... | python.library.mailbox#mailbox.Mailbox.__iter__ |
__len__()
Return a count of messages in the mailbox. | python.library.mailbox#mailbox.Mailbox.__len__ |
__setitem__(key, message)
Replace the message corresponding to key with message. Raise a KeyError exception if no message already corresponds to key. As with add(), parameter message may be a Message instance, an email.message.Message instance, a string, a byte string, or a file-like object (which should be open in b... | python.library.mailbox#mailbox.Mailbox.__setitem__ |
class mailbox.Maildir(dirname, factory=None, create=True)
A subclass of Mailbox for mailboxes in Maildir format. Parameter factory is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If factory is None, MaildirMessage is... | python.library.mailbox#mailbox.Maildir |
add(message)
__setitem__(key, message)
update(arg)
Warning These methods generate unique file names based upon the current process ID. When using multiple threads, undetected name clashes may occur and cause corruption of the mailbox unless threads are coordinated to avoid using these methods to manipulate the s... | python.library.mailbox#mailbox.Maildir.add |
add_folder(folder)
Create a folder whose name is folder and return a Maildir instance representing it. | python.library.mailbox#mailbox.Maildir.add_folder |
clean()
Delete temporary files from the mailbox that have not been accessed in the last 36 hours. The Maildir specification says that mail-reading programs should do this occasionally. | python.library.mailbox#mailbox.Maildir.clean |
close()
Maildir instances do not keep any open files and the underlying mailboxes do not support locking, so this method does nothing. | python.library.mailbox#mailbox.Maildir.close |
flush()
All changes to Maildir mailboxes are immediately applied, so this method does nothing. | python.library.mailbox#mailbox.Maildir.flush |
get_file(key)
Depending upon the host platform, it may not be possible to modify or remove the underlying message while the returned file remains open. | python.library.mailbox#mailbox.Maildir.get_file |
get_folder(folder)
Return a Maildir instance representing the folder whose name is folder. A NoSuchMailboxError exception is raised if the folder does not exist. | python.library.mailbox#mailbox.Maildir.get_folder |
list_folders()
Return a list of the names of all folders. | python.library.mailbox#mailbox.Maildir.list_folders |
lock()
unlock()
Maildir mailboxes do not support (or require) locking, so these methods do nothing. | python.library.mailbox#mailbox.Maildir.lock |
remove_folder(folder)
Delete the folder whose name is folder. If the folder contains any messages, a NotEmptyError exception will be raised and the folder will not be deleted. | python.library.mailbox#mailbox.Maildir.remove_folder |
lock()
unlock()
Maildir mailboxes do not support (or require) locking, so these methods do nothing. | python.library.mailbox#mailbox.Maildir.unlock |
add(message)
__setitem__(key, message)
update(arg)
Warning These methods generate unique file names based upon the current process ID. When using multiple threads, undetected name clashes may occur and cause corruption of the mailbox unless threads are coordinated to avoid using these methods to manipulate the s... | python.library.mailbox#mailbox.Maildir.update |
add(message)
__setitem__(key, message)
update(arg)
Warning These methods generate unique file names based upon the current process ID. When using multiple threads, undetected name clashes may occur and cause corruption of the mailbox unless threads are coordinated to avoid using these methods to manipulate the s... | python.library.mailbox#mailbox.Maildir.__setitem__ |
class mailbox.MaildirMessage(message=None)
A message with Maildir-specific behaviors. Parameter message has the same meaning as with the Message constructor. Typically, a mail user agent application moves all of the messages in the new subdirectory to the cur subdirectory after the first time the user opens and close... | python.library.mailbox#mailbox.MaildirMessage |
add_flag(flag)
Set the flag(s) specified by flag without changing other flags. To add more than one flag at a time, flag may be a string of more than one character. The current “info” is overwritten whether or not it contains experimental information rather than flags. | python.library.mailbox#mailbox.MaildirMessage.add_flag |
get_date()
Return the delivery date of the message as a floating-point number representing seconds since the epoch. | python.library.mailbox#mailbox.MaildirMessage.get_date |
get_flags()
Return a string specifying the flags that are currently set. If the message complies with the standard Maildir format, the result is the concatenation in alphabetical order of zero or one occurrence of each of 'D', 'F', 'P', 'R', 'S', and 'T'. The empty string is returned if no flags are set or if “info” ... | python.library.mailbox#mailbox.MaildirMessage.get_flags |
get_info()
Return a string containing the “info” for a message. This is useful for accessing and modifying “info” that is experimental (i.e., not a list of flags). | python.library.mailbox#mailbox.MaildirMessage.get_info |
get_subdir()
Return either “new” (if the message should be stored in the new subdirectory) or “cur” (if the message should be stored in the cur subdirectory). Note A message is typically moved from new to cur after its mailbox has been accessed, whether or not the message is has been read. A message msg has been rea... | python.library.mailbox#mailbox.MaildirMessage.get_subdir |
remove_flag(flag)
Unset the flag(s) specified by flag without changing other flags. To remove more than one flag at a time, flag maybe a string of more than one character. If “info” contains experimental information rather than flags, the current “info” is not modified. | python.library.mailbox#mailbox.MaildirMessage.remove_flag |
set_date(date)
Set the delivery date of the message to date, a floating-point number representing seconds since the epoch. | python.library.mailbox#mailbox.MaildirMessage.set_date |
set_flags(flags)
Set the flags specified by flags and unset all others. | python.library.mailbox#mailbox.MaildirMessage.set_flags |
set_info(info)
Set “info” to info, which should be a string. | python.library.mailbox#mailbox.MaildirMessage.set_info |
set_subdir(subdir)
Set the subdirectory the message should be stored in. Parameter subdir must be either “new” or “cur”. | python.library.mailbox#mailbox.MaildirMessage.set_subdir |
class mailbox.mbox(path, factory=None, create=True)
A subclass of Mailbox for mailboxes in mbox format. Parameter factory is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If factory is None, mboxMessage is used as the... | python.library.mailbox#mailbox.mbox |
get_file(key)
Using the file after calling flush() or close() on the mbox instance may yield unpredictable results or raise an exception. | python.library.mailbox#mailbox.mbox.get_file |
lock()
unlock()
Three locking mechanisms are used—dot locking and, if available, the flock() and lockf() system calls. | python.library.mailbox#mailbox.mbox.lock |
lock()
unlock()
Three locking mechanisms are used—dot locking and, if available, the flock() and lockf() system calls. | python.library.mailbox#mailbox.mbox.unlock |
class mailbox.mboxMessage(message=None)
A message with mbox-specific behaviors. Parameter message has the same meaning as with the Message constructor. Messages in an mbox mailbox are stored together in a single file. The sender’s envelope address and the time of delivery are typically stored in a line beginning with... | python.library.mailbox#mailbox.mboxMessage |
add_flag(flag)
Set the flag(s) specified by flag without changing other flags. To add more than one flag at a time, flag may be a string of more than one character. | python.library.mailbox#mailbox.mboxMessage.add_flag |
get_flags()
Return a string specifying the flags that are currently set. If the message complies with the conventional format, the result is the concatenation in the following order of zero or one occurrence of each of 'R', 'O', 'D', 'F', and 'A'. | python.library.mailbox#mailbox.mboxMessage.get_flags |
get_from()
Return a string representing the “From ” line that marks the start of the message in an mbox mailbox. The leading “From ” and the trailing newline are excluded. | python.library.mailbox#mailbox.mboxMessage.get_from |
remove_flag(flag)
Unset the flag(s) specified by flag without changing other flags. To remove more than one flag at a time, flag maybe a string of more than one character. | python.library.mailbox#mailbox.mboxMessage.remove_flag |
set_flags(flags)
Set the flags specified by flags and unset all others. Parameter flags should be the concatenation in any order of zero or more occurrences of each of 'R', 'O', 'D', 'F', and 'A'. | python.library.mailbox#mailbox.mboxMessage.set_flags |
set_from(from_, time_=None)
Set the “From ” line to from_, which should be specified without a leading “From ” or trailing newline. For convenience, time_ may be specified and will be formatted appropriately and appended to from_. If time_ is specified, it should be a time.struct_time instance, a tuple suitable for p... | python.library.mailbox#mailbox.mboxMessage.set_from |
class mailbox.Message(message=None)
A subclass of the email.message module’s Message. Subclasses of mailbox.Message add mailbox-format-specific state and behavior. If message is omitted, the new instance is created in a default, empty state. If message is an email.message.Message instance, its contents are copied; fu... | python.library.mailbox#mailbox.Message |
class mailbox.MH(path, factory=None, create=True)
A subclass of Mailbox for mailboxes in MH format. Parameter factory is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If factory is None, MHMessage is used as the defau... | python.library.mailbox#mailbox.MH |
add_folder(folder)
Create a folder whose name is folder and return an MH instance representing it. | python.library.mailbox#mailbox.MH.add_folder |
close()
MH instances do not keep any open files, so this method is equivalent to unlock(). | python.library.mailbox#mailbox.MH.close |
remove(key)
__delitem__(key)
discard(key)
These methods immediately delete the message. The MH convention of marking a message for deletion by prepending a comma to its name is not used. | python.library.mailbox#mailbox.MH.discard |
flush()
All changes to MH mailboxes are immediately applied, so this method does nothing. | python.library.mailbox#mailbox.MH.flush |
get_file(key)
Depending upon the host platform, it may not be possible to remove the underlying message while the returned file remains open. | python.library.mailbox#mailbox.MH.get_file |
get_folder(folder)
Return an MH instance representing the folder whose name is folder. A NoSuchMailboxError exception is raised if the folder does not exist. | python.library.mailbox#mailbox.MH.get_folder |
get_sequences()
Return a dictionary of sequence names mapped to key lists. If there are no sequences, the empty dictionary is returned. | python.library.mailbox#mailbox.MH.get_sequences |
list_folders()
Return a list of the names of all folders. | python.library.mailbox#mailbox.MH.list_folders |
lock()
unlock()
Three locking mechanisms are used—dot locking and, if available, the flock() and lockf() system calls. For MH mailboxes, locking the mailbox means locking the .mh_sequences file and, only for the duration of any operations that affect them, locking individual message files. | python.library.mailbox#mailbox.MH.lock |
pack()
Rename messages in the mailbox as necessary to eliminate gaps in numbering. Entries in the sequences list are updated correspondingly. Note Already-issued keys are invalidated by this operation and should not be subsequently used. | python.library.mailbox#mailbox.MH.pack |
remove(key)
__delitem__(key)
discard(key)
These methods immediately delete the message. The MH convention of marking a message for deletion by prepending a comma to its name is not used. | python.library.mailbox#mailbox.MH.remove |
remove_folder(folder)
Delete the folder whose name is folder. If the folder contains any messages, a NotEmptyError exception will be raised and the folder will not be deleted. | python.library.mailbox#mailbox.MH.remove_folder |
set_sequences(sequences)
Re-define the sequences that exist in the mailbox based upon sequences, a dictionary of names mapped to key lists, like returned by get_sequences(). | python.library.mailbox#mailbox.MH.set_sequences |
lock()
unlock()
Three locking mechanisms are used—dot locking and, if available, the flock() and lockf() system calls. For MH mailboxes, locking the mailbox means locking the .mh_sequences file and, only for the duration of any operations that affect them, locking individual message files. | python.library.mailbox#mailbox.MH.unlock |
remove(key)
__delitem__(key)
discard(key)
These methods immediately delete the message. The MH convention of marking a message for deletion by prepending a comma to its name is not used. | python.library.mailbox#mailbox.MH.__delitem__ |
class mailbox.MHMessage(message=None)
A message with MH-specific behaviors. Parameter message has the same meaning as with the Message constructor. MH messages do not support marks or flags in the traditional sense, but they do support sequences, which are logical groupings of arbitrary messages. Some mail reading pr... | python.library.mailbox#mailbox.MHMessage |
add_sequence(sequence)
Add sequence to the list of sequences that include this message. | python.library.mailbox#mailbox.MHMessage.add_sequence |
get_sequences()
Return a list of the names of sequences that include this message. | python.library.mailbox#mailbox.MHMessage.get_sequences |
remove_sequence(sequence)
Remove sequence from the list of sequences that include this message. | python.library.mailbox#mailbox.MHMessage.remove_sequence |
set_sequences(sequences)
Set the list of sequences that include this message. | python.library.mailbox#mailbox.MHMessage.set_sequences |
class mailbox.MMDF(path, factory=None, create=True)
A subclass of Mailbox for mailboxes in MMDF format. Parameter factory is a callable object that accepts a file-like message representation (which behaves as if opened in binary mode) and returns a custom representation. If factory is None, MMDFMessage is used as the... | python.library.mailbox#mailbox.MMDF |
get_file(key)
Using the file after calling flush() or close() on the MMDF instance may yield unpredictable results or raise an exception. | python.library.mailbox#mailbox.MMDF.get_file |
lock()
unlock()
Three locking mechanisms are used—dot locking and, if available, the flock() and lockf() system calls. | python.library.mailbox#mailbox.MMDF.lock |
lock()
unlock()
Three locking mechanisms are used—dot locking and, if available, the flock() and lockf() system calls. | python.library.mailbox#mailbox.MMDF.unlock |
class mailbox.MMDFMessage(message=None)
A message with MMDF-specific behaviors. Parameter message has the same meaning as with the Message constructor. As with message in an mbox mailbox, MMDF messages are stored with the sender’s address and the delivery date in an initial line beginning with “From “. Likewise, flag... | python.library.mailbox#mailbox.MMDFMessage |
add_flag(flag)
Set the flag(s) specified by flag without changing other flags. To add more than one flag at a time, flag may be a string of more than one character. | python.library.mailbox#mailbox.MMDFMessage.add_flag |
get_flags()
Return a string specifying the flags that are currently set. If the message complies with the conventional format, the result is the concatenation in the following order of zero or one occurrence of each of 'R', 'O', 'D', 'F', and 'A'. | python.library.mailbox#mailbox.MMDFMessage.get_flags |
get_from()
Return a string representing the “From ” line that marks the start of the message in an mbox mailbox. The leading “From ” and the trailing newline are excluded. | python.library.mailbox#mailbox.MMDFMessage.get_from |
remove_flag(flag)
Unset the flag(s) specified by flag without changing other flags. To remove more than one flag at a time, flag maybe a string of more than one character. | python.library.mailbox#mailbox.MMDFMessage.remove_flag |
set_flags(flags)
Set the flags specified by flags and unset all others. Parameter flags should be the concatenation in any order of zero or more occurrences of each of 'R', 'O', 'D', 'F', and 'A'. | python.library.mailbox#mailbox.MMDFMessage.set_flags |
set_from(from_, time_=None)
Set the “From ” line to from_, which should be specified without a leading “From ” or trailing newline. For convenience, time_ may be specified and will be formatted appropriately and appended to from_. If time_ is specified, it should be a time.struct_time instance, a tuple suitable for p... | python.library.mailbox#mailbox.MMDFMessage.set_from |
exception mailbox.NoSuchMailboxError
Raised when a mailbox is expected but is not found, such as when instantiating a Mailbox subclass with a path that does not exist (and with the create parameter set to False), or when opening a folder that does not exist. | python.library.mailbox#mailbox.NoSuchMailboxError |
exception mailbox.NotEmptyError
Raised when a mailbox is not empty but is expected to be, such as when deleting a folder that contains messages. | python.library.mailbox#mailbox.NotEmptyError |
mailcap — Mailcap file handling Source code: Lib/mailcap.py Mailcap files are used to configure how MIME-aware applications such as mail readers and Web browsers react to files with different MIME types. (The name “mailcap” is derived from the phrase “mail capability”.) For example, a mailcap file might contain a line ... | python.library.mailcap |
mailcap.findmatch(caps, MIMEtype, key='view', filename='/dev/null', plist=[])
Return a 2-tuple; the first element is a string containing the command line to be executed (which can be passed to os.system()), and the second element is the mailcap entry for a given MIME type. If no matching MIME type can be found, (None... | python.library.mailcap#mailcap.findmatch |
mailcap.getcaps()
Returns a dictionary mapping MIME types to a list of mailcap file entries. This dictionary must be passed to the findmatch() function. An entry is stored as a list of dictionaries, but it shouldn’t be necessary to know the details of this representation. The information is derived from all of the ma... | python.library.mailcap#mailcap.getcaps |
map(function, iterable, ...)
Return an iterator that applies function to every item of iterable, yielding the results. If additional iterable arguments are passed, function must take that many arguments and is applied to the items from all iterables in parallel. With multiple iterables, the iterator stops when the sh... | python.library.functions#map |
marshal — Internal Python object serialization This module contains functions that can read and write Python values in a binary format. The format is specific to Python, but independent of machine architecture issues (e.g., you can write a Python value to a file on a PC, transport the file to a Sun, and read it back th... | python.library.marshal |
marshal.dump(value, file[, version])
Write the value on the open file. The value must be a supported type. The file must be a writeable binary file. If the value has (or contains an object that has) an unsupported type, a ValueError exception is raised — but garbage data will also be written to the file. The object w... | python.library.marshal#marshal.dump |
marshal.dumps(value[, version])
Return the bytes object that would be written to a file by dump(value, file). The value must be a supported type. Raise a ValueError exception if value has (or contains an object that has) an unsupported type. The version argument indicates the data format that dumps should use (see be... | python.library.marshal#marshal.dumps |
marshal.load(file)
Read one value from the open file and return it. If no valid value is read (e.g. because the data has a different Python version’s incompatible marshal format), raise EOFError, ValueError or TypeError. The file must be a readable binary file. Note If an object containing an unsupported type was ma... | python.library.marshal#marshal.load |
marshal.loads(bytes)
Convert the bytes-like object to a value. If no valid value is found, raise EOFError, ValueError or TypeError. Extra bytes in the input are ignored. | python.library.marshal#marshal.loads |
marshal.version
Indicates the format that the module uses. Version 0 is the historical format, version 1 shares interned strings and version 2 uses a binary format for floating point numbers. Version 3 adds support for object instancing and recursion. The current version is 4. | python.library.marshal#marshal.version |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.