WebSphere Adapter for Email

Activation specification properties

Activation specification properties hold the inbound event processing configuration information for a message endpoint. They can be set through the enterprise service discovery wizard or the WebSphere® Process Server administrative console.

When you configure the adapter, specify the activation specification properties listed below.

Table 1. Activation specification properties
Property Required Description Default Example
ArchiveFileName No The user can specify the pattern used to name the archive file by creating a comma delimited list of header names. The mail message-ID retrieved from the mail header. Example: From, Date becomes From + Date + MessageID. In the example, the adapter takes the From address and the Date from the mail headers and then forms the file name by combining them.
ArchiveFolder No The name of the folder where successfully processed mail will be archived in RFC822 format. If an archive folder is not defined, the adapter will not archive successfully processed mail and events will be deleted from the in progress Folder. Default field is blank.  
DeliveryType No This property determines the order in which the events will be published. Supported values are either ORDERED (for delivery of events one at a time) or UNORDERED (to receive all of the events at the same time). ORDERED  
DefaultObjectName Yes Default object that the adapter emits for inbound connections. EmailBO  
EPDatabasePassword No The password used by the adapter event persistence feature. It is used to get a JDBC database connection from the data source. None  
EPDatabaseSchemaName No The schema name of the database used by the adapter in the event of event persistence failure. EmailEventSchema  
EPDatabaseUserName No The user name used by the adapter event persistence feature. It is used to get a JDBC database connection from the data source. None  
EPDataSourceJNDIName Yes The JNDI name of the data source used by the event persistence class to get a JDBC database connection. The data source must be created in the application server. None  
EPEventTableName Yes The name of the table that will be used by the adapter for event persistence. This value must be unique for each activation specification and the same table name should not be used by other instances of the same adapter or different adapters. If the table does not exist in the database, the adapter will create the table and use it. EmailEventTable  
EventTypeFilter No Delimited list of event types that the adapter should deliver. The adapter will only deliver events that are listed. If the list is empty (null), no filter will be applied and all events will be delivered. null  
FailedEventsFolder No The name of the folder where unsuccessfully processed mail or failed events will be archived in RFC822 format. If a failed events folder is not defined, the adapter will not archive unsuccessfully processed mail. Default field is blank.  
filterFutureEvents Yes True or false value determines whether the adapter will inspect the timestamp on each event and compare them to the system time. If the event time is ahead of the system time, the event will not be delivered. False  
Host Yes The host IP for the mail server localhost  
InProgressFolder Yes The mail server folder where polled mails are first written to in RFC822 format. The name of the RFC822 format file corresponds to the message-ID of the mail. These details are retrieved by the adapter from the e-mail header associated with the mail. Default field is blank.  
MatchAllCriteria No This field can be used to filter which mails are polled from the Poll folder. You may set AND conditions by separating them with a comma. You can also specify which mails you would not like to have polled by specifying NOT (!) in your search criteria. Default registers as a blank field, meaning that you have not selected any filtering options. You can use any of the following header fields when specifying search criteria:
  • content=
  • subject=
  • to=
  • cc=
  • from=
  • sender=
  • date=
MatchSomeCriteria No This field can be used to filter which mails are polled from the poll folder. You may set OR conditions by separating them with a comma. You can also specify which mails you would not like to have polled by specifying NOT (!) in your search criteria. Default registers as a blank field, meaning that you have not selected any filtering options. You can use any of the following header fields when specifying search criteria:
  • content=
  • subject=
  • to=
  • cc=
  • from=
  • sender=
  • date=
Password Yes The password associated with the username. This is used to authenticate the IMAP or POP3 session. None  
PollFolders Yes (POP3)
No (IMAP)
The folder that you would like the adapter to poll. For the POP3 protocol, this value is ignored and the property defaults to Inbox. Multiple poll folders can be defined if they are delimited by commas. For the IMAP protocol there is no default value.  
PollPeriod Yes This property is used by the WBI resource adapter base implementation. It determines the rate (in milliseconds) that the adapter will poll the event store for inbound events. The poll cycle is established at a fixed rate. If a polling cycle is delayed for any reason, the next cycle will immediately begin. If set to "0", the adapter will not wait between polling cycles. 500  
PollQuantity Yes This property is used by the WBI resource adapter base implementation and is used to determine the number of events to deliver to each endpoint per poll cycle. A positive integer greater than one is required. 1  
Protocol Yes The protocol to be used for inbound communication with the mail server. This field can be set to either IMAP or POP3 POP3  
RetryInterval No The value set for this property determines the amount of time (in milliseconds) that the adapter will continually attempt to reconnect with the EIS in the event of an error related to the inbound EIS connection. 60000  
useInboundTransactions Yes If set to true, the adapter will attempt to store XID information in the event store and the adapter will provide assured once event delivery. If set to false, the adapter will not guarantee that the mail will be sent once and only once, but the performance is improved.
Note: This property is only used if the mail database is transactional. If it is not, the transaction can be used, regardless of the configuration.
True  
Username Yes The user ID associated with the IMAP or POP3 session None  
Related tasks
Generating artifacts
Generating artifacts
Related reference
Resource adapter properties
Managed (J2C) connection factory properties
Data transformation properties

Terms of use |

Last updated: Mon 30 Oct 2006 03:44:37

(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)