ikiwiki/ plugins/ contrib/ imailhide (third party plugin)

Plugin: imailhide
Author: Peter_Vizi
Included in ikiwiki: no
Enabled by default: no
Included in goodstuff: no
Currently enabled: yes

# Mailhide Plugin for Ikiwiki

This plugin provides the directive mailhide, that uses the Mailhide API to protect email addresses from spammers.

## Dependencies

The Captcha::reCAPTCHA::Mailhide perl module is required for this plugin.

## Download

You can get the source code from github.

## Installation

Copy `imailhide.pm` to `/usr/share/perl/5.10.0/IkiWiki/Plugin` or `~/.ikiwiki/IkiWiki/Plugin`, and enable it in your `.setup` file

    add_plugins => [qw{goodstuff imailhide ....}],
    mailhide_public_key => "8s99vSA99fF11mao193LWdpa==",
    mailhide_private_key => "6b5e4545326b5e4545326b5e45453223",
    mailhide_default_style => "short",

## Configuration

### `mailhide_public_key`

This is your personal public key that you can get at Google.

### `mailhide_private_key`

This is your personal private key that you can get at Google.

### `mailhide_default_style`

As per the recommendation of the Mailhide API documentation, you can define this as `short` or `long`. The `short` parameter will result in `<a href="...">john</a>` links, while the `long` parameter will result in `joh<a href="...">...</a>@example.com`.

## Parameters

### `email`

Required. This is the email addres that you want to hide.

### `style`

Optional. You can set the style parameter individually for each `mailhide` call. See `mailhide_default_style` for details.

## Known Issues

1. opening new window when displaying email address