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 <description>Mass emails sent from CiviMail.
</description>
9 <archive>true
</archive>
10 <icon>fa-envelope-o
</icon>
11 <component>CiviMail
</component>
13 <add>civicrm/a/#/mailing/new
</add>
14 <update>civicrm/a/#/mailing/[id]
</update>
18 <title>Mailing ID
</title>
19 <type>int unsigned
</type>
20 <required>true
</required>
27 <autoincrement>true
</autoincrement>
30 <name>domain_id
</name>
31 <title>Domain ID
</title>
32 <type>int unsigned
</type>
34 <table>civicrm_domain
</table>
35 <keyColumn>id
</keyColumn>
36 <labelColumn>name
</labelColumn>
38 <comment>Which site is this mailing for
</comment>
45 <name>domain_id
</name>
46 <table>civicrm_domain
</table>
48 <onDelete>SET NULL
</onDelete>
52 <name>header_id
</name>
53 <title>Header ID
</title>
54 <type>int unsigned
</type>
56 <table>civicrm_mailing_component
</table>
57 <keyColumn>id
</keyColumn>
58 <labelColumn>name
</labelColumn>
59 <condition>component_type =
"Header"</condition>
61 <comment>FK to the header component.
</comment>
67 <name>header_id
</name>
68 <table>civicrm_mailing_component
</table>
70 <onDelete>SET NULL
</onDelete>
73 <name>footer_id
</name>
74 <title>Footer ID
</title>
75 <type>int unsigned
</type>
77 <table>civicrm_mailing_component
</table>
78 <keyColumn>id
</keyColumn>
79 <labelColumn>name
</labelColumn>
80 <condition>component_type =
"Footer"</condition>
82 <comment>FK to the footer component.
</comment>
88 <name>footer_id
</name>
89 <table>civicrm_mailing_component
</table>
91 <onDelete>SET NULL
</onDelete>
95 <title>Reply ID
</title>
96 <type>int unsigned
</type>
97 <comment>FK to the auto-responder component.
</comment>
103 <name>reply_id
</name>
104 <table>civicrm_mailing_component
</table>
106 <onDelete>SET NULL
</onDelete>
109 <name>unsubscribe_id
</name>
110 <title>Unsubscribe ID
</title>
111 <type>int unsigned
</type>
112 <comment>FK to the unsubscribe component.
</comment>
114 <label>Unsubscribe
</label>
118 <name>unsubscribe_id
</name>
119 <table>civicrm_mailing_component
</table>
121 <onDelete>SET NULL
</onDelete>
124 <name>resubscribe_id
</name>
125 <title>Mailing Resubscribe
</title>
126 <type>int unsigned
</type>
129 <name>optout_id
</name>
130 <title>Opt Out ID
</title>
131 <type>int unsigned
</type>
132 <comment>FK to the opt-out component.
</comment>
134 <label>Opt Out
</label>
138 <name>optout_id
</name>
139 <table>civicrm_mailing_component
</table>
141 <onDelete>SET NULL
</onDelete>
145 <uniqueName>mailing_name
</uniqueName>
146 <title>Mailing Name
</title>
149 <comment>Mailing Name.
</comment>
155 <name>mailing_type
</name>
157 <title>Mailing Type
</title>
159 <comment>differentiate between standalone mailings, A/B tests, and A/B final-winner
</comment>
161 <callback>CRM_Mailing_PseudoConstant::mailingTypes
</callback>
169 <name>from_name
</name>
170 <title>Mailing From Name
</title>
173 <comment>From Header of mailing
</comment>
179 <name>from_email
</name>
180 <title>Mailing From Email
</title>
183 <comment>From Email of mailing
</comment>
189 <name>replyto_email
</name>
192 <comment>Reply-To Email of mailing
</comment>
195 <label>Reply-To Email
</label>
199 <name>template_type
</name>
200 <title>Template Type
</title>
203 <default>'traditional'
</default>
204 <required>true
</required>
205 <comment>The language/processing system used for email templates.
</comment>
207 <callback>CRM_Mailing_BAO_Mailing::getTemplateTypeNames
</callback>
211 <name>template_options
</name>
212 <title>Template Options (JSON)
</title>
213 <type>longtext
</type>
214 <comment>Advanced options used by the email templating system. (JSON encoded)
</comment>
220 <comment>Subject of mailing
</comment>
223 <label>Subject
</label>
227 <name>body_text
</name>
228 <type>longtext
</type>
229 <comment>Body of the mailing in text format.
</comment>
231 <label>Body Text
</label>
235 <name>body_html
</name>
236 <type>longtext
</type>
237 <comment>Body of the mailing in html format.
</comment>
239 <label>Body HTML
</label>
243 <name>url_tracking
</name>
245 <comment>Should we track URL click-throughs for this mailing?
</comment>
247 <type>CheckBox
</type>
248 <label>Url Tracking
</label>
252 <name>forward_replies
</name>
254 <comment>Should we forward replies back to the author?
</comment>
256 <type>CheckBox
</type>
257 <label>Forward Replies
</label>
261 <name>auto_responder
</name>
263 <comment>Should we enable the auto-responder?
</comment>
265 <type>CheckBox
</type>
266 <label>Auto Responder
</label>
270 <name>open_tracking
</name>
271 <title>Track Mailing?
</title>
273 <comment>Should we track when recipients open/read this mailing?
</comment>
276 <name>is_completed
</name>
277 <title>Mailing Completed
</title>
279 <comment>Has at least one job associated with this mailing finished?
</comment>
281 <type>CheckBox
</type>
285 <name>msg_template_id
</name>
286 <title>Message Template ID
</title>
287 <type>int unsigned
</type>
288 <comment>FK to the message template.
</comment>
290 <label>Message Template
</label>
294 <name>msg_template_id
</name>
295 <table>civicrm_msg_template
</table>
297 <onDelete>SET NULL
</onDelete>
300 <name>override_verp
</name>
304 <comment>Overwrite the VERP address in Reply-To
</comment>
306 <type>CheckBox
</type>
307 <label>Overwrite VERP
</label>
311 <name>created_id
</name>
312 <title>Created By Contact ID
</title>
313 <type>int unsigned
</type>
314 <comment>FK to Contact ID who first created this mailing
</comment>
316 <label>Creator
</label>
320 <name>created_id
</name>
321 <table>civicrm_contact
</table>
323 <onDelete>SET NULL
</onDelete>
326 <name>created_date
</name>
327 <type>timestamp
</type>
328 <default>CURRENT_TIMESTAMP
</default>
329 <required>false
</required>
330 <title>Mailing Created Date
</title>
331 <comment>Date and time this mailing was created.
</comment>
334 <type>Select Date
</type>
335 <formatType>activityDateTime
</formatType>
339 <name>modified_date
</name>
340 <uniqueName>mailing_modified_date
</uniqueName>
341 <type>timestamp
</type>
342 <comment>When the mailing (or closely related entity) was created or modified or deleted.
</comment>
343 <required>false
</required>
344 <export>true
</export>
345 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
</default>
347 <label>Modified Date
</label>
349 <readonly>true
</readonly>
353 <name>scheduled_id
</name>
354 <title>Scheduled By Contact ID
</title>
355 <type>int unsigned
</type>
356 <comment>FK to Contact ID who scheduled this mailing
</comment>
358 <label>Scheduled By
</label>
362 <name>scheduled_id
</name>
363 <table>civicrm_contact
</table>
365 <onDelete>SET NULL
</onDelete>
368 <name>scheduled_date
</name>
369 <type>timestamp
</type>
370 <default>NULL
</default>
371 <required>false
</required>
372 <title>Mailing Scheduled Date
</title>
373 <comment>Date and time this mailing was scheduled.
</comment>
376 <type>Select Date
</type>
377 <formatType>activityDateTime
</formatType>
381 <name>approver_id
</name>
382 <title>Approved By Contact ID
</title>
383 <type>int unsigned
</type>
384 <comment>FK to Contact ID who approved this mailing
</comment>
386 <label>Approved By
</label>
390 <name>approver_id
</name>
391 <table>civicrm_contact
</table>
393 <onDelete>SET NULL
</onDelete>
396 <name>approval_date
</name>
397 <type>timestamp
</type>
398 <default>NULL
</default>
399 <required>false
</required>
400 <title>Mailing Approved Date
</title>
401 <comment>Date and time this mailing was approved.
</comment>
404 <type>Select Date
</type>
405 <formatType>activityDateTime
</formatType>
409 <name>approval_status_id
</name>
410 <type>int unsigned
</type>
411 <title>Approval Status
</title>
412 <comment>The status of this mailing. Values: none, approved, rejected
</comment>
414 <optionGroupName>mail_approval_status
</optionGroupName>
422 <name>approval_note
</name>
423 <type>longtext
</type>
424 <title>Approval Note
</title>
425 <comment>Note behind the decision.
</comment>
428 <type>TextArea
</type>
432 <name>is_archived
</name>
434 <title>Is Mailing Archived?
</title>
436 <comment>Is this mailing archived?
</comment>
438 <type>CheckBox
</type>
443 <name>visibility
</name>
445 <title>Mailing Visibility
</title>
447 <default>'Public Pages'
</default>
448 <comment>In what context(s) is the mailing contents visible (online viewing)
</comment>
450 <callback>CRM_Core_SelectValues::groupVisibility
</callback>
458 <name>campaign_id
</name>
459 <component>CiviCampaign
</component>
460 <type>int unsigned
</type>
461 <title>Campaign ID
</title>
462 <comment>The campaign for which this mailing has been initiated.
</comment>
465 <type>EntityRef
</type>
466 <label>Campaign
</label>
469 <table>civicrm_campaign
</table>
470 <keyColumn>id
</keyColumn>
471 <labelColumn>title
</labelColumn>
472 <prefetch>FALSE
</prefetch>
476 <name>campaign_id
</name>
477 <table>civicrm_campaign
</table>
479 <onDelete>SET NULL
</onDelete>
482 <name>dedupe_email
</name>
484 <title>No Duplicate emails?
</title>
487 <comment>Remove duplicate emails?
</comment>
489 <type>CheckBox
</type>
493 <name>sms_provider_id
</name>
494 <title>SMS Provider ID
</title>
495 <type>int unsigned
</type>
499 <label>SMS Provider
</label>
503 <name>sms_provider_id
</name>
504 <table>civicrm_sms_provider
</table>
506 <onDelete>SET NULL
</onDelete>
511 <title>Mailing Hash
</title>
514 <comment>Key for validating requests related to this mailing.
</comment>
515 <readonly>true
</readonly>
519 <name>index_hash
</name>
520 <fieldName>hash
</fieldName>
524 <name>location_type_id
</name>
525 <title>Location Type ID
</title>
526 <type>int unsigned
</type>
527 <comment>With email_selection_method, determines which email address to use
</comment>
529 <table>civicrm_location_type
</table>
530 <keyColumn>id
</keyColumn>
531 <labelColumn>display_name
</labelColumn>
534 <label>Location Type
</label>
539 <name>location_type_id
</name>
540 <table>civicrm_location_type
</table>
542 <onDelete>SET NULL
</onDelete>
546 <name>email_selection_method
</name>
549 <default>'automatic'
</default>
550 <comment>With location_type_id, determine how to choose the email address to use.
</comment>
552 <callback>CRM_Core_SelectValues::emailSelectMethods
</callback>
555 <label>Email Selection Method
</label>
560 <name>language
</name>
561 <title>Mailing Language
</title>
564 <comment>Language of the content of the mailing. Useful for tokens.
</comment>
567 <optionGroupName>languages
</optionGroupName>
568 <keyColumn>name
</keyColumn>