Results for “iem_server_pub”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IEM_SERVER_PUB is a public API package body owned by the APPS schema in Oracle E-Business Suite. It belongs to the ETRM (Email and Task / Interaction Management) product family, historically associated with the iMarketing and email account configuration modules. The package provides a controlled, programmatic means of enumerating the email servers configured within an EBS instance. It abstracts the underlying email account master data so that calling applications do not query the base tables directly, thereby insulating dependent code from schema changes and providing a consistent, standards-compliant API surface.

The package body carries the version identifier $Header: iempsvrb.pls 120.0, indicating a maintained and released PL/SQL unit rather than a private helper. Consistent with the EBS public API model, every entry point wraps its logic in savepoint handling, message list initialization, and return status management. The package is registered with a PUBLIC API classification in ETRM 12.2.2, which signals that it is supported for external invocation by other EBS modules and by customer extensions.

Key Procedures and Functions

The package exposes a single documented procedure, GET_EMAILSERVER_LIST. Its purpose is to return the set of email servers available in the system for a requested server type, populating an out parameter that carries a table of email server records (server name, active flag, and port).

• GET_EMAILSERVER_LIST — Retrieves distinct inbound (IMAP) or outbound (SMTP) server host and port combinations and returns them as a PL/SQL table of server descriptor records. The procedure accepts an API version number, an initialization flag, a commit flag, a server identifier, and a server type, and returns the standard EBS status triple (x_return_status, x_msg_count, x_msg_data) alongside the server table output. It follows the standard EBS API contract: a savepoint is established, FND_API.Compatible_API_Call validates caller compatibility, FND_MSG_PUB.initialize resets the message stack when requested, and the return status defaults to G_RET_STS_SUCCESS.

No private helper procedures or functions are documented for this package other than the internal cursor declarations used to drive the queries.

Tables Accessed

The package reads from a single documented table, accessed through its APPS synonym:

• IEM_MSTEMAIL_ACCOUNTS — The master email account configuration table. GET_EMAILSERVER_LIST queries it to derive distinct inbound host/port pairs when IMAP servers are requested, and distinct outbound host/port pairs when SMTP servers are requested. The procedure identifies each server by name, marks it active, and records its port number in the returned table. The table is used in read-only mode; no DML is performed by this API.

Usage Notes

IEM_SERVER_PUB is typically invoked when a form, concurrent program, or custom extension needs to present or validate the list of configured email servers rather than querying IEM_MSTEMAIL_ACCOUNTS directly. The ETRM metadata records that the package is referenced by one other package, confirming it functions as a shared service layer within the email configuration stack.

Callers should pass a compatible API version, set the initialization flag appropriately to control message stack behavior, and inspect x_return_status before consuming the returned server table. Because the API is classified as PUBLIC, it is the supported integration point for customer code; direct table access should be avoided to preserve upgrade safety across EBS 12.1.1 and 12.2.x releases. Note that the header reference to iempsvrb.pls and the presence of ETRM object names reflect the module's historical lineage, though the API remains available in the current 12.2.2 file system.