1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
4 <base>CRM/Mailing
</base>
6 <name>civicrm_mailing
</name>
7 <comment>Stores information about a mailing.
</comment>
8 <archive>true
</archive>
11 <title>Mailing ID
</title>
12 <type>int unsigned
</type>
13 <required>true
</required>
17 <autoincrement>true
</autoincrement>
20 <name>domain_id
</name>
21 <title>Mailing Domain
</title>
22 <type>int unsigned
</type>
24 <table>civicrm_domain
</table>
25 <keyColumn>id
</keyColumn>
26 <labelColumn>name
</labelColumn>
28 <comment>Which site is this mailing for
</comment>
32 <name>domain_id
</name>
33 <table>civicrm_domain
</table>
35 <onDelete>SET NULL
</onDelete>
39 <name>header_id
</name>
40 <title>Mailing Header
</title>
41 <type>int unsigned
</type>
43 <table>civicrm_mailing_component
</table>
44 <keyColumn>id
</keyColumn>
45 <labelColumn>name
</labelColumn>
46 <condition>component_type =
"Header"</condition>
48 <comment>FK to the header component.
</comment>
51 <name>header_id
</name>
52 <table>civicrm_mailing_component
</table>
54 <onDelete>SET NULL
</onDelete>
57 <name>footer_id
</name>
58 <title>Mailing Footer
</title>
59 <type>int unsigned
</type>
61 <table>civicrm_mailing_component
</table>
62 <keyColumn>id
</keyColumn>
63 <labelColumn>name
</labelColumn>
64 <condition>component_type =
"Footer"</condition>
66 <comment>FK to the footer component.
</comment>
69 <name>footer_id
</name>
70 <table>civicrm_mailing_component
</table>
72 <onDelete>SET NULL
</onDelete>
76 <title>Mailing Reply
</title>
77 <type>int unsigned
</type>
78 <comment>FK to the auto-responder component.
</comment>
82 <table>civicrm_mailing_component
</table>
84 <onDelete>SET NULL
</onDelete>
87 <name>unsubscribe_id
</name>
88 <title>Mailing Unsubscribe
</title>
89 <type>int unsigned
</type>
90 <comment>FK to the unsubscribe component.
</comment>
93 <name>unsubscribe_id
</name>
94 <table>civicrm_mailing_component
</table>
96 <onDelete>SET NULL
</onDelete>
99 <name>resubscribe_id
</name>
100 <title>Mailing Resubscribe
</title>
101 <type>int unsigned
</type>
104 <name>optout_id
</name>
105 <table>civicrm_mailing_component
</table>
107 <onDelete>SET NULL
</onDelete>
110 <name>optout_id
</name>
111 <title>Mailing Opt Out
</title>
112 <type>int unsigned
</type>
113 <comment>FK to the opt-out component.
</comment>
116 <name>optout_id
</name>
117 <table>civicrm_mailing_component
</table>
119 <onDelete>SET NULL
</onDelete>
123 <uniqueName>mailing_name
</uniqueName>
124 <title>Mailing Name
</title>
127 <comment>Mailing Name.
</comment>
133 <name>mailing_type
</name>
135 <title>Mailing Type
</title>
137 <comment>differentiate between standalone mailings, A/B tests, and A/B final-winner
</comment>
139 <callback>CRM_Mailing_PseudoConstant::mailingTypes
</callback>
147 <name>from_name
</name>
148 <title>Mailing From Name
</title>
151 <comment>From Header of mailing
</comment>
157 <name>from_email
</name>
158 <title>Mailing From Email
</title>
161 <comment>From Email of mailing
</comment>
167 <name>replyto_email
</name>
170 <comment>Reply-To Email of mailing
</comment>
176 <name>template_type
</name>
177 <title>Template Type
</title>
180 <default>'traditional'
</default>
181 <required>true
</required>
182 <comment>The language/processing system used for email templates.
</comment>
184 <callback>CRM_Mailing_BAO_Mailing::getTemplateTypeNames
</callback>
188 <name>template_options
</name>
189 <title>Template Options (JSON)
</title>
190 <type>longtext
</type>
191 <comment>Advanced options used by the email templating system. (JSON encoded)
</comment>
197 <comment>Subject of mailing
</comment>
203 <name>body_text
</name>
204 <type>longtext
</type>
205 <comment>Body of the mailing in text format.
</comment>
208 <name>body_html
</name>
209 <type>longtext
</type>
210 <comment>Body of the mailing in html format.
</comment>
213 <name>url_tracking
</name>
215 <comment>Should we track URL click-throughs for this mailing?
</comment>
217 <type>CheckBox
</type>
221 <name>forward_replies
</name>
223 <comment>Should we forward replies back to the author?
</comment>
225 <type>CheckBox
</type>
229 <name>auto_responder
</name>
231 <comment>Should we enable the auto-responder?
</comment>
233 <type>CheckBox
</type>
237 <name>open_tracking
</name>
238 <title>Track Mailing?
</title>
240 <comment>Should we track when recipients open/read this mailing?
</comment>
243 <name>is_completed
</name>
244 <title>Mailing Completed
</title>
246 <comment>Has at least one job associated with this mailing finished?
</comment>
248 <type>CheckBox
</type>
252 <name>msg_template_id
</name>
253 <title>Mailing Message Template
</title>
254 <type>int unsigned
</type>
255 <comment>FK to the message template.
</comment>
258 <name>msg_template_id
</name>
259 <table>civicrm_msg_template
</table>
261 <onDelete>SET NULL
</onDelete>
264 <name>override_verp
</name>
268 <comment>Overwrite the VERP address in Reply-To
</comment>
270 <type>CheckBox
</type>
274 <name>created_id
</name>
275 <title>Mailing Creator
</title>
276 <type>int unsigned
</type>
277 <comment>FK to Contact ID who first created this mailing
</comment>
280 <name>created_id
</name>
281 <table>civicrm_contact
</table>
283 <onDelete>SET NULL
</onDelete>
286 <name>created_date
</name>
287 <type>timestamp
</type>
288 <default>NULL
</default>
289 <required>false
</required>
290 <title>Mailing Created Date
</title>
291 <comment>Date and time this mailing was created.
</comment>
294 <type>Select Date
</type>
295 <formatType>activityDateTime
</formatType>
299 <name>modified_date
</name>
300 <uniqueName>mailing_modified_date
</uniqueName>
301 <type>timestamp
</type>
302 <comment>When the mailing (or closely related entity) was created or modified or deleted.
</comment>
303 <required>false
</required>
304 <export>true
</export>
305 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
</default>
309 <name>scheduled_id
</name>
310 <title>Scheduled By
</title>
311 <type>int unsigned
</type>
312 <comment>FK to Contact ID who scheduled this mailing
</comment>
315 <name>scheduled_id
</name>
316 <table>civicrm_contact
</table>
318 <onDelete>SET NULL
</onDelete>
321 <name>scheduled_date
</name>
322 <type>timestamp
</type>
323 <default>NULL
</default>
324 <required>false
</required>
325 <title>Mailing Scheduled Date
</title>
326 <comment>Date and time this mailing was scheduled.
</comment>
329 <type>Select Date
</type>
330 <formatType>activityDateTime
</formatType>
334 <name>approver_id
</name>
335 <title>Approved By
</title>
336 <type>int unsigned
</type>
337 <comment>FK to Contact ID who approved this mailing
</comment>
340 <name>approver_id
</name>
341 <table>civicrm_contact
</table>
343 <onDelete>SET NULL
</onDelete>
346 <name>approval_date
</name>
347 <type>timestamp
</type>
348 <default>NULL
</default>
349 <required>false
</required>
350 <title>Mailing Approved Date
</title>
351 <comment>Date and time this mailing was approved.
</comment>
354 <type>Select Date
</type>
355 <formatType>activityDateTime
</formatType>
359 <name>approval_status_id
</name>
360 <type>int unsigned
</type>
361 <title>Approval Status
</title>
362 <comment>The status of this mailing. Values: none, approved, rejected
</comment>
364 <optionGroupName>mail_approval_status
</optionGroupName>
372 <name>approval_note
</name>
373 <type>longtext
</type>
374 <title>Approval Note
</title>
375 <comment>Note behind the decision.
</comment>
378 <type>TextArea
</type>
382 <name>is_archived
</name>
384 <title>Is Mailing Archived?
</title>
386 <comment>Is this mailing archived?
</comment>
388 <type>CheckBox
</type>
393 <name>visibility
</name>
395 <title>Mailing Visibility
</title>
397 <default>'Public Pages'
</default>
398 <comment>In what context(s) is the mailing contents visible (online viewing)
</comment>
400 <callback>CRM_Core_SelectValues::groupVisibility
</callback>
408 <name>campaign_id
</name>
409 <type>int unsigned
</type>
410 <title>Mailing Campaign
</title>
411 <comment>The campaign for which this mailing has been initiated.
</comment>
413 <table>civicrm_campaign
</table>
414 <keyColumn>id
</keyColumn>
415 <labelColumn>title
</labelColumn>
423 <name>campaign_id
</name>
424 <table>civicrm_campaign
</table>
426 <onDelete>SET NULL
</onDelete>
429 <name>dedupe_email
</name>
431 <title>No Duplicate emails?
</title>
434 <comment>Remove duplicate emails?
</comment>
436 <type>CheckBox
</type>
440 <name>sms_provider_id
</name>
441 <title>Mailing SMS Provider
</title>
442 <type>int unsigned
</type>
449 <name>sms_provider_id
</name>
450 <table>civicrm_sms_provider
</table>
452 <onDelete>SET NULL
</onDelete>
457 <title>Mailing Hash
</title>
460 <comment>Key for validating requests related to this mailing.
</comment>
464 <name>index_hash
</name>
465 <fieldName>hash
</fieldName>
469 <name>location_type_id
</name>
470 <title>Location Type
</title>
471 <type>int unsigned
</type>
472 <comment>With email_selection_method, determines which email address to use
</comment>
474 <table>civicrm_location_type
</table>
475 <keyColumn>id
</keyColumn>
476 <labelColumn>display_name
</labelColumn>
481 <name>location_type_id
</name>
482 <table>civicrm_location_type
</table>
484 <onDelete>SET NULL
</onDelete>
488 <name>email_selection_method
</name>
491 <default>'automatic'
</default>
492 <comment>With location_type_id, determine how to choose the email address to use.
</comment>
494 <callback>CRM_Core_SelectValues::emailSelectMethods
</callback>
499 <name>language
</name>
500 <title>Mailing Language
</title>
503 <comment>Language of the content of the mailing. Useful for tokens.
</comment>
506 <optionGroupName>languages
</optionGroupName>
507 <keyColumn>name
</keyColumn>