Skip to content

Latest commit

 

History

History
217 lines (141 loc) · 5.8 KB

message-personalization.md

File metadata and controls

217 lines (141 loc) · 5.8 KB
title up
Message personalization
../customize.md#customizing-sympa-services

Message personalization

How it works

(Work in progress)

List of template variables

Following TT2 template variables in the message body and/or message footer/header will be extracted.

  • [% listname %]

    Name of the list.

  • [% domain %]

    Mail domain name of the list.

    Note

    • On Sympa prior to 6.2.54, [% robot %] may be used.

  • [% wwsympa_url %]

    URL prefix of web interface, if enabled.

  • [% headers %]

    A hash array containing some header fields of original message.

    • [% headers.date %]

    • [% headers.from %]

    • [% headers.subject %]

    • [% headers.to %]

    • [% headers.item('content-type') %]

    • [% headers.item('message-id') %]

      Values of header fields. These are unfolded but not decoded (see also [% subject %] below).

    Additionally, following less useful fields are also provided, if the message has them.

    • [% headers.item('thread-topic') %]
    • [% headers.item('x-original-to') %]
    • [% headers.item('x-originating-ip') %]

  • [% part %]

    A hash array containing the MIME information of original message (if it is single-part) or the current part (if the message consists of multiple MIME parts).

    • [% part.description %]

      Value of Content-Description field, decoded.

    • [% part.disposition %]

      Value of Content-Disposition field without options, lowercased.

    • [% part.encoding %]

      MIME body encoding, i.e. the value of Content-Transfer-Encoding field, lowercased.

    • [% part.type %]

      MIME type, i.e. the effective value of Content-Type field without options, lowercased.

  • [% subject %]

    Decoded subject of original message.

  • [% user %]

    A hash array containing the information of the subscriber.

    • [% user.email %]

      E-mail address.

    • [% user.gecos %]

      Display name.

    • [% user.bounce %]

    • [% user.bounce_address %]

    • [% user.bounce_score %]

      Bounce information, if the subscriber is bouncing.

    • [% user.inclusion %]

    • [% user.inclusion_ext %]

    • [% user.inclusion_label %]

      Information of inclusion (Sympa 6.2.45b or later).

      Note

      • On Sympa 6.2.44 or earlier, use [% user.included %] that has true value if the subscriber is included.

    • [% user.subscribed %]

      True value if the subscriber has been added manually, i.e. with subscription request by the member or addition by the list administrator.

    • [% user.suspend %]

    • [% user.startdate %]

    • [% user.enddate %]

      Information about suspension, if the subscriber is suspended.

    • [% user.reception %]

      The reception mode. See also "Message reception modes".

    • [% user.topics %]

      Selected message topics. See also "Message topics".

    • [% user.visibiity %]

      Visibility mode, i.e. whether the subscriber is listed in the list review page or not. Either noconceal or conceal.

    • [% user.date %]

      Unix time of addition.

    • [% user.update_date %]

      Unix time of the last update.

    • [% user.number_messages %]

      Number of messages this subscriber has sent through this list.

    • [% user.custom_attribute.<id>.value %]

      Custom attributes if any. See also "Custom user attributes".

Obsoleted template variables

These variables were obsoleted.

  • [% user.escaped_email %]

    Preferred: [% user.email | uri %]

  • [% user.friendly_date %]

    Preferred: [% user.date | optdesc('unixtime') %]

Examples

Adding unsubscription links

This is an example of an application of message personalization feature.

Add a file named message_footer to the list directory with following content:

Click here to unsubscribe: [% 'auto_signoff' | url_abs([listname],{email=>user.email}) %]

And set these list parameters:

Then, each time a message is sent to the list, this file will be converted and allow to display the following text at the bottom of each message:

Click here to unsubscribe: https://web.example.org/sympa/auto_signoff/mylist?email=bob.mcbob%40domain.tld

Note

  • On Sympa earlier than 6.2.60:

    • personalization_feature parameter was named "merge_feature".
    • personalization.mail_apply_on was not required (not implemented).

  • On Sympa earlier than 6.2.42:

  • The line above is an example for Sympa 6.2 later than Aug 2016. With earlier versions it should be:

    Click here to unsubscribe: [% wwsympa_url %]/auto_signoff/[% listname %]/[% user.escaped_email %]