Package README (CVS ver. 1.16)

PortalTransport

    PortalTransport provides a subscription service for CMF content types. It
    offers:

        * processing of inbound e-mail for subscription purposes

    * delivery of e-mail to subscribers

        * a set of customizable templates for subscription process


Prerequisites:

    Zope 2.6.2+ (www.zope.org)

    CMF 1.4.2+ (cmf.zope.org)

    Plone 2+ (www.plone.org)

    ArcheTypes 1.2.5 (http://sourceforge.net/projects/archetypes/)

    CMFFormController (http://sourceforge.net/projects/collective/)

    email (for python2.1 http://mimelib.sourceforge.net/)

    stripogram http://www.zope.org/Members/chrisw/StripOGram


Setting up receiving of mail

  1) If you want to use a MailTransport, you must first install the
  gateway-script
  'mailloader.py' as root in a location of the mail-server where your MTA can
  execute it (Note: In some secured sendmail-installations this could be
  '/etc/smrsh'). Then you  must add a new alias in the '/etc/aliases' (or
  '/etc/postfix/aliases' or whatever the name of your MTA-alias-file is) and
  run 'newaliases'. Your new alias with 'foo' as your
  mailinglist-email-address-name should look like:

  foo: "|mailloader.py http://ZopeServer:Port/PloneSite/portal_mailtransport/de-
  liver [maxBytes]"

  2) another way install SMTPService http://dev.legco.biz/products/smtpservice/

Editing subscription templates

  Default templates are provided for the subscription process. You can modify
  these templates
  through the Plone Control Panel to suit your needs.

  The subject line is a TALES expression. To translate text into other
  languages, use

    python:here.translate('Your message.', 'i18ndomain')

  where i18ndomain is optional. If not specified, the PortalTransport domain is
  used.

  The body is a page template. Translate text using regular TAL notation. The
  first line should
  indicate the i18n domain:

    <tal:block i18n:domain="your domain here">

  These variables can be used in the text:

    options/content     - content object providing subscription

    options/content_title   - title of object providing subscription

    options/content_url     - url of object providing subscription

    options/content_email   - email address of object providing subscription

    options/subscribe_url       - URL to subscribe to object

    options/confirm_url         - URL to confirm subscribe / unsubscribe
    request for anonymous

    options/unsubscribe_url     - URL to unsubscribe from object

    options/email       - email address of subscriber

    options/fullname        - name of subscriber

    options/member      - member object; None if person is anonymous

    options/portal      - portal instance

    options/portal_url      - portal url

    options/portal_email    - portal email address

    options/portal_email_from   - portal administrator name


  Simple Mail Template:

    This template uses python. so you can refer to any options key.

  DTML Mail Template:

    This template uses DTMLMethod for rendering template. So you can
    refer any option key as dtml var.

Bugs

   Report bugs to sf.net/projects/collective, using the PortalTransport
   category.