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>
9 <icon>fa-envelope-o
</icon>
10 <component>CiviMail
</component>
12 <add>civicrm/a/#/mailing/new
</add>
13 <update>civicrm/a/#/mailing/[id]
</update>
17 <title>Mailing ID
</title>
18 <type>int unsigned
</type>
19 <required>true
</required>
26 <autoincrement>true
</autoincrement>
29 <name>domain_id
</name>
30 <title>Domain ID
</title>
31 <type>int unsigned
</type>
33 <table>civicrm_domain
</table>
34 <keyColumn>id
</keyColumn>
35 <labelColumn>name
</labelColumn>
37 <comment>Which site is this mailing for
</comment>
44 <name>domain_id
</name>
45 <table>civicrm_domain
</table>
47 <onDelete>SET NULL
</onDelete>
51 <name>header_id
</name>
52 <title>Header ID
</title>
53 <type>int unsigned
</type>
55 <table>civicrm_mailing_component
</table>
56 <keyColumn>id
</keyColumn>
57 <labelColumn>name
</labelColumn>
58 <condition>component_type =
"Header"</condition>
60 <comment>FK to the header component.
</comment>
66 <name>header_id
</name>
67 <table>civicrm_mailing_component
</table>
69 <onDelete>SET NULL
</onDelete>
72 <name>footer_id
</name>
73 <title>Footer ID
</title>
74 <type>int unsigned
</type>
76 <table>civicrm_mailing_component
</table>
77 <keyColumn>id
</keyColumn>
78 <labelColumn>name
</labelColumn>
79 <condition>component_type =
"Footer"</condition>
81 <comment>FK to the footer component.
</comment>
87 <name>footer_id
</name>
88 <table>civicrm_mailing_component
</table>
90 <onDelete>SET NULL
</onDelete>
94 <title>Reply ID
</title>
95 <type>int unsigned
</type>
96 <comment>FK to the auto-responder component.
</comment>
102 <name>reply_id
</name>
103 <table>civicrm_mailing_component
</table>
105 <onDelete>SET NULL
</onDelete>
108 <name>unsubscribe_id
</name>
109 <title>Unsubscribe ID
</title>
110 <type>int unsigned
</type>
111 <comment>FK to the unsubscribe component.
</comment>
113 <label>Unsubscribe
</label>
117 <name>unsubscribe_id
</name>
118 <table>civicrm_mailing_component
</table>
120 <onDelete>SET NULL
</onDelete>
123 <name>resubscribe_id
</name>
124 <title>Mailing Resubscribe
</title>
125 <type>int unsigned
</type>
128 <name>optout_id
</name>
129 <title>Opt Out ID
</title>
130 <type>int unsigned
</type>
131 <comment>FK to the opt-out component.
</comment>
133 <label>Opt Out
</label>
137 <name>optout_id
</name>
138 <table>civicrm_mailing_component
</table>
140 <onDelete>SET NULL
</onDelete>
144 <uniqueName>mailing_name
</uniqueName>
145 <title>Mailing Name
</title>
148 <comment>Mailing Name.
</comment>
154 <name>mailing_type
</name>
156 <title>Mailing Type
</title>
158 <comment>differentiate between standalone mailings, A/B tests, and A/B final-winner
</comment>
160 <callback>CRM_Mailing_PseudoConstant::mailingTypes
</callback>
168 <name>from_name
</name>
169 <title>Mailing From Name
</title>
172 <comment>From Header of mailing
</comment>
178 <name>from_email
</name>
179 <title>Mailing From Email
</title>
182 <comment>From Email of mailing
</comment>
188 <name>replyto_email
</name>
191 <comment>Reply-To Email of mailing
</comment>
194 <label>Reply-To Email
</label>
198 <name>template_type
</name>
199 <title>Template Type
</title>
202 <default>'traditional'
</default>
203 <required>true
</required>
204 <comment>The language/processing system used for email templates.
</comment>
206 <callback>CRM_Mailing_BAO_Mailing::getTemplateTypeNames
</callback>
210 <name>template_options
</name>
211 <title>Template Options (JSON)
</title>
212 <type>longtext
</type>
213 <comment>Advanced options used by the email templating system. (JSON encoded)
</comment>
219 <comment>Subject of mailing
</comment>
222 <label>Subject
</label>
226 <name>body_text
</name>
227 <type>longtext
</type>
228 <comment>Body of the mailing in text format.
</comment>
230 <label>Body Text
</label>
234 <name>body_html
</name>
235 <type>longtext
</type>
236 <comment>Body of the mailing in html format.
</comment>
238 <label>Body HTML
</label>
242 <name>url_tracking
</name>
244 <comment>Should we track URL click-throughs for this mailing?
</comment>
246 <type>CheckBox
</type>
247 <label>Url Tracking
</label>
251 <name>forward_replies
</name>
253 <comment>Should we forward replies back to the author?
</comment>
255 <type>CheckBox
</type>
256 <label>Forward Replies
</label>
260 <name>auto_responder
</name>
262 <comment>Should we enable the auto-responder?
</comment>
264 <type>CheckBox
</type>
265 <label>Auto Responder
</label>
269 <name>open_tracking
</name>
270 <title>Track Mailing?
</title>
272 <comment>Should we track when recipients open/read this mailing?
</comment>
275 <name>is_completed
</name>
276 <title>Mailing Completed
</title>
278 <comment>Has at least one job associated with this mailing finished?
</comment>
280 <type>CheckBox
</type>
284 <name>msg_template_id
</name>
285 <title>Message Template ID
</title>
286 <type>int unsigned
</type>
287 <comment>FK to the message template.
</comment>
289 <label>Message Template
</label>
293 <name>msg_template_id
</name>
294 <table>civicrm_msg_template
</table>
296 <onDelete>SET NULL
</onDelete>
299 <name>override_verp
</name>
303 <comment>Overwrite the VERP address in Reply-To
</comment>
305 <type>CheckBox
</type>
306 <label>Overwrite VERP
</label>
310 <name>created_id
</name>
311 <title>Created By Contact ID
</title>
312 <type>int unsigned
</type>
313 <comment>FK to Contact ID who first created this mailing
</comment>
315 <label>Creator
</label>
319 <name>created_id
</name>
320 <table>civicrm_contact
</table>
322 <onDelete>SET NULL
</onDelete>
325 <name>created_date
</name>
326 <type>timestamp
</type>
327 <default>NULL
</default>
328 <required>false
</required>
329 <title>Mailing Created Date
</title>
330 <comment>Date and time this mailing was created.
</comment>
333 <type>Select Date
</type>
334 <formatType>activityDateTime
</formatType>
338 <name>modified_date
</name>
339 <uniqueName>mailing_modified_date
</uniqueName>
340 <type>timestamp
</type>
341 <comment>When the mailing (or closely related entity) was created or modified or deleted.
</comment>
342 <required>false
</required>
343 <export>true
</export>
344 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
</default>
346 <label>Modified Date
</label>
351 <name>scheduled_id
</name>
352 <title>Scheduled By Contact ID
</title>
353 <type>int unsigned
</type>
354 <comment>FK to Contact ID who scheduled this mailing
</comment>
356 <label>Scheduled By
</label>
360 <name>scheduled_id
</name>
361 <table>civicrm_contact
</table>
363 <onDelete>SET NULL
</onDelete>
366 <name>scheduled_date
</name>
367 <type>timestamp
</type>
368 <default>NULL
</default>
369 <required>false
</required>
370 <title>Mailing Scheduled Date
</title>
371 <comment>Date and time this mailing was scheduled.
</comment>
374 <type>Select Date
</type>
375 <formatType>activityDateTime
</formatType>
379 <name>approver_id
</name>
380 <title>Approved By Contact ID
</title>
381 <type>int unsigned
</type>
382 <comment>FK to Contact ID who approved this mailing
</comment>
384 <label>Approved By
</label>
388 <name>approver_id
</name>
389 <table>civicrm_contact
</table>
391 <onDelete>SET NULL
</onDelete>
394 <name>approval_date
</name>
395 <type>timestamp
</type>
396 <default>NULL
</default>
397 <required>false
</required>
398 <title>Mailing Approved Date
</title>
399 <comment>Date and time this mailing was approved.
</comment>
402 <type>Select Date
</type>
403 <formatType>activityDateTime
</formatType>
407 <name>approval_status_id
</name>
408 <type>int unsigned
</type>
409 <title>Approval Status
</title>
410 <comment>The status of this mailing. Values: none, approved, rejected
</comment>
412 <optionGroupName>mail_approval_status
</optionGroupName>
420 <name>approval_note
</name>
421 <type>longtext
</type>
422 <title>Approval Note
</title>
423 <comment>Note behind the decision.
</comment>
426 <type>TextArea
</type>
430 <name>is_archived
</name>
432 <title>Is Mailing Archived?
</title>
434 <comment>Is this mailing archived?
</comment>
436 <type>CheckBox
</type>
441 <name>visibility
</name>
443 <title>Mailing Visibility
</title>
445 <default>'Public Pages'
</default>
446 <comment>In what context(s) is the mailing contents visible (online viewing)
</comment>
448 <callback>CRM_Core_SelectValues::groupVisibility
</callback>
456 <name>campaign_id
</name>
457 <type>int unsigned
</type>
458 <title>Campaign ID
</title>
459 <comment>The campaign for which this mailing has been initiated.
</comment>
463 <label>Campaign
</label>
467 <name>campaign_id
</name>
468 <table>civicrm_campaign
</table>
470 <onDelete>SET NULL
</onDelete>
473 <name>dedupe_email
</name>
475 <title>No Duplicate emails?
</title>
478 <comment>Remove duplicate emails?
</comment>
480 <type>CheckBox
</type>
484 <name>sms_provider_id
</name>
485 <title>SMS Provider ID
</title>
486 <type>int unsigned
</type>
490 <label>SMS Provider
</label>
494 <name>sms_provider_id
</name>
495 <table>civicrm_sms_provider
</table>
497 <onDelete>SET NULL
</onDelete>
502 <title>Mailing Hash
</title>
505 <comment>Key for validating requests related to this mailing.
</comment>
509 <name>index_hash
</name>
510 <fieldName>hash
</fieldName>
514 <name>location_type_id
</name>
515 <title>Location Type ID
</title>
516 <type>int unsigned
</type>
517 <comment>With email_selection_method, determines which email address to use
</comment>
519 <table>civicrm_location_type
</table>
520 <keyColumn>id
</keyColumn>
521 <labelColumn>display_name
</labelColumn>
524 <label>Location Type
</label>
529 <name>location_type_id
</name>
530 <table>civicrm_location_type
</table>
532 <onDelete>SET NULL
</onDelete>
536 <name>email_selection_method
</name>
539 <default>'automatic'
</default>
540 <comment>With location_type_id, determine how to choose the email address to use.
</comment>
542 <callback>CRM_Core_SelectValues::emailSelectMethods
</callback>
545 <label>Email Selection Method
</label>
550 <name>language
</name>
551 <title>Mailing Language
</title>
554 <comment>Language of the content of the mailing. Useful for tokens.
</comment>
557 <optionGroupName>languages
</optionGroupName>
558 <keyColumn>name
</keyColumn>