Commit | Line | Data |
---|---|---|
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 | 273 | <name>created_date</name> |
4387c66f | 274 | <type>timestamp</type> |
275 | <default>CURRENT_TIMESTAMP</default> | |
276 | <required>false</required> | |
5435b737 EM |
277 | <title>Mailing Created Date</title> |
278 | <comment>Date and time this mailing was created.</comment> | |
279 | <add>3.0</add> | |
280 | <html> | |
281 | <type>Select Date</type> | |
4387c66f | 282 | <formatType>activityDateTime</formatType> |
5435b737 | 283 | </html> |
6a488035 TO |
284 | </field> |
285 | <field> | |
5435b737 | 286 | <name>scheduled_id</name> |
32ac94e8 | 287 | <title>Scheduled By</title> |
5435b737 EM |
288 | <type>int unsigned</type> |
289 | <comment>FK to Contact ID who scheduled this mailing</comment> | |
6a488035 TO |
290 | </field> |
291 | <foreignKey> | |
5435b737 EM |
292 | <name>scheduled_id</name> |
293 | <table>civicrm_contact</table> | |
294 | <key>id</key> | |
295 | <onDelete>SET NULL</onDelete> | |
6a488035 TO |
296 | </foreignKey> |
297 | <field> | |
5435b737 | 298 | <name>scheduled_date</name> |
4387c66f | 299 | <type>timestamp</type> |
300 | <default>NULL</default> | |
301 | <required>false</required> | |
5435b737 EM |
302 | <title>Mailing Scheduled Date</title> |
303 | <comment>Date and time this mailing was scheduled.</comment> | |
304 | <add>3.3</add> | |
4387c66f | 305 | <html> |
306 | <type>Select Date</type> | |
307 | <formatType>activityDateTime</formatType> | |
308 | </html> | |
6a488035 TO |
309 | </field> |
310 | <field> | |
5435b737 | 311 | <name>approver_id</name> |
32ac94e8 | 312 | <title>Approved By</title> |
5435b737 EM |
313 | <type>int unsigned</type> |
314 | <comment>FK to Contact ID who approved this mailing</comment> | |
6a488035 TO |
315 | </field> |
316 | <foreignKey> | |
5435b737 EM |
317 | <name>approver_id</name> |
318 | <table>civicrm_contact</table> | |
319 | <key>id</key> | |
320 | <onDelete>SET NULL</onDelete> | |
6a488035 TO |
321 | </foreignKey> |
322 | <field> | |
5435b737 | 323 | <name>approval_date</name> |
4387c66f | 324 | <type>timestamp</type> |
325 | <default>NULL</default> | |
326 | <required>false</required> | |
5435b737 EM |
327 | <title>Mailing Approved Date</title> |
328 | <comment>Date and time this mailing was approved.</comment> | |
329 | <add>3.3</add> | |
4387c66f | 330 | <html> |
331 | <type>Select Date</type> | |
332 | <formatType>activityDateTime</formatType> | |
333 | </html> | |
5435b737 EM |
334 | </field> |
335 | <field> | |
336 | <name>approval_status_id</name> | |
337 | <type>int unsigned</type> | |
338 | <title>Approval Status</title> | |
339 | <comment>The status of this mailing. Values: none, approved, rejected</comment> | |
340 | <pseudoconstant> | |
341 | <optionGroupName>mail_approval_status</optionGroupName> | |
342 | </pseudoconstant> | |
343 | <html> | |
344 | <type>Select</type> | |
345 | </html> | |
346 | <add>3.3</add> | |
347 | </field> | |
348 | <field> | |
349 | <name>approval_note</name> | |
350 | <type>longtext</type> | |
351 | <title>Approval Note</title> | |
352 | <comment>Note behind the decision.</comment> | |
353 | <add>3.3</add> | |
354 | <html> | |
355 | <type>TextArea</type> | |
356 | </html> | |
357 | </field> | |
358 | <field> | |
359 | <name>is_archived</name> | |
360 | <type>boolean</type> | |
56b7523d | 361 | <title>Is Mailing Archived?</title> |
5435b737 EM |
362 | <default>0</default> |
363 | <comment>Is this mailing archived?</comment> | |
364 | <html> | |
365 | <type>CheckBox</type> | |
366 | </html> | |
367 | <add>2.2</add> | |
368 | </field> | |
369 | <field> | |
370 | <name>visibility</name> | |
371 | <type>varchar</type> | |
56b7523d | 372 | <title>Mailing Visibility</title> |
5435b737 EM |
373 | <length>40</length> |
374 | <default>'Public Pages'</default> | |
375 | <comment>In what context(s) is the mailing contents visible (online viewing)</comment> | |
376 | <pseudoconstant> | |
377 | <callback>CRM_Core_SelectValues::groupVisibility</callback> | |
378 | </pseudoconstant> | |
379 | <add>3.3</add> | |
380 | <html> | |
381 | <type>Select</type> | |
382 | </html> | |
383 | </field> | |
384 | <field> | |
385 | <name>campaign_id</name> | |
386 | <type>int unsigned</type> | |
56b7523d | 387 | <title>Mailing Campaign</title> |
5435b737 EM |
388 | <comment>The campaign for which this mailing has been initiated.</comment> |
389 | <pseudoconstant> | |
390 | <table>civicrm_campaign</table> | |
391 | <keyColumn>id</keyColumn> | |
392 | <labelColumn>title</labelColumn> | |
393 | </pseudoconstant> | |
394 | <add>3.4</add> | |
395 | <html> | |
396 | <type>Select</type> | |
397 | </html> | |
3c7d2158 | 398 | </field> |
399 | <foreignKey> | |
5435b737 EM |
400 | <name>campaign_id</name> |
401 | <table>civicrm_campaign</table> | |
402 | <key>id</key> | |
403 | <onDelete>SET NULL</onDelete> | |
6a488035 TO |
404 | </foreignKey> |
405 | <field> | |
5435b737 EM |
406 | <name>dedupe_email</name> |
407 | <type>boolean</type> | |
56b7523d | 408 | <title>No Duplicate emails?</title> |
5435b737 EM |
409 | <default>0</default> |
410 | <add>4.1</add> | |
411 | <comment>Remove duplicate emails?</comment> | |
412 | <html> | |
413 | <type>CheckBox</type> | |
414 | </html> | |
6a488035 | 415 | </field> |
3c7d2158 | 416 | <field> |
5435b737 | 417 | <name>sms_provider_id</name> |
0d94665e | 418 | <title>Mailing SMS Provider</title> |
5435b737 EM |
419 | <type>int unsigned</type> |
420 | <add>4.2</add> | |
421 | <html> | |
422 | <type>Select</type> | |
423 | </html> | |
3c7d2158 | 424 | </field> |
425 | <foreignKey> | |
5435b737 EM |
426 | <name>sms_provider_id</name> |
427 | <table>civicrm_sms_provider</table> | |
428 | <key>id</key> | |
429 | <onDelete>SET NULL</onDelete> | |
430 | <add>4.2</add> | |
6a488035 | 431 | </foreignKey> |
c57f36a1 | 432 | <field> |
5435b737 EM |
433 | <name>hash</name> |
434 | <title>Mailing Hash</title> | |
435 | <type>varchar</type> | |
436 | <length>16</length> | |
437 | <comment>Key for validating requests related to this mailing.</comment> | |
438 | <add>4.5</add> | |
c57f36a1 PJ |
439 | </field> |
440 | <index> | |
5435b737 EM |
441 | <name>index_hash</name> |
442 | <fieldName>hash</fieldName> | |
443 | <add>4.5</add> | |
c57f36a1 | 444 | </index> |
bac4cd35 | 445 | <field> |
446 | <name>location_type_id</name> | |
447 | <title>Location Type</title> | |
448 | <type>int unsigned</type> | |
bac4cd35 | 449 | <comment>With email_selection_method, determines which email address to use</comment> |
78301a79 TO |
450 | <pseudoconstant> |
451 | <table>civicrm_location_type</table> | |
452 | <keyColumn>id</keyColumn> | |
453 | <labelColumn>display_name</labelColumn> | |
454 | </pseudoconstant> | |
64dfb8df | 455 | <add>4.6</add> |
bac4cd35 | 456 | </field> |
befed893 CDU |
457 | <foreignKey> |
458 | <name>location_type_id</name> | |
459 | <table>civicrm_location_type</table> | |
460 | <key>id</key> | |
461 | <onDelete>SET NULL</onDelete> | |
462 | <add>4.6</add> | |
463 | </foreignKey> | |
f96a4094 | 464 | <field> |
bac4cd35 | 465 | <name>email_selection_method</name> |
466 | <type>varchar</type> | |
467 | <length>20</length> | |
468 | <default>'automatic'</default> | |
469 | <comment>With location_type_id, determine how to choose the email address to use.</comment> | |
78301a79 TO |
470 | <pseudoconstant> |
471 | <callback>CRM_Core_SelectValues::emailSelectMethods</callback> | |
472 | </pseudoconstant> | |
64dfb8df | 473 | <add>4.6</add> |
bac4cd35 | 474 | </field> |
c00b95ef ML |
475 | <field> |
476 | <name>language</name> | |
477 | <title>Mailing Language</title> | |
478 | <type>varchar</type> | |
479 | <length>5</length> | |
480 | <comment>Language of the content of the mailing. Useful for tokens.</comment> | |
481 | <add>4.6</add> | |
482 | <pseudoconstant> | |
483 | <optionGroupName>languages</optionGroupName> | |
484 | <keyColumn>name</keyColumn> | |
485 | </pseudoconstant> | |
486 | <html> | |
487 | <type>Select</type> | |
488 | </html> | |
489 | </field> | |
c2b4755a | 490 | </table> |