Merge pull request #9564 from totten/master-19690-cleanup
[civicrm-core.git] / xml / schema / Mailing / Mailing.xml
CommitLineData
6a488035
TO
1<?xml version="1.0" encoding="iso-8859-1" ?>
2
3<table>
4 <base>CRM/Mailing</base>
5 <class>Mailing</class>
6 <name>civicrm_mailing</name>
7 <comment>Stores information about a mailing.</comment>
8 <archive>true</archive>
9 <field>
5435b737 10 <name>id</name>
0d94665e 11 <title>Mailing ID</title>
5435b737
EM
12 <type>int unsigned</type>
13 <required>true</required>
6a488035
TO
14 </field>
15 <primaryKey>
5435b737
EM
16 <name>id</name>
17 <autoincrement>true</autoincrement>
6a488035
TO
18 </primaryKey>
19 <field>
5435b737 20 <name>domain_id</name>
0d94665e 21 <title>Mailing Domain</title>
5435b737
EM
22 <type>int unsigned</type>
23 <pseudoconstant>
24 <table>civicrm_domain</table>
25 <keyColumn>id</keyColumn>
26 <labelColumn>name</labelColumn>
27 </pseudoconstant>
28 <comment>Which site is this mailing for</comment>
29 <add>3.4</add>
6a488035
TO
30 </field>
31 <foreignKey>
5435b737
EM
32 <name>domain_id</name>
33 <table>civicrm_domain</table>
34 <key>id</key>
35 <onDelete>SET NULL</onDelete>
36 <add>3.4</add>
6a488035
TO
37 </foreignKey>
38 <field>
5435b737 39 <name>header_id</name>
0d94665e 40 <title>Mailing Header</title>
5435b737
EM
41 <type>int unsigned</type>
42 <comment>FK to the header component.</comment>
6a488035
TO
43 </field>
44 <foreignKey>
5435b737
EM
45 <name>header_id</name>
46 <table>civicrm_mailing_component</table>
47 <key>id</key>
48 <onDelete>SET NULL</onDelete>
6a488035
TO
49 </foreignKey>
50 <field>
5435b737 51 <name>footer_id</name>
0d94665e 52 <title>Mailing Footer</title>
5435b737
EM
53 <type>int unsigned</type>
54 <comment>FK to the footer component.</comment>
6a488035
TO
55 </field>
56 <foreignKey>
5435b737
EM
57 <name>footer_id</name>
58 <table>civicrm_mailing_component</table>
59 <key>id</key>
60 <onDelete>SET NULL</onDelete>
6a488035
TO
61 </foreignKey>
62 <field>
5435b737 63 <name>reply_id</name>
0d94665e 64 <title>Mailing Reply</title>
5435b737
EM
65 <type>int unsigned</type>
66 <comment>FK to the auto-responder component.</comment>
6a488035
TO
67 </field>
68 <foreignKey>
5435b737
EM
69 <name>reply_id</name>
70 <table>civicrm_mailing_component</table>
71 <key>id</key>
72 <onDelete>SET NULL</onDelete>
6a488035
TO
73 </foreignKey>
74 <field>
5435b737 75 <name>unsubscribe_id</name>
0d94665e 76 <title>Mailing Unsubscribe</title>
5435b737
EM
77 <type>int unsigned</type>
78 <comment>FK to the unsubscribe component.</comment>
6a488035
TO
79 </field>
80 <foreignKey>
5435b737
EM
81 <name>unsubscribe_id</name>
82 <table>civicrm_mailing_component</table>
83 <key>id</key>
84 <onDelete>SET NULL</onDelete>
6a488035
TO
85 </foreignKey>
86 <field>
5435b737 87 <name>resubscribe_id</name>
0d94665e 88 <title>Mailing Resubscribe</title>
5435b737 89 <type>int unsigned</type>
6a488035
TO
90 </field>
91 <foreignKey>
5435b737
EM
92 <name>optout_id</name>
93 <table>civicrm_mailing_component</table>
94 <key>id</key>
95 <onDelete>SET NULL</onDelete>
6a488035
TO
96 </foreignKey>
97 <field>
5435b737 98 <name>optout_id</name>
0d94665e 99 <title>Mailing Opt Out</title>
5435b737
EM
100 <type>int unsigned</type>
101 <comment>FK to the opt-out component.</comment>
6a488035
TO
102 </field>
103 <foreignKey>
5435b737
EM
104 <name>optout_id</name>
105 <table>civicrm_mailing_component</table>
106 <key>id</key>
107 <onDelete>SET NULL</onDelete>
6a488035
TO
108 </foreignKey>
109 <field>
5435b737 110 <name>name</name>
0d94665e 111 <title>Mailing Name</title>
5435b737
EM
112 <type>varchar</type>
113 <length>128</length>
114 <comment>Mailing Name.</comment>
115 <html>
116 <type>Text</type>
117 </html>
6a488035 118 </field>
e81bac46 119 <field>
120 <name>mailing_type</name>
121 <type>varchar</type>
122 <title>Mailing Type</title>
123 <length>32</length>
124 <comment>differentiate between standalone mailings, A/B tests, and A/B final-winner</comment>
125 <pseudoconstant>
126 <callback>CRM_Mailing_PseudoConstant::mailingTypes</callback>
127 </pseudoconstant>
128 <add>4.6</add>
129 <html>
130 <type>Select</type>
131 </html>
132 </field>
6a488035 133 <field>
5435b737 134 <name>from_name</name>
0d94665e 135 <title>Mailing From Name</title>
5435b737
EM
136 <type>varchar</type>
137 <length>128</length>
138 <comment>From Header of mailing</comment>
139 <html>
140 <type>Text</type>
141 </html>
6a488035
TO
142 </field>
143 <field>
5435b737 144 <name>from_email</name>
0d94665e 145 <title>Mailing From Email</title>
5435b737
EM
146 <type>varchar</type>
147 <length>128</length>
148 <comment>From Email of mailing</comment>
149 <html>
150 <type>Text</type>
151 </html>
6a488035
TO
152 </field>
153 <field>
5435b737
EM
154 <name>replyto_email</name>
155 <type>varchar</type>
156 <length>128</length>
157 <comment>Reply-To Email of mailing</comment>
158 <html>
159 <type>Text</type>
160 </html>
6a488035 161 </field>
703875d8
TO
162 <field>
163 <name>template_type</name>
164 <title>Template Type</title>
165 <type>varchar</type>
166 <length>64</length>
167 <default>'traditional'</default>
168 <required>true</required>
169 <comment>The language/processing system used for email templates.</comment>
170 <pseudoconstant>
171 <callback>CRM_Mailing_BAO_Mailing::getTemplateTypeNames</callback>
172 </pseudoconstant>
173 </field>
174 <field>
175 <name>template_options</name>
176 <title>Template Options (JSON)</title>
177 <type>longtext</type>
178 <comment>Advanced options used by the email templating system. (JSON encoded)</comment>
179 </field>
6a488035 180 <field>
5435b737
EM
181 <name>subject</name>
182 <type>varchar</type>
183 <length>128</length>
184 <comment>Subject of mailing</comment>
185 <html>
186 <type>Text</type>
187 </html>
6a488035
TO
188 </field>
189 <field>
5435b737
EM
190 <name>body_text</name>
191 <type>longtext</type>
192 <comment>Body of the mailing in text format.</comment>
6a488035
TO
193 </field>
194 <field>
5435b737
EM
195 <name>body_html</name>
196 <type>longtext</type>
197 <comment>Body of the mailing in html format.</comment>
6a488035
TO
198 </field>
199 <field>
5435b737
EM
200 <name>url_tracking</name>
201 <type>boolean</type>
202 <comment>Should we track URL click-throughs for this mailing?</comment>
203 <html>
204 <type>CheckBox</type>
205 </html>
6a488035
TO
206 </field>
207 <field>
5435b737
EM
208 <name>forward_replies</name>
209 <type>boolean</type>
210 <comment>Should we forward replies back to the author?</comment>
211 <html>
212 <type>CheckBox</type>
213 </html>
6a488035
TO
214 </field>
215 <field>
5435b737
EM
216 <name>auto_responder</name>
217 <type>boolean</type>
218 <comment>Should we enable the auto-responder?</comment>
219 <html>
220 <type>CheckBox</type>
221 </html>
6a488035
TO
222 </field>
223 <field>
5435b737 224 <name>open_tracking</name>
32ac94e8 225 <title>Track Mailing?</title>
5435b737
EM
226 <type>boolean</type>
227 <comment>Should we track when recipients open/read this mailing?</comment>
6a488035
TO
228 </field>
229 <field>
5435b737 230 <name>is_completed</name>
32ac94e8 231 <title>Mailing Completed</title>
5435b737
EM
232 <type>boolean</type>
233 <comment>Has at least one job associated with this mailing finished?</comment>
234 <html>
235 <type>CheckBox</type>
236 </html>
6a488035
TO
237 </field>
238 <field>
5435b737 239 <name>msg_template_id</name>
32ac94e8 240 <title>Mailing Message Template</title>
5435b737
EM
241 <type>int unsigned</type>
242 <comment>FK to the message template.</comment>
6a488035
TO
243 </field>
244 <foreignKey>
5435b737
EM
245 <name>msg_template_id</name>
246 <table>civicrm_msg_template</table>
247 <key>id</key>
248 <onDelete>SET NULL</onDelete>
6a488035
TO
249 </foreignKey>
250 <field>
5435b737
EM
251 <name>override_verp</name>
252 <type>boolean</type>
253 <default>0</default>
254 <add>2.2</add>
255 <comment>Should we overrite VERP address in Reply-To</comment>
256 <html>
257 <type>CheckBox</type>
258 </html>
6a488035
TO
259 </field>
260 <field>
5435b737 261 <name>created_id</name>
32ac94e8 262 <title>Mailing Creator</title>
5435b737
EM
263 <type>int unsigned</type>
264 <comment>FK to Contact ID who first created this mailing</comment>
6a488035
TO
265 </field>
266 <foreignKey>
5435b737
EM
267 <name>created_id</name>
268 <table>civicrm_contact</table>
269 <key>id</key>
270 <onDelete>SET NULL</onDelete>
6a488035
TO
271 </foreignKey>
272 <field>
5435b737
EM
273 <name>created_date</name>
274 <type>datetime</type>
275 <title>Mailing Created Date</title>
276 <comment>Date and time this mailing was created.</comment>
277 <add>3.0</add>
278 <html>
279 <type>Select Date</type>
280 </html>
6a488035
TO
281 </field>
282 <field>
5435b737 283 <name>scheduled_id</name>
32ac94e8 284 <title>Scheduled By</title>
5435b737
EM
285 <type>int unsigned</type>
286 <comment>FK to Contact ID who scheduled this mailing</comment>
6a488035
TO
287 </field>
288 <foreignKey>
5435b737
EM
289 <name>scheduled_id</name>
290 <table>civicrm_contact</table>
291 <key>id</key>
292 <onDelete>SET NULL</onDelete>
6a488035
TO
293 </foreignKey>
294 <field>
5435b737
EM
295 <name>scheduled_date</name>
296 <type>datetime</type>
297 <title>Mailing Scheduled Date</title>
298 <comment>Date and time this mailing was scheduled.</comment>
299 <add>3.3</add>
6a488035
TO
300 </field>
301 <field>
5435b737 302 <name>approver_id</name>
32ac94e8 303 <title>Approved By</title>
5435b737
EM
304 <type>int unsigned</type>
305 <comment>FK to Contact ID who approved this mailing</comment>
6a488035
TO
306 </field>
307 <foreignKey>
5435b737
EM
308 <name>approver_id</name>
309 <table>civicrm_contact</table>
310 <key>id</key>
311 <onDelete>SET NULL</onDelete>
6a488035
TO
312 </foreignKey>
313 <field>
5435b737
EM
314 <name>approval_date</name>
315 <type>datetime</type>
316 <title>Mailing Approved Date</title>
317 <comment>Date and time this mailing was approved.</comment>
318 <add>3.3</add>
319 </field>
320 <field>
321 <name>approval_status_id</name>
322 <type>int unsigned</type>
323 <title>Approval Status</title>
324 <comment>The status of this mailing. Values: none, approved, rejected</comment>
325 <pseudoconstant>
326 <optionGroupName>mail_approval_status</optionGroupName>
327 </pseudoconstant>
328 <html>
329 <type>Select</type>
330 </html>
331 <add>3.3</add>
332 </field>
333 <field>
334 <name>approval_note</name>
335 <type>longtext</type>
336 <title>Approval Note</title>
337 <comment>Note behind the decision.</comment>
338 <add>3.3</add>
339 <html>
340 <type>TextArea</type>
341 </html>
342 </field>
343 <field>
344 <name>is_archived</name>
345 <type>boolean</type>
56b7523d 346 <title>Is Mailing Archived?</title>
5435b737
EM
347 <default>0</default>
348 <comment>Is this mailing archived?</comment>
349 <html>
350 <type>CheckBox</type>
351 </html>
352 <add>2.2</add>
353 </field>
354 <field>
355 <name>visibility</name>
356 <type>varchar</type>
56b7523d 357 <title>Mailing Visibility</title>
5435b737
EM
358 <length>40</length>
359 <default>'Public Pages'</default>
360 <comment>In what context(s) is the mailing contents visible (online viewing)</comment>
361 <pseudoconstant>
362 <callback>CRM_Core_SelectValues::groupVisibility</callback>
363 </pseudoconstant>
364 <add>3.3</add>
365 <html>
366 <type>Select</type>
367 </html>
368 </field>
369 <field>
370 <name>campaign_id</name>
371 <type>int unsigned</type>
56b7523d 372 <title>Mailing Campaign</title>
5435b737
EM
373 <comment>The campaign for which this mailing has been initiated.</comment>
374 <pseudoconstant>
375 <table>civicrm_campaign</table>
376 <keyColumn>id</keyColumn>
377 <labelColumn>title</labelColumn>
378 </pseudoconstant>
379 <add>3.4</add>
380 <html>
381 <type>Select</type>
382 </html>
3c7d2158 383 </field>
384 <foreignKey>
5435b737
EM
385 <name>campaign_id</name>
386 <table>civicrm_campaign</table>
387 <key>id</key>
388 <onDelete>SET NULL</onDelete>
6a488035
TO
389 </foreignKey>
390 <field>
5435b737
EM
391 <name>dedupe_email</name>
392 <type>boolean</type>
56b7523d 393 <title>No Duplicate emails?</title>
5435b737
EM
394 <default>0</default>
395 <add>4.1</add>
396 <comment>Remove duplicate emails?</comment>
397 <html>
398 <type>CheckBox</type>
399 </html>
6a488035 400 </field>
3c7d2158 401 <field>
5435b737 402 <name>sms_provider_id</name>
0d94665e 403 <title>Mailing SMS Provider</title>
5435b737
EM
404 <type>int unsigned</type>
405 <add>4.2</add>
406 <html>
407 <type>Select</type>
408 </html>
3c7d2158 409 </field>
410 <foreignKey>
5435b737
EM
411 <name>sms_provider_id</name>
412 <table>civicrm_sms_provider</table>
413 <key>id</key>
414 <onDelete>SET NULL</onDelete>
415 <add>4.2</add>
6a488035 416 </foreignKey>
c57f36a1 417 <field>
5435b737
EM
418 <name>hash</name>
419 <title>Mailing Hash</title>
420 <type>varchar</type>
421 <length>16</length>
422 <comment>Key for validating requests related to this mailing.</comment>
423 <add>4.5</add>
c57f36a1
PJ
424 </field>
425 <index>
5435b737
EM
426 <name>index_hash</name>
427 <fieldName>hash</fieldName>
428 <add>4.5</add>
c57f36a1 429 </index>
bac4cd35 430 <field>
431 <name>location_type_id</name>
432 <title>Location Type</title>
433 <type>int unsigned</type>
bac4cd35 434 <comment>With email_selection_method, determines which email address to use</comment>
78301a79
TO
435 <pseudoconstant>
436 <table>civicrm_location_type</table>
437 <keyColumn>id</keyColumn>
438 <labelColumn>display_name</labelColumn>
439 </pseudoconstant>
64dfb8df 440 <add>4.6</add>
bac4cd35 441 </field>
befed893
CDU
442 <foreignKey>
443 <name>location_type_id</name>
444 <table>civicrm_location_type</table>
445 <key>id</key>
446 <onDelete>SET NULL</onDelete>
447 <add>4.6</add>
448 </foreignKey>
f96a4094 449 <field>
bac4cd35 450 <name>email_selection_method</name>
451 <type>varchar</type>
452 <length>20</length>
453 <default>'automatic'</default>
454 <comment>With location_type_id, determine how to choose the email address to use.</comment>
78301a79
TO
455 <pseudoconstant>
456 <callback>CRM_Core_SelectValues::emailSelectMethods</callback>
457 </pseudoconstant>
64dfb8df 458 <add>4.6</add>
bac4cd35 459 </field>
c00b95ef
ML
460 <field>
461 <name>language</name>
462 <title>Mailing Language</title>
463 <type>varchar</type>
464 <length>5</length>
465 <comment>Language of the content of the mailing. Useful for tokens.</comment>
466 <add>4.6</add>
467 <pseudoconstant>
468 <optionGroupName>languages</optionGroupName>
469 <keyColumn>name</keyColumn>
470 </pseudoconstant>
471 <html>
472 <type>Select</type>
473 </html>
474 </field>
c2b4755a 475</table>