DBMS_AQELM, 2 of 2

Summary of DBMS_AQELM Subprograms

Table 7-1 DBMS_AQELM Subprograms

Subprogram	Description
SET_MAILHOST Procedure	Sets the host name for SMTP server.
GET_MAILHOST Procedure	Gets the host name for SMTP server.
SET_MAILPORT Procedure	Sets the port number for SMTP server.
GET_MAILPORT Procedure	Gets the port number for SMTP server.
SET_SENDFROM Procedure	Sets the sent-from e-mail address.
GET_SENDFROM Procedure	Gets the sent-from e-mail address.
SET_PROXY Procedure	Sets the proxy server name to be used for requests of HTTP protocol, excluding requests for hosts that belong to the domain specified in `no_proxy_domains`.
GET_PROXY Procedure	Gets the proxy server name and `no_proxy_domains` set by `DBMS_AQELM.SET_PROXY` for HTTP notifications.

SET_MAILHOST Procedure

This procedure sets the host name for the SMTP server. As part of the configuration for e-mail notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on the DBMS_AQELM package needs to set the host name before registering for e-mail notifications. The database will use this SMTP server host name to send out e-mail notifications.

Syntax

DBMS_AQELM.SET_MAILHOST (
   mailhost  IN  VARCHAR2);

Parameters

Table 7-2 SET_MAILHOST Procedure Parameters

Parameter	Description
`mailhost`	The SMTP server host name.

GET_MAILHOST Procedure

This procedure gets the host name set by DBMS_AQELM.SET_MAILHOST for the SMTP server.

Syntax

DBMS_AQELM.GET_MAILHOST (
   mailhost  OUT VARCHAR2);

Parameters

Table 7-3 GET_MAILHOST Procedure Parameters

Parameter	Description
`mailhost`	The SMTP server host name.

SET_MAILPORT Procedure

This procedure sets the port number for the SMTP server. As part of the configuration for e-mail notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on DBMS_AQELM package needs to set the port number before registering for e-mail notifications. The database will use this SMTP server port number to send out e-mail notifications. If not set, the SMTP mailport defaults to 25.

Syntax

DBMS_AQELM.SET_MAILPORT (
   mailport  IN NUMBER);

Parameters

Table 7-4 shows the parameters for the SET_MAILPORT procedure.

Table 7-4 SET_MAILPORT Procedure Parameters

Parameter	Description
`mailport`	The SMTP server port number.

GET_MAILPORT Procedure

This procedure gets the port number for the SMTP server set by the DBMS_AQELM. SET_MAILPORT procedure or the default value, which is 25.

Syntax

DBMS_AQELM.GET_MAILPORT (
   mailport  OUT NUMBER);

Parameters

Table 7-5 GET_MAILPORT Procedure Parameters

Parameter	Description
`mailport`	The SMTP server port number.

SET_SENDFROM Procedure

This procedure sets the sent-from e-mail address. As part of the configuration for e-mail notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on the DBMS_AQELM package should set the sent-from address before registering for e-mail notifications This e-mail address is used in the sent-from field in all the e-mail notifications sent out by the database to the registered e-mail addresses.

Syntax

DBMS_AQELM.SET_SENDFROM (
   sendfrom  IN  VARCHAR2);

Parameters

Table 7-6 SET_SENDFROM Procedure Parameters

Parameter	Description
`sendfrom`	The sent-from e-mail address.

GET_SENDFROM Procedure

This procedure gets the sent-from e-mail address set by DBMS_AQELM.SET_SENDFROM procedure.

Syntax

DBMS_AQELM.GET_SENDFROM (
   sendfrom  OUT  VARCHAR2);

Parameters

Table 7-7 GET_SENDFROM Procedure Parameters

Parameter	Procedure
`sendfrom`	The sent-from e-mail address.

SET_PROXY Procedure

This procedure sets the proxy server name to be used for requests of HTTP protocol, excluding requests for hosts that belong to the domain specified in no_proxy_domains. The proxy server name can include an optional TCP/IP port number at which the proxy server listens. If the port is not specified for the proxy server, port 80 is assumed. no_proxy_domains is a list of domains or hosts for which HTTP requests should be sent directly to the destination HTTP server instead of going through a proxy server. Optionally, a port number can be specified for each domain or host. If the port number is specified, the no-proxy restriction is only applied to the request at that port of the particular domain or host. When no_proxy_domains is NULL and the proxy server is set, all requests go through the proxy server. When the proxy server is not set, http_send sends the requests to the target Web servers directly.

As part of the configuration for HTTP notifications, a user with AQ_ADMINISTRATOR_ROLE or with EXECUTE permissions on the DBMS_AQELM package can choose to set the proxy server name and a list of no_proxy_domains, if required, before registering for HTTP notifications. The database will use this information to post HTTP notifications.

Syntax

DBMS_AQELM.SET_PROXY (
   proxy            IN VARCHAR2,
   no_proxy_domains IN VARCHAR2 DEFAULT NULL);

Parameters

Table 7-8 SET_PROXY Procedure Parameters

Parameter	Procedure
proxy	The proxy server host and port number. The syntax is `"[http://]host[:port][/]"`. For example, `"www-proxy.my-company.com:80"`.
`no_proxy_domains`	The list of no-proxy domains or hosts. The syntax is a list of host or domains, with optional port numbers separated by a comma, a semi-colon, or a space. For example, `"corp.my-company.com, eng.my-company.com:80"`

GET_PROXY Procedure

This procedure gets the proxy server name and no_proxy_domains set by DBMS_AQELM.SET_PROXY for HTTP notifications.

Syntax

DBMS_AQELM.GET_PROXY (
   proxy            OUT VARCHAR2,
   no_proxy_domains OUT VARCHAR2);

Parameters

Table 7-9 GET_PROXY Procedure Parameters

Parameter	Procedure
proxy	The proxy server host and port number.
`no_proxy_domains`	The list of no-proxy domains or hosts.