[civicrm-core.git] / xml / schema / Mailing / Mailing.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

<table>
  <base>CRM/Mailing</base>
  <class>Mailing</class>
  <name>civicrm_mailing</name>
  <comment>Stores information about a mailing.</comment>
  <archive>true</archive>
  <field>
      <name>id</name>
      <type>int unsigned</type>
      <required>true</required>
  </field>
  <primaryKey>
       <name>id</name>
       <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
      <name>domain_id</name>
      <type>int unsigned</type>
      <pseudoconstant>
          <table>civicrm_domain</table>
          <keyColumn>id</keyColumn>
          <labelColumn>name</labelColumn>
      </pseudoconstant>
      <comment>Which site is this mailing for</comment>
      <add>3.4</add>
  </field>
  <foreignKey>
       <name>domain_id</name>
       <table>civicrm_domain</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
       <add>3.4</add>
  </foreignKey>
  <field>
      <name>header_id</name>
      <type>int unsigned</type>
      <comment>FK to the header component.</comment>
  </field>
  <foreignKey>
       <name>header_id</name>
       <table>civicrm_mailing_component</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
      <name>footer_id</name>
      <type>int unsigned</type>
      <comment>FK to the footer component.</comment>
  </field>
  <foreignKey>
       <name>footer_id</name>
       <table>civicrm_mailing_component</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
        <name>reply_id</name>
        <type>int unsigned</type>
        <comment>FK to the auto-responder component.</comment>
  </field>
  <foreignKey>
        <name>reply_id</name>
        <table>civicrm_mailing_component</table>
        <key>id</key>
        <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
        <name>unsubscribe_id</name>
        <type>int unsigned</type>
        <comment>FK to the unsubscribe component.</comment>
  </field>
  <foreignKey>
        <name>unsubscribe_id</name>
        <table>civicrm_mailing_component</table>
        <key>id</key>
        <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
        <name>resubscribe_id</name>
        <type>int unsigned</type>
  </field>
  <foreignKey>
        <name>optout_id</name>
        <table>civicrm_mailing_component</table>
        <key>id</key>
        <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
        <name>optout_id</name>
        <type>int unsigned</type>
        <comment>FK to the opt-out component.</comment>
  </field>
  <foreignKey>
        <name>optout_id</name>
        <table>civicrm_mailing_component</table>
        <key>id</key>
        <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
       <name>name</name>
       <type>varchar</type>
       <length>128</length>
       <comment>Mailing Name.</comment>
       <html>
         <type>Text</type>
       </html>
  </field>
  <field>
       <name>from_name</name>
       <type>varchar</type>
       <length>128</length>
       <comment>From Header of mailing</comment>
       <html>
         <type>Text</type>
       </html>
  </field>
  <field>
       <name>from_email</name>
       <type>varchar</type>
       <length>128</length>
       <comment>From Email of mailing</comment>
       <html>
         <type>Text</type>
       </html>
  </field>
  <field>
       <name>replyto_email</name>
       <type>varchar</type>
       <length>128</length>
       <comment>Reply-To Email of mailing</comment>
       <html>
         <type>Text</type>
       </html>
  </field>
  <field>
       <name>subject</name>
       <type>varchar</type>
       <length>128</length>
       <comment>Subject of mailing</comment>
       <html>
         <type>Text</type>
       </html>
  </field>
  <field>
       <name>body_text</name>
       <type>longtext</type>
       <comment>Body of the mailing in text format.</comment>
  </field>
  <field>
       <name>body_html</name>
       <type>longtext</type>
       <comment>Body of the mailing in html format.</comment>
  </field>
  <field>
       <name>url_tracking</name>
       <type>boolean</type>
       <comment>Should we track URL click-throughs for this mailing?</comment>
       <html>
         <type>CheckBox</type>
       </html>
  </field>
  <field>
       <name>forward_replies</name>
       <type>boolean</type>
       <comment>Should we forward replies back to the author?</comment>
       <html>
         <type>CheckBox</type>
       </html>
  </field>
  <field>
        <name>auto_responder</name>
        <type>boolean</type>
        <comment>Should we enable the auto-responder?</comment>
        <html>
          <type>CheckBox</type>
        </html>
  </field>
  <field>
       <name>open_tracking</name>
       <type>boolean</type>
       <comment>Should we track when recipients open/read this mailing?</comment>
  </field>
  <field>
       <name>is_completed</name>
       <type>boolean</type>
       <comment>Has at least one job associated with this mailing finished?</comment>
       <html>
         <type>CheckBox</type>
       </html>
  </field>
  <field>
      <name>msg_template_id</name>
      <type>int unsigned</type>
      <comment>FK to the message template.</comment>
  </field>
  <foreignKey>
       <name>msg_template_id</name>
       <table>civicrm_msg_template</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
      <name>override_verp</name>
      <type>boolean</type>
      <default>0</default>
      <add>2.2</add>
      <comment>Should we overrite VERP address in Reply-To</comment>
      <html>
         <type>CheckBox</type>
      </html>
  </field>
  <field>
      <name>created_id</name>
      <type>int unsigned</type>
      <comment>FK to Contact ID who first created this mailing</comment>
  </field>
  <foreignKey>
       <name>created_id</name>
       <table>civicrm_contact</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
      <name>created_date</name>
      <type>datetime</type>
      <title>Mailing Created Date</title>
      <comment>Date and time this mailing was created.</comment>
      <add>3.0</add>
      <html>
        <type>Select Date</type>
      </html>
  </field>
  <field>
      <name>scheduled_id</name>
      <type>int unsigned</type>
      <comment>FK to Contact ID who scheduled this mailing</comment>
  </field>
  <foreignKey>
       <name>scheduled_id</name>
       <table>civicrm_contact</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
      <name>scheduled_date</name>
      <type>datetime</type>
      <title>Mailing Scheduled Date</title>
      <comment>Date and time this mailing was scheduled.</comment>
      <add>3.3</add>
  </field>
  <field>
      <name>approver_id</name>
      <type>int unsigned</type>
      <comment>FK to Contact ID who approved this mailing</comment>
  </field>
  <foreignKey>
       <name>approver_id</name>
       <table>civicrm_contact</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
      <name>approval_date</name>
      <type>datetime</type>
      <title>Mailing Approved Date</title>
      <comment>Date and time this mailing was approved.</comment>
      <add>3.3</add>
  </field>
  <field>
      <name>approval_status_id</name>
      <type>int unsigned</type>
      <title>Approval Status</title>
      <comment>The status of this mailing. Values: none, approved, rejected</comment>
      <pseudoconstant>
        <optionGroupName>mail_approval_status</optionGroupName>
      </pseudoconstant>
      <html>
        <type>Select</type>
      </html>
      <add>3.3</add>
  </field>
  <field>
      <name>approval_note</name>
      <type>longtext</type>
      <title>Approval Note</title>
      <comment>Note behind the decision.</comment>
      <add>3.3</add>
      <html>
         <type>TextArea</type>
       </html>
  </field>
  <field>
       <name>is_archived</name>
       <type>boolean</type>
       <default>0</default>
       <comment>Is this mailing archived?</comment>
       <html>
         <type>CheckBox</type>
       </html>
       <add>2.2</add>
  </field>
  <field>
       <name>visibility</name>
       <type>varchar</type>
       <length>40</length>
       <default>'Public Pages'</default>
       <comment>In what context(s) is the mailing contents visible (online viewing)</comment>
       <pseudoconstant>
         <callback>CRM_Core_SelectValues::groupVisibility</callback>
       </pseudoconstant>
       <add>3.3</add>
       <html>
         <type>Select</type>
       </html>
  </field>
  <field>
       <name>campaign_id</name>
       <type>int unsigned</type>
       <comment>The campaign for which this mailing has been initiated.</comment>
       <pseudoconstant>
          <table>civicrm_campaign</table>
          <keyColumn>id</keyColumn>
          <labelColumn>title</labelColumn>
       </pseudoconstant>
       <add>3.4</add>
       <html>
          <type>Select</type>
        </html>
  </field>
  <foreignKey>
       <name>campaign_id</name>
       <table>civicrm_campaign</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
      <name>dedupe_email</name>
      <type>boolean</type>
      <default>0</default>
      <add>4.1</add>
      <comment>Remove duplicate emails?</comment>
      <html>
         <type>CheckBox</type>
       </html>
  </field>
  <field>
       <name>sms_provider_id</name>
       <type>int unsigned</type>
       <add>4.2</add>
       <html>
         <type>Select</type>
       </html>
  </field>
  <foreignKey>
       <name>sms_provider_id</name>
       <table>civicrm_sms_provider</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
       <add>4.2</add>
  </foreignKey>
  <field>
      <name>hash</name>
      <title>Mailing Hash</title>
      <type>varchar</type>
      <length>16</length>
      <comment>Key for validating requests related to this mailing.</comment>
      <add>4.5</add>
  </field>
  <index>
       <name>index_hash</name>
       <fieldName>hash</fieldName>
       <add>4.5</add>
  </index>
