Activation specification properties, WebSphere Adapter for Email

IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Email > Reference > Inbound configuration properties
Activation specification properties

Activation specification properties are properties that hold the inbound event processing configuration information for an export.

The following table lists the activation specification properties for inbound communication. You set the activation specification properties using the external service wizard and can change them before deployment using the IBM Integration Designer Assembly Editor. After deployment, you can change these values using the IBM BPM or WebSphere Enterprise Service Bus Process Administrative Console.
A more detailed description of each property is provided in the sections that follow the table. For information about how to read the property detail tables in the sections that follow, see Guide to information about properties.

Activation specification properties
In the wizard In the Process Administrative Console Description
Archive file naming pattern ArchiveFileNamingPattern A comma delimited pattern of header names used to name archived files being stored in the archive folder.
Archive folder ArchiveFolder The file folder on the local system where successfully processed emails are archived as files.
Bidi format string
BIDIContextEIS

Indicates the bidi format for string type business data exchanged between the mail server and the adapter
Database schema name EP_SchemaName The schema name for the database used by the adapter's event persistence feature
Delivery type
DeliveryType

Determines the order in which events are delivered by the adapter to the export.
Emit individual business objects from a multipart email EmitIndividualBOs Specifies whether the adapter creates individual business objects for each part of a multipart email.
Enable transport security (SSL) enableSSL Specifies whether a Secure Sockets Layer (SSL) connection is enabled.
Ensure once-only event delivery
AssuredOnceDelivery

Specifies whether the adapter provides assured once delivery of events.
Event recovery data source (JNDI) name EP_DataSource_JNDIName The JNDI name of the data source used by the event persistence class to acquire the JDBC database connection
Event recovery table name EP_TableName The name of the event store used by the adapter
Retry limit for failed events FailedEventRetryLimit The number of times the adapter attempts to redeliver an event before marking the event as failed.
Failed events folder FailedEventsFolder The absolute path to the file folder on the local system where unsuccessfully processed email events are archived in file format.
Host name HostName The IP address of the host where the mail server is running.
Interval between polling periods
PollPeriod

The length of time that the adapter waits between polling periods.
Match all search criteria MatchAllSearchCriteria The search criteria to filter which events are polled from the mail server.
Match some search criteria MatchSomeSearchCriteria The search criteria to filter which events are polled from the mail server.
Maximum events in polling period
PollQuantity

The number of events the adapter delivers to the export during each poll period.
Maximum connections
MaximumConnections

The maximum number of connections that the adapter can use for inbound event delivery.
Minimum connections
MinimumConnections

The minimum number of connections that the adapter can use for inbound event delivery.
Maximum number of retries in case of system connection failure
RetryLimit

The number of times the adapter tries to reestablish an inbound connection after an error.
Password Password The password associated with the mail server user name.
Password used to connect to event data source EP_Password The password used by the adapter's event persistence feature. It is used to acquire the JDBC database connection from the data source configured in the server.
Poll folder Poll folder The name of the mail folder or mail folders the adapter polls for inbound requests (emails).
Port Port The POP3 or IMAP port where the mail server is listening.
Protocol Protocol The protocol adapter uses for inbound communication with the mail server.
Retry EIS connection on startup RetryConnectionOnStartup
Controls whether the adapter retries the connection to the mail server if it cannot connect at startup.
Time between retries in case of system connection failure (milliseconds)
RetryInterval

The length of time that the adapter waits between attempts to reestablish connection after an error during inbound operations.
Staging directory InProgressFolder The folder on the file system where the emails polled from the mail server are first written in file format.
Stop polling on error
StopPollingOnError

Specifies whether the adapter stops polling for events when it encounters an error during polling.
(Not available) UseFiveLevelBO Specifies whether business graphs and wrappers are generated for child business objects of the email parent business object.
User name UserName The user name for the mail server.
User name used to connect to event data source EP_UserName The user name used by the adapter's assured-once delivery feature.

Archive file naming pattern (ArchiveFile)

This property is used to specify a comma delimited pattern of header names used to name archived files being stored in the archive folder.

