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>
42 <comment>FK to the header component.
</comment>
45 <name>header_id
</name>
46 <table>civicrm_mailing_component
</table>
48 <onDelete>SET NULL
</onDelete>
51 <name>footer_id
</name>
52 <title>Mailing Footer
</title>
53 <type>int unsigned
</type>
54 <comment>FK to the footer component.
</comment>
57 <name>footer_id
</name>
58 <table>civicrm_mailing_component
</table>
60 <onDelete>SET NULL
</onDelete>
64 <title>Mailing Reply
</title>
65 <type>int unsigned
</type>
66 <comment>FK to the auto-responder component.
</comment>
70 <table>civicrm_mailing_component
</table>
72 <onDelete>SET NULL
</onDelete>
75 <name>unsubscribe_id
</name>
76 <title>Mailing Unsubscribe
</title>
77 <type>int unsigned
</type>
78 <comment>FK to the unsubscribe component.
</comment>
81 <name>unsubscribe_id
</name>
82 <table>civicrm_mailing_component
</table>
84 <onDelete>SET NULL
</onDelete>
87 <name>resubscribe_id
</name>
88 <title>Mailing Resubscribe
</title>
89 <type>int unsigned
</type>
92 <name>optout_id
</name>
93 <table>civicrm_mailing_component
</table>
95 <onDelete>SET NULL
</onDelete>
98 <name>optout_id
</name>
99 <title>Mailing Opt Out
</title>
100 <type>int unsigned
</type>
101 <comment>FK to the opt-out component.
</comment>
104 <name>optout_id
</name>
105 <table>civicrm_mailing_component
</table>
107 <onDelete>SET NULL
</onDelete>
111 <title>Mailing Name
</title>
114 <comment>Mailing Name.
</comment>
120 <name>mailing_type
</name>
122 <title>Mailing Type
</title>
124 <comment>differentiate between standalone mailings, A/B tests, and A/B final-winner
</comment>
126 <callback>CRM_Mailing_PseudoConstant::mailingTypes
</callback>
134 <name>from_name
</name>
135 <title>Mailing From Name
</title>
138 <comment>From Header of mailing
</comment>
144 <name>from_email
</name>
145 <title>Mailing From Email
</title>
148 <comment>From Email of mailing
</comment>
154 <name>replyto_email
</name>
157 <comment>Reply-To Email of mailing
</comment>
163 <name>template_type
</name>
164 <title>Template Type
</title>
167 <default>'traditional'
</default>
168 <required>true
</required>
169 <comment>The language/processing system used for email templates.
</comment>
171 <callback>CRM_Mailing_BAO_Mailing::getTemplateTypeNames
</callback>
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>
184 <comment>Subject of mailing
</comment>
190 <name>body_text
</name>
191 <type>longtext
</type>
192 <comment>Body of the mailing in text format.
</comment>
195 <name>body_html
</name>
196 <type>longtext
</type>
197 <comment>Body of the mailing in html format.
</comment>
200 <name>url_tracking
</name>
202 <comment>Should we track URL click-throughs for this mailing?
</comment>
204 <type>CheckBox
</type>
208 <name>forward_replies
</name>
210 <comment>Should we forward replies back to the author?
</comment>
212 <type>CheckBox
</type>
216 <name>auto_responder
</name>
218 <comment>Should we enable the auto-responder?
</comment>
220 <type>CheckBox
</type>
224 <name>open_tracking
</name>
225 <title>Track Mailing?
</title>
227 <comment>Should we track when recipients open/read this mailing?
</comment>
230 <name>is_completed
</name>
231 <title>Mailing Completed
</title>
233 <comment>Has at least one job associated with this mailing finished?
</comment>
235 <type>CheckBox
</type>
239 <name>msg_template_id
</name>
240 <title>Mailing Message Template
</title>
241 <type>int unsigned
</type>
242 <comment>FK to the message template.
</comment>
245 <name>msg_template_id
</name>
246 <table>civicrm_msg_template
</table>
248 <onDelete>SET NULL
</onDelete>
251 <name>override_verp
</name>
255 <comment>Should we overrite VERP address in Reply-To
</comment>
257 <type>CheckBox
</type>
261 <name>created_id
</name>
262 <title>Mailing Creator
</title>
263 <type>int unsigned
</type>
264 <comment>FK to Contact ID who first created this mailing
</comment>
267 <name>created_id
</name>
268 <table>civicrm_contact
</table>
270 <onDelete>SET NULL
</onDelete>
273 <name>created_date
</name>
274 <type>timestamp
</type>
275 <default>CURRENT_TIMESTAMP
</default>
276 <required>false
</required>
277 <title>Mailing Created Date
</title>
278 <comment>Date and time this mailing was created.
</comment>
281 <type>Select Date
</type>
282 <formatType>activityDateTime
</formatType>
286 <name>scheduled_id
</name>
287 <title>Scheduled By
</title>
288 <type>int unsigned
</type>
289 <comment>FK to Contact ID who scheduled this mailing
</comment>
292 <name>scheduled_id
</name>
293 <table>civicrm_contact
</table>
295 <onDelete>SET NULL
</onDelete>
298 <name>scheduled_date
</name>
299 <type>timestamp
</type>
300 <default>NULL
</default>
301 <required>false
</required>
302 <title>Mailing Scheduled Date
</title>
303 <comment>Date and time this mailing was scheduled.
</comment>
306 <type>Select Date
</type>
307 <formatType>activityDateTime
</formatType>
311 <name>approver_id
</name>
312 <title>Approved By
</title>
313 <type>int unsigned
</type>
314 <comment>FK to Contact ID who approved this mailing
</comment>
317 <name>approver_id
</name>
318 <table>civicrm_contact
</table>
320 <onDelete>SET NULL
</onDelete>
323 <name>approval_date
</name>
324 <type>timestamp
</type>
325 <default>NULL
</default>
326 <required>false
</required>
327 <title>Mailing Approved Date
</title>
328 <comment>Date and time this mailing was approved.
</comment>
331 <type>Select Date
</type>
332 <formatType>activityDateTime
</formatType>
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>
341 <optionGroupName>mail_approval_status
</optionGroupName>
349 <name>approval_note
</name>
350 <type>longtext
</type>
351 <title>Approval Note
</title>
352 <comment>Note behind the decision.
</comment>
355 <type>TextArea
</type>
359 <name>is_archived
</name>
361 <title>Is Mailing Archived?
</title>
363 <comment>Is this mailing archived?
</comment>
365 <type>CheckBox
</type>
370 <name>visibility
</name>
372 <title>Mailing Visibility
</title>
374 <default>'Public Pages'
</default>
375 <comment>In what context(s) is the mailing contents visible (online viewing)
</comment>
377 <callback>CRM_Core_SelectValues::groupVisibility
</callback>
385 <name>campaign_id
</name>
386 <type>int unsigned
</type>
387 <title>Mailing Campaign
</title>
388 <comment>The campaign for which this mailing has been initiated.
</comment>
390 <table>civicrm_campaign
</table>
391 <keyColumn>id
</keyColumn>
392 <labelColumn>title
</labelColumn>
400 <name>campaign_id
</name>
401 <table>civicrm_campaign
</table>
403 <onDelete>SET NULL
</onDelete>
406 <name>dedupe_email
</name>
408 <title>No Duplicate emails?
</title>
411 <comment>Remove duplicate emails?
</comment>
413 <type>CheckBox
</type>
417 <name>sms_provider_id
</name>
418 <title>Mailing SMS Provider
</title>
419 <type>int unsigned
</type>
426 <name>sms_provider_id
</name>
427 <table>civicrm_sms_provider
</table>
429 <onDelete>SET NULL
</onDelete>
434 <title>Mailing Hash
</title>
437 <comment>Key for validating requests related to this mailing.
</comment>
441 <name>index_hash
</name>
442 <fieldName>hash
</fieldName>
446 <name>location_type_id
</name>
447 <title>Location Type
</title>
448 <type>int unsigned
</type>
449 <comment>With email_selection_method, determines which email address to use
</comment>
451 <table>civicrm_location_type
</table>
452 <keyColumn>id
</keyColumn>
453 <labelColumn>display_name
</labelColumn>
458 <name>location_type_id
</name>
459 <table>civicrm_location_type
</table>
461 <onDelete>SET NULL
</onDelete>
465 <name>email_selection_method
</name>
468 <default>'automatic'
</default>
469 <comment>With location_type_id, determine how to choose the email address to use.
</comment>
471 <callback>CRM_Core_SelectValues::emailSelectMethods
</callback>
476 <name>language
</name>
477 <title>Mailing Language
</title>
480 <comment>Language of the content of the mailing. Useful for tokens.
</comment>
483 <optionGroupName>languages
</optionGroupName>
484 <keyColumn>name
</keyColumn>