EKM Tag Documentation - ekm:emailtofriend

This tag is used to output a button or link on the product page allowing the visitor to email a link, for the product, to a friend.

This tag can only be used on the product page.

Tag Information
Nesting This Tag

Basic Use

This tag will output a link to a popup which allows the visitor to send a link to the product they are currently viewing to a friend's email. In it's basic use the tag will output a text link which opens a popup.


[ekm:emailtofriend][/ekm:emailtofriend]

This would output something like...

Email to a Friend

Advanced Use

In it's most advanced use you can specify whether or not you want to display a button or text link as well as specify what message you want to appear in the email.


[ekm:emailtofriend]
    button='yes';
    linktext='Email to a Friend';
    message='I found this and thought of you.';
[/ekm:emailtofriend]

This would output something like...

Tag Attributes

Display As Button?

button='no'';

Specify whether or not you want to display the link as a button or a text link. When using a button you cannot place this tag between the ekm:productstart and ekm:productend tags as this will cause issues interacting with the link.

Value

Description

auto

Displays as a text link

yes

Will display as a button

Display as text link

Link/Button Text

linktext='Email To A Friend';

Define the text that will appear as a link or the text that will appear on the button.

Value

Description

{user defined}

Define the message you wish to appear on the button or link.

Email Message

message='I found this and thought of you.';

Define the message you wish to appear by default in the message field of the popup.

Value

Description

{user defined}

Define the message you wish to appear.

Background Colour

backgroundcolour='#000000';

Specify the colour you wish the background of the popup to display.

Value

Description

{user defined}

Specify a HEX code (including #) for the background colour of the popup.

The EKM system allows for some tags to be nested within other tags.

Nesting This Tag

When nesting this tag you do not need to make any alterations.


[ekm:if]
    iftype='EQUALS';
    ifvalue='1';
    ifvalue2='1';
    ifthen='[ekm:emailtofriend][/ekm:emailtofriend]';
    ifelse='';
[/ekm:if]

EKM Tag: [ekm:emailtofriend]