Archive file naming pattern details
Required No
Default The message-ID of the email event. This information is retrieved from the email header.
Property type String
Usage This property is to be used with the Archive folder (ArchiveFolder) property.
Example If the header values From, Date are specified, the adapter picks the From address and Date from the email headers and combines them with the message ID to form the file name (From name + Date + Message ID).
Globalized Yes
Bidi supported No

Archive folder (ArchiveFolder)

This property specifies the file folder on the local system where successfully processed emails are archived in RFC822 file format.

Archive folder details
Required No
Default No default value
Property type String
Usage This folder must be manually created on the same system as the adapter before the adapter is run. If no archive folder is specified, the adapter does not successfully archive the emails. They are deleted from the In progress folder.
You can use a WebSphere Application Server environment variable to represent the archive folder. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${ARCHIVE_FOLDER}. See the topic on creating an environment variable in this documentation.
Globalized Yes
Bidi supported Yes

Auto create event table property (EP_CreateTable)

This property specifies whether the adapter should create an event store if it detects one does not exist.

Automatically create event table details
Required No
Possible values
True
False
Default True
Property type Boolean
Usage
If set to True, the adapter creates an event store if it detects that one does not exist.
If set to False, the adapter does not create an event store even if one does not exist. Verify that an event store exists if you want to ensure the delivery of events.
Globalized No
Bidi supported No

Bidi format string (BIDIContextEIS)

This property indicates the bidi format for string type business data exchanged between the mail server and the adapter.

Bidi format string details
Required No
Possible values IBM BPM and WebSphere Enterprise Service Bus use ILYNN (implicit, left-to-right, on, off, nominal). These five attributes comprise the format used by Windows.
Default No default value
Property type String
Usage A five-character string that identifies the bidirectional format used by the mail server.
If the mail server that sends or receives data from the server uses a different format than ILYNN, the adapter converts the format before introducing the data to the server. For the conversion to occur, you use the external service wizard to set attribute values that represent the bidirectional format used by the mail server. This is done when you configure the module for the first time.
Example
ILYNN
VRYNN
VLYNN
Globalized No
Bidi supported No

Database schema name (EP_SchemaName)

This property specifies the schema name for the database used by the adapter's assured-once delivery feature.

Database schema name details
Required No
Default No default value
Property type String
Usage Specifies the schema name for the database used by the adapter's assured-once delivery feature. This value is not case-sensitive.
Globalized Yes
Bidi supported Yes

Delivery type (DeliveryType)

This property specifies the order in which events are delivered by the adapter to the export.

Delivery type details
Required No
Possible values
ORDERED
UNORDERED

Default ORDERED
Property type String
Usage The following values are supported:

ORDERED: The adapter delivers events to the export one at a time.
UNORDERED: The adapter delivers all events to the export at once.

Globalized No
Bidi supported No

Emit individual business objects from a multipart email (EmitIndividualBOs)

This property specifies whether the adapter creates individual business objects for each part of a multipart email.

Emit individual business objects from a multipart email details
Required No
Default False
Property type Boolean
Usage The split for individual business object is completed by the adapter and each of the business objects is emitted as generic email (emitEmail). Each part of a multipart email is considered an individual business object and emitted using the email wrapper object, where content of each part is set in the mail content attribute.
Globalized (Not available)
Bidi supported No

Enable transport security (SecureConnectionProperty)

This property specifies if the SSL connection is enabled for the POP3 or IMAP protocol chosen in the Protocol property.

Enable transport security details
Required No
Default False
Property type Boolean
Usage
If set to True, the port value needs to be set to one of the following values:
For the POP3 protocol, 995
For the IMAP protocol, 993
Globalized No
Bidi supported No

Ensure once-only event delivery (AssuredOnceDelivery)

This property specifies whether to provide ensure once-only event delivery for inbound events.

