Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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 | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | /* | |
36 | * Settings metadata file | |
37 | */ | |
38 | ||
dfe1f88a CW |
39 | return [ |
40 | 'profile_double_optin' => [ | |
6a488035 TO |
41 | 'group_name' => 'Mailing Preferences', |
42 | 'group' => 'mailing', | |
43 | 'name' => 'profile_double_optin', | |
74f89a9f | 44 | 'type' => 'Boolean', |
6a488035 | 45 | 'html_type' => 'checkbox', |
007e3bdc | 46 | 'default' => '1', |
6a488035 | 47 | 'add' => '4.1', |
74f89a9f | 48 | 'title' => ts('Enable Double Opt-in for Profile Group(s) field'), |
6a488035 TO |
49 | 'is_domain' => 1, |
50 | 'is_contact' => 0, | |
74f89a9f | 51 | 'description' => ts('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, |
dfe1f88a CW |
53 | ], |
54 | 'track_civimail_replies' => [ | |
6a488035 TO |
55 | 'group_name' => 'Mailing Preferences', |
56 | 'group' => 'mailing', | |
57 | 'name' => 'track_civimail_replies', | |
74f89a9f | 58 | 'type' => 'Boolean', |
6a488035 | 59 | 'html_type' => 'checkbox', |
007e3bdc | 60 | 'default' => '0', |
6a488035 | 61 | 'add' => '4.1', |
74f89a9f | 62 | 'title' => ts('Track replies using VERP in Reply-To header'), |
6a488035 TO |
63 | 'is_domain' => 1, |
64 | 'is_contact' => 0, | |
74f89a9f | 65 | 'description' => ts('If checked, mailings will default to tracking replies using VERP-ed Reply-To. '), |
08e57c58 | 66 | 'help_text' => NULL, |
6a488035 | 67 | 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting', |
dfe1f88a CW |
68 | ], |
69 | 'civimail_workflow' => [ | |
6a488035 TO |
70 | 'group_name' => 'Mailing Preferences', |
71 | 'group' => 'mailing', | |
72 | 'name' => 'civimail_workflow', | |
74f89a9f | 73 | 'type' => 'Boolean', |
6a488035 | 74 | 'html_type' => 'checkbox', |
007e3bdc | 75 | 'default' => '0', |
6a488035 | 76 | 'add' => '4.1', |
74f89a9f | 77 | 'title' => ts('Enable workflow support for CiviMail'), |
6a488035 TO |
78 | 'is_domain' => 1, |
79 | 'is_contact' => 0, | |
74f89a9f | 80 | 'description' => ts('Drupal-only. Rules module must be enabled (beta feature - use with caution).'), |
08e57c58 | 81 | 'help_text' => NULL, |
dfe1f88a CW |
82 | ], |
83 | 'civimail_server_wide_lock' => [ | |
6a488035 TO |
84 | 'group_name' => 'Mailing Preferences', |
85 | 'group' => 'mailing', | |
86 | 'name' => 'civimail_server_wide_lock', | |
74f89a9f | 87 | 'type' => 'Boolean', |
6a488035 | 88 | 'html_type' => 'checkbox', |
007e3bdc | 89 | 'default' => '0', |
6a488035 | 90 | 'add' => '4.1', |
74f89a9f | 91 | 'title' => ts('Enable global server wide lock for CiviMail'), |
6a488035 TO |
92 | 'is_domain' => 1, |
93 | 'is_contact' => 0, | |
08e57c58 TO |
94 | 'description' => NULL, |
95 | 'help_text' => NULL, | |
dfe1f88a CW |
96 | ], |
97 | 'replyTo' => [ | |
6098a966 TO |
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, | |
dfe1f88a CW |
110 | ], |
111 | 'mailing_backend' => [ | |
6a488035 TO |
112 | 'group_name' => 'Mailing Preferences', |
113 | 'group' => 'mailing', | |
114 | 'name' => 'mailing_backend', | |
115 | 'type' => 'Array', | |
116 | 'html_type' => 'checkbox', | |
dfe1f88a | 117 | 'default' => ['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, | |
dfe1f88a CW |
124 | ], |
125 | 'profile_add_to_group_double_optin' => [ | |
6a488035 TO |
126 | 'group_name' => 'Mailing Preferences', |
127 | 'group' => 'mailing', | |
128 | 'name' => 'profile_add_to_group_double_optin', | |
74f89a9f | 129 | 'type' => 'Boolean', |
6a488035 | 130 | 'html_type' => 'checkbox', |
007e3bdc | 131 | 'default' => '0', |
6a488035 | 132 | 'add' => '4.1', |
74f89a9f | 133 | 'title' => ts('Enable Double Opt-in for Profile Group(s) field'), |
6a488035 TO |
134 | 'is_domain' => 1, |
135 | 'is_contact' => 0, | |
74f89a9f | 136 | 'description' => ts('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, |
dfe1f88a CW |
138 | ], |
139 | 'disable_mandatory_tokens_check' => [ | |
9babb598 OB |
140 | 'group_name' => 'Mailing Preferences', |
141 | 'group' => 'mailing', | |
142 | 'name' => 'disable_mandatory_tokens_check', | |
74f89a9f | 143 | 'type' => 'Boolean', |
9babb598 OB |
144 | 'html_type' => 'checkbox', |
145 | 'default' => 0, | |
146 | 'add' => '4.4', | |
74f89a9f | 147 | 'title' => ts('Disable check for mandatory tokens'), |
9babb598 OB |
148 | 'is_domain' => 1, |
149 | 'is_contact' => 0, | |
74f89a9f | 150 | 'description' => ts('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, |
dfe1f88a CW |
152 | ], |
153 | 'dedupe_email_default' => [ | |
9d76357a DG |
154 | 'group_name' => 'Mailing Preferences', |
155 | 'group' => 'mailing', | |
156 | 'name' => 'dedupe_email_default', | |
74f89a9f | 157 | 'type' => 'Boolean', |
9d76357a DG |
158 | 'html_type' => 'checkbox', |
159 | 'default' => 1, | |
160 | 'add' => '4.5', | |
74f89a9f | 161 | 'title' => ts('CiviMail dedupes e-mail addresses by default'), |
9d76357a DG |
162 | 'is_domain' => 1, |
163 | 'is_contact' => 0, | |
74f89a9f | 164 | 'description' => ts('Set the "dedupe e-mail" option when sending a new mailing to "true" by default.'), |
08e57c58 | 165 | 'help_text' => NULL, |
dfe1f88a CW |
166 | ], |
167 | 'hash_mailing_url' => [ | |
c57f36a1 PJ |
168 | 'group_name' => 'Mailing Preferences', |
169 | 'group' => 'mailing', | |
170 | 'name' => 'hash_mailing_url', | |
74f89a9f | 171 | 'type' => 'Boolean', |
c57f36a1 PJ |
172 | 'html_type' => 'checkbox', |
173 | 'default' => 0, | |
174 | 'add' => '4.5', | |
74f89a9f | 175 | 'title' => ts('Hashed Mailing URL\'s'), |
c57f36a1 PJ |
176 | 'is_domain' => 1, |
177 | 'is_contact' => 0, | |
74f89a9f | 178 | 'description' => ts('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, |
dfe1f88a CW |
180 | ], |
181 | 'civimail_multiple_bulk_emails' => [ | |
84fb7424 TO |
182 | 'group_name' => 'Mailing Preferences', |
183 | 'group' => 'mailing', | |
184 | 'name' => 'civimail_multiple_bulk_emails', | |
74f89a9f | 185 | 'type' => 'Boolean', |
84fb7424 TO |
186 | 'html_type' => 'checkbox', |
187 | 'default' => 0, | |
188 | 'add' => '4.5', | |
74f89a9f | 189 | 'title' => ts('Enable multiple bulk email address for a contact.'), |
84fb7424 TO |
190 | 'is_domain' => 1, |
191 | 'is_contact' => 0, | |
38056b36 | 192 | 'description' => ts('CiviMail will deliver a copy of the email to each bulk email listed for the contact. Enabling this setting will also change the options for the "Email on Hold" field in Advanced Search.'), |
84fb7424 | 193 | 'help_text' => NULL, |
dfe1f88a CW |
194 | ], |
195 | 'include_message_id' => [ | |
89595c92 TO |
196 | 'group_name' => 'Mailing Preferences', |
197 | 'group' => 'mailing', | |
198 | 'name' => 'include_message_id', | |
74f89a9f | 199 | 'type' => 'Boolean', |
89595c92 TO |
200 | 'html_type' => 'checkbox', |
201 | 'default' => FALSE, | |
202 | 'add' => '4.5', | |
74f89a9f | 203 | 'title' => ts('Enable CiviMail to generate Message-ID header'), |
89595c92 TO |
204 | 'is_domain' => 1, |
205 | 'is_contact' => 0, | |
206 | 'description' => '', | |
207 | 'help_text' => NULL, | |
dfe1f88a CW |
208 | ], |
209 | 'mailerBatchLimit' => [ | |
988689cc TO |
210 | 'group_name' => 'Mailing Preferences', |
211 | 'group' => 'mailing', | |
212 | 'name' => 'mailerBatchLimit', | |
213 | 'type' => 'Integer', | |
214 | 'quick_form_type' => 'Element', | |
215 | 'html_type' => 'text', | |
dfe1f88a | 216 | 'html_attributes' => [ |
988689cc TO |
217 | 'size' => 4, |
218 | 'maxlength' => 8, | |
dfe1f88a | 219 | ], |
988689cc TO |
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, | |
dfe1f88a CW |
227 | ], |
228 | 'mailerJobSize' => [ | |
988689cc TO |
229 | 'group_name' => 'Mailing Preferences', |
230 | 'group' => 'mailing', | |
231 | 'name' => 'mailerJobSize', | |
232 | 'type' => 'Integer', | |
233 | 'quick_form_type' => 'Element', | |
234 | 'html_type' => 'text', | |
dfe1f88a | 235 | 'html_attributes' => [ |
988689cc TO |
236 | 'size' => 4, |
237 | 'maxlength' => 8, | |
dfe1f88a | 238 | ], |
988689cc TO |
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, | |
dfe1f88a CW |
246 | ], |
247 | 'mailerJobsMax' => [ | |
988689cc TO |
248 | 'group_name' => 'Mailing Preferences', |
249 | 'group' => 'mailing', | |
250 | 'name' => 'mailerJobsMax', | |
251 | 'type' => 'Integer', | |
252 | 'quick_form_type' => 'Element', | |
253 | 'html_type' => 'text', | |
dfe1f88a | 254 | 'html_attributes' => [ |
988689cc TO |
255 | 'size' => 4, |
256 | 'maxlength' => 8, | |
dfe1f88a | 257 | ], |
988689cc TO |
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, | |
dfe1f88a CW |
265 | ], |
266 | 'mailThrottleTime' => [ | |
988689cc TO |
267 | 'group_name' => 'Mailing Preferences', |
268 | 'group' => 'mailing', | |
269 | 'name' => 'mailThrottleTime', | |
270 | 'type' => 'Integer', | |
271 | 'quick_form_type' => 'Element', | |
272 | 'html_type' => 'text', | |
dfe1f88a | 273 | 'html_attributes' => [ |
988689cc TO |
274 | 'size' => 4, |
275 | 'maxlength' => 8, | |
dfe1f88a | 276 | ], |
988689cc TO |
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, | |
dfe1f88a CW |
284 | ], |
285 | 'verpSeparator' => [ | |
988689cc TO |
286 | 'group_name' => 'Mailing Preferences', |
287 | 'group' => 'mailing', | |
288 | 'name' => 'verpSeparator', | |
289 | 'type' => 'String', | |
290 | 'quick_form_type' => 'Element', | |
291 | 'html_type' => 'text', | |
dfe1f88a | 292 | 'html_attributes' => [ |
988689cc TO |
293 | 'size' => 4, |
294 | 'maxlength' => 32, | |
dfe1f88a | 295 | ], |
988689cc TO |
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, | |
dfe1f88a CW |
303 | ], |
304 | 'write_activity_record' => [ | |
007e3bdc TO |
305 | 'group_name' => 'Mailing Preferences', |
306 | 'group' => 'mailing', | |
307 | 'name' => 'write_activity_record', | |
308 | 'type' => 'Boolean', | |
74f89a9f | 309 | 'html_type' => 'checkbox', |
310 | 'quick_form_type' => 'CheckBox', | |
007e3bdc TO |
311 | 'default' => '1', |
312 | 'add' => '4.7', | |
74f89a9f | 313 | 'title' => ts('Enable CiviMail to create activities on delivery'), |
007e3bdc TO |
314 | 'is_domain' => 1, |
315 | 'is_contact' => 0, | |
316 | 'description' => NULL, | |
317 | 'help_text' => NULL, | |
dfe1f88a CW |
318 | ], |
319 | 'simple_mail_limit' => [ | |
eb523ccd | 320 | 'group_name' => 'Mailing Preferences', |
321 | 'group' => 'mailing', | |
322 | 'name' => 'simple_mail_limit', | |
323 | 'type' => 'Integer', | |
324 | 'quick_form_type' => 'Element', | |
325 | 'html_type' => 'text', | |
dfe1f88a | 326 | 'html_attributes' => [ |
eb523ccd | 327 | 'size' => 4, |
328 | 'maxlength' => 8, | |
dfe1f88a | 329 | ], |
eb523ccd | 330 | 'default' => 50, |
331 | 'title' => 'Simple mail limit', | |
332 | 'is_domain' => 1, | |
333 | 'is_contact' => 0, | |
334 | 'description' => 'The number of emails sendable via simple mail. Make sure you understand the implications for your spam reputation and legal requirements for bulk emails before editing. As there is some risk both to your spam reputation and the products if this is misused it is a hidden setting', | |
335 | 'help_text' => 'CiviCRM forces users sending more than this number of mails to use CiviMails. CiviMails have additional precautions: not sending to contacts who do not want bulk mail, adding domain name and opt out links. You should familiarise yourself with the law relevant to you on bulk mailings if changing this setting. For the US https://en.wikipedia.org/wiki/CAN-SPAM_Act_of_2003 is a good place to start.', | |
dfe1f88a CW |
336 | ], |
337 | 'auto_recipient_rebuild' => [ | |
05752ee5 | 338 | 'group_name' => 'Mailing Preferences', |
339 | 'group' => 'mailing', | |
340 | 'name' => 'auto_recipient_rebuild', | |
341 | 'type' => 'Boolean', | |
74f89a9f | 342 | 'html_type' => 'checkbox', |
343 | 'quick_form_type' => 'CheckBox', | |
05752ee5 | 344 | 'default' => '1', |
74f89a9f | 345 | 'title' => ts('Enable automatic CiviMail recipient count display'), |
05752ee5 | 346 | 'is_domain' => 1, |
347 | 'is_contact' => 0, | |
74f89a9f | 348 | 'description' => ts('Enable this setting to rebuild recipient list automatically during composing mail. Disable will allow you to rebuild recipient manually.'), |
349 | 'help_text' => ts('CiviMail automatically fetches recipient list and count whenever mailing groups are included or excluded while composing bulk mail. This phenomena may degrade performance for large sites, so disable this setting to build and fetch recipients for selected groups, manually.'), | |
dfe1f88a CW |
350 | ], |
351 | 'allow_mail_from_logged_in_contact' => [ | |
beac1417 MW |
352 | 'group_name' => 'Mailing Preferences', |
353 | 'group' => 'mailing', | |
354 | 'name' => 'allow_mail_from_logged_in_contact', | |
355 | 'type' => 'Boolean', | |
356 | 'quick_form_type' => 'YesNo', | |
357 | 'default' => 1, | |
358 | 'title' => 'Allow mail from logged in contact', | |
359 | 'is_domain' => 1, | |
360 | 'is_contact' => 0, | |
361 | 'description' => 'Allow sending email from the logged in contact\'s email address', | |
362 | 'help_text' => 'CiviCRM allows you to send email from the domain from email addresses and the logged in contact id addresses by default. Disable this if you only want to allow the domain from addresses to be used.', | |
dfe1f88a CW |
363 | ], |
364 | ]; |