Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | /* | |
36 | * Settings metadata file | |
37 | */ | |
38 | ||
39 | return array( | |
40 | 'profile_double_optin' => array( | |
41 | 'group_name' => 'Mailing Preferences', | |
42 | 'group' => 'mailing', | |
43 | 'name' => 'profile_double_optin', | |
44 | 'type' => 'Integer', | |
45 | 'html_type' => 'checkbox', | |
007e3bdc | 46 | 'default' => '1', |
6a488035 TO |
47 | 'add' => '4.1', |
48 | 'title' => 'Enable Double Opt-in for Profile Group(s) field', | |
49 | 'is_domain' => 1, | |
50 | 'is_contact' => 0, | |
56fdfc52 | 51 | 'description' => 'When CiviMail is enabled, users who "subscribe" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.', |
08e57c58 | 52 | 'help_text' => NULL, |
6a488035 TO |
53 | ), |
54 | 'track_civimail_replies' => array( | |
55 | 'group_name' => 'Mailing Preferences', | |
56 | 'group' => 'mailing', | |
57 | 'name' => 'track_civimail_replies', | |
58 | 'type' => 'Integer', | |
59 | 'html_type' => 'checkbox', | |
007e3bdc | 60 | 'default' => '0', |
6a488035 | 61 | 'add' => '4.1', |
fe4df6d3 | 62 | 'title' => 'Track replies using VERP in Reply-To header', |
6a488035 TO |
63 | 'is_domain' => 1, |
64 | 'is_contact' => 0, | |
fe4df6d3 | 65 | 'description' => 'If checked, mailings will default to tracking replies using VERP-ed Reply-To. ', |
08e57c58 | 66 | 'help_text' => NULL, |
6a488035 TO |
67 | 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting', |
68 | ), | |
69 | 'civimail_workflow' => array( | |
70 | 'group_name' => 'Mailing Preferences', | |
71 | 'group' => 'mailing', | |
72 | 'name' => 'civimail_workflow', | |
73 | 'type' => 'Integer', | |
74 | 'html_type' => 'checkbox', | |
007e3bdc | 75 | 'default' => '0', |
6a488035 | 76 | 'add' => '4.1', |
66f90900 | 77 | 'title' => 'Use CiviMail Workflow', |
6a488035 TO |
78 | 'is_domain' => 1, |
79 | 'is_contact' => 0, | |
80 | 'description' => 'When CiviMail is enabled, users who "subscribe" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.', | |
08e57c58 | 81 | 'help_text' => NULL, |
6a488035 TO |
82 | ), |
83 | 'civimail_server_wide_lock' => array( | |
84 | 'group_name' => 'Mailing Preferences', | |
85 | 'group' => 'mailing', | |
86 | 'name' => 'civimail_server_wide_lock', | |
87 | 'type' => 'Integer', | |
88 | 'html_type' => 'checkbox', | |
007e3bdc | 89 | 'default' => '0', |
6a488035 | 90 | 'add' => '4.1', |
66f90900 | 91 | 'title' => 'Lock Mails Server-Wide for Mail Sending', |
6a488035 TO |
92 | 'is_domain' => 1, |
93 | 'is_contact' => 0, | |
08e57c58 TO |
94 | 'description' => NULL, |
95 | 'help_text' => NULL, | |
6a488035 | 96 | ), |
6098a966 TO |
97 | 'replyTo' => array( |
98 | 'group_name' => 'Mailing Preferences', | |
99 | 'group' => 'mailing', | |
100 | 'name' => 'replyTo', | |
101 | 'type' => 'Boolean', | |
102 | 'quick_form_type' => 'YesNo', | |
103 | 'default' => 0, | |
104 | 'add' => '4.6', | |
105 | 'title' => 'Enable Custom Reply-To', | |
106 | 'is_domain' => 1, | |
107 | 'is_contact' => 0, | |
108 | 'description' => 'Allow CiviMail users to send mailings with a custom Reply-To header', | |
109 | 'help_text' => NULL, | |
110 | ), | |
6a488035 TO |
111 | 'mailing_backend' => array( |
112 | 'group_name' => 'Mailing Preferences', | |
113 | 'group' => 'mailing', | |
114 | 'name' => 'mailing_backend', | |
115 | 'type' => 'Array', | |
116 | 'html_type' => 'checkbox', | |
007e3bdc | 117 | 'default' => array('outBound_option' => '3'), |
6a488035 | 118 | 'add' => '4.1', |
66f90900 | 119 | 'title' => 'Mailing Backend', |
6a488035 TO |
120 | 'is_domain' => 1, |
121 | 'is_contact' => 0, | |
08e57c58 TO |
122 | 'description' => NULL, |
123 | 'help_text' => NULL, | |
6a488035 | 124 | ), |
6a488035 TO |
125 | 'profile_add_to_group_double_optin' => array( |
126 | 'group_name' => 'Mailing Preferences', | |
127 | 'group' => 'mailing', | |
128 | 'name' => 'profile_add_to_group_double_optin', | |
129 | 'type' => 'Integer', | |
130 | 'html_type' => 'checkbox', | |
007e3bdc | 131 | 'default' => '0', |
6a488035 TO |
132 | 'add' => '4.1', |
133 | 'title' => 'Enable Double Opt-in for Profile Group(s) field', | |
134 | 'is_domain' => 1, | |
135 | 'is_contact' => 0, | |
136 | 'description' => 'When CiviMail is enabled, users who "subscribe" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.', | |
08e57c58 | 137 | 'help_text' => NULL, |
6a488035 | 138 | ), |
9babb598 OB |
139 | 'disable_mandatory_tokens_check' => array( |
140 | 'group_name' => 'Mailing Preferences', | |
141 | 'group' => 'mailing', | |
142 | 'name' => 'disable_mandatory_tokens_check', | |
143 | 'type' => 'Integer', | |
144 | 'html_type' => 'checkbox', | |
145 | 'default' => 0, | |
146 | 'add' => '4.4', | |
147 | 'title' => 'Disable check for mandatory tokens', | |
148 | 'is_domain' => 1, | |
149 | 'is_contact' => 0, | |
150 | 'description' => 'Don\'t check for presence of mandatory tokens (domain address; unsubscribe/opt-out) before sending mailings. WARNING: Mandatory tokens are a safe-guard which facilitate compliance with the US CAN-SPAM Act. They should only be disabled if your organization adopts other mechanisms for compliance or if your organization is not subject to CAN-SPAM.', | |
08e57c58 | 151 | 'help_text' => NULL, |
c57f36a1 | 152 | ), |
9d76357a DG |
153 | 'dedupe_email_default' => array( |
154 | 'group_name' => 'Mailing Preferences', | |
155 | 'group' => 'mailing', | |
156 | 'name' => 'dedupe_email_default', | |
157 | 'type' => 'Integer', | |
158 | 'html_type' => 'checkbox', | |
159 | 'default' => 1, | |
160 | 'add' => '4.5', | |
161 | 'title' => 'CiviMail dedupes e-mail addresses by default', | |
162 | 'is_domain' => 1, | |
163 | 'is_contact' => 0, | |
164 | 'description' => 'Set the "dedupe e-mail" option when sending a new mailing to "true" by default.', | |
08e57c58 | 165 | 'help_text' => NULL, |
9babb598 | 166 | ), |
c57f36a1 PJ |
167 | 'hash_mailing_url' => array( |
168 | 'group_name' => 'Mailing Preferences', | |
169 | 'group' => 'mailing', | |
170 | 'name' => 'hash_mailing_url', | |
171 | 'type' => 'Integer', | |
172 | 'html_type' => 'checkbox', | |
173 | 'default' => 0, | |
174 | 'add' => '4.5', | |
175 | 'title' => 'Hashed Mailing URL\'s', | |
176 | 'is_domain' => 1, | |
177 | 'is_contact' => 0, | |
178 | 'description' => 'If enabled, a randomized hash key will be used to reference the mailing URL in the mailing.viewUrl token, instead of the mailing ID', | |
08e57c58 | 179 | 'help_text' => NULL, |
c57f36a1 | 180 | ), |
84fb7424 TO |
181 | 'civimail_multiple_bulk_emails' => array( |
182 | 'group_name' => 'Mailing Preferences', | |
183 | 'group' => 'mailing', | |
184 | 'name' => 'civimail_multiple_bulk_emails', | |
185 | 'type' => 'Integer', | |
186 | 'html_type' => 'checkbox', | |
187 | 'default' => 0, | |
188 | 'add' => '4.5', | |
189 | 'title' => ' Multiple Bulk Emails', | |
190 | 'is_domain' => 1, | |
191 | 'is_contact' => 0, | |
192 | 'description' => 'If enabled, CiviMail will deliver a copy of the email to each bulk email listed for the contact.', | |
193 | 'help_text' => NULL, | |
194 | ), | |
89595c92 TO |
195 | 'include_message_id' => array( |
196 | 'group_name' => 'Mailing Preferences', | |
197 | 'group' => 'mailing', | |
198 | 'name' => 'include_message_id', | |
199 | 'type' => 'Integer', | |
200 | 'html_type' => 'checkbox', | |
201 | 'default' => FALSE, | |
202 | 'add' => '4.5', | |
203 | 'title' => 'Enable CiviMail to generate Message-ID header', | |
204 | 'is_domain' => 1, | |
205 | 'is_contact' => 0, | |
206 | 'description' => '', | |
207 | 'help_text' => NULL, | |
208 | ), | |
988689cc TO |
209 | 'mailerBatchLimit' => array( |
210 | 'group_name' => 'Mailing Preferences', | |
211 | 'group' => 'mailing', | |
212 | 'name' => 'mailerBatchLimit', | |
213 | 'type' => 'Integer', | |
214 | 'quick_form_type' => 'Element', | |
215 | 'html_type' => 'text', | |
216 | 'html_attributes' => array( | |
217 | 'size' => 4, | |
218 | 'maxlength' => 8, | |
219 | ), | |
220 | 'default' => 0, | |
221 | 'add' => '4.7', | |
222 | 'title' => 'Mailer Batch Limit', | |
223 | 'is_domain' => 1, | |
224 | 'is_contact' => 0, | |
225 | 'description' => 'Throttle email delivery by setting the maximum number of emails sent during each CiviMail run (0 = unlimited).', | |
226 | 'help_text' => NULL, | |
988689cc TO |
227 | ), |
228 | 'mailerJobSize' => array( | |
229 | 'group_name' => 'Mailing Preferences', | |
230 | 'group' => 'mailing', | |
231 | 'name' => 'mailerJobSize', | |
232 | 'type' => 'Integer', | |
233 | 'quick_form_type' => 'Element', | |
234 | 'html_type' => 'text', | |
235 | 'html_attributes' => array( | |
236 | 'size' => 4, | |
237 | 'maxlength' => 8, | |
238 | ), | |
239 | 'default' => 0, | |
240 | 'add' => '4.7', | |
241 | 'title' => 'Mailer Job Size', | |
242 | 'is_domain' => 1, | |
243 | 'is_contact' => 0, | |
244 | 'description' => 'If you want to utilize multi-threading enter the size you want your sub jobs to be split into. Recommended values are between 1,000 and 10,000. Use a lower value if your server has multiple cron jobs running simultaneously, but do not use values smaller than 1,000. Enter "0" to disable multi-threading and process mail as one single job - batch limits still apply.', | |
245 | 'help_text' => NULL, | |
988689cc TO |
246 | ), |
247 | 'mailerJobsMax' => array( | |
248 | 'group_name' => 'Mailing Preferences', | |
249 | 'group' => 'mailing', | |
250 | 'name' => 'mailerJobsMax', | |
251 | 'type' => 'Integer', | |
252 | 'quick_form_type' => 'Element', | |
253 | 'html_type' => 'text', | |
254 | 'html_attributes' => array( | |
255 | 'size' => 4, | |
256 | 'maxlength' => 8, | |
257 | ), | |
258 | 'default' => 0, | |
259 | 'add' => '4.7', | |
260 | 'title' => 'Mailer Cron Job Limit', | |
261 | 'is_domain' => 1, | |
262 | 'is_contact' => 0, | |
263 | 'description' => 'The maximum number of mailer delivery jobs executing simultaneously (0 = allow as many processes to execute as started by cron)', | |
264 | 'help_text' => NULL, | |
988689cc TO |
265 | ), |
266 | 'mailThrottleTime' => array( | |
267 | 'group_name' => 'Mailing Preferences', | |
268 | 'group' => 'mailing', | |
269 | 'name' => 'mailThrottleTime', | |
270 | 'type' => 'Integer', | |
271 | 'quick_form_type' => 'Element', | |
272 | 'html_type' => 'text', | |
273 | 'html_attributes' => array( | |
274 | 'size' => 4, | |
275 | 'maxlength' => 8, | |
276 | ), | |
277 | 'default' => 0, | |
278 | 'add' => '4.7', | |
279 | 'title' => 'Mailer Throttle Time', | |
280 | 'is_domain' => 1, | |
281 | 'is_contact' => 0, | |
282 | 'description' => 'The time to sleep in between each e-mail in micro seconds. Setting this above 0 allows you to control the rate at which e-mail messages are sent to the mail server, avoiding filling up the mail queue very quickly. Set to 0 to disable.', | |
283 | 'help_text' => NULL, | |
988689cc TO |
284 | ), |
285 | 'verpSeparator' => array( | |
286 | 'group_name' => 'Mailing Preferences', | |
287 | 'group' => 'mailing', | |
288 | 'name' => 'verpSeparator', | |
289 | 'type' => 'String', | |
290 | 'quick_form_type' => 'Element', | |
291 | 'html_type' => 'text', | |
292 | 'html_attributes' => array( | |
293 | 'size' => 4, | |
294 | 'maxlength' => 32, | |
295 | ), | |
296 | 'default' => '.', | |
297 | 'add' => '4.7', | |
298 | 'title' => 'VERP Separator', | |
299 | 'is_domain' => 1, | |
300 | 'is_contact' => 0, | |
301 | 'description' => 'Separator character used when CiviMail generates VERP (variable envelope return path) Mail-From addresses.', | |
302 | 'help_text' => NULL, | |
988689cc | 303 | ), |
007e3bdc TO |
304 | 'write_activity_record' => array( |
305 | 'group_name' => 'Mailing Preferences', | |
306 | 'group' => 'mailing', | |
307 | 'name' => 'write_activity_record', | |
308 | 'type' => 'Boolean', | |
309 | 'quick_form_type' => 'YesNo', | |
310 | 'default' => '1', | |
311 | 'add' => '4.7', | |
312 | 'title' => 'Enable CiviMail to create activities on delivery', | |
313 | 'is_domain' => 1, | |
314 | 'is_contact' => 0, | |
315 | 'description' => NULL, | |
316 | 'help_text' => NULL, | |
317 | ), | |
66f90900 | 318 | ); |