</table>
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>
	10	<name>id</name>
	11	<type>int unsigned</type>
	12	<required>true</required>
	13	</field>
	14	<primaryKey>
	15	<name>id</name>
	16	<autoincrement>true</autoincrement>
	17	</primaryKey>
	18	<field>
	19	<name>domain_id</name>
	20	<type>int unsigned</type>
c2b4755a EM	21	<pseudoconstant>
	22	<table>civicrm_domain</table>
	23	<keyColumn>id</keyColumn>
	24	<labelColumn>name</labelColumn>
	25	</pseudoconstant>
6a488035 TO	26	<comment>Which site is this mailing for</comment>
	27	<add>3.4</add>
	28	</field>
	29	<foreignKey>
	30	<name>domain_id</name>
	31	<table>civicrm_domain</table>
	32	<key>id</key>
	33	<onDelete>SET NULL</onDelete>
	34	<add>3.4</add>
	35	</foreignKey>
	36	<field>
	37	<name>header_id</name>
	38	<type>int unsigned</type>
	39	<comment>FK to the header component.</comment>
	40	</field>
	41	<foreignKey>
	42	<name>header_id</name>
	43	<table>civicrm_mailing_component</table>
	44	<key>id</key>
	45	<onDelete>SET NULL</onDelete>
	46	</foreignKey>
	47	<field>
	48	<name>footer_id</name>
	49	<type>int unsigned</type>
	50	<comment>FK to the footer component.</comment>
	51	</field>
	52	<foreignKey>
	53	<name>footer_id</name>
	54	<table>civicrm_mailing_component</table>
	55	<key>id</key>
	56	<onDelete>SET NULL</onDelete>
	57	</foreignKey>
	58	<field>
	59	<name>reply_id</name>
	60	<type>int unsigned</type>
	61	<comment>FK to the auto-responder component.</comment>
	62	</field>
	63	<foreignKey>
	64	<name>reply_id</name>
	65	<table>civicrm_mailing_component</table>
	66	<key>id</key>
	67	<onDelete>SET NULL</onDelete>
	68	</foreignKey>
	69	<field>
	70	<name>unsubscribe_id</name>
	71	<type>int unsigned</type>
	72	<comment>FK to the unsubscribe component.</comment>
	73	</field>
	74	<foreignKey>
	75	<name>unsubscribe_id</name>
	76	<table>civicrm_mailing_component</table>
	77	<key>id</key>
	78	<onDelete>SET NULL</onDelete>
	79	</foreignKey>
	80	<field>
	81	<name>resubscribe_id</name>
	82	<type>int unsigned</type>
	83	</field>
	84	<foreignKey>
	85	<name>optout_id</name>
	86	<table>civicrm_mailing_component</table>
	87	<key>id</key>
	88	<onDelete>SET NULL</onDelete>
	89	</foreignKey>
