| 1 | \section{\module{mhlib} ---
|
|---|
| 2 | Access to MH mailboxes}
|
|---|
| 3 |
|
|---|
| 4 | % LaTeX'ized from the comments in the module by Skip Montanaro
|
|---|
| 5 | % <[email protected]>.
|
|---|
| 6 |
|
|---|
| 7 | \declaremodule{standard}{mhlib}
|
|---|
| 8 | \modulesynopsis{Manipulate MH mailboxes from Python.}
|
|---|
| 9 |
|
|---|
| 10 |
|
|---|
| 11 | The \module{mhlib} module provides a Python interface to MH folders and
|
|---|
| 12 | their contents.
|
|---|
| 13 |
|
|---|
| 14 | The module contains three basic classes, \class{MH}, which represents a
|
|---|
| 15 | particular collection of folders, \class{Folder}, which represents a single
|
|---|
| 16 | folder, and \class{Message}, which represents a single message.
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | \begin{classdesc}{MH}{\optional{path\optional{, profile}}}
|
|---|
| 20 | \class{MH} represents a collection of MH folders.
|
|---|
| 21 | \end{classdesc}
|
|---|
| 22 |
|
|---|
| 23 | \begin{classdesc}{Folder}{mh, name}
|
|---|
| 24 | The \class{Folder} class represents a single folder and its messages.
|
|---|
| 25 | \end{classdesc}
|
|---|
| 26 |
|
|---|
| 27 | \begin{classdesc}{Message}{folder, number\optional{, name}}
|
|---|
| 28 | \class{Message} objects represent individual messages in a folder. The
|
|---|
| 29 | Message class is derived from \class{mimetools.Message}.
|
|---|
| 30 | \end{classdesc}
|
|---|
| 31 |
|
|---|
| 32 |
|
|---|
| 33 | \subsection{MH Objects \label{mh-objects}}
|
|---|
| 34 |
|
|---|
| 35 | \class{MH} instances have the following methods:
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | \begin{methoddesc}[MH]{error}{format\optional{, ...}}
|
|---|
| 39 | Print an error message -- can be overridden.
|
|---|
| 40 | \end{methoddesc}
|
|---|
| 41 |
|
|---|
| 42 | \begin{methoddesc}[MH]{getprofile}{key}
|
|---|
| 43 | Return a profile entry (\code{None} if not set).
|
|---|
| 44 | \end{methoddesc}
|
|---|
| 45 |
|
|---|
| 46 | \begin{methoddesc}[MH]{getpath}{}
|
|---|
| 47 | Return the mailbox pathname.
|
|---|
| 48 | \end{methoddesc}
|
|---|
| 49 |
|
|---|
| 50 | \begin{methoddesc}[MH]{getcontext}{}
|
|---|
| 51 | Return the current folder name.
|
|---|
| 52 | \end{methoddesc}
|
|---|
| 53 |
|
|---|
| 54 | \begin{methoddesc}[MH]{setcontext}{name}
|
|---|
| 55 | Set the current folder name.
|
|---|
| 56 | \end{methoddesc}
|
|---|
| 57 |
|
|---|
| 58 | \begin{methoddesc}[MH]{listfolders}{}
|
|---|
| 59 | Return a list of top-level folders.
|
|---|
| 60 | \end{methoddesc}
|
|---|
| 61 |
|
|---|
| 62 | \begin{methoddesc}[MH]{listallfolders}{}
|
|---|
| 63 | Return a list of all folders.
|
|---|
| 64 | \end{methoddesc}
|
|---|
| 65 |
|
|---|
| 66 | \begin{methoddesc}[MH]{listsubfolders}{name}
|
|---|
| 67 | Return a list of direct subfolders of the given folder.
|
|---|
| 68 | \end{methoddesc}
|
|---|
| 69 |
|
|---|
| 70 | \begin{methoddesc}[MH]{listallsubfolders}{name}
|
|---|
| 71 | Return a list of all subfolders of the given folder.
|
|---|
| 72 | \end{methoddesc}
|
|---|
| 73 |
|
|---|
| 74 | \begin{methoddesc}[MH]{makefolder}{name}
|
|---|
| 75 | Create a new folder.
|
|---|
| 76 | \end{methoddesc}
|
|---|
| 77 |
|
|---|
| 78 | \begin{methoddesc}[MH]{deletefolder}{name}
|
|---|
| 79 | Delete a folder -- must have no subfolders.
|
|---|
| 80 | \end{methoddesc}
|
|---|
| 81 |
|
|---|
| 82 | \begin{methoddesc}[MH]{openfolder}{name}
|
|---|
| 83 | Return a new open folder object.
|
|---|
| 84 | \end{methoddesc}
|
|---|
| 85 |
|
|---|
| 86 |
|
|---|
| 87 |
|
|---|
| 88 | \subsection{Folder Objects \label{mh-folder-objects}}
|
|---|
| 89 |
|
|---|
| 90 | \class{Folder} instances represent open folders and have the following
|
|---|
| 91 | methods:
|
|---|
| 92 |
|
|---|
| 93 |
|
|---|
| 94 | \begin{methoddesc}[Folder]{error}{format\optional{, ...}}
|
|---|
| 95 | Print an error message -- can be overridden.
|
|---|
| 96 | \end{methoddesc}
|
|---|
|
|---|