Ensure once-only event delivery details
Required Yes
Possible values
True
False
Default True
Property type Boolean
Usage When this property is set to True, the adapter provides assured once event delivery. This means that each event is delivered once and only once. A value of False does not provide assured once event delivery, but provides better performance.
When this property is set to True, the adapter attempts to store transaction (XID) information in the event store. If it is set to False, the adapter does not attempt to store the information.
This property is used only if the export component is transactional. If it is not, no transaction can be used, regardless of the value of this property.
Globalized No
Bidi supported No

Event recovery data source (JNDI) name property (EP_DataSource_JNDIName)

This property specifies the JNDI name of the data source that will be used by the event persistence class to acquire the JDBC database connection.

Event recovery data source (JNDI) name details
Required Yes, if the AssuredOnceDelivery property is set to True
Default No default value
Property type String
Usage This value is case-sensitive.
The external service wizard does not create the data source on IBM BPM or WebSphere Enterprise Service Bus. Verify that the data source is defined on the server before deploying the adapter.
Globalized Yes
Bidi supported Yes

Event recovery table name property (EP_TableName)

This property specifies the name of the event store that will be used by the adapter for event persistence.

Event recovery table name details
Required Yes, if the AssuredOnceDelivery property is set to True
Default EmailEventTable
Property type String
Usage The value specified for this property must be unique for each adapter instance and cannot be used by another instance. This value is not case-sensitive.
Globalized Yes
Bidi supported Yes

Retry limit for failed events (FailedEventRetryLimit)

This property specifies the number of times that the adapter attempts to redeliver an event before marking the event as failed.

Retry limit for failed events details
Required No
Possible values Integers
Default 5
Property type Integer
Usage Use this property to control how many times the adapter tries to send an event before marking it as failed. It accepts the following values:

Default

If this property is not set, the adapter tries five additional times before marking the event as failed.

0

The adapter tries to deliver the event an infinite number of times. When the property is set to 0, the event remains in the event store and the event is never marked as failed.

> 0

For integers greater than zero, the adapter retries the specified number of times before marking the event as failed.

< 0

For negative integers, the adapter does not retry failed events.

Globalized No
Bidi supported No

Failed events folder (FailedEventsFolder)

This property specifies the file folder on the local system where unsuccessfully processed email events are archived in file format.

Failed events folder details
Required No
Default No default value
Property type String
Usage This folder must be manually created on the same system as the adapter before the adapter is run. If you do not specify a failed events folder, the adapter does not archive any unsuccessful email event.
You can use a WebSphere Application Server environment variable to represent the failed events folder. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${FAILEDEVENTS_FOLDER}. See the topic on creating an environment variable in this documentation.
Globalized Yes
Bidi supported No

Host name (HostName)

This property specifies the IP address of the host where the mail server is running.

Host name details
Required No
Default localhost
Property type String
Usage Specifies the IP address of the host where the mail server is running
Globalized No
Bidi supported Yes

Interval between polling periods (PollPeriod)

This property specifies the length of time that the adapter waits between polling periods.

Interval between polling periods details
Required Yes
Possible values Integers greater than or equal to 0.
Default 2000
Unit of measure Milliseconds
Property type Integer
Usage The poll period is established at a fixed rate, which means that if running the poll cycle is delayed for any reason (for example, if a prior poll cycle takes longer than expected to complete) the next poll cycle occurs immediately to make up for the lost time caused by the delay.
Globalized No
Bidi supported No

Match all search criteria (MatchAllCriteria)

This property specifies search criteria that the adapter uses to filter which events are polled from designated poll folders on the mail server. Events that meet the ANDed conditions are polled.

Match all search criteria details
Required No
Possible values
You can use any of the following header values when specifying search criteria:

content=
subject=
to=
cc=
from=
sender=
date=

