Listar 1.0.0 Variable Reference
Note: The 'valid' field describes the Listar config files where that variable is valid. 'G' means the global config file, 'V' means a virtual host configuration file, and 'L' means individual list files.
ACCOUNT MANAGEMENT | |||
Variable | Type | Valid | Description |
allow-setaddy | boolean | GVL |
Allow the use of the setaddy command to replace the subscribed address. Example:allow-setaddy=no Default value is true |
ADDRESS HANDLING | |||
Variable | Type | Valid | Description |
deny-822-bounce | boolean | GVL |
Should the RFC822 Resent-From: header be trusted for sender. Example:deny-822-bounce = yes Default value is false |
deny-822-from | boolean | GVL |
Should the RFC822 From: header be trusted for sender. Example:deny-822-from = no Default value is false |
ADDRESSES | |||
Variable | Type | Valid | Description |
administrivia-address | string | GVL |
Address to which subscription/unsubscription attempt notifications should be sent. Example:administrivia-address = mylist-admins@host.dom |
approved-address | string | GVL |
Address to which approved/rejected/modified moderated posts should be sent. Example:approved-address = mylist-repost@myhost.dom Default value is <$list>-repost@<$hostname> |
listserver-address | string | GV |
The email address for the listserver control account. Example:listserver-address = listserv@myhost.dom Default value is listar@localhost |
listserver-admin | string | GV |
The email address of the human in charge of the listserver. Example:listserver-admin = user1@host2.dom Default value is root@localhost |
listserver-full-name | string | GV |
The friendly name used to identify the listserver. Example:listserver-full-name = List Server Default value is Listar |
ADMINISTRATION | |||
Variable | Type | Valid | Description |
paranoia | boolean | GVL |
Are the various list config files allowed to be edited remotely for this list. Example:paranoia = yes Default value is false |
ADMINISTRIVIA | |||
Variable | Type | Valid | Description |
administrivia-body-lines | integer | GVL |
How many lines of the body to check for commands. Example:administrivia-body-lines = -1 Default value is 6 |
administrivia-check | boolean | GVL |
Should the administrivia check be enabled. Example:administrivia-check = false Default value is true |
administrivia-regexp-file | string | GVL |
File containing regexps used to detect if a user is sending list commands to the list instead of the request address, and bounce those messages to the moderator for handling. Example:administrivia-regexp-file = admin-regexp Default value is admin-regexp |
ANTISPAM | |||
Variable | Type | Valid | Description |
allow-spam | boolean | GVL |
Should we disable the antispam check for this list. Example:allow-spam = false Default value is false |
antispam-blackhole | boolean | GVL |
If we receive spam, should we simply eat it? (If 'no', then it is moderated.) Example:antispam-blackhole = yes Default value is false |
spamfile | string | GVL |
The file on disk which contains the regular expressions used to detect if a given sender is a spammer. Example:spamfile = spam-regexp Default value is spam-regexp |
BASIC CONFIGURATION | |||
Variable | Type | Valid | Description |
advertise | boolean | GVL |
Does this list show up as being available. Example:advertise = false Default value is true |
config-file | string | GV |
The name of the list-specific configuration file. Example:config-file = config Default value is config |
default-flags | string | GVL |
Default flags given to a user when they are subscribed. Example:default-flags = |NOPOST|DIGEST| Default value is |ECHOPOST| |
description | string | GVL |
Description of the list. Example:description = This is my special list |
hostname | string | GV |
Hostname for URLs/addresses/headers Example:hostname = lists.mydomain.com |
ignore-subject-commands | boolean | GV |
Should the server ignore commands in the subject line. Example:ignore-subject-commands = false Default value is false |
list-owner | string | GVL |
Defines an email address to reach the list owner(s). Example:list-owner = list2-admins@hostname.dom |
reply-to | string | GVL |
Address which will appear in the Reply-To: header. Example:reply-to = list@myhost.dom |
subject-tag | string | GVL |
Optional tag to be included in subject lines of posts sent to the list. Example:subject-tag = [MyList] |
task-no-footer | boolean | GVL |
Should the messages produced by the server have a footer with version information Example:task-no-footer = yes Default value is false |
BOUNCE HANDLING | |||
Variable | Type | Valid | Description |
bounce-always-unsub | boolean | GVL |
Should the user be unsubscribed when more than max transient bounces have occured. Example:bounce-always-unsub = false Default value is false |
bounce-max-fatal | integer | GVL |
Maximum number of fatal bounces before action is taken. Example:bounce-max-fatal = 10 Default value is 10 |
bounce-max-transient | integer | GVL |
Maximum number of transient bounces before action is taken. Example:bounce-max-transient = 100 Default value is 30 |
bounce-never-unsub | boolean | GVL |
Should the user be unsubscribed when more than max fatal bounces have occured, or just set vacation. Example:bounce-never-unsub = off Default value is false |
bounce-never-vacation | boolean | GVL |
Should the user ever be set vacation for exceeding the maximum number of bounces. Example:bounce-never-vacation = yes Default value is false |
bounce-timeout-days | integer | GVL |
Length of time (in days) during which the maximum number of bounces must not be exceeded. Example:bounce-timeout-days = 7 Default value is 7 |
bouncer-unsub-file | string | GVL |
File under the list directory to send to a user when they are automatically unsubscribed by the bouncer. Example:bouncer-unsub-file = text/bounce-unsub.txt Default value is text/bounce-unsub.txt |
bouncer-vacation-file | string | GVL |
File under the list directory to send to a user when they are automatically set vacation by the bouncer. Example:bouncer-vacation-file = text/bounce-vacation.txt Default value is text/bounce-vacation.txt |
CGI | |||
Variable | Type | Valid | Description |
cgi-template-dir | string | GVL |
Directory for CGI gateway templates. Example:cgi-template-dir = <$listserver-data>/templates Default value is <$listserver-data>/templates |
lsg2-cgi-url | string | GV |
URL on the associated web server pointing to the LSG/2 cgi wrapper. Example:lsg2-cgi-url = http://my.dom/cgi-bin/lsg2.cgi |
lsg2-cookie-duration | duration | GV |
The length of time that cookies for the LSG/2 web form should last. Example:lsg2-cookie-duration = 30 m Default value is 15 m |
lsg2-iis-support | boolean | G |
Does LSG/2 need to run in Microsoft IIS-compatible mode? (Likely breaks other webservers.) Example:lg2-iis-support = yes Default value is false |
lsg2-paranoia | boolean | GV |
Is LSG/2 paranoid, e.g. does it deny all remote administration. Example:lsg2-paranoia = no Default value is false |
COOKIES | |||
Variable | Type | Valid | Description |
expire-all-cookies | boolean | GV |
Should we expire cookies for all lists on initial run? Should only be set to 'no' on installations with a huge (multi-thousand) number of lists. Example:expire-all-cookies = yes Default value is true |
DEBUGGING | |||
Variable | Type | Valid | Description |
debug | integer | GVL |
How much logging should be done. Example:debug = 10 Default value is 0 |
logfile | string | GV |
Filename where debugging log information will be stored. Example:logfile = ./server.log |
preserve-queue | boolean | GVL |
Controls whether to remove queue file after processing. Example:preserve-queue = yes Default value is false |
validate-users | boolean | GVL |
Perform a minimal validation of user@host.dom on all users in the list's user file and log errors. Example:validate-users = true Default value is false |
DIGEST | |||
Variable | Type | Valid | Description |
digest-administrivia-file | string | GVL |
File on disk used to store digest administrative information. Example:digest-administrivia-file = digest/administrivia Default value is digest/administrivia |
digest-alter-datestamp | boolean | GVL |
Should digests use a different datestamp format. Example:digest-alter-datestamp = on Default value is false |
digest-altertoc | boolean | GVL |
Should this list use an alternate form for the digest Table of Contents. Example:digest-altertoc = false Default value is false |
digest-footer-file | string | GVL |
Filename for a footer file automatically included with every digest Example:digest-footer-file = text/digest-footer.txt Default value is text/digest-footer.txt |
digest-from | string | GVL |
Email address used as the From: header when the digest is distributed. Example:digest-from = listname@host.dom |
digest-header-file | string | GVL |
Filename for a header file automatically included with every digest Example:digest-header-file = text/digest-header.txt Default value is text/digest-header.txt |
digest-max-size | integer | GVL |
Maximum size a digest can reach before being automatically sent. Example:digest-max-size = 40000 Default value is 0 |
digest-max-time | duration | GVL |
Maximum age of a digest before it is sent automatically. Example:digest-max-time = 24h Default value is 0s |
digest-name | string | GVL |
If digests are kept, what do we use as the name template for the stored copy of the digest. Example:digest-name = digests/%l/V%V.I%i |
digest-no-fork | boolean | GVL |
Should digesting be done by forking a seperate process. Example:digest-no-fork = true Default value is false |
digest-no-toc | boolean | GVL |
Should digests exclude the Table of Contents entirely. Example:digest-no-toc = TRUE Default value is false |
digest-no-unmime | boolean | GVL |
Should posts in the digest not be unmimed. Example:digest-no-unmime = off Default value is false |
digest-send-mode | choice | GVL |
Mode used when sending digests daily via a timed job (usually around midnight of the host machine's time). 'procdigest' means that when that happens, the digest will be sent regardless of your time and size settings (which are still honored for normal posts). Time and size are self-explanatory; time means that it will only send if there's been more than digest-max-time elapsed, while size will only send if digest-max-size has been exceeded. digest-max-size and digest-max-time DO still apply when individual posts come across the list, even if procdigest is set; having digest-max-size set to 50000 and this variable to procdigest would mean that the digest would be sent when it exceeded 50k, or during the midnight automated run (perhaps the day's digest only reached 20k; it would still be sent). Example:digest-send-mode = time Default value is procdigest |
digest-strip-tags | boolean | GVL |
Should subject lines of the messages in the digest have the list subject-tag stripped. Example:digest-strip-tags = on Default value is false |
digest-to | string | GVL |
Email addres used as the To: header when the digest is distributed. Example:digest-to = listname@host.dom |
digest-transient | boolean | GVL |
Are digests removed completely after they are sent. Example:digest-transient = off Default value is true |
digest-transient-administrivia | boolean | GVL |
Should the digest administrivia file be removed after the digest is next sent. Example:digest-transient-administrivia = true Default value is false |
no-digest | boolean | GVL |
Should digesting be disabled for this list. Example:no-digest = yes Default value is false |
DUPLICATE MESSAGE DETECTION | |||
Variable | Type | Valid | Description |
no-dupes | boolean | GVL |
Should we track the Message-Id headers from incoming traffic to prevent duplicate posts to the list. Message-Id's expire after 1 day. Example:no-dupes = off Default value is true |
no-dupes-forever | boolean | GVL |
Should we never expire the Message-Id's. Example:no-dupes-forever = yes Default value is false |
ERROR HANDLING | |||
Variable | Type | Valid | Description |
error-include-queue | boolean | GVL |
Should error reports contain the queue associated with that run Example:error-include-queue = yes Default value is true |
FILEARCHIVE | |||
Variable | Type | Valid | Description |
file-archive-dir | string | GVL |
Where are the archives for the list located. Example:file-archive-dir = files |
file-archive-status | choice | GVL |
Who is allowed to retrieve the file archives. Example:file-archive-status = admin Default value is public |
FILES | |||
Variable | Type | Valid | Description |
blacklist-mask | string | GVL |
Per-list file containing regular expressions for users who are not allowed to subscribe to the list. Example:blacklist-mask = blacklist Default value is blacklist |
blacklist-reject-file | string | GVL |
File sent to a user when their subscription or post is rejected because they are blacklisted. Example:blacklist-reject-file = text/blacklist.txt Default value is text/blacklist.txt |
closed-file | string | GVL |
File sent to message author when the post is rejected because the list is closed. Example:closed-file = text/closed-post.txt Default value is text/closed-post.txt |
closed-subscribe-file | string | GVL |
Filename of file to be sent if a user tries to subscribe to a closed subscription list. Example:closed-subscribe-file = text/closed-subscribe.txt Default value is text/closed-subscribe.txt |
faq-file | string | GVL |
File on disk containing the list's FAQ file. Example:faq-file = text/faq.txt Default value is text/faq.txt |
footer-file | string | GVL |
Text to append to list messages. Example:footer-file = text/footer.txt Default value is text/footer.txt |
global-blacklist | string | GV |
Global file containing regular expressions for users who are not allowed to subscribe to lists hosted on this server. Example:global-blacklist = banned Default value is banned |
goodbye-file | string | GVL |
File sent to someone unsubscribing from a list. Example:goodbye-file = text/goodbye.txt Default value is text/goodbye.txt |
header-file | string | GVL |
Text to prepend to list messages. Example:header-file = text/header.txt Default value is text/header.txt |
info-file | string | GVL |
File on disk containing the list's info file. Example:info-file = text/info.txt Default value is text/info.txt |
moderator-welcome-file | string | GVL |
File sent to a new moderator when they set MODERATOR. Example:moderator-welcome-file = text/moderator.txt Default value is text/moderator.txt |
no-command-file | string | GV |
This is a global file to send if a message to the main listserver or request address has no commands. Example:no-command-file = helpfile Default value is listar.hlp |
nopost-file | string | GVL |
File sent to users flagged NOPOST if they submit a post to the list Example:nopost-file = text/nopost.txt Default value is text/nopost.txt |
outside-file | string | GVL |
File sent to message author when post is accepted to list but author is not a subscriber. Example:outside-file = text/outside.txt Default value is text/outside.txt |
overquote-file | string | GVL |
Filename under the list directory of the file sent to a user who fails an overquoting check. (See 'quoting-limit'.) This is the file retrieved with 'getconf overquote'. Example:overquote-file = text/overquote.txt Default value is text/overquote.txt |
posting-acl-file | string | GVL |
The filename within the list directory to use for the posting-acl file. Example:posting-acl-file = postacl Default value is postacl |
submodes-file | string | GVL |
File containing list specific customized subscription modes. Example:submodes-file = submodes Default value is submodes |
subscribe-acl-file | string | GVL |
File containing regular expressions against which a user's address will be matched when they try to subscribe to a list. If an address does not match at least one, subscription is denied. Can be gotten with 'getconf acl'. Example:subscribe-acl-file = subscribe-acl Default value is subscribe-acl |
subscribe-acl-text-file | string | GVL |
Textfile to be sent to a user who fails the ACL subscription check. Can be gotten with 'getconf acl-text'. Example:subscribe-acl-text-file = text/subscribe-acl-deny.txt Default value is text/subscribe-acl-deny.txt |
tempban-end-file | string | GVL |
Filename of file to be sent to a user who was tempbanned when the tempban expires. Example:tempban-end-file = text/tempban-end.txt Default value is text/tempban-end.txt |
tempban-file | string | GVL |
Filename of file to be sent to a user when an admin issues the tempban command on them. Example:tempban-file = text/tempban.txt Default value is text/tempban.txt |
welcome-file | string | GVL |
File sent to new subscribers of a list. Example:welcome-file = text/intro.txt Default value is text/intro.txt |
HEADERS | |||
Variable | Type | Valid | Description |
strip-headers | string | GVL |
A colon seperated list of headers to remove from outgoing messages. Example:strip-headers = X-pmrq:X-Reciept-To |
strip-mdn | boolean | GVL |
If true, strip all read-reciept (mail delivery notification) headers from mail before sending out. Example:strip-mdn = on Default value is true |
LIST INTEGRATION | |||
Variable | Type | Valid | Description |
cc-lists | string | L |
A colon seperated list of local lists which recieve copies of all posts to this list. Example:cc-lists = mylist1:mylist2 Default value is
|
union-lists | string | L |
A colon seperated list of local lists whose members can post to this list even if it is closed. Example:union-lists = mylist1:mylist2 |
LISTARCHIVE | |||
Variable | Type | Valid | Description |
archive-world-readable | boolean | GVL |
Should we make all archive files world-readable? Example:archive-world-readable = yes Default value is true |
mbox-archive-path | string | GVL |
Path to where MBox format archives are stored. Example:mbox-archive-path = archives/mylist/mbox |
mh-archive-path | string | GVL |
Path to where MH format archives are stored. Example:mh-archive-path = archives/mylist/mh |
LOCATION | |||
Variable | Type | Valid | Description |
lists-root | string | GV |
Location of the directory containing all the list info. Example:lists-root = lists Default value is <$listserver-data>/lists |
listserver-conf | string | G |
The path to the listserver configuration files. Example:listserver-conf = /usr/local/mylists/configs |
listserver-data | string | GV |
The path to the listserver data root. Example:listserver-data = /usr/local/mylists/data |
listserver-modules | string | G |
The path to the directory containing the LPM modules. Example:listserver-modules = /usr/local/lists/modules |
listserver-root | string | G |
The path to the root of the Listserver installation Example:listserver-root = /usr/local/listserver |
MAINTENANCE | |||
Variable | Type | Valid | Description |
listserver-bin-dir | string | G |
When creating a new list, what directory do we prepend to the binary name when we make the aliases (if not set, defaults to the path the binary was run with). Example:listserver-bin-dir = /home/list |
newlist-qmail | boolean | G |
When creating a new list, do we need to make dot-qmail aliases? Example:newlist-qmail = no Default value is false |
MIME | |||
Variable | Type | Valid | Description |
humanize-html | boolean | GVL |
Should HTML attachments be converted to plaintext Example:humanize-html = no Default value is true |
humanize-mime | boolean | GVL |
Should the server strip out non-text MIME attachments. Example:humanize-mime = true Default value is true |
humanize-quotedprintable | boolean | GVL |
If set to true, attempt to remove any and all quoted printable characters from subject and body replacing them with their actual character. Example:humanize-quotedprintable = true Default value is false |
pantomime-dir | string | GVL |
Directory on disk to store binary files placed on the web via PantoMIME. Example:pantomime-dir = /var/www/listar/html/pantomime |
pantomime-url | string | GVL |
URL corresponding to pantomime-dir Example:pantomime-url = http://www.listar.org/pantomime |
rabid-mime | boolean | GVL |
Should ABSOLUTELY no attachments, EVEN text/plain, be allowed Example:rabid-mime = no Default value is false |
unmime-forceweb | boolean | GVL |
Should all attachments (even text/plain) be forced to the web (pantomime-dir and pantomime-url must be set or all will be eaten) Example:unmime-forceweb = yes Default value is false |
unmime-quiet | boolean | GVL |
Should the listserver report when it strips MIME attachments. Example:unmime-quiet = no Default value is false |
MISC | |||
Variable | Type | Valid | Description |
assume-lists-valid | boolean | GV |
Should we assume that all list directories are valid or should we perform checks Example:assume-lists-valid = yes Default value is false |
closed-post | boolean | GVL |
Is this list closed to posting from non-members. Example:closed-post = true Default value is false |
closed-post-blackhole | boolean | GVL |
Do messages submitted to a closed-post list by non-members get thrown away. Example:closed-post-blackhole = yes Default value is false |
enforced-address-blackhole | boolean | GVL |
If this is true and enforced-addressing-to is enabled, posts that fail the check will be simply eaten. Otherwise, they will be marked for moderation. Example:enforced-address-blackhole = true Default value is false |
enforced-addressing-to | string | GVL |
If this is set, this address must be in the To or Cc field of a post to the list. Usually, you would set the list address here. Example:enforced-addressing-to = mylist@foo.bar.com |
force-from-address | string | GVL |
If specified, this will be used as the RFC 822 From: address. Example:force-from-address = list-admins@myhost.dom |
form-show-listname | boolean | GVL |
Should we use the list name (or RFC2369 name) instead of the listserver full name for forms on a per-list basis? (Like admin wrappers and such.) Example:form-show-listname = yes Default value is false |
posting-acl | boolean | GVL |
Should we check the postacl file if it exists? Example:posting-acl = true Default value is true |
precedence | string | GVL |
The precedence header which will be included in all traffic to the list. Example:precedence = bulk Default value is bulk |
reply-to-sender | boolean | GVL |
Forcibly set the Reply-To: header to be the address the mail came from. Example:reply-to-sender = false Default value is false |
tag-to-front | boolean | GVL |
If set to true and there is a subject tag for the list, it will be removed and moved to the beginning of the line (before any 'Re:'s). If not set, any duplicate Re:'s will still be removed, and the subject-tag will be moved after the Re:. Example:tag-to-front = no Default value is true |
who-status | choice | GVL |
Who is allowed to view the list membership. Example:who-status = admin Default value is private |
MODERATION | |||
Variable | Type | Valid | Description |
admin-approvepost | boolean | GVL |
Are posts by an administrator to a moderated list automatically approved. Example:admin-approvepost = false Default value is true |
moderate-include-queue | boolean | GVL |
Should moderated messages contain the full message that triggered moderation? Example:moderate-include-queue = yes Default value is false |
moderate-notify-nonsub | boolean | GVL |
Should posts from non-subscribers be acked if they are moderated. Example:moderate-notify-nonsub = true Default value is false |
moderated | boolean | GVL |
Is this list moderated. Example:moderated = yes Default value is false |
moderator | string | GVL |
Address for the list moderator(s). Example:moderator = foolist-moderators@hostname.dom |
moderator-approvepost | boolean | GVL |
Are posts by a moderator to a moderated list automatically approved. Example:moderator-approvepost = false Default value is true |
password-failure-blackhole | boolean | GVL |
If true, a post to a password list that doesn't have the correct password will be eaten. If false, it will be sent to the moderators. Example:password-failure-blackhole = yes Default value is true |
password-implies-approved | boolean | GVL |
If true, a correct use of X-posting-pass automatically preapproves the message. Useful if you want to have a moderated list and allow preapproved functionality through the use of the password. Example:password-implies-approved = yes Default value is false |
post-password | string | GVL |
If specified, all incoming messages must have an X-posting-pass: header with this password in it. Example:post-password = NeverBeGuessed |
post-password-reject-file | string | GVL |
File sent to submitters to a password protected list if they don't include the posting password header. Example:post-password-reject-file = text/postpassword.txt Default value is text/postpassword.txt |
subject-required | boolean | GVL |
If set to true, then any post sent to the list without a subject will be made moderated. Example:subject-required = yes Default value is false |
verbose-moderate-fail | boolean | GVL |
When a moderator approves a message but it is rejected, should the message in question be included in the rejection note? Example:verbose-moderate-fail = yes Default value is true |
PASSWORD | |||
Variable | Type | Valid | Description |
allow-site-passwords | boolean | GV |
Are sitewide passwords allowed. Example:allow=site-passwords = false Default value is false |
password-expiration-time | duration | GV |
How quickly to auth-password cookies expire. Example:password-expiration-time = 2 d Default value is 1 h |
POSTING LIMITS | |||
Variable | Type | Valid | Description |
body-max-size | integer | GVL |
Posts with a body larger than this in bytes will be moderated. Example:body-max-size = 10000 |
header-max-size | integer | GVL |
Posts with headers larger than this in bytes will be moderated. Example:header-max-size = 2000 |
QUOTING | |||
Variable | Type | Valid | Description |
quoting-limits | boolean | GVL |
If true, posts to the list will be checked for overquoting. Example:quoting-limits = yes Default value is false |
quoting-line-reset | boolean | GVL |
If quoting-limits is on, should the count of quoted lines be reset if the user places their own text in the message? (This has the effect of making it so that quoting-max-lines is the total number of lines that can be quoted at once IN A BLOCK, instead of in the entire message.) Example:quoting-line-reset = yes Default value is true |
quoting-max-lines | integer | GVL |
If greater than 0 and quoting-limits is true, this is the maximum number of lines allowed to be quoted from a previous message. Example:quoting-max-lines = 10 Default value is 10 |
quoting-max-percent | integer | GVL |
If greater than 0 and quoting-limits is true, this is the maximum percent of the message allowed to be quoted from a previous post. Example:quoting-max-percent = 15 Default value is 0 |
quoting-tolerance-lines | integer | GVL |
If greater than 0, this is the number of lines that must be exceeded in the total message before the quoting percentage limit will be applied. It would be silly to have a 25% quoting limit and have a three-line message be rejected because two lines were quoted. Example:quoting-tolerance-lines = 7 Default value is 7 |
RFC2369 | |||
Variable | Type | Valid | Description |
rfc2369-archive-url | string | GVL |
The URL for use in the List-archive: RFC 2369 header. Example:rfc2369-archive-url = ftp://ftp.myhost.dom/lists |
rfc2369-headers | boolean | GVL |
Should RFC 2369 headers be enabled for this list. Example:rfc2369-headers = on Default value is false |
rfc2369-list-help | string | GVL |
URL to use in the RFC 2369 List-help: header. Example:rfc2369-list-help = http://www.mydom.com/list/help.html |
rfc2369-listname | string | GVL |
The name of the list to use in the RFC 2369 List-name: header. Example:rfc2369-listname = Mylist |
rfc2369-minimal | boolean | GVL |
Should only the minimal set of RFC 2369 headers be emitted. Example:rfc2369-minimal = true Default value is false |
rfc2369-post-address | string | GVL |
The mailto to be used in the RFC 2369 List-post: header. The special value of 'closed' will show the list as closed in that header. Example:rfc2369-post-address = myname@myhost.dom |
rfc2369-subscribe | string | GVL |
If specified, this overrides the default generated RFC2369 List-subscribe value. Example:rfc2369-subscribe = mailto:listar@listar.org?subject=subscribe%20listar-support |
rfc2369-unsubscribe | string | GVL |
If specified, this overrides the default generated RFC2369 List-unsubscribe value. Example:rfc2369-unsubscribe = mailto:listar@listar.org?subject=unsubscribe%20listar-support |
SMTP | |||
Variable | Type | Valid | Description |
form-cc-address | string | GVL |
Who should be cc'd on any tasks/forms that the server sends. Example:form-cc-address = user2@host1.dom |
full-bounce | boolean | GVL |
Should bounces contain the full message or only the headers. Example:full-bounce = false Default value is false |
mailserver | string | GV |
The name of the outging SMTP server to use. Example:mailserver = mail.host1.dom Default value is localhost |
max-rcpt-tries | integer | GV |
How many times to attempt reading a RCPT TO: response. Example:max-recpt-tries = 3 Default value is 5 |
send-as | string | GVL |
Controls what the SMTP return path is set to. Example:send-as = list2-bounce@test2.dom |
sendmail-sleep | boolean | GV |
Should we attempt to sleep a short time between message recipients. Example:sendmail-sleep = on Default value is false |
sendmail-sleep-length | duration | GV |
Override if you need the 'Sendmail Sleeper' option at a different duration than the 3 second default. Example:sendmail-sleep-length = 1 s Default value is 3 s |
smtp-blind-blast | boolean | GV |
Should Listar perform all SMTP operations without regard for result codes (e.g. trust that it was delivered)? NOT RECOMMENDED. Example:smtp-blind-blast = yes Default value is false |
smtp-queue-chunk | integer | GVL |
Maximum recipients per message submitted to the mail server. Larger lists will be split into chunks of this size. Example:smtp-queue-chunk = 25 |
smtp-retry-forever | boolean | GV |
Should Listar continue to wait for SMTP responses for an infinite amount of time, e.g. never give up? This can negatively impact delivery times. Example:smtp-retry-forever = yes Default value is false |
smtp-socket | integer | GV |
Which socket should the SMTP server be contacted on. Example:smtp-socket = 26 Default value is 25 |
SOCKET IO | |||
Variable | Type | Valid | Description |
socket-timeout | duration | GV |
How long should the server wait on reading a socket. Example:socket-timeout = 5 m Default value is 30 s |
SUBSCRIBE OPTIONS | |||
Variable | Type | Valid | Description |
admin-silent-subscribe | boolean | GVL |
If set true, when an admin subscribes a user to a list they will receive no subscription notification AND no welcome message. Example:admin-silent-subscribe = no Default value is false |
administrivia-include-requests | boolean | GVL |
Should the mail which caused the (un)subscription action be included in the message to the administrivia address. Example:administrivia-include-requests = on Default value is false |
no-administrivia | boolean | GVL |
Should the administrivia address be notified when a user subscribes or unsubscribes. Example:no-administrivia = on Default value is false |
owner-fallback | boolean | GVL |
Should the list-owner be used if administrivia-address is not defined when notifying of (un)subscribes. Example:owner-fallback = true Default value is false |
silent-resubscribe | boolean | GVL |
Silence warnings when an already-subscribed user re-subscribes. Example:silent-resubscribe = on Default value is false |
subscribe-confirm-file | string | GVL |
File sent to someone subscribing to a list, if subscribe-mode = confirm. Example:subscribe-confirm-file = text/subscribe-confirm.txt Default value is text/subscribe-confirm.txt |
subscribe-confirm-subject | string | GVL |
Subject to be used in the mail sent to someone subscribing to a list, if subscribe-mode = confirm. Example:subscribe-confirm-subject = Subscription confirmation for '<$list>' Default value is Subscription confirmation for '<$list>' |
subscribe-mode | choice | GVL |
Subscription mode for the list. Example:subscribe-mode = open Default value is closed |
subscription-acl | boolean | GVL |
If 'true' and the file given in 'subscribe-acl-file' exists, a subscription access list check will be performed when users attempt to subscribe to the list. Example:subscription-acl = true Default value is true |
unsubscribe-confirm-file | string | GVL |
File sent to someone unsubscribing from a list, if unsubscribe-mode = confirm. Example:unsubscribe-confirm-file = text/unsubscribe-confirm.txt Default value is text/unsubscribe-confirm.txt |
unsubscribe-confirm-subject | string | GVL |
Subject to be used in the mail sent to someone unsubscribing from a list, if unsubscribe-mode = confirm. Example:unsubscribe-confirm-subject = Unsubscription confirmation for '<$list>' Default value is Unsubscription confirmation for '<$list>' |
unsubscribe-mode | choice | GVL |
Unsubscription mode for the list. Example:unsubscribe-mode = closed Default value is open |
TEMPBAN | |||
Variable | Type | Valid | Description |
tempban-default-duration | duration | GVL |
If an administrator issues the tempban command without a duration, this default will be used. Example:tempban-default-duration = 7 d Default value is 7 d |
TIMEOUTS | |||
Variable | Type | Valid | Description |
adminreq-expiration-time | duration | GVL |
How long until administrative request cookies expire. Example:adminreq-expiration-time = 3 h |
cookie-expiration-time | duration | GVL |
How long until a generated cookie expires. Example:cookie-expiration-time = 3 d 6 h Default value is 1 d |
filereq-expiration-time | duration | GVL |
How long until config file request cookies expire. Example:filereq-expiration-time = 3 h |
modpost-expiration-time | duration | GVL |
How long until a moderated post cookie expires. Example:modpost-expiration-time = 2 h |
reply-expires-time | duration | GV |
How long until an automatic reply expires from the mailbox Example:reply-expires-time = 3 h Default value is 1 d |
subscription-expiration-time | duration | GVL |
How long until subscription verification cookies expire. Example:subscription-expiration-time = 5 d |
unsubscription-expiration-time | duration | GVL |
How long until unsubscription verification cookies expire. Example:unsubscription-expiration-time = 5 d |
TOLIST | |||
Variable | Type | Valid | Description |
megalist | boolean | GVL |
Should we process this list on-disk instead of in memory? This disables the receipient list sorting and list-merging functionality of Listar, in order to prevent large memory footprint operations. It is useful for lists where the receipient list is too large to effectively do memory-based operations on. Example:megalist = true Default value is false |
no-loose-domain-match | boolean | GVL |
Should the server treat users of a subdomain as users of the domain for validation purposes. Example:no-loose-domain-match = on Default value is false |
per-user-modifications | boolean | GVL |
Do we do per-user processing for list members. Example:per-user-modifications = false Default value is false |
sort-tolist | boolean | GVL |
Should the recipients be sorted by domain before sending. This is memory expensive and is a bad idea if your SMTP server already does this sorting. If you SMTP server doesn't do this, it can really improve outgoing mail performance. Example:sort-tolist = off Default value is true |
tolist-send-pause | integer | GVL |
How long (in milliseconds) do we sleep between SMTP chunks. Example:tolist-send-pause = 30 Default value is 0 |
VACATION | |||
Variable | Type | Valid | Description |
vacation-default-duration | duration | GVL |
If a person sends the vacation command without a duration, how long they will be set vacation. Example:vacation-default-duration Default value is 14 d |