[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>
    <html>
      <type>Number</type>
    </html>
    <add>2.2</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>domain_id</name>
    <title>Domain ID</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>
    <html>
      <label>Domain</label>
    </html>
    <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>
    <default>0</default>
    <required>true</required>
    <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>
    <default>0</default>
    <required>true</required>
    <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>
    <required>true</required>
    <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>
    <required>true</required>
    <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>
0481e12c A	13	<html>
	14	<type>Number</type>
	15	</html>
6a488035 TO	16	<add>2.2</add>
	17	</field>
	18	<primaryKey>
	19	<name>id</name>
	20	<autoincrement>true</autoincrement>
	21	</primaryKey>
	22	<field>
4cc2ccac	23	<name>domain_id</name>
047c5009	24	<title>Domain ID</title>
4cc2ccac EM	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>
57e94608	33	<html>
047c5009	34	<label>Domain</label>
57e94608	35	</html>
4cc2ccac	36	<add>3.1</add>
6a488035	37	</field>
41876fd8	38	<foreignKey>
4cc2ccac EM	39	<name>domain_id</name>
	40	<table>civicrm_domain</table>
	41	<key>id</key>
	42	<add>4.5</add>
ce62f51a	43	<onDelete>CASCADE</onDelete>
41876fd8	44	</foreignKey>
6a488035 TO	45	<field>
6a488035 TO	46	<name>name</name>
45afd2ea	47	<title>Mail Settings Name</title>
6a488035 TO	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>
45afd2ea	55	<title>Is Default Mail Settings?</title>
6a488035	56	<type>boolean</type>
c1e814c7 MD	57	<default>0</default>
c1e814c7 MD	58	<required>true</required>
6a488035 TO	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>
45afd2ea	64	<title>email Domain</title>
6a488035 TO	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>
45afd2ea	72	<title>email Local Part</title>
6a488035 TO	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>
45afd2ea	80	<title>Return Path</title>
6a488035 TO	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>
45afd2ea	88	<title>Protocol</title>
6a488035 TO	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>
cbf48754 AS	93	<pseudoconstant>
	94	<optionGroupName>mail_protocol</optionGroupName>
	95	</pseudoconstant>
614d72ec	96	<html>
e0991796	97	<type>Select</type>
614d72ec	98	</html>
6a488035 TO	99	</field>
	100	<field>
	101	<name>server</name>
45afd2ea	102	<title>Mail Server</title>
6a488035 TO	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>
45afd2ea	110	<title>Mail Port</title>
6a488035 TO	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>
45afd2ea	117	<title>Mail Account Username</title>
6a488035 TO	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>
45afd2ea	125	<title>Mail Account Password</title>
6a488035 TO	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>
45afd2ea	133	<title>Mail Account Uses SSL</title>
6a488035	134	<type>boolean</type>
c1e814c7 MD	135	<default>0</default>
c1e814c7 MD	136	<required>true</required>
6a488035 TO	137	<comment>whether to use SSL or not</comment>
	138	<add>2.2</add>
	139	</field>
	140	<field>
	141	<name>source</name>
45afd2ea	142	<title>Mail Folder</title>
6a488035 TO	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>
040073c9 CW	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>
f945f0c4 I	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>
c1e814c7	168	<required>true</required>
f945f0c4 I	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>
993a642c I	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>
c1e814c7	180	<required>true</required>
993a642c I	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>
6a488035	187	</table>