Default No default value. It means that you have not selected any filtering options.
Property type String
Usage
Specify AND conditions by separating them with a comma (,). This limits the event search to only mail events in the poll folder that meet the ANDed specific search criteria.
Specify NOT conditions by separating them with an exclamation mark (!). This limits the event search to only mail events in the poll folder that do not include the search options NOTed.
If both Match all search criteria and Match some criteria properties are set, the adapter uses the AND operation between the fields. This means that the outputs of the first set of conditions are subjected to the second set of conditions.
For example, if sender=xyz@abc.com, to=pqr@abc.com is set for Match all search criteria property and subject=test, from!=lmn@abc.com is set for Match some search criteria property, the adapter searches for events with a sender value of xyz@abc.com and a to value of pqr@abc.com that might also have a subject value of test and which does not have a from value of lmn@abc.com.
Example
sender=xyz@abc.com,to=pqr@abc.com picks up any events with a sender value that matches sender=xyz@abc.com and a to value of to=pqr@abc.com.
sender=xyz@abc.com,to!=pqr@abc.com picks up any events with a sender value that matches sender=xyz@abc.com and does not have a to value of pqr@abc.com.
Globalized No
Bidi supported No

Match some search criteria (MatchSomeCriteria)

This property specifies the search criteria the adapter uses to filter which events are polled from the designated poll folders on the mail server. Events that meet the ORed conditions are polled.

Match some search criteria details
Required No
Possible values
You can use any of the following header values when specifying search criteria:

content=
subject=
to=
cc=
from=
sender=
date=

Default Default is blank. It means that you have not selected any filtering options.
Property type String
Usage
Specify OR conditions by separating them with a comma (,). This limits the event search to mail events in the poll folder that meet the ORed search criteria.
Specify NOT conditions by separating them with an exclamation mark (!). This limits the event search to only mail events in the poll folder that do not include the search options NOTed.
If both Match all search criteria and Match some criteria properties are set, the adapter uses the AND operation between the fields. This means that the outputs of the first set of conditions are subjected to the second set of conditions.
For example, if sender=xyz@abc.com, to=pqr@abc.com is set for Match all search criteria property and subject=test, from!=lmn@abc.com is set for Match some search criteria property, the adapter searches for events with a sender value of xyz@abc.com and a to value of pqr@abc.com that might also have a subject value of test and which does not have a from value of lmn@abc.com.
Example
sender=xyz@abc.com,to=pqr@abc.com picks up any events with a sender value that matches sender=xyz@abc.com and a to value of to=pqr@abc.com.
sender=xyz@abc.com,to!=pqr@abc.com picks up any events with a sender value that matches sender=xyz@abc.com and does not have a to value of pqr@abc.com.
Globalized No
Bidi supported No

Maximum connections (MaximumConnections)

This property specifies the maximum number of connections that the adapter can use for inbound event delivery.

Maximum connections details
Required No
Default 1
Property type Integer
Usage Only positive values are valid. Any value less than 1 is treated as 1 by the adapter.
Globalized No
Bidi supported No

Minimum connections (MinimumConnections)

This property specifies the minimum number of connections that the adapter can use for inbound event delivery.

Minimum connections details
Required No
Default 1
Property type Integer
Usage Only positive values are valid. Any value less than 1 is treated as 1 by the adapter.
Globalized No
Bidi supported No

Maximum events in polling period (PollQuantity)

This property specifies the number of events that the adapter delivers to the export during each poll period.

Maximum events in polling period details
Required Yes
Default 10
Property type Integer
Usage The value must be greater than 0. If this value is increased, more events are processed per polling period and the adapter may perform less efficiently. If this value is decreased, fewer events are processed per polling period and the adapter's performance might improve slightly.
Globalized No
Bidi supported No

Maximum number of retries in case of system connection failure (RetryLimit)

This property specifies the number of times the adapter tries to reestablish an inbound connection.

Maximum number of retries in case of system connection failure
Required No
Possible values 0 and positive integers
Default 0
Property type Integer
Usage
This property controls how many times the adapter retries the connection if the adapter cannot connect to the mail server to perform inbound processing. A value of 0 indicates an infinite number of retries.
To control whether the adapter retries if it cannot connect to the mail server when it is first started, use the RetryConnectionOnStartup property.
Globalized No
Bidi supported No

Password (Password)

This property specifies the password for the user name associated with the mail server.