90	<field>
91	<name>optout_id</name>
92	<type>int unsigned</type>
93	<comment>FK to the opt-out component.</comment>
94	</field>
95	<foreignKey>
96	<name>optout_id</name>
97	<table>civicrm_mailing_component</table>
98	<key>id</key>
99	<onDelete>SET NULL</onDelete>
100	</foreignKey>
101	<field>
102	<name>name</name>
103	<type>varchar</type>
104	<length>128</length>
105	<comment>Mailing Name.</comment>
614d72ec	106	<html>
	107	<type>Text</type>
	108	</html>
6a488035 TO	109	</field>
	110	<field>
	111	<name>from_name</name>
	112	<type>varchar</type>
	113	<length>128</length>
	114	<comment>From Header of mailing</comment>
614d72ec	115	<html>
	116	<type>Text</type>
	117	</html>
6a488035 TO	118	</field>
	119	<field>
	120	<name>from_email</name>
	121	<type>varchar</type>
	122	<length>128</length>
	123	<comment>From Email of mailing</comment>
614d72ec	124	<html>
	125	<type>Text</type>
	126	</html>
6a488035 TO	127	</field>
	128	<field>
	129	<name>replyto_email</name>
	130	<type>varchar</type>
	131	<length>128</length>
	132	<comment>Reply-To Email of mailing</comment>
