PDA

View Full Version : [FQuest Announce] Templates Patch for ezmlm-idx


Bruce
10-03-2006, 05:41 PM
In response to the complexities of customizing messages for multiple mailing lists (http://www.aota.net/forums/showthread.php?t=21867), we have patched ezmlm-idx to make such customizations simpler.

This patch is already in place on the servers, and will automatically apply to all lists created anew from this point forward. You need do nothing for newly created lists to take advantage of this change.

This patch allows you to create generic text files that are usable for all of your lists. It is only pertinent to those clients using the ezmlm-idx mailing list feature in their CNC (http://www.FutureQuest.net/Services/CNC/) and who also wish to customize the default text for emails sent by the list manager program.

Details regarding customizing the text files for ezmlm lists are provided in the following Knowledgebase article:
Modifying Your Mailing List (http://service.FutureQuest.net/kb141)

For further details, please visit the complete ezmlm-idx manual (http://www.ezmlm.org/manual/manual.html#SEC_Contents).

To create a new mailing lists, please visit your CNC (http://www.FutureQuest.net/Services/CNC/) and click on the "Mailing Lists" link. General information about the ezmlm-idx mailing list manager (http://www.ezmlm.org) offered in your CNC can be found in the mailing list category of our Knowledgebase (http://service.FutureQuest.net/?_a=knowledgebase&_j=subcat&_i=31).

For existing lists, if you wish to take advantage of the new patch, the following explanation provides technical details that may assist you in doing so.

Assuming your domain name is example.com, your login name is "username" and your mailing list's name is "listname", then the template files for your list reside in the directory
/big/dom/xexample/username/listname/text
These template files contain a number of tags that are substituted at the time that a message is processed by ezmlm-idx. For example, the ezmlm-idx templates use the tags <#h#> and <#H#>, which both refer to the host name of the list. On FutureQuest the hostname for a list is lists.example.com. So, any template files that contain <#h#> will have that tag replaced with lists.example.com at the time the email is sent. It does turn out that both <#h#> and <#H#> were and are replaced with the same hostname value.

However, the ezmlm-idx tags <#l#> and <#L#> were not and are not identical in all cases. The <#L#> tag refers to the base list name (whatever name you selected for your mailing list), and the <#l#> represents the modified list name (which may be either listname or listname-digest). These are not interchangeable in all cases.

Before this patch was applied, you would only ever have seen the <#l#> in the template files in the directory
/big/dom/xdomain/username/listname/text

The <#L#> tag was used at list creation time, and substituted at the time the list was created, and would not have appeared your template files, nor would it have been available for you to use in the templates files. As a result of this patch, the <#L#> tag is now available for your use. (This also applies to the tag <#H#> which was not available for your use previously in template files, but is now available to you as well.)

From now on the text files in all newly created lists will have the tags <#L#> and <#H#> left in place, instead of being substituted with the listname and hostname when the list is created. This patch will allow you to create generic text files that are usable for all of your lists.

The difference between the <#L#> (base list name) and <#l#> (modified list name) needs some explanation. Ezmlm-idx lists may have more than one list of subscriber addresses. In particular, mailing lists set up with the digest option will have a main list and a digest list. The base list name is the name the list was configured with, which is never modified. The modified list name is the actual subscriber list in use.

This means that when an email is sent to listname-digest-subscribe, for example, <#L#> will be replaced with "listname" as usual, but <#l#> will be replaced with "listname-digest". As such the text files will need to use <#L#> for addresses that are only relevant for the base list (such as listname-info listname-help listname-get.### etc), while <#l#> is needed for the subscribe addresses (such as putting "listname-unsubscribe" in the text/trailer file).

For assistance in using your mailing lists, please take advantage of these forums, and post your requests for assistance in the forums. Support for the usage and configuration of ezmlm mailing lists cannot be provided from the Service Desk.

Evoir
10-03-2006, 06:31 PM
Thank you for doing this. :)

Isn't it possible to simply create a new list, take those files and replace the ones for the old list? Am I missing something?

sheila
10-03-2006, 06:34 PM
You could do that...the new files will work with old lists. However, if you've already customized the old lists, you would lose your customized text files by doing this.

pvechi
10-04-2006, 05:34 AM
We currently have a list with the "legacy ezmlm". If we convert to ezmlm-idx will we be able to take advantage of these new changes?

Arthur
10-04-2006, 05:39 AM
We currently have a list with the "legacy ezmlm". If we convert to ezmlm-idx will we be able to take advantage of these new changes? Yes, if you convert the list a new set of templates will be created.

Before you convert your list, be sure to read the implications (listed on the conversion page in your CNC).

-Arthur

Erica C.
01-09-2007, 06:11 PM
This patch is already in place on the servers, and will automatically apply to all lists created anew from this point forward. You need do nothing for newly created lists to take advantage of this change.

This patch allows you to create generic text files that are usable for all of your lists. It is only pertinent to those clients using the ezmlm-idx mailing list feature in their CNC (http://www.FutureQuest.net/Services/CNC/) and who also wish to customize the default text for emails sent by the list manager program.

First, thanks!

If I understand correctly, modifications made once will carry over to new lists. If that's so, I may be having a problem. I made changes to the text of one list then my client created some new mailing lists and the modified messages don't seem to be there.

Any thoughts?

Erica

sheila
01-09-2007, 06:15 PM
Erica, did you download the text files for ezmlm-idx from the modified domain and then upload them to the new domain with the second list?

Erica C.
01-09-2007, 06:17 PM
I modified the text files using the CNC.

All the lists are at the same domain.

Thanks.

Erica

sheila
01-09-2007, 06:20 PM
But each list has its own private directory inside the $HOME directory, and inside the list directory is the /text directory with all the modified files. If you modify the files for one list, that does not affect the other lists. You would need to copy them over to any list for which you want to use the same text template files.

text files are located in
/big/dom/xdomain/username/listname/text

Erica C.
01-09-2007, 06:24 PM
Pardon my ignorance/cluelessness. I just copy and replace the relevant files?

Is there something else I should be doing in terms of the patch mentioned above?

Thanks,

Erica

sheila
01-09-2007, 06:36 PM
The way the text files work is explained in this Knowledgebase article:
Modifying your Mailing List (http://service.futurequest.net/index.php?_a=knowledgebase&_j=questiondetails&_i=141&nav=+%26gt%3B+%3Ca+href%3D%27index.php%3F_a%3Dknowledgebase%26_j% 3Dsubcat%26_i%3D8%27%3EEmail%3C%2Fa%3E+%26gt%3B+%3Ca+href%3D%27in dex.php%3F_a%3Dknowledgebase%26_j%3Dsubcat%26_i%3D31%27%3EMailing +Lists%2Fezmlm%3C%2Fa%3E)
Under the section: Modifying Text in Mailing List Messages

I would suggest reviewing that section for a more complete understanding.

But essentially, yes, you would just copy and replace the relevant files.

What this patch does, it it makes the templates more "generic" than they were before. Prior to this patch you would have had to modify the text files for each list. Now you simply have to modify them for a single list and copy them to the others if you wish to use the same set of templates for each list. (Obviously, since the files for each list are saved separately, you also have the option of using different templates for different lists as well.)

Erica C.
01-09-2007, 07:43 PM
Ah. I see. I thought that making the changes to one set it as a new default.

Thanks for your patience.

Erica (where's that "light dawns" smiley?)

sheila
01-11-2007, 01:12 AM
(where's that "light dawns" smiley?)

How about his one? :]

or perhaps this? :QTidea:

;)