Password details
Required Yes
Default No default value
Property type String
Usage Authenticates the inbound POP3 or IMAP session with the mail server. IBM BPM or WebSphere Enterprise Service Bus Process Administrative Console does not encrypt the Password property the first time.
Globalized Yes
Bidi supported Yes

Password used to connect to event data source property (EP_Password)

This property specifies the password used by the adapter's assured-once delivery feature.

Password used to connect to event data source details
Required Yes, if the AssuredOnceDelivery property is set to True
Default No default value
Property type String
Usage Specify the password that the adapter uses to connect to the event store. This value is case-sensitive.
Globalized Yes
Bidi supported Yes

Poll folder (PollFolder)

This property specifies the name of the mail folder or mail folders the adapter polls for inbound requests (emails).

Poll folder details
Required
No for POP3 protocol
Yes for IMAP protocol
Default
For the POP3 protocol, the default is Inbox
For the IMAP protocol, there is no default value.
Property type String
Usage
For the POP3 protocol, the adapter cannot poll multiple mail server folders. It automatically defaults to Inbox because Inbox is the only supported value with POP3.
If the Protocol property is set to POP3, this property defaults to Inbox. No other value for POP3 is supported.
If the Protocol property is set to IMAP, you can define one or more mail folder names. To poll multiple mail server folders, folder names are delimited with commas.
Globalized Yes
Bidi supported No

Port (Port)

This property specifies the POP3 or IMAP port where the mail server is listening.

Port details
Required No
Default
110 when the protocol is set to POP3
143 when the protocol is set to IMAP
Property type Integer
Usage
If the Secure connection (SSL) property is set to True, this property must be updated.
For the POP3 protocol, it must be set to 995.
For the IMAP protocol, it must be set to 993.
Globalized No
Bidi supported No

Protocol (Protocol)

The property specifies the protocol used for inbound communication with the mail server.

Protocol details
Required No
Possible values
IMAP
POP3
Default POP3
Property type String
Usage
If set to IMAP, the adapter uses the IMAP email protocol for inbound communication.

If set to POP3, the adapter uses the POP3 email protocol for inbound communication.
Globalized No
Bidi supported No

Retry EIS connection on startup (RetryConnectionOnStartup)

This property controls whether the adapter attempts to connect again to the mail server if it cannot connect at startup.

Retry EIS connection on startup details
Required No
Possible values
True
False
Default False
Property type Boolean
Usage This property indicates whether the adapter should retry the connection to the mail server if the connection cannot be made when the adapter is started:

Set the property to False when you want immediate feedback about whether the adapter can establish a connection to the mail server, for example, when you are building and testing the application that receives events from the adapter. If the adapter cannot connect, the adapter writes log and trace information and stops. The administrative console.shows the application status as Stopped. After you resolve the connection problem, start the adapter manually.
Set the property to True if you do not need immediate feedback about the connection. If the adapter cannot connect during startup, it writes log and trace information, and then attempts to reconnect, using the RetryInterval property to determine how frequently to retry and the value of the RetryLimit property to retry multiple times until that value is reached. The administrative console.shows the application status as Started.

Globalized No
Bidi supported No

Time between retries in case of system connection failure (RetryInterval)

When the adapter encounters an error related to the inbound connection, this property specifies the length of time the adapter waits before trying to reestablish a connection.

Retry interval details
Required Yes
Default 2000
Unit of measure Milliseconds
Property type Integer
Usage Only positive values are valid. When the adapter encounters an error related to the inbound connection, this property specifies the length of time the adapter waits before trying to establish a new connection.
Globalized No
Bidi supported No

Staging directory (InProgressFolder)

This property specifies the folder on the file system where the emails polled from the mail server are first written in file format.

Staging directory details
Required Yes
Default No default value
Property type String
Usage This folder must be created on the same system where the adapter is running before the adapter is started. After being written to the file system in file format, each file is named based on the Message-ID of its corresponding email event. These details are retrieved from the email header value.
You can use a WebSphere Application Server environment variable to represent the In progress folder. Specify the name of the environment variable in braces, preceded by a $ symbol.
For example: ${INPROGRESS_FOLDER}. See the topic on creating an environment variable in this documentation.
Globalized Yes
Bidi supported Yes

