<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"mh-folder-objects.html" />
<link rel=
"prev" href=
"module-mhlib.html" />
<link rel=
"parent" href=
"module-mhlib.html" />
<link rel=
"next" href=
"mh-folder-objects.html" />
<meta name='aesop' content='information'
/>
<title>12.5.1 MH Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"12.5 mhlib "
href=
"module-mhlib.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"12.5 mhlib "
href=
"module-mhlib.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"12.5.2 Folder Objects"
href=
"mh-folder-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-mhlib.html">12.5 mhlib
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-mhlib.html">12.5 mhlib
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"mh-folder-objects.html">12.5.2 Folder Objects
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION0014510000000000000000"></A><A NAME=
"mh-objects"></A>
<tt class=
"class">MH
</tt> instances have the following methods:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3975' xml:id='l2h-
3975'
class=
"method">error
</tt></b>(
</nobr></td>
<td><var>format
</var><big>[
</big><var>, ...
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Print an error message - can be overridden.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3976' xml:id='l2h-
3976'
class=
"method">getprofile
</tt></b>(
</nobr></td>
<td><var>key
</var>)
</td></tr></table></dt>
Return a profile entry (
<code>None
</code> if not set).
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3977' xml:id='l2h-
3977'
class=
"method">getpath
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return the mailbox pathname.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3978' xml:id='l2h-
3978'
class=
"method">getcontext
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return the current folder name.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3979' xml:id='l2h-
3979'
class=
"method">setcontext
</tt></b>(
</nobr></td>
<td><var>name
</var>)
</td></tr></table></dt>
Set the current folder name.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3980' xml:id='l2h-
3980'
class=
"method">listfolders
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return a list of top-level folders.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3981' xml:id='l2h-
3981'
class=
"method">listallfolders
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return a list of all folders.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3982' xml:id='l2h-
3982'
class=
"method">listsubfolders
</tt></b>(
</nobr></td>
<td><var>name
</var>)
</td></tr></table></dt>
Return a list of direct subfolders of the given folder.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3983' xml:id='l2h-
3983'
class=
"method">listallsubfolders
</tt></b>(
</nobr></td>
<td><var>name
</var>)
</td></tr></table></dt>
Return a list of all subfolders of the given folder.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3984' xml:id='l2h-
3984'
class=
"method">makefolder
</tt></b>(
</nobr></td>
<td><var>name
</var>)
</td></tr></table></dt>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3985' xml:id='l2h-
3985'
class=
"method">deletefolder
</tt></b>(
</nobr></td>
<td><var>name
</var>)
</td></tr></table></dt>
Delete a folder - must have no subfolders.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3986' xml:id='l2h-
3986'
class=
"method">openfolder
</tt></b>(
</nobr></td>
<td><var>name
</var>)
</td></tr></table></dt>
Return a new open folder object.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"12.5 mhlib "
href=
"module-mhlib.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"12.5 mhlib "
href=
"module-mhlib.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"12.5.2 Folder Objects"
href=
"mh-folder-objects.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-mhlib.html">12.5 mhlib
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-mhlib.html">12.5 mhlib
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"mh-folder-objects.html">12.5.2 Folder Objects
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.