https://github.com/collective/Products.PrintingMailHost

A monkey patch to send MailHost messages to standard out
https://github.com/collective/Products.PrintingMailHost

Last synced: 3 months ago
JSON representation

A monkey patch to send MailHost messages to standard out

• Host: GitHub
• URL: https://github.com/collective/Products.PrintingMailHost
• Owner: collective
• Created: 2013-10-21T16:04:46.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T15:59:19.000Z (over 1 year ago)
• Last Synced: 2024-04-09T22:09:28.064Z (3 months ago)
• Language: Python
• Homepage: https://pypi.org/project/Products.PrintingMailHost/
• Size: 87.9 KB
• Stars: 2
• Watchers: 116
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst

Lists

• awesome-plone - Products.PrintingMailHost - Log mail messages instead of sending mail. (Develop)

README

        
Products.PrintingMailHost

=========================

This is a hack. :)

This product, when installed, will check if Zope is running in debug mode,

and if so, monkey patch (that is, grab the internals of, squeeze tight, then

rip hard, just like monkeys do) Zope's MailHost class, meaning that *any and

all* uses of a MailHost will be "fixed" so that instead of sending mail, it

prints messages to the zope event log.

This is useful if you don't have a local mailhost for testing, or if you

prefer not to spam the crap out of yourself whilst finding out if your bulk

mail script is working.

If Zope is not running in debug mode, it will not install itself. However,

I wouldn't recommend putting it on a production site. You never know what

those monkeys may get up to...

You can optionally enable the PrintingMailHost with an environment variable

as of version 0.3.  See the installation instructions for more information

about how to use it.

Compatibility

-------------

Works on Plone 4.3, Plone 5.0, 5.1, 5.2 and 6 (in Python 2.7, and 3.6-3.11).

Author

------

Martin Aspeli 

    Initial idea, release management

Contributors

------------

Dorneles Tremea 

    Fixed to work both with old-style and new-style classes. Extended

    to also patch SecureMailBase from SecureMailHost, if available.

Clayton Parker 

Maurits van Rees 

Harald Friessnegger 

Products.PrintingMailHost Installation

======================================

To include ``Products.PrintingMailHost`` in your pip installation of Plone, just add it to ``requirements.txt``.

To install Products.PrintingMailHost into your Plone instance in

buildout, you can do this:

- Add ``Products.PrintingMailHost`` to the list of eggs to install, e.g.::

    [instance]

    ...

    eggs =

        ...

        Products.PrintingMailHost

- If you want to enable PrintingMailHost when debug-mode is off::

    [instance]

    ...

    environment-vars =

        ...

        ENABLE_PRINTING_MAILHOST True

- If you want to disable PrintingMailHost when debug-mode is on::

    [instance]

    ...

    environment-vars =

        ...

        ENABLE_PRINTING_MAILHOST False

- If PrintingMailHost is enabled, and you *additionally* want to send

  each email to a fixed address, you can add another environment

  variable::

    [instance]

    ...

    environment-vars =

        ...

        PRINTING_MAILHOST_FIXED_ADDRESS [email protected]

  Or multiple addresses separated by spaces::

        PRINTING_MAILHOST_FIXED_ADDRESS [email protected] [email protected]

  For clarity: this first prints the email, with the original

  recipient address, and then sends an actual email with the same

  contents to the fixed address you have specified.  The original

  recipient is visible in the ``To:`` field.  It is similar to

  receiving a blind carbon copy (bcc) of an email, except that the

  original recipient never gets the email.

- Re-run buildout in order to make any of the above changes active::

    $ ./bin/buildout