Lyris User's Guide
[previous] [next] [contents]
Recipient Fields
Table of Contents
· Introduction
· Email Commands
· Web Interface for Users
· Server Administrator
· Site Administrator
· List Administrator
· Other Topics
· · Security Considerations
· · Security Issues Relating to Members
· · Lyris List Manager Mail Merge
· · · How can I use the Mail merge feature?
· · · Where can I use the Mail merge tags?
· · · · Recipient Fields
· · · · Member Fields
· · · · List fields
· · · · Site fields
· · · · Email Address fields
· · · · Incoming Mail fields
· · · · Date Field
· · · · Http Fetch Field
· · The Lyris List Manager command line
· · Modifying lyris.plc
· Add-On Packages
· Installing and Upgrading
· Appendix
· Frequently Asked Questions

Recipient Fields

The following mail merge fields are substituted on the fly, for each recipient as each message is delivered.

$subst('Recip.nameemail')
The full name and email address of the recipient. For example, you might want each posting to your list to have a header which identifies the original author, as in:

    From: $subst('Recip.nameemail')

If a full name is not available, Lyris List Manager will only put the email address.

For example:

    Bob Smith <bob@somewhere.com>

Or if no name is available:

    bob@somewhere.com

$subst('Recip.EmailAddr')
This substitutes in the recipients' email address.

For example, you might make your list header be:

    To: $subst('Recip.EmailAddr')

    You may be interested to know….

And Lyris List Manager would substitute it to say:

    To: bob.smith@somewhere.com

    You may be interested to know….

$subst('Recip.FullName')
This substitutes in the recipients' full name. If the member does not have a full name, their email address is used instead.

For example, you might start your mailing out with this:

    Dear $subst('Recip.FullName'), we are glad that you have…

And Lyris List Manager would substitute it to say:

    Dear Bob Smith, we are glad that you have…

$subst('Recip.password')
The password of this recipient. This is an effective way to inform the user of their password, particularly if your list is set to use 'random' passwords.

$subst('Recip.FirstName')
This substitutes in the recipients' first name (the first component of their full name). If the member does not have a full name, their email address is used instead. If a member only has a single component to their name, that component is used.

For example, you might start your mailing out with this:

    Dear $subst('Recip.FirstName'), we are glad that you have…

And Lyris List Manager would substitute it to say:

    Dear Bob, we are glad that you have…

$subst('Recip.MemberID')
This substitutes in the recipients' unique Member ID. This is useful for exactly identifying the user.

$subst('Recip.list')
The name of the mailing list this recipient is receiving this message from.

$subst('Recip.receiveack')
Whether or not this recipient receives acknowledgements of their postings.

$subst('Recip.subtype')
The type of subscription this recipient has.

$subst('Recip.expiredate')
The date (if any) that this recipient's subscription expires.

$subst('recip.whatlists')

This substitutes in a listing of all the lists the recipient is a member of. This is very useful when you want to let users know exactly which lists they have signed up for. It is important to note that this tag only shows those lists where the member's status is "normal". In otherwords, if a list the member has subscribed to is set to require confirmation, and the member has not confirmed, the list will not show up in this listing.

For example, you may want to use this merge tag in the confirmation document:

    Welcome! You have signed up for the following lists:

    $subst('recip.whatlists')

    By replying to this message, you confirm...

An excellent opportunity for the above example is when a member signs up for many lists at once and they are sent a single confirmation document. That way, rather than receiving a confirmation for each list, they receive a single confirmation with a listing of the lists.

$subst('recip.whatlistsunconfirmed')

This substitutes a listing of all the lists the recipient has subscribed to, but has not yet sent confirmation for. This is particularly useful when adding a member to many lists and you want to send them a single confirmation that shows the lists they have not yet confirmed on.

For example, you may want to use this merge tag in the confirmation document:

    Welcome! Your confirmation is needed for the following lists:

    $subst('recip.whatlistsunconfirmed')

    By replying to this message, you will confirm yourself for all of these lists...

A good opportunity to use this tag is when you have subscribed someone to many lists at once using the 'Add' command in a command message. In that command message, you also specified that the member should receive a single confirmation message by using the oneconfirm modifier.

$subst('PurgeID')
This substitutes in the Recipient's email address, in square brackets. If this text is forwarded to the unsubscribe-listname@… or purge@… address, Lyris List Manager will automatically locate it and unsubscribe this address. This allows you to provide a failsafe unsubscribe mechanism. For example, a typical list footer might be:

    This is a posting from: $subst('List.Name')

    To unsubscribe, forward this message to $subst('Email.UnSub')

    $subst('PurgeID')

$subst('Outmail.MessageID')
This substitutes in the message's unique ID. This is useful for exactly identifying the message.

For example, if you sent the following message to a mailing list:

    Hello! Your email address is $subst('Recip.EmailAddr'), your member ID is $subst('Recip.MemberID') and the ID of this message is $subst('Outmail.MessageID').

To the person who received the message, it might look like this:

    Hello! Your email address is bob@somewhere.com, your member ID is 905 and the ID of this message is 3154.

$subst('Recip.datejoined')
The date that this recipient joined this mailing list.

$subst('Recip.numbounces')
The number of bounces this recipient has produced in recent days.

$subst('Recip.datebounce')
The date of the most recent bounce received from this recipient.

$subst('Recip.islistadm')
Whether or not this recipient is a list administrator.

$subst('Recip.confirmdat')
The date (if any) that this recipient confirmed their membership. Only applies to lists where "confirm membership: yes" is set.

$subst('Recip.notifyerr')
Whether or not this recipient receives error mail notifications (i.e., bounce reports).

$subst('Recip.dateheld')
If this recipient is held, what date they were held on.

$subst('Recip.webenv')
If this recipient subscribed using the web interface, the environment variables (such as browser type, TCP/IP address, referrer, etc.) that were active at that time.

$subst('Recip.norepro')
Whether or not this recipient receives copies of their own postings.

$subst('Recip.cleanauto')
Whether or not this recipient will be automatically held if they bounce too much mail.

$subst('Recip.subtopics')
The subtopics that this recipient belongs to (this feature is currently inactive).

$subst('Recip.comments')
The comments that this recipient has.

$subst('Recip.additional')
The additional information this recipient has. This field is not used by Lyris List Manager, and is meant for user-defined data of any type.

$subst('Recip.userid')
The userid information this recipient has. This field is not used by Lyris List Manager, and is meant for user-defined data of any type.

Other pages which link to this page:
  • Where can I use the Mail merge tags?
  • Significant New Features in v4.0
  • Notable Improvements in v4.0
  • New in 3.0 beta 5 (v2.548)
  • Page 444 of 629