Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/piotr-cz/mod_freshmail2

Moduł zapisu do newslettera w systemie FreshMail
https://github.com/piotr-cz/mod_freshmail2

email-marketing freshmail joomla joomla-module php

Last synced: 27 days ago
JSON representation

Moduł zapisu do newslettera w systemie FreshMail

Awesome Lists containing this project

README

        

FreshMail Subscription ![JED icon](./artwork/JED_icon.png "mod_freshmail2")
======================

[Polska dokumentacja](https://github.com/piotr-cz/mod_freshmail2/blob/master/README.md)

Module for newsletter subscription in [Freshmail](http://freshmail.com/) system

Functionality
-------------
- Custom fields management (Displaying, Required)
- New subscription notifications by email
- Option to use terms of service in form
- Layouts
- Horizontal (Bootstrap 2 / 3)
- Inline (Bootstrap 2 / 3)
- Beez (Joomla 2.5)
- Atomic (Joomla 2.5)
- Limit module Impressions or Duration or hide after registration
- Ajax (req. Joomla 3.1+)
- Subscription list selection
- Captcha integration

Requirements
------------

- Joomla 2.5+ or 3.0+
- PHP 5.3
- Account in Freshmail system

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

1. Download [latest release](https://github.com/piotr-cz/mod_freshmail2/releases/latest) and install using Extension Manager _(Extensions > Manage > Upload Package File)_.
2. Add module _(Extensions > Module Manager > New > Freshmail Subscription)_

Configuration
-------------

1. Enter Freshmail account **API Key (32 characters)** _(Options > API Key)_
2. Enter **API Secret (40 characters)** _(Options > API Secret)_
3. Select Subscribers list _(Options > Subscribers list)_

In your [freshmail.com panel](https://app.freshmail.com/pl/dashboard/index/) you may find API Key and API Secret in _Subscribers > contact list > Parameters > API keys_ or in _[Settings > Plugins and API > Your API keys](https://app.freshmail.com/en/settings/integration/)_.

### Basic options

![Basic options](./artwork/screenshots/screen-admin-opcje-podstawowe.png "Basic options")

### Advanced options

![Advanced options](./artwork/screenshots/screen-admin-opcje-wzbogacone.png "Advanced options")

### Layouts

**Vertical layout**

![Vertical layout](./artwork/screenshots/screen-site-wetykalny.png "Vertical layout")

**Horizontal layout**

![Horizontal layout](./artwork/screenshots/screen-site-horyzontalny.png "Horizontal layout")

List selection layouts
----------------------

Default layout uses _checkbox_ type. To change to other, adjust code in layout to:

**Radio**

```php

$list) : ?>

selected) : ?> checked="checked" value="subscriberListHash ?>" />
name ?>

```

**Select**

```php

$list) : ?>
selected) : ?> selected="selected">name ?>

```

**Checkbox**

```php

$list) : ?>

selected) : ?> checked="checked" value="subscriberListHash ?>" />
name ?>

```

Custom templates
----------------

Module communicates with user trough messages that use
[API Joomla](http://docs.joomla.org/Display_error_messages_and_notices).
In template there should be a code responsible for showing these:
`` as in default template Atomic.

For AJAX functionality to work in custom template, form should consist
an attribute `data-freshmail2=""`.

Authors
-------

- [piotr_cz](https://github.com/piotr-cz)

Issues/ Feature requirements
----------------------------

[Submit issue or feature requirement here](https://github.com/piotr-cz/mod_freshmail2/issues)

[Latest development snapshot](https://github.com/piotr-cz/mod_freshmail2/archive/master.zip)