[civicrm-core.git] / xml / schema / Core / MailSettings.xml

<table>
  <base>CRM/Core</base>
  <class>MailSettings</class>
  <name>civicrm_mail_settings</name>
  <comment>Various email accounts for use by CiviMail (and its processor)</comment>
  <add>2.2</add>
  <field>
    <name>id</name>
    <title>Mail Settings ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>primary key</comment>
    <add>2.2</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>domain_id</name>
    <title>Mail Settings Domain</title>
    <type>int unsigned</type>
    <required>true</required>
    <pseudoconstant>
      <table>civicrm_domain</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <comment>Which Domain is this match entry for</comment>
    <add>3.1</add>
  </field>
  <foreignKey>
    <name>domain_id</name>
    <table>civicrm_domain</table>
    <key>id</key>
    <add>4.5</add>
    <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
    <name>name</name>
    <title>Mail Settings Name</title>
    <type>varchar</type>
    <length>255</length>
    <comment>name of this group of settings</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>is_default</name>
    <title>Is Default Mail Settings?</title>
    <type>boolean</type>
    <comment>whether this is the default set of settings for this domain</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>domain</name>
    <title>email Domain</title>
    <type>varchar</type>
    <length>255</length>
    <comment>email address domain (the part after @)</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>localpart</name>
    <title>email Local Part</title>
    <type>varchar</type>
    <length>255</length>
    <comment>optional local part (like civimail+ for addresses like civimail+s.1.2@example.com)</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>return_path</name>
    <title>Return Path</title>
    <type>varchar</type>
    <length>255</length>
    <comment>contents of the Return-Path header</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>protocol</name>
    <title>Protocol</title>
    <type>varchar</type>
    <length>255</length>
    <comment>name of the protocol to use for polling (like IMAP, POP3 or Maildir)</comment>
    <add>2.2</add>
    <pseudoconstant>
      <optionGroupName>mail_protocol</optionGroupName>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>server</name>
    <title>Mail Server</title>
    <type>varchar</type>
    <length>255</length>
    <comment>server to use when polling</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>port</name>
    <title>Mail Port</title>
    <type>int unsigned</type>
    <comment>port to use when polling</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>username</name>
    <title>Mail Account Username</title>
    <type>varchar</type>
    <length>255</length>
    <comment>username to use when polling</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>password</name>
    <title>Mail Account Password</title>
    <type>varchar</type>
    <length>255</length>
    <comment>password to use when polling</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>is_ssl</name>
    <title>Mail Account Uses SSL</title>
    <type>boolean</type>
    <comment>whether to use SSL or not</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>source</name>
    <title>Mail Folder</title>
    <type>varchar</type>
    <length>255</length>
    <comment>folder to poll from when using IMAP, path to poll from when using Maildir, etc.</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>activity_status</name>
    <title>Activity Status</title>
    <type>varchar</type>
    <length>255</length>
    <comment>Name of status to use when creating email to activity.</comment>
    <add>4.7</add>
    <pseudoconstant>
      <optionGroupName>activity_status</optionGroupName>
      <keyColumn>name</keyColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>is_non_case_email_skipped</name>
    <title>Skip emails which do not have a Case ID or Case hash</title>
    <type>boolean</type>
    <default>0</default>
    <html>
      <type>CheckBox</type>
    </html>
    <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>
    <add>5.31</add>
  </field>
  <field>
    <name>is_contact_creation_disabled_if_no_match</name>
    <type>boolean</type>
    <title>Do not create new contacts when filing emails</title>
    <default>0</default>
    <html>
      <type>CheckBox</type>
    </html>
    <description>If this option is enabled, CiviCRM will not create new contacts when filing emails.</description>
    <add>5.31</add>
  </field>
</table>
Commit	Line	Data
6a488035 TO	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>
45afd2ea	9	<title>Mail Settings ID</title>
6a488035 TO	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>
4cc2ccac	20	<name>domain_id</name>
45afd2ea	21	<title>Mail Settings Domain</title>
4cc2ccac EM	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>
6a488035	31	</field>
41876fd8	32	<foreignKey>
4cc2ccac EM	33	<name>domain_id</name>
	34	<table>civicrm_domain</table>
	35	<key>id</key>
	36	<add>4.5</add>
ce62f51a	37	<onDelete>CASCADE</onDelete>
41876fd8	38	</foreignKey>
6a488035 TO	39	<field>
6a488035 TO	40	<name>name</name>
45afd2ea	41	<title>Mail Settings Name</title>
6a488035 TO	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>
45afd2ea	49	<title>Is Default Mail Settings?</title>
6a488035 TO	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>
45afd2ea	56	<title>email Domain</title>
6a488035 TO	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>
45afd2ea	64	<title>email Local Part</title>
6a488035 TO	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>
45afd2ea	72	<title>Return Path</title>
6a488035 TO	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>
45afd2ea	80	<title>Protocol</title>
6a488035 TO	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>
cbf48754 AS	85	<pseudoconstant>
	86	<optionGroupName>mail_protocol</optionGroupName>
	87	</pseudoconstant>
614d72ec	88	<html>
e0991796	89	<type>Select</type>
614d72ec	90	</html>
6a488035 TO	91	</field>
	92	<field>
	93	<name>server</name>
45afd2ea	94	<title>Mail Server</title>
6a488035 TO	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>
45afd2ea	102	<title>Mail Port</title>
6a488035 TO	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>
45afd2ea	109	<title>Mail Account Username</title>
6a488035 TO	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>
45afd2ea	117	<title>Mail Account Password</title>
6a488035 TO	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>
45afd2ea	125	<title>Mail Account Uses SSL</title>
6a488035 TO	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>
45afd2ea	132	<title>Mail Folder</title>
6a488035 TO	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>
040073c9 CW	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>
f945f0c4 I	153	<field>
	154	<name>is_non_case_email_skipped</name>
	155	<title>Skip emails which do not have a Case ID or Case hash</title>
	156	<type>boolean</type>
	157	<default>0</default>
	158	<html>
	159	<type>CheckBox</type>
	160	</html>
	161	<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>
	162	<add>5.31</add>
	163	</field>
993a642c I	164	<field>
	165	<name>is_contact_creation_disabled_if_no_match</name>
	166	<type>boolean</type>
	167	<title>Do not create new contacts when filing emails</title>
	168	<default>0</default>
	169	<html>
	170	<type>CheckBox</type>
	171	</html>
	172	<description>If this option is enabled, CiviCRM will not create new contacts when filing emails.</description>
	173	<add>5.31</add>
	174	</field>
6a488035	175	</table>