twisted.mail.mail.MailService(service.MultiService) class documentation

Part of twisted.mail.mail View Source (View In Hierarchy)

An email service.

Instance Variable queue A queue for outgoing messages. (type: Queue or None)
Instance Variable domains A mapping of supported domain name to domain object. (type: dict of bytes -> IDomain provider)
Instance Variable portals A mapping of domain name to authentication portal. (type: dict of bytes -> Portal)
Instance Variable aliases A mapping of domain name to alias. (type: None or dict of bytes -> IAlias provider)
Instance Variable smtpPortal A portal for authentication for the SMTP server. (type: Portal)
Instance Variable monitor A service to monitor changes to files. (type: FileMonitoringService)
Method __init__ Initialize the mail service.
Method getPOP3Factory Create a POP3 protocol factory.
Method getSMTPFactory Create an SMTP protocol factory.
Method getESMTPFactory Create an ESMTP protocol factory.
Method addDomain Add a domain for which the service will accept email.
Method setQueue Set the queue for outgoing emails.
Method requestAvatar Return a message delivery for an authenticated SMTP user.
Method lookupPortal Find the portal for a domain.
Method defaultPortal Return the portal for the default domain.

Inherited from MultiService:

Method privilegedStartService Do preparation work for starting the service.
Method startService Start the service.
Method stopService Stop the service.
Method getServiceNamed Get the child service with a given name.
Method __iter__ Get an iterator over all child services.
Method addService Add a child service.
Method removeService Remove a child service.

Inherited from Service (via MultiService):

Method __getstate__ Undocumented
Method setName Set the name of the service.
Method setServiceParent Set the parent of the service. This method is responsible for setting the parent attribute on this service (the child service).
Method disownServiceParent Use this API to remove an IService from an IServiceCollection.
queue =
A queue for outgoing messages. (type: Queue or None)
domains =
A mapping of supported domain name to domain object. (type: dict of bytes -> IDomain provider)
portals =
A mapping of domain name to authentication portal. (type: dict of bytes -> Portal)
aliases =
A mapping of domain name to alias. (type: None or dict of bytes -> IAlias provider)
smtpPortal =
A portal for authentication for the SMTP server. (type: Portal)
monitor =
A service to monitor changes to files. (type: FileMonitoringService)
def __init__(self): (source)
overrides twisted.application.service.MultiService.__init__

Initialize the mail service.

def getPOP3Factory(self): (source)

Create a POP3 protocol factory.

ReturnsA POP3 protocol factory. (type: POP3Factory)
def getSMTPFactory(self): (source)

Create an SMTP protocol factory.

ReturnsAn SMTP protocol factory. (type: SMTPFactory)
def getESMTPFactory(self): (source)

Create an ESMTP protocol factory.

ReturnsAn ESMTP protocol factory. (type: ESMTPFactory)
def addDomain(self, name, domain): (source)

Add a domain for which the service will accept email.

ParametersnameA domain name. (type: bytes)
domainA domain object. (type: IDomain provider)
def setQueue(self, queue): (source)

Set the queue for outgoing emails.

ParametersqueueA queue for outgoing messages. (type: Queue)
def requestAvatar(self, avatarId, mind, *interfaces): (source)

Return a message delivery for an authenticated SMTP user.

ParametersavatarIdA string which identifies an authenticated user. (type: bytes)
mindUnused. (type: None)
interfacesA group of interfaces one of which the avatar must support. (type: n-tuple of zope.interface.Interface)
ReturnsA tuple of the supported interface, a message delivery, and a logout function. (type: 3-tuple of (1) IMessageDelivery, (2) ESMTPDomainDelivery, (3) no-argument callable)
RaisesNotImplementedErrorWhen the given interfaces do not include IMessageDelivery.
def lookupPortal(self, name): (source)

Find the portal for a domain.

ParametersnameA domain name. (type: bytes)
ReturnsA portal. (type: Portal)
def defaultPortal(self): (source)

Return the portal for the default domain.

The default domain is named ''.

ReturnsThe portal for the default domain. (type: Portal)
API Documentation for Twisted, generated by pydoctor at 2018-07-14 04:53:34.