PHPackages                             blueways/bw-email - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. blueways/bw-email

ActiveTypo3-cms-extension[Mail & Notifications](/categories/mail)

blueways/bw-email
=================

TYPO3 extension for sending responsive email templates

v3.0.0(2y ago)04.9k[3 issues](https://github.com/maikschneider/bw_email/issues)1GPL-2.0-or-laterPHP

Since Feb 1Pushed 2y ago1 watchersCompare

[ Source](https://github.com/maikschneider/bw_email)[ Packagist](https://packagist.org/packages/blueways/bw-email)[ RSS](/packages/blueways-bw-email/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (1)Dependencies (8)Versions (32)Used By (1)

Responsive email extension for TYPO3
====================================

[](#responsive-email-extension-for-typo3)

This is the offical documentation of the bw\_email extension.

About
-----

[](#about)

You can use this extension to send whole pages or any other element that has a TCA definition.

The templates are parsed with [Zurb Foundation Inky](https://foundation.zurb.com/emails.html). You can use the Inky markup in your fluid templates to generate the table markup needed for most mail clients.

Installation
------------

[](#installation)

- Require via composer `composer require blueways/bw-email`
- Activate in Extension Manager
- Include static TypoScript template

Templates
---------

[](#templates)

The extensions offers some default templates located in `ÈXT:bw_email/Resources/Private/Templates`. You can override the templates by setting the paths via constants:

```
plugin.tx_bwemail {
    view {
        templateRootPath =
        partialRootPath =
        layoutRootPath =
    }
}

```

Default mail settings
---------------------

[](#default-mail-settings)

To register new templates, use TypoScript setup:

```
plugin.tx_bwemail {
    settings {
        # Remove all default templates
        templates >
        templates {
            TemplateFileName = Title of Template
        }

        # Default setup
        css = EXT:bw_email/Resources/Public/Css/app.css
        senderAddress = noreply@example.com
        senderName = Example sender name
        replytoAddress =
        subject = Example subject
        template = Default
        showUid = 1
        recipientAddress =
    }
}

```

Data sources
------------

[](#data-sources)

Right from the start you can send single Emails to an email address from inside the email wizard. If you like to send emails to multiple people, you can create a Email data source entry and select one of the following build-in connectors:

- fe\_users
- CSV file (upcoming)

Usage in other extensions
-------------------------

[](#usage-in-other-extensions)

You can use the `Blueways\View\EmailView` in your own extension to render responsive email HTML with Inky syntax. It works just like the `StandaloneView`.

Extend
------

[](#extend)

You can use the DataSource-Provider or create your own ContactProvider.

### DataSource model

[](#datasource-model)

If you like to configure your source via Backend, you can use the existing DataSource model. Create your own Model by extending the `ContactSource` Model and implement the `getContacts()` method.

Don't forget to register the inheritance via typoscript:

```
config.tx_extbase.persistence.classes {
    Blueways\BwEmail\Domain\Model\ContactSource {
        subclasses {
            Vendor\Extension\YourModel = Vendor\Extension\YourModel
        }
    }

    Vendor\Extension\YourModel.mapping {
        recordType = Vendor\Extension\YourModel
        tableName = tx_bwemail_domain_model_contactsource
    }
}

```

### ContactProvider service

[](#contactprovider-service)

If you like to use external data, you can write your own ContactProvider. Just extend from `Blueways\BwEmail\Service\ContactProvider` and register the class via Hook:

Known issues
============

[](#known-issues)

- CSS files need to be hard coded in email template (see Default.html)
- Inline RTE links are wrapped with an additional `` that causes line breaks
- Internal links may be broken

Usage in other content elements
===============================

[](#usage-in-other-content-elements)

It is possible to use the email wizard in other content elements like Textmedia or News: Just add an element with the TCA-RenderType "sendMailButton". Here is an example of how to add a Send Mail button to tt\_content elements:

```
// TCA/Overrides/tt_content.php