xml/schema/Core/MailSettings.xml

   1 <table>
   2   <base>CRM/Core</base>
   3   <class>MailSettings</class>
   4   <name>civicrm_mail_settings</name>
   5   <comment>Various email accounts for use by CiviMail (and its processor)</comment>
   6   <add>2.2</add>
   7   <field>
   8     <name>id</name>
   9     <type>int unsigned</type>
  10     <required>true</required>
  11     <comment>primary key</comment>
  12     <add>2.2</add>
  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>
  21     <required>true</required>
  22     <pseudoconstant>
  23       <table>civicrm_domain</table>
  24       <keyColumn>id</keyColumn>
  25       <labelColumn>name</labelColumn>
  26     </pseudoconstant>
  27     <comment>Which Domain is this match entry for</comment>
  28     <add>3.1</add>
  29   </field>
  30   <foreignKey>
  31     <name>domain_id</name>
  32     <table>civicrm_domain</table>
  33     <key>id</key>
  34     <add>4.5</add>
  35   </foreignKey>
  36   <field>
  37     <name>name</name>
  38     <type>varchar</type>
  39     <length>255</length>
  40     <comment>name of this group of settings</comment>
  41     <add>2.2</add>
  42   </field>
  43   <field>
  44     <name>is_default</name>
  45     <type>boolean</type>
  46     <comment>whether this is the default set of settings for this domain</comment>
  47     <add>2.2</add>
  48   </field>
  49   <field>
  50     <name>domain</name>
  51     <type>varchar</type>
  52     <length>255</length>
  53     <comment>email address domain (the part after @)</comment>
  54     <add>2.2</add>
  55   </field>
  56   <field>
  57     <name>localpart</name>
  58     <type>varchar</type>
  59     <length>255</length>
  60     <comment>optional local part (like civimail+ for addresses like civimail+s.1.2@example.com)</comment>
  61     <add>2.2</add>
  62   </field>
  63   <field>
  64     <name>return_path</name>
  65     <type>varchar</type>
  66     <length>255</length>
  67     <comment>contents of the Return-Path header</comment>
  68     <add>2.2</add>
  69   </field>
  70   <field>
  71     <name>protocol</name>
  72     <type>varchar</type>
  73     <length>255</length>
  74     <comment>name of the protocol to use for polling (like IMAP, POP3 or Maildir)</comment>
  75     <add>2.2</add>
  76     <pseudoconstant>
  77       <optionGroupName>mail_protocol</optionGroupName>
  78     </pseudoconstant>
  79     <html>
  80       <type>Select</type>
  81     </html>
  82   </field>
  83   <field>
  84     <name>server</name>
  85     <type>varchar</type>
  86     <length>255</length>
  87     <comment>server to use when polling</comment>
  88     <add>2.2</add>
  89   </field>
  90   <field>
  91     <name>port</name>
  92     <type>int unsigned</type>
  93     <comment>port to use when polling</comment>
  94     <add>2.2</add>
  95   </field>
  96   <field>
  97     <name>username</name>
  98     <type>varchar</type>
  99     <length>255</length>
 100     <comment>username to use when polling</comment>
 101     <add>2.2</add>
 102   </field>
 103   <field>
 104     <name>password</name>
 105     <type>varchar</type>
 106     <length>255</length>
 107     <comment>password to use when polling</comment>
 108     <add>2.2</add>
 109   </field>
 110   <field>
 111     <name>is_ssl</name>
 112     <type>boolean</type>
 113     <comment>whether to use SSL or not</comment>
 114     <add>2.2</add>
 115   </field>
 116   <field>
 117     <name>source</name>
 118     <type>varchar</type>
 119     <length>255</length>
 120     <comment>folder to poll from when using IMAP, path to poll from when using Maildir, etc.</comment>
 121     <add>2.2</add>
 122   </field>
 123 </table>