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     <title>Mail Settings ID</title>
  10     <type>int unsigned</type>
  11     <required>true</required>
  12     <comment>primary key</comment>
  13     <add>2.2</add>
  14   </field>
  15   <primaryKey>
  16     <name>id</name>
  17     <autoincrement>true</autoincrement>
  18   </primaryKey>
  19   <field>
  20     <name>domain_id</name>
  21     <title>Mail Settings Domain</title>
  22     <type>int unsigned</type>
  23     <required>true</required>
  24     <pseudoconstant>
  25       <table>civicrm_domain</table>
  26       <keyColumn>id</keyColumn>
  27       <labelColumn>name</labelColumn>
  28     </pseudoconstant>
  29     <comment>Which Domain is this match entry for</comment>
  30     <add>3.1</add>
  31   </field>
  32   <foreignKey>
  33     <name>domain_id</name>
  34     <table>civicrm_domain</table>
  35     <key>id</key>
  36     <add>4.5</add>
  37     <onDelete>CASCADE</onDelete>
  38   </foreignKey>
  39   <field>
  40     <name>name</name>
  41     <title>Mail Settings Name</title>
  42     <type>varchar</type>
  43     <length>255</length>
  44     <comment>name of this group of settings</comment>
  45     <add>2.2</add>
  46   </field>
  47   <field>
  48     <name>is_default</name>
  49     <title>Is Default Mail Settings?</title>
  50     <type>boolean</type>
  51     <comment>whether this is the default set of settings for this domain</comment>
  52     <add>2.2</add>
  53   </field>
  54   <field>
  55     <name>domain</name>
  56     <title>email Domain</title>
  57     <type>varchar</type>
  58     <length>255</length>
  59     <comment>email address domain (the part after @)</comment>
  60     <add>2.2</add>
  61   </field>
  62   <field>
  63     <name>localpart</name>
  64     <title>email Local Part</title>
  65     <type>varchar</type>
  66     <length>255</length>
  67     <comment>optional local part (like civimail+ for addresses like civimail+s.1.2@example.com)</comment>
  68     <add>2.2</add>
  69   </field>
  70   <field>
  71     <name>return_path</name>
  72     <title>Return Path</title>
  73     <type>varchar</type>
  74     <length>255</length>
  75     <comment>contents of the Return-Path header</comment>
  76     <add>2.2</add>
  77   </field>
  78   <field>
  79     <name>protocol</name>
  80     <title>Protocol</title>
  81     <type>varchar</type>
  82     <length>255</length>
  83     <comment>name of the protocol to use for polling (like IMAP, POP3 or Maildir)</comment>
  84     <add>2.2</add>
  85     <pseudoconstant>
  86       <optionGroupName>mail_protocol</optionGroupName>
  87     </pseudoconstant>
  88     <html>
  89       <type>Select</type>
  90     </html>
  91   </field>
  92   <field>
  93     <name>server</name>
  94     <title>Mail Server</title>
  95     <type>varchar</type>
  96     <length>255</length>
  97     <comment>server to use when polling</comment>
  98     <add>2.2</add>
  99   </field>
 100   <field>
 101     <name>port</name>
 102     <title>Mail Port</title>
 103     <type>int unsigned</type>
 104     <comment>port to use when polling</comment>
 105     <add>2.2</add>
 106   </field>
 107   <field>
 108     <name>username</name>
 109     <title>Mail Account Username</title>
 110     <type>varchar</type>
 111     <length>255</length>
 112     <comment>username to use when polling</comment>
 113     <add>2.2</add>
 114   </field>
 115   <field>
 116     <name>password</name>
 117     <title>Mail Account Password</title>
 118     <type>varchar</type>
 119     <length>255</length>
 120     <comment>password to use when polling</comment>
 121     <add>2.2</add>
 122   </field>
 123   <field>
 124     <name>is_ssl</name>
 125     <title>Mail Account Uses SSL</title>
 126     <type>boolean</type>
 127     <comment>whether to use SSL or not</comment>
 128     <add>2.2</add>
 129   </field>
 130   <field>
 131     <name>source</name>
 132     <title>Mail Folder</title>
 133     <type>varchar</type>
 134     <length>255</length>
 135     <comment>folder to poll from when using IMAP, path to poll from when using Maildir, etc.</comment>
 136     <add>2.2</add>
 137   </field>
 138   <field>
 139     <name>activity_status</name>
 140     <title>Activity Status</title>
 141     <type>varchar</type>
 142     <length>255</length>
 143     <comment>Name of status to use when creating email to activity.</comment>
 144     <add>4.7</add>
 145     <pseudoconstant>
 146       <optionGroupName>activity_status</optionGroupName>
 147       <keyColumn>name</keyColumn>
 148     </pseudoconstant>
 149     <html>
 150       <type>Select</type>
 151     </html>
 152   </field>
 153 </table>