[Zope3-checkins] CVS: Zope3/doc/zcml/namespaces.zope.org/mail - directService.stx:1.1 queuedService.stx:1.1 sendmailMailer.stx:1.1 smtpMailer.stx:1.1

[Stephan Richter]

Update of /cvs-repository/Zope3/doc/zcml/namespaces.zope.org/mail
In directory cvs.zope.org:/tmp/cvs-serv7874/mail

Added Files:
	directService.stx queuedService.stx sendmailMailer.stx 
	smtpMailer.stx 
Log Message:
Update ZCML directives documentation.


=== Added File Zope3/doc/zcml/namespaces.zope.org/mail/directService.stx ===
directService

  File zope/app/mail/meta.zcml, lines 11 - 15.

  This directive creates and registers a global direct mail service. It
  be only called once during startup.

  Attributes

    name -- TextLine (optional, default=u'Mail')

      Name

      Specifies the Service name of the mail service. The default is "Mail".

    permission -- TextLine (required)

      Permission

      Defines the permission needed to use this service.

    mailer -- TextLine (required)

      Mailer

      Defines the mailer to be used for sending mail.



=== Added File Zope3/doc/zcml/namespaces.zope.org/mail/queuedService.stx ===
queuedService

  File zope/app/mail/meta.zcml, lines 5 - 9.

  This directive creates and registers a global queued mail service. It
  be only called once during startup.

  Attributes

    name -- TextLine (optional, default=u'Mail')

      Name

      Specifies the Service name of the mail service. The default is "Mail".

    permission -- TextLine (required)

      Permission

      Defines the permission needed to use this service.

    mailer -- TextLine (required)

      Mailer

      Defines the mailer to be used for sending mail.

    queuePath -- Path (required)

      Queue Path

      Defines the path for the queue directory.



=== Added File Zope3/doc/zcml/namespaces.zope.org/mail/sendmailMailer.stx ===
sendmailMailer

  File zope/app/mail/meta.zcml, lines 17 - 21.

  Registers a new Sendmail mailer.

  Attributes

    id -- TextLine (required)

      Id

      Id of the Mailer.

    command -- ASCII (optional, default=None)

      Command

      A template command for sending out mail, containing %(from)s and %(to)s
      respective addresses.



=== Added File Zope3/doc/zcml/namespaces.zope.org/mail/smtpMailer.stx ===
smtpMailer

  File zope/app/mail/meta.zcml, lines 23 - 27.

  Registers a new SMTP mailer.

  Attributes

    id -- TextLine (required)

      Id

      Id of the Mailer.

    hostname -- BytesLine (optional, default='localhost')

      Hostname

      Hostname of the SMTP host.

    port -- Int (optional, default=23)

      Port

      Port of the SMTP server.

    username -- TextLine (optional, default=None)

      Username

      A username for SMTP AUTH.

    password -- TextLine (optional, default=None)

      Password

      A password for SMTP AUTH.