614d72ec	133	<html>
	134	<type>Text</type>
	135	</html>
6a488035 TO	136	</field>
	137	<field>
	138	<name>subject</name>
	139	<type>varchar</type>
	140	<length>128</length>
	141	<comment>Subject of mailing</comment>
614d72ec	142	<html>
	143	<type>Text</type>
	144	</html>
6a488035 TO	145	</field>
	146	<field>
	147	<name>body_text</name>
	148	<type>longtext</type>
	149	<comment>Body of the mailing in text format.</comment>
	150	</field>
	151	<field>
	152	<name>body_html</name>
	153	<type>longtext</type>
	154	<comment>Body of the mailing in html format.</comment>
	155	</field>
	156	<field>
	157	<name>url_tracking</name>
	158	<type>boolean</type>
	159	<comment>Should we track URL click-throughs for this mailing?</comment>
614d72ec	160	<html>
	161	<type>CheckBox</type>
	162	</html>
6a488035 TO	163	</field>
	164	<field>
	165	<name>forward_replies</name>
	166	<type>boolean</type>
	167	<comment>Should we forward replies back to the author?</comment>
614d72ec	168	<html>
	169	<type>CheckBox</type>
	170	</html>
6a488035 TO	171	</field>
	172	<field>
	173	<name>auto_responder</name>
	174	<type>boolean</type>
	175	<comment>Should we enable the auto-responder?</comment>
614d72ec	176	<html>
	177	<type>CheckBox</type>
	178	</html>
6a488035 TO	179	</field>
	180	<field>
	181	<name>open_tracking</name>
	182	<type>boolean</type>
	183	<comment>Should we track when recipients open/read this mailing?</comment>
	184	</field>
	185	<field>
	186	<name>is_completed</name>
	187	<type>boolean</type>
	188	<comment>Has at least one job associated with this mailing finished?</comment>
614d72ec	189	<html>
	190	<type>CheckBox</type>
	191	</html>
6a488035 TO	192	</field>
	193	<field>
	194	<name>msg_template_id</name>
	195	<type>int unsigned</type>
	196	<comment>FK to the message template.</comment>
	197	</field>
	198	<foreignKey>
	199	<name>msg_template_id</name>
	200	<table>civicrm_msg_template</table>
	201	<key>id</key>
	202	<onDelete>SET NULL</onDelete>
	203	</foreignKey>
	204	<field>
	205	<name>override_verp</name>
	206	<type>boolean</type>
	207	<default>0</default>
3c7d2158	208	<add>2.2</add>
6a488035	209	<comment>Should we overrite VERP address in Reply-To</comment>
614d72ec	210	<html>
	211	<type>CheckBox</type>
	212	</html>
6a488035 TO	213	</field>
	214	<field>
	215	<name>created_id</name>
	216	<type>int unsigned</type>
c2b4755a	217	<comment>FK to Contact ID who first created this mailing</comment>
6a488035 TO	218	</field>
	219	<foreignKey>
	220	<name>created_id</name>
	221	<table>civicrm_contact</table>
	222	<key>id</key>
	223	<onDelete>SET NULL</onDelete>
	224	</foreignKey>
	225	<field>
	226	<name>created_date</name>
	227	<type>datetime</type>
	228	<title>Mailing Created Date</title>
	229	<comment>Date and time this mailing was created.</comment>
	230	<add>3.0</add>
614d72ec	231	<html>
	232	<type>Select Date</type>
	233	</html>
6a488035 TO	234	</field>
	235	<field>
	236	<name>scheduled_id</name>
	237	<type>int unsigned</type>
	238	<comment>FK to Contact ID who scheduled this mailing</comment>
	239	</field>
	240	<foreignKey>
	241	<name>scheduled_id</name>
	242	<table>civicrm_contact</table>
	243	<key>id</key>
	244	<onDelete>SET NULL</onDelete>
	245	</foreignKey>
	246	<field>
	247	<name>scheduled_date</name>
	248	<type>datetime</type>
	249	<title>Mailing Scheduled Date</title>
	250	<comment>Date and time this mailing was scheduled.</comment>
	251	<add>3.3</add>
	252	</field>
	253	<field>
	254	<name>approver_id</name>
	255	<type>int unsigned</type>
	256	<comment>FK to Contact ID who approved this mailing</comment>
	257	</field>
	258	<foreignKey>
	259	<name>approver_id</name>
	260	<table>civicrm_contact</table>
	261	<key>id</key>
	262	<onDelete>SET NULL</onDelete>
	263	</foreignKey>
	264	<field>
	265	<name>approval_date</name>
	266	<type>datetime</type>
	267	<title>Mailing Approved Date</title>
	268	<comment>Date and time this mailing was approved.</comment>
	269	<add>3.3</add>
	270	</field>
	271	<field>
	272	<name>approval_status_id</name>
	273	<type>int unsigned</type>
	274	<title>Approval Status</title>
	275	<comment>The status of this mailing. Values: none, approved, rejected</comment>
