Package buildbot :: Package util :: Module maildir :: Class MaildirService

Class MaildirService

 twisted.application.service.Service --+    
                                       |    
twisted.application.service.MultiService --+
                                           |
                                          MaildirService

Known Subclasses:

I watch a maildir for new messages. I should be placed as the service child of some MultiService instance. When running, I use the linux dirwatcher API (if available) or poll for new files in the 'new' subdirectory of my maildir path. When I discover a new message, I invoke my .messageReceived() method with the short filename of the new message, so the full name of the new file can be obtained with os.path.join(maildir, 'new', filename). messageReceived() should be overridden by a subclass to do something useful. I will not move or delete the file on my own: the subclass's messageReceived() should probably do that.

Instance Methods

__init__(self, basedir=None)
Create the Maildir watcher.

source code

setBasedir(self, basedir)

source code

startService(self)

source code

dnotify_callback(self)

source code

stopService(self)

source code

poll(*args, **kwargs)

source code

moveToCurDir(self, filename)
Call this from messageReceived to start processing the message; this moves the message file to the 'cur' directory and returns an open file handle for it.

source code

messageReceived(self, filename)
Process a received message.

source code

Inherited from twisted.application.service.MultiService: __iter__, __provides__, addService, getServiceNamed, privilegedStartService, removeService

Inherited from twisted.application.service.Service: __getstate__, __providedBy__, disownServiceParent, setName, setServiceParent

Class Variables

pollinterval = 10

Inherited from twisted.application.service.MultiService: __implemented__

Inherited from twisted.application.service.Service: name, parent, running

Method Details

init(self, basedir=None)
(Constructor)

source code

Create the Maildir watcher. BASEDIR is the maildir directory (the one which contains new/ and tmp/)

Overrides: twisted.application.service.MultiService.__init__

startService(self)

source code

Overrides: twisted.application.service.Service.startService

stopService(self)

source code

Overrides: twisted.application.service.Service.stopService

poll(*args, **kwargs)

source code

Decorators:

@defer.deferredGenerator

moveToCurDir(self, filename)

source code

Call this from messageReceived to start processing the message; this moves the message file to the 'cur' directory and returns an open file handle for it.

Parameters:

filename - unqualified filename of the message

Returns:

open file

messageReceived(self, filename)

source code

Process a received message. The filename is relative to self.newdir. Returns a Deferred.

Class MaildirService

__init__(self, basedir=None) (Constructor)

startService(self)

stopService(self)

poll(*args, **kwargs)

moveToCurDir(self, filename)

messageReceived(self, filename)

init(self, basedir=None)
(Constructor)