Using
e-Mail adapter meta-objects
Meta-objects are business objects that are designed to
contain configuration information for adapters. A meta-object is
required to configure the e-Mail adapter for event notification.
The e-Mail adapter gets the name of its top-level meta-object
from the adapter property PollConfigMO. You must create the definition
of this meta-object to match the structure described in Structure
of the e-Mail adapter meta-object. Then specify its name in the PollConfigMO property.
For information on creating a business object definition, see the Business Object Development Guide.
Important:
In order for the e-Mail adapter to use the configuration
information in the meta-object, you must create the meta-object's
definition and add it to the list of business objects that the adapter
supports.
Structure
of the e-Mail adapter meta-object
The meta-object for the e-Mail adapter is a hierarchical
business object whose top-level object can contain any number of
child objects. Each child object represents one poll location. To
configure the adapter to check one or more poll locations, you must set
up the meta-object with a corresponding number of child meta-objects.
For an illustration of the meta-object definition, see Figure 5.
Top-level meta-object attributes
All attributes of the top-level meta-object are container
attributes of cardinality 1. For example, if a adapter has two poll
locations, Location1 and Location2, the attribute types might be
MO_PollLocation1 and MO_PollLocation2.
Child
meta-object attributes
Each child meta-object is a flat object with the attributes
listed in Table 15.
Table 15. Child meta-object attributes
Name |
Description |
PollHostName |
Name of the host machine running the mail server.
The mailbox is located on this server. JavaMail requires this name
to connect to the mail store. |
UserName |
The name of the user. The adapter polls in the mailbox
of this user. JavaMail requires this to authenticate the user. |
Password |
The password of the user. JavaMail requires this
to authenticate the user. |
PollFolder |
Name of the folder in the mailbox. The adapter polls
in this folder. This folder should exist in the mailbox of the user.
The default value is PollFolder.
BiDi supported for Windows. All BiDi enabled properties
will be transformed from Windows BiDi format into BiDi.Metadata
format, which is an e-Mail connector standard property. |
ArchiveFolder |
Name of the folder in the mailbox. The adapter archives
the successful messages (successful events) in this folder. This
folder should exist in the mailbox of the user. If a value is not specified
for this attribute, the adapter deletes successful messages after
processing them.
BiDi supported for Windows. All BiDi enabled properties
will be transformed from Windows BiDi format into BiDi.Metadata
format, which is an e-Mail connector standard property. |
FailFolder |
Name of the folder in the mailbox. The adapter archives
the failed messages (failed events) in this folder. If a value is
not specified for this attribute, the adapter deletes failed messages.
BiDi supported for Windows. All BiDi enabled properties
will be transformed from Windows BiDi format into BiDi.Metadata
format, which is an e-Mail connector standard property. |
ExternalProperty |
The absolute path of the property file name used
when the adapter connects to the mail server for polling. Example: mail.imap.partialfetch=false |
InDoubtEvents |
Valid values for this attribute are Reprocess, FailOnStartUp, LogError, and Ignore. If there are in-doubt events in this poll location, during initialization
the adapter processes them based on the default value set for this
attribute. If the value is set to Reprocess, the adapter resets the SEEN flag of the in-doubt events
in the poll folder, and picks up these messages in the subsequent
poll calls. If it is set to FailOnStartUp and there are in-doubt transactions in this poll folder,
the adapter fails. If it is set to LogError and there are in-doubt transactions in this poll folder,
the adapter logs the error and continues. If it is set to Ignore and there are in-doubt transactions in the poll folder, the
adapter simply ignores them. The default value is Reprocess. |
Reconnect |
Values for this attribute are True or False.
This value is used to determine whether a reconnect attempt should
be made for each poll cycle in the event of a connection loss. |
Meta-object
example
Figure 5 shows an example of
a top-level meta-object named MO_Email_Default. The e-Mail adapter uses this meta-object to poll two locations,
which are specified in the two child meta-objects, MO_PollLocation1 and MO_PollLocation2.
In the example, the value of the EventRecovery attribute in MO_PollLocation1 is set to Resubmit, and the value of this attribute in MO_PollLocation2 is set to Ignore. The value of the EventRecovery attribute informs the adapter
administrator to resubmit in-doubt events for Location1 and ignore
in-doubt events for Location2.
Figure 5. e-Mail adapter meta-object example