Stop the adapter when an error is encountered while polling (StopPollingOnError)

This property specifies whether the adapter will stop polling for events when it encounters an error during polling.

Stop the adapter when an error is encountered while polling details
Required No
Possible values
True
False
Default False
Property type Boolean
Usage
If this property is set to True, the adapter stops polling when it encounters an error.
If this property is set to False, the adapter logs an exception when it encounters an error during polling and continues polling.
Globalized No
Bidi supported No

UseFiveLevelBO

This property specifies whether business graphs and wrappers are generated for child business objects of the email parent business object.

Use five level business object details
Required No
Default True
Property type Boolean
Usage This property is for compatibility with earlier versions with version 6.0.2 business objects and does not appear in the external service wizard. In version 6.0.2, the default for this property was True.
Globalized (Not available)
Bidi supported No

User name (UserName)

This property specifies the user name for the mail server to be used for the inbound POP3 or IMAP session.

User name details
Required Yes
Default No default value
Property type String
Usage The mail server must be running on the host specified in the host property.
Globalized Yes
Bidi supported Yes

User name used to connect to event data source property (EP_UserName)

This property specifies the user name used by the adapter's event assured-once delivery feature.

User name used to connect to event data source details
Required Yes, if you want assured-once delivery
Default No default value
Property type String
Usage Specify the user name that the adapter uses to connect to the event store.
Globalized Yes
Bidi supported Yes

Inbound configuration properties

Related concepts:

Inbound processing
WebSphere Application Server environment variables
Required folders for inbound processing

Related tasks:

Setting deployment and runtime properties for inbound processing
Defining WebSphere Application Server environment variables

Related reference:

Guide to information about properties
Connection properties for the external service wizard
Resource adapter properties
Managed connection factory properties

In the wizard	In the Process Administrative Console	Description
Archive file naming pattern	ArchiveFileNamingPattern	A comma delimited pattern of header names used to name archived files being stored in the archive folder.
Archive folder	ArchiveFolder	The file folder on the local system where successfully processed emails are archived as files.
Bidi format string	BIDIContextEIS	Indicates the bidi format for string type business data exchanged between the mail server and the adapter
Database schema name	EP_SchemaName	The schema name for the database used by the adapter's event persistence feature
Delivery type	DeliveryType	Determines the order in which events are delivered by the adapter to the export.
Emit individual business objects from a multipart email	EmitIndividualBOs	Specifies whether the adapter creates individual business objects for each part of a multipart email.
Enable transport security (SSL)	enableSSL	Specifies whether a Secure Sockets Layer (SSL) connection is enabled.
Ensure once-only event delivery	AssuredOnceDelivery	Specifies whether the adapter provides assured once delivery of events.
Event recovery data source (JNDI) name	EP_DataSource_JNDIName	The JNDI name of the data source used by the event persistence class to acquire the JDBC database connection
Event recovery table name	EP_TableName	The name of the event store used by the adapter
Retry limit for failed events	FailedEventRetryLimit	The number of times the adapter attempts to redeliver an event before marking the event as failed.
Failed events folder	FailedEventsFolder	The absolute path to the file folder on the local system where unsuccessfully processed email events are archived in file format.
Host name	HostName	The IP address of the host where the mail server is running.
Interval between polling periods	PollPeriod	The length of time that the adapter waits between polling periods.
Match all search criteria	MatchAllSearchCriteria	The search criteria to filter which events are polled from the mail server.
Match some search criteria	MatchSomeSearchCriteria	The search criteria to filter which events are polled from the mail server.
Maximum events in polling period	PollQuantity	The number of events the adapter delivers to the export during each poll period.
Maximum connections	MaximumConnections	The maximum number of connections that the adapter can use for inbound event delivery.
Minimum connections	MinimumConnections	The minimum number of connections that the adapter can use for inbound event delivery.
Maximum number of retries in case of system connection failure	RetryLimit	The number of times the adapter tries to reestablish an inbound connection after an error.
Password	Password	The password associated with the mail server user name.
Password used to connect to event data source	EP_Password	The password used by the adapter's event persistence feature. It is used to acquire the JDBC database connection from the data source configured in the server.
Poll folder	Poll folder	The name of the mail folder or mail folders the adapter polls for inbound requests (emails).
Port	Port	The POP3 or IMAP port where the mail server is listening.
Protocol	Protocol	The protocol adapter uses for inbound communication with the mail server.
Retry EIS connection on startup	RetryConnectionOnStartup	Controls whether the adapter retries the connection to the mail server if it cannot connect at startup.
Time between retries in case of system connection failure (milliseconds)	RetryInterval	The length of time that the adapter waits between attempts to reestablish connection after an error during inbound operations.
Staging directory	InProgressFolder	The folder on the file system where the emails polled from the mail server are first written in file format.
Stop polling on error	StopPollingOnError	Specifies whether the adapter stops polling for events when it encounters an error during polling.
(Not available)	UseFiveLevelBO	Specifies whether business graphs and wrappers are generated for child business objects of the email parent business object.
User name	UserName	The user name for the mail server.
User name used to connect to event data source	EP_UserName	The user name used by the adapter's assured-once delivery feature.

