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</title>
  26     <type>int unsigned</type>
  27     <required>true</required>
  28     <comment>The ID of a previous mailing to include/exclude recipients.</comment>
  29   </field>
  30   <foreignKey>
  31     <name>mailing_id</name>
  32     <table>civicrm_mailing</table>
  33     <key>id</key>
  34     <onDelete>CASCADE</onDelete>
  35   </foreignKey>
  36   <field>
  37     <name>group_type</name>
  38     <title>Mailing Group Type</title>
  39     <type>varchar</type>
  40     <length>8</length>
  41     <comment>Are the members of the group included or excluded?.</comment>
  42     <pseudoconstant>
  43       <callback>CRM_Core_SelectValues::getMailingGroupTypes</callback>
  44     </pseudoconstant>
  45     <html>
  46       <type>Select</type>
  47     </html>
  48   </field>
  49   <field>
  50     <name>entity_table</name>
  51     <title>Mailing Group Entity Table</title>
  52     <type>varchar</type>
  53     <length>64</length>
  54     <required>true</required>
  55     <comment>Name of table where item being referenced is stored.</comment>
  56     <pseudoconstant>
  57       <callback>CRM_Mailing_BAO_Mailing::mailingGroupEntityTables</callback>
  58     </pseudoconstant>
  59   </field>
  60   <field>
  61     <name>entity_id</name>
  62     <title>Mailing Group Entity</title>
  63     <type>int unsigned</type>
  64     <required>true</required>
  65     <comment>Foreign key to the referenced item.</comment>
  66   </field>
  67   <dynamicForeignKey>
  68     <idColumn>entity_id</idColumn>
  69     <typeColumn>entity_table</typeColumn>
  70   </dynamicForeignKey>
  71   <field>
  72     <name>search_id</name>
  73     <title>Mailing Group Search</title>
  74     <type>int</type>
  75     <comment>The filtering search. custom search id or -1 for civicrm api search</comment>
  76   </field>
  77   <field>
  78     <name>search_args</name>
  79     <title>Mailing Group Search Arguments</title>
  80     <type>text</type>
  81     <comment>The arguments to be sent to the search function</comment>
  82   </field>
  83 </table>