Sign In Sign Out Mailing Lists Unsubscribe or Change Settings Help

bugzilla.org

= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
configset  GLOBAL  welcome_files <<TAG
[VALUE LINES]
TAG
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
configset listname welcome_files <<TAG
[VALUE LINES]
TAG
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Default Value : default ... (only first item is shown)
Data Type     : welcome_files
Category      : reply
Password Notes: Visible only with password. 
= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

EXAMPLE:
configset listname welcome_files << ENDTAG
Welcome to listname@example.org, save this message!
public/charter.txt : N
Common Sense Rules at Example.Org - please save!
public/rules.txt : NS
ENDTAG

The welcome_files setting determines which documents are mailed when
someone joins a mailing list with the "subscribe" command, or when
someone registers using the "register" command.

Each file takes two lines.  The first should be an explanatory message
which will appear in the Subject or Content-description header of the
e-mail message that is sent to the new subscriber.  The second line
consists of a file name and a flag field, which are separated by a colon
(':') or pipe symbol ('|').

The first line of each file description will be displayed in the Subject
header of a message if the file is the first file to appear in a welcome
message.  Otherwise, the first line will appear in a Content-Description
header of an attachment to the welcome message.

The first field of the second line of a file description is a file name.
The file must already be present in the file space of your mailing list.
The "get" command can be used to verify that the file exists:

  get-immediate LISTNAME FILENAME

Files can be created in your list's file space using the "put" command.

Each file in a list's file space has a brief description.  If you wish
to use a file's default description in the subject or
content-description header of a welcome message, simply use the word
"default".  See "help admin_documents" for an introduction to the file
space and file descriptions.

The second field of the second line of a file description is an optional
flag field.  Four flags are supported:  

  * 'E' causes the file to be included only if it exists in the list's
     explicit search path (as specified by the file_search setting).  The
     default locations will not be searched.  If the file does not exist,
     it will be completely ignored.

  * 'N' indicates that the file should be the first part of a new welcome 
     message; 

  * 'R' causes the file to be included only if the address was
     already registered.

  * 'S' causes the file to undergo variable substitution (and possibly 
     auto-inclusion of additional files).  The variables supported include
     the standard substitutions, plus USER, PASSWORD, FRONTER, FOOTER,
     RANDOM_FRONTER, RANDOM_FOOTER, ALL_FRONTERS, and ALL_FOOTERS.  See
     "help variables" for a description of each substitution variable.

  * 'U' causes the file to be included only if the address was
     not already registered.

Regardless of whether the 'S' flag is present, the substitutions will be
applied to the subject from the first line of the description.

Welcome files with neither the 'R' flag nor the 'U' flag will always be
included in a welcome message.


Here is another example:

configset LISTNAME welcome_files <<END
default
welcome
Picture of the list owner!
owner.jpg 
Q and A for the $LIST mailing list
/faq : NSE
END

In this example, two welcome messages will be sent to new subscribers.
The first welcome message consists of a file called "welcome" and an
attached photograph called "owner.jpg".  The second welcome message
consists of a single file called "/faq".  If no file named "/faq" exists
for this list, the second message will not be sent.  (If 'E' was not
present, the default FAQ file would be sent, which simply informs the user
that no FAQ document exists.)


The following example uses the 'U' flag to send extra information to
newcomers who have not previously joined a mailing list at
bugzilla.org:

configset LISTNAME welcome_files <<END
Welcome to the $LIST mailing list!
welcome : S
Your registration at $SITE
registered : US
END

In this example, newcomers will receive a message consisting of two
files, "welcome" and "registered".  Subscribers who are already
registered at this domain will only receive the first welcome file.


Each file in a list's file space has a brief description.  If you
wish to use a file's default description in the subject or content-description
header of a welcome message, simply use the word "default".

The GLOBAL welcome_files setting only applies to messages that are sent
when someone uses the "register" command.

It is possible to use comments before, between, and after the individual
rules, but not within rules.  Comments are lines that begin with a '#'.
You can use comments as a reminder of what a file does or why
it was chosen, but comments have no impact on how the setting works.


See Also:
   help admin_documents   (for an introduction to the file space)
   help configset_farewell
   help configset_farewell_files
   help configset_file_search (determines how files are looked for)
   help configset_welcome (determines if welcome messages are sent)
   help get               (to retrieve files from the list's file space)
   help put               (to store files in the list's file space)
   help register
   help subscribe
   help unregister
   help unsubscribe
   help variables         (for an explanation of substitution variables)

This is the "configset_welcome_files" help document for 
Majordomo 2, version 0.1201103110.

For a list of all help documents, send the following command:
   help topics
in the body of a message to majordomo@bugzilla.org.

If you need assistance, please contact the bugzilla.org administrators.
Sign In Sign Out Mailing Lists Unsubscribe or Change Settings Help