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     <html>
  14       <type>Number</type>
  15     </html>
  16     <add>2.2</add>
  17   </field>
  18   <primaryKey>
  19     <name>id</name>
  20     <autoincrement>true</autoincrement>
  21   </primaryKey>
  22   <field>
  23     <name>domain_id</name>
  24     <title>Domain ID</title>
  25     <type>int unsigned</type>
  26     <required>true</required>
  27     <pseudoconstant>
  28       <table>civicrm_domain</table>
  29       <keyColumn>id</keyColumn>
  30       <labelColumn>name</labelColumn>
  31     </pseudoconstant>
  32     <comment>Which Domain is this match entry for</comment>
  33     <html>
  34       <label>Domain</label>
  35     </html>
  36     <add>3.1</add>
  37   </field>
  38   <foreignKey>
  39     <name>domain_id</name>
  40     <table>civicrm_domain</table>
  41     <key>id</key>
  42     <add>4.5</add>
  43     <onDelete>CASCADE</onDelete>
  44   </foreignKey>
  45   <field>
  46     <name>name</name>
  47     <title>Mail Settings Name</title>
  48     <type>varchar</type>
  49     <length>255</length>
  50     <comment>name of this group of settings</comment>
  51     <add>2.2</add>
  52   </field>
  53   <field>
  54     <name>is_default</name>
  55     <title>Is Default Mail Settings?</title>
  56     <type>boolean</type>
  57     <default>0</default>
  58     <required>true</required>
  59     <comment>whether this is the default set of settings for this domain</comment>
  60     <add>2.2</add>
  61   </field>
  62   <field>
  63     <name>domain</name>
  64     <title>email Domain</title>
  65     <type>varchar</type>
  66     <length>255</length>
  67     <comment>email address domain (the part after @)</comment>
  68     <add>2.2</add>
  69   </field>
  70   <field>
  71     <name>localpart</name>
  72     <title>email Local Part</title>
  73     <type>varchar</type>
  74     <length>255</length>
  75     <comment>optional local part (like civimail+ for addresses like civimail+s.1.2@example.com)</comment>
  76     <add>2.2</add>
  77   </field>
  78   <field>
  79     <name>return_path</name>
  80     <title>Return Path</title>
  81     <type>varchar</type>
  82     <length>255</length>
  83     <comment>contents of the Return-Path header</comment>
  84     <add>2.2</add>
  85   </field>
  86   <field>
  87     <name>protocol</name>
  88     <title>Protocol</title>
  89     <type>varchar</type>
  90     <length>255</length>
  91     <comment>name of the protocol to use for polling (like IMAP, POP3 or Maildir)</comment>
  92     <add>2.2</add>
  93     <pseudoconstant>
  94       <optionGroupName>mail_protocol</optionGroupName>
  95     </pseudoconstant>
  96     <html>
  97       <type>Select</type>
  98     </html>
  99   </field>
 100   <field>
 101     <name>server</name>
 102     <title>Mail Server</title>
 103     <type>varchar</type>
 104     <length>255</length>
 105     <comment>server to use when polling</comment>
 106     <add>2.2</add>
 107   </field>
 108   <field>
 109     <name>port</name>
 110     <title>Mail Port</title>
 111     <type>int unsigned</type>
 112     <comment>port to use when polling</comment>
 113     <add>2.2</add>
 114   </field>
 115   <field>
 116     <name>username</name>
 117     <title>Mail Account Username</title>
 118     <type>varchar</type>
 119     <length>255</length>
 120     <comment>username to use when polling</comment>
 121     <add>2.2</add>
 122   </field>
 123   <field>
 124     <name>password</name>
 125     <title>Mail Account Password</title>
 126     <type>varchar</type>
 127     <length>255</length>
 128     <comment>password to use when polling</comment>
 129     <add>2.2</add>
 130   </field>
 131   <field>
 132     <name>is_ssl</name>
 133     <title>Mail Account Uses SSL</title>
 134     <type>boolean</type>
 135     <default>0</default>
 136     <required>true</required>
 137     <comment>whether to use SSL or not</comment>
 138     <add>2.2</add>
 139   </field>
 140   <field>
 141     <name>source</name>
 142     <title>Mail Folder</title>
 143     <type>varchar</type>
 144     <length>255</length>
 145     <comment>folder to poll from when using IMAP, path to poll from when using Maildir, etc.</comment>
 146     <add>2.2</add>
 147   </field>
 148   <field>
 149     <name>activity_status</name>
 150     <title>Activity Status</title>
 151     <type>varchar</type>
 152     <length>255</length>
 153     <comment>Name of status to use when creating email to activity.</comment>
 154     <add>4.7</add>
 155     <pseudoconstant>
 156       <optionGroupName>activity_status</optionGroupName>
 157       <keyColumn>name</keyColumn>
 158     </pseudoconstant>
 159     <html>
 160       <type>Select</type>
 161     </html>
 162   </field>
 163   <field>
 164     <name>is_non_case_email_skipped</name>
 165     <title>Skip emails which do not have a Case ID or Case hash</title>
 166     <type>boolean</type>
 167     <default>0</default>
 168     <required>true</required>
 169     <html>
 170       <type>CheckBox</type>
 171     </html>
 172     <comment>Enabling this option will have CiviCRM skip any emails that do not have the Case ID or Case Hash so that the system will only process emails that can be placed on case records. Any emails that are not processed will be moved to the ignored folder.</comment>
 173     <add>5.31</add>
 174   </field>
 175   <field>
 176     <name>is_contact_creation_disabled_if_no_match</name>
 177     <type>boolean</type>
 178     <title>Do not create new contacts when filing emails</title>
 179     <default>0</default>
 180     <required>true</required>
 181     <html>
 182       <type>CheckBox</type>
 183     </html>
 184     <description>If this option is enabled, CiviCRM will not create new contacts when filing emails.</description>
 185     <add>5.31</add>
 186   </field>
 187 </table>