Required	No
Default	The message-ID of the email event. This information is retrieved from the email header.
Property type	String
Usage	This property is to be used with the Archive folder (ArchiveFolder) property.
Example	If the header values From, Date are specified, the adapter picks the From address and Date from the email headers and combines them with the message ID to form the file name (From name + Date + Message ID).
Globalized	Yes
Bidi supported	No

Required	No
Default	No default value
Property type	String
Usage	This folder must be manually created on the same system as the adapter before the adapter is run. If no archive folder is specified, the adapter does not successfully archive the emails. They are deleted from the In progress folder. You can use a WebSphere Application Server environment variable to represent the archive folder. Specify the name of the environment variable in braces, preceded by a $ symbol. For example: ${ARCHIVE_FOLDER}. See the topic on creating an environment variable in this documentation.
Globalized	Yes
Bidi supported	Yes

Required	No
Possible values	True False
Default	True
Property type	Boolean
Usage	If set to True, the adapter creates an event store if it detects that one does not exist. If set to False, the adapter does not create an event store even if one does not exist. Verify that an event store exists if you want to ensure the delivery of events.
Globalized	No
Bidi supported	No

Required	No
Possible values	IBM BPM and WebSphere Enterprise Service Bus use ILYNN (implicit, left-to-right, on, off, nominal). These five attributes comprise the format used by Windows.
Default	No default value
Property type	String
Usage	A five-character string that identifies the bidirectional format used by the mail server. If the mail server that sends or receives data from the server uses a different format than ILYNN, the adapter converts the format before introducing the data to the server. For the conversion to occur, you use the external service wizard to set attribute values that represent the bidirectional format used by the mail server. This is done when you configure the module for the first time.
Example	ILYNN VRYNN VLYNN
Globalized	No
Bidi supported	No

Required	No
Possible values	ORDERED UNORDERED
Default	ORDERED
Property type	String
Usage	The following values are supported: ORDERED: The adapter delivers events to the export one at a time. UNORDERED: The adapter delivers all events to the export at once.
Globalized	No
Bidi supported	No

Required	No
Default	False
Property type	Boolean
Usage	The split for individual business object is completed by the adapter and each of the business objects is emitted as generic email (emitEmail). Each part of a multipart email is considered an individual business object and emitted using the email wrapper object, where content of each part is set in the mail content attribute.
Globalized	(Not available)
Bidi supported	No

Required	Yes, if the AssuredOnceDelivery property is set to True
Default	No default value
Property type	String
Usage	This value is case-sensitive. The external service wizard does not create the data source on IBM BPM or WebSphere Enterprise Service Bus. Verify that the data source is defined on the server before deploying the adapter.
Globalized	Yes
Bidi supported	Yes

