Package twisted :: Package coil :: Package plugins :: Module mail :: Class MailConfigurator
[frames | no frames]

Class MailConfigurator

Collection --+        
             |        
   Constrained --+    
                 |    
  ConfigCollection --+
                     |
      Configurator --+
                     |
                    MailConfigurator


Method Summary
  __init__(self, instance)
Initialize this configurator with the instance it will be configuring.
  config_name(self, name)
  config_storagePath(self, path)
  configDispensers(self)
Return list of dispensers.
  makePOP3Server(self)
  makeSMTPServer(self)
    Inherited from Configurator
  configure(self, dict)
Set a list of configuration variables.
  getConfiguration(self)
Return a mapping of key/value tuples describing my configuration.
  getInstance(self)
Return the instance being configured.
  getType(self, name)
Get the type of a configuration variable.
    Inherited from ConfigCollection
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me.
  getEntityType(self)
  getNameType(self)
    Inherited from Constrained
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name.
  putEntity(self, name, entity)
Store an entity if it meets both constraints.
  reallyPutEntity(self, name, entity)
    Inherited from Collection
  delEntity(self, name)
Remove a static reference for 'name'.
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand.
  getEntity(self, name, request)
Retrieve an entity from me.
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity.
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand.
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to.
  listEntities(self, request)
Retrieve a list of all name, entity pairs I contain.
  listNames(self, request)
Retrieve a list of all names for entities that I contain.
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to.
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to.
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'.
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'.

Class Variable Summary
tuple __implements__ = (<class twisted.coil.coil.IConfigurator...
str configName = 'Twisted Mail Service'
dict configTypes = {'serviceName': [<type 'str'>, 'Service Na...
class configurableClass = twisted.mail.mail.MailService
class entityType = twisted.mail.mail.IDomain

Method Details

__init__(self, instance)
(Constructor)

Initialize this configurator with the instance it will be configuring.
Overrides:
twisted.coil.coil.Configurator.__init__ (inherited documentation)

configDispensers(self)

Return list of dispensers.
Overrides:
twisted.coil.coil.Configurator.configDispensers (inherited documentation)

Class Variable Details

__implements__

Type:
tuple
Value:
(<class twisted.coil.coil.IConfigurator at 0x8386b34>,
 <class twisted.coil.coil.IConfigCollection at 0x8378a74>)             

configName

Type:
str
Value:
'Twisted Mail Service'                                                 

configTypes

Type:
dict
Value:
{'serviceName': [<type 'str'>, 'Service Name', ''],
 'storagePath': [<type 'str'>,
                 'Storage Path',
                 'Folder where messages will be stored.']}             

Generated by Epydoc 2.0 on Sat Sep 13 04:21:00 2003 http://epydoc.sf.net