mhlib — Доступ к почтовым ящикам MH

Модуль mhlib предоставляет интерфейс Python для папок MH и их содержимого.

Модуль содержит три основных класса: MH, представляющий определённую коллекцию папок, Folder, представляющий отдельную папку, и Message, представляющий отдельное сообщение.

class mhlib.MH([path[, profile]])

MH представляет собой коллекцию папок MH.

class mhlib.Folder(mh, name)

Класс Folder представляет отдельную папку и её сообщения.

class mhlib.Message(folder, number[, name])

Объекты Message представляют отдельные сообщения в папке. Класс Message наследуется от mimetools.Message.

1. Объекты MH

MH экземпляры имеют следующие методы:

MH.error(format[, ...])

Вывести сообщение об ошибке — может быть переопределено.

MH.getprofile(key)

Возвращает запись профиля (None если не задана).

MH.getpath()

Возвращает путь к почтовому ящику.

MH.getcontext()

Возвращает имя текущей папки.

MH.setcontext(name)

Устанавливает имя текущей папки.

MH.listfolders()

Возвращает список папок верхнего уровня.

MH.listallfolders()

Возвращает список всех папок.

MH.listsubfolders(name)

Возвращает список непосредственных подпапок заданной папки.

MH.listallsubfolders(name)

Возвращает список всех подпапок заданной папки.

MH.makefolder(name)

Создаёт новую папку.

MH.deletefolder(name)

Удаляет папку — она не должна содержать подпапок.

MH.openfolder(name)

Возвращает новый открытый объект папки.

2. Объекты папок

Folder экземпляры представляют открытые папки и имеют следующие методы:

Folder.error(format[, ...])

Выводит сообщение об ошибке — может быть переопределено.

Folder.getfullname()

Возвращает полное имя пути папки.

Folder.getsequencesfilename()

Возвращает полное имя файла последовательностей папки.

Folder.getmessagefilename(n)

Возвращает полное имя файла сообщения n папки.

Folder.listmessages()

Возвращает список сообщений в папке (в виде номеров).

Folder.getcurrent()

Возвращает текущий номер сообщения.

Folder.setcurrent(n)

Устанавливает текущий номер сообщения на n.

Folder.parsesequence(seq)

Парсит синтаксис msgs в список сообщений.

Folder.getlast()

Получить последнее сообщение, или 0 если в папке нет сообщений.

Folder.setlast(n)

Установить последнее сообщение (только для внутреннего использования).

Folder.getsequences()

Возвращает словарь последовательностей в папке. Имена последовательностей используются в качестве ключей, а значениями являются списки номеров сообщений в последовательностях.

Folder.putsequences(dict)

Возвращает словарь последовательностей в папке имя: список.

Folder.removemessages(list)

Удаляет сообщения из списка из папки.

Folder.refilemessages(list, tofolder)

Перемещает сообщения из списка в другую папку.

Folder.movemessage(n, tofolder, ton)

Перемещает одно сообщение в указанное место назначения в другой папке.

Folder.copymessage(n, tofolder, ton)

Копирует одно сообщение в указанное место назначения в другой папке.

3. Объекты сообщений

Класс Message добавляет один метод к тем, что у mimetools.Message:

Message.openmessage(n)

Возвращает новый открытый объект сообщения (стоит файловый дескриптор).