6ce01b02 CW	276	<pseudoconstant>
	277	<optionGroupName>mail_approval_status</optionGroupName>
	278	</pseudoconstant>
614d72ec	279	<html>
e0991796	280	<type>Select</type>
614d72ec	281	</html>
6a488035 TO	282	<add>3.3</add>
	283	</field>
	284	<field>
	285	<name>approval_note</name>
	286	<type>longtext</type>
	287	<title>Approval Note</title>
	288	<comment>Note behind the decision.</comment>
	289	<add>3.3</add>
614d72ec	290	<html>
	291	<type>TextArea</type>
	292	</html>
6a488035 TO	293	</field>
	294	<field>
	295	<name>is_archived</name>
	296	<type>boolean</type>
	297	<default>0</default>
	298	<comment>Is this mailing archived?</comment>
614d72ec	299	<html>
	300	<type>CheckBox</type>
	301	</html>
6a488035 TO	302	<add>2.2</add>
6a488035 TO	303	</field>
3c7d2158	304	<field>
3c7d2158	305	<name>visibility</name>
f3800cf8	306	<type>varchar</type>
f3800cf8	307	<length>40</length>
902d0e66	308	<default>'Public Pages'</default>
3c7d2158	309	<comment>In what context(s) is the mailing contents visible (online viewing)</comment>
71a707c3	310	<pseudoconstant>
93bfa565	311	<callback>CRM_Core_SelectValues::groupVisibility</callback>
71a707c3	312	</pseudoconstant>
3c7d2158	313	<add>3.3</add>
614d72ec	314	<html>
	315	<type>Select</type>
	316	</html>
3c7d2158	317	</field>
	318	<field>
	319	<name>campaign_id</name>
	320	<type>int unsigned</type>
	321	<comment>The campaign for which this mailing has been initiated.</comment>
3e3eacd0 CW	322	<pseudoconstant>
	323	<table>civicrm_campaign</table>
	324	<keyColumn>id</keyColumn>
	325	<labelColumn>title</labelColumn>
3e3eacd0	326	</pseudoconstant>
3c7d2158	327	<add>3.4</add>
614d72ec	328	<html>
	329	<type>Select</type>
	330	</html>
3c7d2158	331	</field>
	332	<foreignKey>
	333	<name>campaign_id</name>
	334	<table>civicrm_campaign</table>
	335	<key>id</key>
6a488035 TO	336	<onDelete>SET NULL</onDelete>
	337	</foreignKey>
	338	<field>
	339	<name>dedupe_email</name>
	340	<type>boolean</type>
	341	<default>0</default>
3c7d2158	342	<add>4.1</add>
6a488035	343	<comment>Remove duplicate emails?</comment>
614d72ec	344	<html>
	345	<type>CheckBox</type>
	346	</html>
6a488035	347	</field>
3c7d2158	348	<field>
	349	<name>sms_provider_id</name>
	350	<type>int unsigned</type>
	351	<add>4.2</add>
614d72ec	352	<html>
	353	<type>Select</type>
	354	</html>
3c7d2158	355	</field>
	356	<foreignKey>
	357	<name>sms_provider_id</name>
	358	<table>civicrm_sms_provider</table>
	359	<key>id</key>
6a488035 TO	360	<onDelete>SET NULL</onDelete>
	361	<add>4.2</add>
	362	</foreignKey>
c57f36a1 PJ	363	<field>
	364	<name>hash</name>
	365	<title>Mailing Hash</title>
	366	<type>varchar</type>
	367	<length>16</length>
	368	<comment>Key for validating requests related to this mailing.</comment>
	369	<add>4.5</add>
	370	</field>
	371	<index>
	372	<name>index_hash</name>
	373	<fieldName>hash</fieldName>
	374	<add>4.5</add>
	375	</index>
c2b4755a	376	</table>