Message Tracking documentation

To use the Tracking module, you first need to enable the merge_feature on your list.

When the merge_feature is enabled, the Tracking tab will be displayed in the Admin web interface. This will display the details for any tracked messages.

To send a tracked message, you need to add three specific items of TT2 code to the message.

Add the Plugin

In all cases, you should start the message by including the Tracking plugin.

[% USE Tracking -%]

Add the Read-track item

This should be done once (and only once) in the message, at any point after the USE statement. Generally, you should place it somewhere right at the end of the message.

[% Tracking.base -%]

Indicate trackable links, if any

This is optional, and can be done any number of times after the USE statement. You should not place any other FILTER, INCLUDE or PROCESS directives within the trackable section.

[% FILTER Tracking -%]
... place your message and any embedded HTML links in here ...
[% END -%]

Create an Unsubscribe link

You can generate an unsubscribe link as a URL, or by using a special function. The special function will generate a visible URL if the message is viewed in a non-HTML-capable mail reader, and a clickable link otherwise. You should make sure that your Unsubscribe URL is not inside the FILTER block, else it will not work.

If you do not wish to receive this message, then you can [% Tracking.unsubscribe('Unsubscribe') %].

If you do not wish to receive this message, then click <A href=[% wwsympa_url %]/auto_signoff/[% listname %]/[% user.escaped_email %]>here</A>


[% USE Tracking -%]
Hello, [% user.gecos %]!
[% FILTER Tracking -%]
This is a wonderful offer for you to purchase. Simply click <A href=>here</A> to buy our all-new Chocolate Fireguards!
[% END -%]
To be removed from this list, click <A href=[% wwsympa_url %]/auto_signoff/[% listname %]/[% user.escaped_email %]>here</A>
[% Tracking.base -%]

In this example, the link is tracked, but the unsubscribe link is not. It also keeps track of message views, thanks to the Tracking.base at the end. Note that only HTML links (IE, the HREF in an A tag) are modified and tracked; a URL simply placed in text is not modified.

Top of page