Configuring the adapter definition

You must configure the e-Mail adapter before running it. To configure the adapter:

After configuring the meta-objects, you must add support for them to the adapter definition. To configure an adapter definition, use Connector Configurator (which you launch from System Manager, if your integration broker is ICS), or Connector Configurator (if your integration broker is WebSphere MQ Integrator Broker).

An adapter obtains its configuration values at startup. During a runtime session, you may want to change the values of one or more adapter properties. Changes to some adapter configuration properties may take effect immediately or may require a restart of the adapter or of the whole integration system, depending on the property and the integration system. To determine when changes to the adapter configuration take effect, refer to the Update Method column on the relevant properties tab in the adapter configuration tool.

Standard configuration properties

Standard configuration properties provide information that all adapters use. See Appendix A, Standard configuration properties for adapters for documentation of these properties.

Important:
Because this adapter supports all integration brokers, configuration properties for all brokers are relevant to it.

Table 2 provides information specific to this adapter about configuration properties in the appendix.

Table 2. Property information specific to this adapter

Property Note
CharacterEncoding
This adapter does not use this property.
ApplicationName
You must provide a value for this configuration property before running the adapter.
Locale
Because this adapter has been internationalized, you can change the value of this property. See release notes for the adapter to determine currently supported locales.

Adapter-specific properties

Adapter-specific configuration properties provide information for the adapter that is specific to the application or technology that the adapter integrates. Adapter-specific properties enable you to change adapter behavior without having to recode and rebuild the application-specific component.

Table 3 lists the adapter-specific configuration properties for the e-Mail adapter. See the sections that follow for explanations of the properties.

Table 3. Adapter-specific configuration properties

Name Possible values Default value Required
ApplicationPassword password that corresponds to ApplicationUserName
Yes, if
Application
UserName
is set
ApplicationUserName username required by the SMTP server
No
BusinessObjectMimeCharset a valid character set value
No
BusinessObjectMimeEncoding a valid data encoding value
No
DataHandlerConfigMO Data handler meta-object name MO_DataHandler_Default Yes
DebugMode true or false
false
No
DefaultVerb a verb value that is valid for the business objects handled by the adapter Create No
MailsPerMailBox Any positive integer
1
No
MessageContentMimeCharset a valid character set value
No
MessageContentMimeEncoding a valid data encoding value
No
MessageHeaderMimeCharset a valid character set value
No
MessageHeaderMimeEncoding a valid data encoding value
No
PollConfigMO Meta-object name

No
PollQuantity Any positive integer
1
No
SMTP_MailPort Port number for SMTP host
No
UseDefaults sets the default value for a required attribute True No

ApplicationPassword

The password that is associated with the value entered for ApplicationUserName.

ApplicationUserName

The username required for authentication at the SMTP server.

BusinessObjectMimeCharset

The character set for business objects contained in the e-mail. Reference the e-mail RFC documents to determine the proper value for the environment. An example is iso-8859-1, which is the Latin 1 character set of Western European languages.

BusinessObjectMimeEncoding

The encoding for business objects contained in the e-mail. Reference the e-mail RFC documents to determine the proper value for the environment. As an example, you specify Q for "Quoted-Printable" and B for "Base64". If this property is set to a value then business objects are sent as message parts; if it is not specified then business objects are sent as attached files.

DataHandlerConfigMO

Name of the meta-object that the Data Handler uses to set configuration properties. Also used by the DataHandler base class to determine which DataHandler class to use for a particular content type. For information on this meta-object, see Data handler meta-objects.

DebugMode

Specifies whether JavaMail debug messages are sent to STDOUT.

DefaultVerb

Specifies the value that is inserted in the Verb attribute for top-level business objects created by the adapter during event notification if the Verb attribute does not contain a value. In some situations the adapter may poll an event and create a business object, but the original data source (such as an XML document) might not have information in it that directly corresponds to the Verb attribute of the business object definition. If business objects are delivered to the integration broker without a valid verb then they are regarded as not being subscribed to, and do not get processed. You can specify a valid verb (such as Create) for this property to populate the Verb attribute of the top-level business objects handled by the adapter in the case that the verb is blank or null.

The default value is Create.

MailsPerMailBox

Specifies the number of messages processed in each mailbox before the adapter proceeds to process the next mailbox.

MessageContentMimeCharset

The character set for the message content. Reference the e-mail RFC documents to determine the proper value for the environment. An example is iso-8859-1, which is the Latin 1 character set of Western European languages.

MessageContentMimeEncoding

The encoding for the message content. Reference the e-mail RFC documents to determine the proper value for the environment. As an example, you specify Q for "Quoted-Printable" and B for "Base64".

MessageHeaderMimeCharset

The character set for the message header. Reference the e-mail RFC documents to determine the proper value for the environment. An example is iso-8859-1, which is the Latin 1 character set of Western European languages.

MessageHeaderMimeEncoding

The encoding for the message header. Reference the e-mail RFC documents to determine the proper value for the environment. As an example, you specify Q for "Quoted-Printable" and B for "Base64".

PollConfigMO

The name of the meta-object that the e-Mail adapter uses for polling. For information on the e-Mail adapter meta-object, see Using e-Mail adapter meta-objects.

PollQuantity

Specifies the maximum number of events polled during a single poll call.

SMTP_MailPort

The port number used by the SMTP mail host to send e-mail.

UseDefaults

When this is set to true, default values will be used to set values for required attributes. When this is set to fasle, or not set, default values will not be used. The default setting is True.

Copyright IBM Corp. 1997, 2004