radiant-database-mailer-extension

KO | EN

gitlite — search

#python #typescript #llm #go #android #rust #linux #windows #awesome #kubernetes #vue #pytorch #mcp #openai

radiant-database-mailer-extension

(★ 20)

Save fields from mailer forms to the database.

radiant-database-mailer-extension Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Database Mailer
===

About
---

A [Radiant][rd] Extension by [Aissac][ai] that adds database persistence to emailed forms. It works on top of the Radiant [Mailer Extension][rme] and the fields recorded to the database are user defined. The extension adds a tab to the Radiant admin interface allowing you to browse saved records.

Tested on Radiant 0.7.1, 0.8 and 0.9 RC1.

Check out the [screencast][rce]

Features
---

* Save posted form fields and entire mail message to the database
* Save e-mail attachments using paperclip
* Configurable save-to-database for mailer forms
* Add fields to be saved without loosing data
* Admin interface to browse saved records
* Export data to CSV and XLS

Important Notice!
---

The git branches on this repository hold stable versions of the extension for older versions of Radiant CMS. For example the _0.8_ branch is compatible with Radiant 0.8.

To checkout one of these branches:

git clone git://github.com/Aissac/radiant-database-mailer-extension.git vendor/extensions/database_mailer
 cd vendor/extensions/database_mailer
 git checkout -b <branch-name> origin/<remote-branch-name>

As an example if you're working on Radiant 0.8 you will need to checkout the 0.8 branch:
    
    cd vendor/extensions/database_mailer
    git checkout -b my_branch origin/0.8

Installation
---

Radiant Database Mailer Extension has three dependecies, the Radiant Mailer Extension, the `will_paginate` gem/plugin and the `paperclip` gem/plugin

Install the `mailer` extension:

git clone git://github.com/radiant/radiant-mailer-extension.git vendor/extensions/mailer

###Note

At the time being you will need Aissac's version of the [Radiant Mailer Extension][arme], as it incorporates sending e-mails with attachments.

the `will_paginate` gem/plugin:

git clone git://github.com/mislav/will_paginate.git vendor/plugins/will_paginate
    
or

sudo gem install will_paginate

and the `paperclip` gem/plugin

git clone git://github.com/thoughtbot/paperclip.git vendor/plugins/paperclip

sudo gem install paperclip

Next edit `config/environment.rb` and add desired fields to be recorded:

DATABASE_MAILER_COLUMNS = {
      :name => :string,
      :message => :text,
      :email => :string
    }

And finally add the [Database Mailer Extension][rdme]:

git clone git://github.com/Aissac/radiant-database-mailer-extension.git vendor/extensions/database_mailer

Migrate and update the extension:

rake radiant:extensions:database_mailer:migrate
    rake radiant:extensions:database_mailer:update

Configuration
---

Adding fields to the `DATABASE_MAILER_COLUMNS` hash and re-running `rake radiant:extensions:database_mailer:migrate` nondestructively adds fields to be saved. Fields removed from the hash are not deleted.

Look at the Mailer Extension README for information on how to configure mail delivery.

If you set `save_to_database` to false in the Mailer config, saving to the database is skipped and just mail delivery takes place. Example (in the `mailer` page part):

subject: From the website of Whatever
    from: noreply@example.com
    redirect_to: /contact/thank-you
    save_to_database: false
    recipients:
      - one@one.com
      - two@two.com

Any attachments that the e-mail might have will be saved on the file system. They can be downloaded from the details page of every record.

If you want to take advantage of the blob field you need to create a `email` page part. The blob field keeps the sent version of the email.

Fields that are not specified by `DATABASE_MAILER_COLUMNS` are silently ignored.

Usage
---

Create your Mailer pages and make sure to use the same field names:

<r:mailer:form>
 <label for="name">Name:</label> 
 <r:mailer:text name="name" />

<label for="email">Email:</label> 
 <r:mailer:text name="email" /> 
 
 <label for="message">Message:</label> 
 <r:mailer:textarea name="message" /> 
 
 <label for="attachment">Image:</label> 
 <r:mailer:file name="attachment" /> 
 
 <input type="submit" value="Send" />
 </r:mailer:form>

Create the `mailer` page part:

subject: From the website of Whatever
    from: noreply@example.com
    redirect_to: /contact/thank-you
    recipients:
      - one@one.com
      - two@two.com
      
Create an `email` page part (to take advantage of the blob field):

<r:mailer>
 Name: <r:get name="name" />
 Email: <r:get name="email" />
 Message: <r:get name="message" />
 </r:mailer>

Contributors
---

* Cristi Duma ([@cristi_duma][cd])
* Istvan Hoka ([@ihoka][ih])

[rd]: http://radiantcms.org/
[ai]: http://www.aissac.ro/
[rme]: http://github.com/radiant/radiant-mailer-extension
[arme]: http://github.com/Aissac/radiant-mailer-extension
[rdme]: http://blog.aissac.ro/radiant/database-mailer-extension/
[cd]: http://twitter.com/cristi_duma
[ih]: http://twitter.com/ihoka
[rce]:http://blog.aissac.ro/2010/03/16/episode-5-radiant-database-mailer-extension/

radiant-database-mailer-extension

radiant-database-mailer-extension Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

radiant-database-mailer-extension

radiant-database-mailer-extension Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README