collective.MockMailHost 0.9

Integration

Example how to integrate collective.MockMailHost to your testing setup based on plone.app.testing. Add the package to your extras_requires section in your package’s setup.py file, so buildout will automatically download the package for you.:

setup(name='my.package',
      ...
      extras_require={
        'test': [
            'plone.app.testing',
            'collective.MockMailHost',
        ]
      },
      ...
      )

Your test layer setup could look like this example below:

from plone.app.testing import helpers, layers
from plone.testing import z2


class MyLayer(helpers.PloneSandboxLayer):
    defaultBases = (layers.PLONE_FIXTURE, )

    def setUpZope(self, app, configurationContext):
        # Load zcml
        import collective.MockMailHost
        self.loadZCML(package=collective.MockMailHost)

        # Install product and call its initialize() function
        z2.installProduct(app, 'collective.MockMailHost')

        # Note: you can skip this if my.product is not a Zope 2-style
        # product, i.e. it is not in the Products.* namespace and it
        # does not have a <five:registerPackage /> directive in its
        # configure.zcml.

    def tearDownZope(self, app):
        # Uninstall product
        z2.uninstallProduct(app, 'collective.MockMailHost')

        # Note: Again, you can skip this if my.product is not a Zope 2-
        # style product

    def setUpPloneSite(self, portal):
        helpers.quickInstallProduct(portal, 'collective.MockMailHost')

        helpers.applyProfile(portal, 'collective.MockMailHost:default')

MY_FIXTURE = MyLayer()

Validate mailhost replacement

>>> self.portal.MailHost
<MockMailHost at ...>

>>> from Products.CMFCore.utils import getToolByName
>>> getToolByName(self.portal, 'MailHost')
<MockMailHost at ...>

>>> from zope.component import getUtility
>>> from Products.MailHost.interfaces import IMailHost
>>> getUtility(IMailHost)
<MockMailHost at ...>

Send email

>>> to = "member@example.com"
>>> from = "admin@example.com"
>>> msg = """
...
... Dear Sir:
...
... Thank you"""
>>> self.portal.MailHost.send(msg, to, from)
>>> len(self.portal.MailHost.messages)
1
>>> print self.portal.MailHost.messages[0].as_string()
...
To: member@example.com
From: admin@example.com
...
>>> print self.portal.MailHost.messages[0].as_string()
...
Dear Sir:
...
>>> self.portal.MailHost.reset()
>>> len(self.portal.MailHost.messages)
0

0.9 (2015-07-10)

• Clean up msg before sending. Otherwise Plone self registration email does not work [sureshvv]

0.8 (2015-06-13)

• Add browser view for functional testing [Casecarsid]

0.7 (2013-07-05)

• MANIFEST [sureshvv]

0.6 (2013-07-03)

• Track msg_type also. [sureshvv]

• Behave more like collective.testcaselayer’s MockMailHost. [saily]

• Documentation updates [saily]

0.5 - 2012-09-25

• Remove ZopeSkel and Paster dependency from setup.py [saily]

• Moved to github and changed to README.rst, links in setup.py [saily]

• Allow multiple paramters for send and secureSend method in MockMailHost class. [saily]

0.4 (2011-05-17)

• Register MockMailHost in SiteManager to get MockMailHost when using getToolByName(context, 'MailHost') or getUtility(IMailHost). [saily]

• Inherit from MailHost instead of SimpleItem [saily]

• Implement the secureSend method [saily]

0.3 (2011-04-04)

• Add **kwargs to MockMailHost’s send method to support mto, mfrom, … keyword arguments as default MailHost does. [saily]

• Added file for generic setup various handlers [sureshvv]

0.2 (2010-05-21)

• Added tests [sureshvv]

0.1 (2010-05-16)

• Initial release [sureshvv]