POP3 Adapter Configuration Properties

The following table lists the configuration properties that you can set for a POP3 adapter receive location:

Property name Type Description Restrictions Comments
mailServer VT_BSTR Specify the POP3 mail server that houses the mailbox that will be polled by the POP3 adapter. None None
serverPort VT_BSTR Specify the port for the POP3 mail server. Valid values are from 0 to 65535. A value of 0 indicates to use the default POP3 port of 110 if the sslRequired property is set to false or port 995 if the sslRrequired property is set to true.

The default value is 0.
userName VT_BSTR Specify the user name to use for authentication with the POP3 server. None None
password VT_BSTR Specify the user password to use for authentication with the POP3 server. This value is always masked when exporting a binding file. This field must be manually populated with the password before importing the binding file into the target BizTalk Server configuration. None
authenticationScheme VT_BSTR Specify the type of authentication to use with the destination server. Valid values are:

- Basic
- Digest
- SPA
There is not a default value for this property.
sslRequired VT_BSTR Specify whether to use SSL to communicate with the destination server. Valid values are:

- true
- false
The default value is false.
applyMIME VT_BSTR Specify whether to apply MIME decoding to messages received by the POP3 adapter. Valid values are:

- true
- false
The default value is true.
bodyPartContentType VT_BSTR Specify the body part content type of the incoming e-mail message to submit to BizTalk Server. Valid values are:

- body
- text/xml
- text/plain
- text/
There is not a default value for this property.
bodyPartIndex VT_BSTR Specify the body part of the incoming e-mail message to submit to BizTalk Server. Valid values are from 0 to 128. The default value is 0.
errorThreshold VT_BSTR Specify the maximum number of network or protocol errors to wait before shutting down the adapter. Valid values are from 0 to 4294967295. Specify a value of 0 to prevent the adapter from shutting down.

The default value is 10.
pollingInterval VT_BSTR Specify the interval between attempts to retrieve messages from the POP3 server. Valid values are:

- From 1 to 120 if the pollingUnitOfMeasure value is Days.
- From 1 to 2880 if the pollingUnitOfMeasure value is Hours.
- From 1 to 172800 if the pollingUnitOfMeasure value is Minutes.
- From 2 to 10368000 if the pollingUnitOfMeasure value is Seconds.
The default value is 5.
pollingUnitOfMeasure VT_BSTR Specify the unit of measure to be used in conjunction with the value for pollingInterval. Valid values are:

- Days
- Hours
- Minutes
- Seconds
The default value is Minutes.
uri VT_BSTR Specify the full path to the mailbox monitored by the receive location. The URI for a send port or receive location cannot exceed 256 characters. None

The following code shows the format of the string you use to set the properties:

<CustomProps><AdapterConfig vt="8"><Config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><mailServer>test.microsoft.com</mailServer><serverPort>0</serverPort><userName>testuser</userName><password>******</password><authenticationScheme>Basic</authenticationScheme><sslRequired>false</sslRequired><applyMIME>true</applyMIME><bodyPartContentType>text/xml</bodyPartContentType><bodyPartIndex>1</bodyPartIndex><errorThreshold>10</errorThreshold><pollingInterval>5</pollingInterval><pollingUnitOfMeasure>Minutes</pollingUnitOfMeasure><uri>POP3://test.microsoft.com#testuser</uri></Config></AdapterConfig></CustomProps>  

Note

When specifying TransportTypeData configuration data for an adapter that is built using the Adapter Framework, the name/value pairs that are used must all be stored into the <AdapterConfig> element. Since the <AdapterConfig> element specifies the VT_BSTR (vt="8") data type then the < > characters in the data must be escaped.