Required	No
Possible values	Integers
Default	5
Property type	Integer
Usage	Use this property to control how many times the adapter tries to send an event before marking it as failed. It accepts the following values: Default If this property is not set, the adapter tries five additional times before marking the event as failed. 0 The adapter tries to deliver the event an infinite number of times. When the property is set to 0, the event remains in the event store and the event is never marked as failed. > 0 For integers greater than zero, the adapter retries the specified number of times before marking the event as failed. < 0 For negative integers, the adapter does not retry failed events.
Globalized	No
Bidi supported	No

Required	No
Default	localhost
Property type	String
Usage	Specifies the IP address of the host where the mail server is running
Globalized	No
Bidi supported	Yes

Required	Yes
Possible values	Integers greater than or equal to 0.
Default	2000
Unit of measure	Milliseconds
Property type	Integer
Usage	The poll period is established at a fixed rate, which means that if running the poll cycle is delayed for any reason (for example, if a prior poll cycle takes longer than expected to complete) the next poll cycle occurs immediately to make up for the lost time caused by the delay.
Globalized	No
Bidi supported	No

Required	No
Possible values	You can use any of the following header values when specifying search criteria: content= subject= to= cc= from= sender= date=
Default	No default value. It means that you have not selected any filtering options.
Property type	String
Usage	Specify AND conditions by separating them with a comma (,). This limits the event search to only mail events in the poll folder that meet the ANDed specific search criteria. Specify NOT conditions by separating them with an exclamation mark (!). This limits the event search to only mail events in the poll folder that do not include the search options NOTed. If both Match all search criteria and Match some criteria properties are set, the adapter uses the AND operation between the fields. This means that the outputs of the first set of conditions are subjected to the second set of conditions. For example, if sender=xyz@abc.com, to=pqr@abc.com is set for Match all search criteria property and subject=test, from!=lmn@abc.com is set for Match some search criteria property, the adapter searches for events with a sender value of xyz@abc.com and a to value of pqr@abc.com that might also have a subject value of test and which does not have a from value of lmn@abc.com.
Example	sender=xyz@abc.com,to=pqr@abc.com picks up any events with a sender value that matches sender=xyz@abc.com and a to value of to=pqr@abc.com. sender=xyz@abc.com,to!=pqr@abc.com picks up any events with a sender value that matches sender=xyz@abc.com and does not have a to value of pqr@abc.com.
Globalized	No
Bidi supported	No

Required	No
Possible values	0 and positive integers
Default	0
Property type	Integer
Usage	This property controls how many times the adapter retries the connection if the adapter cannot connect to the mail server to perform inbound processing. A value of 0 indicates an infinite number of retries. To control whether the adapter retries if it cannot connect to the mail server when it is first started, use the RetryConnectionOnStartup property.
Globalized	No
Bidi supported	No

Required	No for POP3 protocol Yes for IMAP protocol
Default	For the POP3 protocol, the default is Inbox For the IMAP protocol, there is no default value.
Property type	String
Usage	For the POP3 protocol, the adapter cannot poll multiple mail server folders. It automatically defaults to Inbox because Inbox is the only supported value with POP3. If the Protocol property is set to POP3, this property defaults to Inbox. No other value for POP3 is supported. If the Protocol property is set to IMAP, you can define one or more mail folder names. To poll multiple mail server folders, folder names are delimited with commas.
Globalized	Yes
Bidi supported	No

Required	No
Default	110 when the protocol is set to POP3 143 when the protocol is set to IMAP
Property type	Integer
Usage	If the Secure connection (SSL) property is set to True, this property must be updated. For the POP3 protocol, it must be set to 995. For the IMAP protocol, it must be set to 993.
Globalized	No
Bidi supported	No

Required	No
Possible values	IMAP POP3
Default	POP3
Property type	String
Usage	If set to IMAP, the adapter uses the IMAP email protocol for inbound communication. If set to POP3, the adapter uses the POP3 email protocol for inbound communication.
Globalized	No
Bidi supported	No

Required	Yes, if you want assured-once delivery
Default	No default value
Property type	String
Usage	Specify the user name that the adapter uses to connect to the event store.
Globalized	Yes
Bidi supported	Yes