xml/schema/Mailing/MailingGroup.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Mailing</base>
   5   <class>MailingGroup</class>
   6   <name>civicrm_mailing_group</name>
   7   <comment>Stores information about the groups that participate in this mailing..</comment>
   8   <archive>true</archive>
   9   <component>CiviMail</component>
  10   <field>
  11     <name>id</name>
  12     <title>Mailing Group ID</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <html>
  16       <type>Number</type>
  17     </html>
  18   </field>
  19   <primaryKey>
  20     <name>id</name>
  21     <autoincrement>true</autoincrement>
  22   </primaryKey>
  23   <field>
  24     <name>mailing_id</name>
  25     <title>Mailing ID</title>
  26     <type>int unsigned</type>
  27     <required>true</required>
  28     <comment>The ID of a previous mailing to include/exclude recipients.</comment>
  29     <html>
  30       <label>Mailing</label>
  31     </html>
  32   </field>
  33   <foreignKey>
  34     <name>mailing_id</name>
  35     <table>civicrm_mailing</table>
  36     <key>id</key>
  37     <onDelete>CASCADE</onDelete>
  38   </foreignKey>
  39   <field>
  40     <name>group_type</name>
  41     <title>Mailing Group Type</title>
  42     <type>varchar</type>
  43     <length>8</length>
  44     <comment>Are the members of the group included or excluded?.</comment>
  45     <pseudoconstant>
  46       <callback>CRM_Core_SelectValues::getMailingGroupTypes</callback>
  47     </pseudoconstant>
  48     <html>
  49       <type>Select</type>
  50     </html>
  51   </field>
  52   <field>
  53     <name>entity_table</name>
  54     <title>Mailing Group Entity Table</title>
  55     <type>varchar</type>
  56     <length>64</length>
  57     <required>true</required>
  58     <comment>Name of table where item being referenced is stored.</comment>
  59     <pseudoconstant>
  60       <callback>CRM_Mailing_BAO_Mailing::mailingGroupEntityTables</callback>
  61     </pseudoconstant>
  62   </field>
  63   <field>
  64     <name>entity_id</name>
  65     <title>Mailing Group Entity</title>
  66     <type>int unsigned</type>
  67     <required>true</required>
  68     <comment>Foreign key to the referenced item.</comment>
  69   </field>
  70   <dynamicForeignKey>
  71     <idColumn>entity_id</idColumn>
  72     <typeColumn>entity_table</typeColumn>
  73   </dynamicForeignKey>
  74   <field>
  75     <name>search_id</name>
  76     <title>Mailing Group Search</title>
  77     <type>int</type>
  78     <comment>The filtering search. custom search id or -1 for civicrm api search</comment>
  79   </field>
  80   <field>
  81     <name>search_args</name>
  82     <title>Mailing Group Search Arguments</title>
  83     <type>text</type>
  84     <comment>The arguments to be sent to the search function</comment>
  85   </field>
  86 </table>