meta data for this page
  •  
Translations of this page:

All config file options

Constants and variables

# editcategorytypepurposeallowed valuesdefault
1wordwrap_htmlrenderingconstantApply line wrapA number0
2warn_savechangescompositionconstantWarn when changing page and there are unsaved changestrue false 0 11
3warn_about_php_settingsconstantDisplay a warning if some PHP settings are not as desiredtrue false 0 11
4verboseconstantDisplay more information about what phpList is doing, including log entries for every email that is senttrue falsefalse
5usetinymcetemplconstant
6usetinymcemesgconstant
7usertable_prefixsystemvariableprefix for subscriber related datastringphplist_user_
8userspage_maxsubscriber managementconstantSuppress the listing of subscribers when there are more than this valueNumber1000
9user_wwwrootsystemconstantfix the URL for the public pagesa valid URL in the context of the systemnot set
10usefckcompositionconstantUse the FCKeditor for creating campaignstrue false 0 11
11useckcompositionconstantUse the CKeditor for creating campaignstrue false 0 10
12use_spam_blockanti-spamconstantBlock spammers from signing uptrue false 0 11
13use_repetitioncompositionconstantAdd the functionality to repeat campaignstrue false 0 10
14use_prepareconstantUse the prepare systemtrue false 0 10
15use_precedence_headerrenderingconstantUse the Precedence: header in outgoing mailstrue false 0 1true
16use_personalised_remoteurlsrenderingconstantNot sure
17use_pdfconstantEnable the automatic conversion to PDF functionality0 10
18use_minified_assetsconstantWhen displaying pages use the minified version of the CSS and JS files.true falsetrue
19use_manual_text_partcompositionconstantManually enter the text version of the campaigntrue falsefalse
20use_local_spoolqueue processingconstantExperimental, do not use
21use_list_excludesegmentationconstantAllow selection of lists NOT to send a campaign totrue false 0 10
22use_editmessageconstantAllow editing a campaign0 10
23use_domain_throttlequeue processingconstantEnable throttling per domaintrue false 0 10
24use_amazonsesawsconstantDetermine whether to send with Amazon SESdo not set this value
25use_advanced_bouncehandlingbounce managementconstantAllow fine grained regular expressions to determine what to do with bounced messages.true false 0 10
26use_admin_details_for_messagescompositionconstantPre-fill the From field when creating a campaign, with the details of the administrator logged intrue false 0 11
27uploadimages_dircompositionconstantLocation of a webserver-writable folder for storing images.Any name of a directoryimages
28unsubscribe_requires_passwordsecurityconstantRequest a valid password before acting on unsubscribe.true false 0 1false
29unsubscribe_jumpoffsubscriptionconstantImmediately unsubscribe someone when they click the Unsubscribe link in an email message they received, without asking them first why they are unsubscribing.true false 1 0false
30unblacklist_in_profilesubscriber managementconstantAdd a link to remove a subscriber from the blacklist in their profiletrue false 0 10
31uisystemvariableUser Interfaceany subdirectory in admin/ui/dressprow
32translations_xmli18nconstantLocation where translations can be fetched and refreshedA URL that returns a valid XMLhttp://translate.phplist.com/translations.xml
33tmpdirsystemvariableLocation to place temporary files, when neededwritable path for webserver/tmp
34tld_refetch_timeoutsystemconstantRefresh time for automatically updating the list of TLDsAny number15552000
35tld_auth_md5systemconstantThe MD5 of the TLD_AUTH_LISTAny URLhttp://www.phplist.com/files/tlds-alpha-by-domain.txt.md5
36tld_auth_listsystemconstantURL that returns a list of valid Top Level DomainsAny URLhttp://www.phplist.com/files/tlds-alpha-by-domain.txt
37tinymcepathcompositionconstantno value
38textemail_encodingrenderingconstantSet the transfer encoding for the text part of an outgoing message7bit 8bit7bit
39testconstantTry the system without sending any emails.true false 0 11
40table_prefixsystemvariableprefix for all table namesstringphplist_
41stats_intervalstatisticsconstantNot sure
42stats_collection_addressfeedbackvariableEmail address to send the statistics report toemail addressphplist-stats@phplist.com
43stacked_attribute_selectionsegmentationconstantUse stacking of attribute segmentationtrue false 0 10
44smtp_timeoutqueue processingconstantTimeout when sending a mail with SMTPAny number5
45silent_resubscribesubscriptionconstantAllow existing subscribers to re-subscribe without throwing an error.true false 0 1true
46show_unsubscribelinksubscriptionconstantShow a link to the unsubscribe page on the subscribe pagetrue falsetrue
47show_pqchoicequeue processingconstantEnable remote cron processing choicetrue, false, 0, 1false (Jan 2015)
48show_list_ofall_subscriberssegmentationconstantOn the list and members page, show a static "list" that has all subscribers in the system as memberstrue false 1 0false
49sendtest_throttlesecurityconstantLimit the use of the send test functionalityAny number1
50sendtest_maxsecurityconstantLimit the number of email addresses that can be used in the send test functionalityAny number999
51sendprocess_servernamequeue processingconstantString to identify a send processany textlocalhost
52send_queue_processing_report
53send_one_testmailcompositionconstantSend one test email when using the test functionalitytrue false 0 11
54send_listadmin_copysystemconstantSend a notification to the owner of a listtrue false 0 1false
55rfc_direct_deliverysubscriptionconstantDirect delivery of the request for confirmationtrue false 0 1false
56resetstats_maxconstantdisallow resetting statistics when this value has been reachedpositive number10
57require_loginsecurityvariableActivate the authentication system0 11
58remote_url_refetch_timeoutsystemconstantHow long to keep a remote URL in cache before fetching it againAny number greater than 03600 (one hour)
59registerfeedbackconstantLet the phpList developers get a little bit of feedback on the use of phpList by retrieving the "Powered By" image from the phpList websitetrue false 0 11
60public_protocolsystemconstantSet the protocol for public pages.http httpshttp
61processcampaigns_parallelqueue processingconstantWhen processing multiple campaigns, send them in paralleltrue, false, 0, 1false
62preferencepage_show_private_listssegmentationconstantWhen a subscriber is viewing their preferences page, show all lists, not just the public onestrue false 0 10
63plugins_disabledsystemvariableDisable selected pluginsarray of plugin namesempty array
64plugin_rootdirsconstantSemi-colon separated list of directories to look for plugins.Text, pointing to the directories.no value
65phpmailertesthostcompositionconstantThe SMTP server to use when sending a test mailthe FQDN of the SMTP serverPHPMAILERHOST
66phpmailersubscribehostsystemconstantSMTP host for sending messages that originate from the subscribe pagesa valid FQDN of the SMTP hostPHPMAILERHOST
67phpmailerportsystemconstantThe port number for the SMTP connection to PHPMAILERHOSTintegerno value
68phpmailerhostsystemconstantSMTP host for sending messagesa valid FQDN of the SMTP hostno value
69phpmailerblastportqueue processingconstantThe port to use with PHPMAILERBLASTHOSTA working portPHPMAILERPORT
70phpmailerblasthostqueue processingconstantSMTP server to use when sending the actual campaignThe FQDB of the serverPHPMAILERHOST
71phpmailer_smtpusersystemvariableSTMP Authentication usernamestringno value
72phpmailer_smtppasswordsystemvariableSMTP authentication passwordstringno value
73phpmailer_smtpoptionssendingvariablepass smtpoptions to phpMailerany valid smtpoptions for phpMailer
74phpmailer_securerenderingconstantSet the Secure option in phpMailerauto tls ssl falseauto
75phpmailersystemconstantUse phpMailer for sendingtrue false 0 11
76password_change_timeframesecurityconstantTime allowed for an admin to use the token to change their password.A valid mySQL INTERVAL value1 day
77pagetextcreditssubscriptionconstantUse text credits for phpList on pages, instead of an imagetrue false 0 10
78pagerootsystemvariableLocation of phpList in relation to the web server roota valid path/lists/
79numattachmentscompositionconstantHow many attachments to allow uploading in one go.Any positive number1
80notify_spamanti-spamconstantSend an alert when spam was blockedtrue false 0 11
81noteditableconfigadminvariableSuppress certain config values from being editable in the admin pages.array of valuesempty array
82nostatscollectionfeedbackconstantSwitch off collection of statistics0 1 true falsefalse
83mimetypes_filecompositionconstantFile containing the Mime-types of binary filesstring pointing to a file with mime-types/etc/mime.types
84messagequeue_preparequeue processingconstantRun the queue in a two-process waytrue false 0 10
85message_sendstatus_sampletimequeue processingconstantThe number of second to sample for a running campaign, to calculate the send speedAny positive number600
86message_sendstatus_inactivethresholdqueue processingconstantHow soon to say a campaign being sent is "stalled" or not sendingAny number120
87message_envelopebounce managementvariableThe email address where bounces will goone single valid email addressno value
88merge_duplicates_delete_duplicatesubscriber managementconstantWhen merging duplicate subscribers, remove the duplicatetrue falsetrue
89maxlistsegmentationconstantThe maximum number of lists a non-superuser administrator can haveAny positive number1
90max_user_ppconstantLimit the amount of results listed in a pagepositive number50
91max_sendprocessesqueue processingconstantNumber of simultaneous sending processes allowed11
92max_processqueue_timequeue processingconstantLimit the time that can be used to process the queueAny number99999
93max_process_messagequeue processingconstantHow many campaigns to process at the same timeAny positive number5
94max_msg_ppconstantLimit the amount of results listed in a pagepositive number5
95max_avatar_sizesubscriber managementconstantSize of file for avatarAny sensible number2000
96manually_process_queuequeue processingconstantSend queued messages from the admin interface.true false 0 11
97manually_process_bouncesbounce managementconstantProcess the bounces in the admin interfacetrue false 0 11
98mailqueue_throttlequeue processingconstantAdd a delay between messages to avoid overloading the server.Any number, even fractions0
99mailqueue_batch_sizequeue processingconstantBatch processingA number higher or equal to 00
100mailqueue_batch_periodqueue processingconstantThe time allowed for sending a batch.Any number3600
101mailqueue_autothrottlequeue processingconstantAutomatically slow down sending the queue to spread the batch size across the batch period.true false 1 00
102language_switchadminconstantAllow changing language using a dropdowntrue false 0 11
103language_modulei18nvariableThe default language for the frontendany of the files in lists/texts/english.inc
104language_auto_updatei18nconstantAutomatically update translations when the filesystem file is newer than the last updatetrue falsetrue
105keepforwarderattributessocial networkingconstantUse the attributes of the subscriber for placeholder when forwarding a messagetrue false 0 1false
106installation_namesystemvariableName a phpList installation to be able to distinguish different installationsstringphpList
107import_filesizesubscriber managementconstantMaximum size of an import fileNumber (in MB)5
108htmlemail_encodingrenderingconstantSet the transfer encoding for the HTML part of the generated messages8bit 7bit base64 quoted-printablequoted-printable
109hash_algosecurityconstantThe hash method to use when hashing passwordsany algorithm accepted in your PHP system, see http://php.net/hash-algossha256
110forward_personal_note_sizesocial networkingconstantAllow a personal note to be added when forwarding a messageA number (size in bytes)0 (disable)
111forward_email_periodsocial networkingconstantLimit the time period for reaching the maximum forwarding amountA valid mySQL INTERVAL value1 day
112forward_email_countsocial networkingconstantNumber of email addresses allowed to enter when forwarding a messageA number1
113forward_alternative_contentsocial networkingconstantEnter different content for the message that is forwardedtrue false 0 1false
114filesystem_attachmentscompositionconstantAllow adding attachments from the filesystem of the server phpList is running ontrue false 0 10
115fckimages_dircompositionconstantLocation for uploading images in the FCKeditorDirectory name in the "lists" directoryuploadimages
116export_mimetypesubscriber managementvariableThe mime-type sent to the browser for the export filea mime-typeapplication/csv
117export_excelsubscriber managementconstantFormat the export file to allow use in Microsoft Exceltrue falsefalse
118error404pagesystemconstantAllow a custom file-not-found pagefilename in webroot
119encryption_algosecurityconstantThe encryption method to use when encrypting passwordsany algorithm accepted in your PHP system, see http://php.net/hash-algossha256
120encrypt_admin_passwordssecurityconstantEnable encryption of admin passwordstrue false 0 11
121empty_value_prefixsegmentationconstantSet a dropdown prefix which indicates no valueA short string--
122embeduploadimagesrenderingconstantAdd uploaded images as embedded images when sendingtrue false 0 10
123embedexternalimagescompositionconstantpull external images and embed them in campaignstrue falsefalse
124emailtextcreditsrenderingconstantUse text credits for phpList in emails, instead of an imagetrue false 0 10
125email_address_validation_levelsubscriber managementconstantA choice of level of validation of an email address0, 1, 2, 3, 43
126domain_batch_sizequeue processingconstantAmount of mails to allow being sent to the same domain in the indicated timeAny number larger than 01
127domain_batch_periodqueue processingconstantTime frame for domain throttlingAny number larger than 1120
128domain_auto_throttlequeue processingconstantAuto throttle sending to domainstrue false 0 10
129devsitesystemconstantRun phpList in development modetrue falsefalse
130default_system_languagei18nvariableLanguage to use when it cannot be determined from the contextISO code of the languageen
131default_mimetypecompositionconstantFallback for the mimetype when it could not be determineda sensible mimetypeapplication/octet-stream
132default_messageagequeue processingconstantAmount of time to allow sending a campaign, until it is considered too oldAny sensible number604800
133db_translationi18nconstantNo ideatrue false0
134date_start_yearsegmentationconstantSet the start year for any date dropdownAny recent year1900
135date_end_yearsegmentationconstantSet the end year for any date dropdownany sensible year0
136database_moduledatabasevariablethe file holding the database abstractionmysql.incmysql.inc
137database_connection_ssldatabasevariableUse SSL when connecting to the databasetrue falsefalse
138database_connection_compressiondatabasevariableUse compression in the mySql database connectiontrue falsefalse
139dataentryconstanthttp
140clicktrack_showdetailstatisticsconstantShow more detail in the statistics when tracking clickstrue false 0 10
141clicktrack_linkmapstatisticsconstantDefine a mod-rewrite mapping of clicked linksA sensible stringno value
142clicktrackstatisticsconstantEnable tracking of clicks in campaigns via URL rewritingtrue false 0 11
143check_sessionipsecurityconstantVerify the session of the logged in administratortrue false 0 11
144check_referrersecurityconstantVerify that the referring web page is allowedtrue false 0 11
145check_for_hostsubscriber managementvariableVerify that the HOST part of an email address is a deliverable domaintrue false 0 10
146bounce_unsubscribe_thresholdsubscriber managementvariableHow many consecutive bounces to consider before marking a subscriber unconfirmedInteger5
147bounce_protocolbounce managementvariableWhat method to use to fetch bouncespop mboxpop
148bounce_mailbox_purge_unprocessedbounce managementvariableDelete bounces from the mailbox that were not matched to be for a campaign or subscriber (unidentified bounce)true false 0 1true
149bounce_mailbox_purgebounce managementvariabledelete bounces from the mailbox once they have been processedtrue false 0 1true
150block_pasted_clicktracklinkscompositionconstantDetect clicktrack links in the content and block sending the campaign if foundtrue false 0 10
151blacklist_gracetimesubscriber managementconstantNumber of minutes to allow sending a message after blacklisting a subscriberinteger5
152blacklist_email_on_bouncebounce managementconstantAdd an address to the blacklist when it has bounced too many timesAny number5
153aws_secretkeyawsconstantSecret key for sending with Amazon SESstringno value
154aws_posturlawsconstantThe URL for Amazon AWShttps://email.us-east-1.amazonaws.com/
155aws_accesskeyidawsconstantThe access key for using Amazon SESno value
156attributevalue_reorder_limitsegmentationconstantdisallow ordering the attribute values where there are more than this amountnumber100
157attachment_repositorysystemvariableLocation where uploaded files are storedA webserver writable pathno value
158async_request_intervalsystemconstantcreate a delay between Ajax requests on a pageany number > 00
159askforpasswordsecurityconstantAsk subscribers to enter a password for their profile when they registertrue false 0 10
160always_add_usertrackstatisticsconstantAlways add the tracking image to campaignstrue false 0 11
161allowed_referrerssecurityvariableDomains that can refer to the phpList systemarray of domainsempty array
162allow_updateradminconstantEnable Automatic Updatertrue, falsetrue
163allow_non_list_subscribesubscriptionconstantDo not require choosing a list to subscribe totrue false 0 10
164allow_importsubscriber managementconstantEnable import functionalitytrue false 0 1true
165allow_deletebouncebounce managementconstantEnable deletion of bouncestrue false 0 11
166allow_attachmentscompositionconstantChange ALLOW_ATTACHMENTS from 0 to 1 to turn on attachment support. You'll note on the send a message page that there's an additional tab labeled Attach. Click on this tab while preparing your message to add attachments. The attachment tab will display the current (server-set) size limits and allow you to browse for new files to attach. Attachments on text format messages are accessed via a URL included at the bottom of the message. Since phpList 3.4.2 those links will open attachements directly from the browser.0 1 true false0
167admin_wwwrootsystemconstantfix the URL for the admin pagesa valid URL in the context of the systemnot set
168admin_protocolconstantenforce HTTPS on admin pageshttp httpshttp
169admin_auth_moduleauthenticationvariableclass for authentication of the administratorclass filephplist_auth.inc
170add_email_throttlesecurityconstantLimit the use of the Add email in the send test functionalityAny number1
171access_control_allow_originssecurityconstantBlock requests from an incorrect location, but allow multiple domainsarray of domainsundefined
172access_control_allow_originsecurityconstantBlock requests from an incorrect locationhttp://'.$_SERVER['HTTP_HOST']
173attribute_valuesgeography