The UTL_SMTP package is designed for sending electronic mails (e-mails) over Simple Mail Transfer Protocol (SMTP) as specified by RFC821.
See Also:
Oracle Database Development GuideThis chapter contains the following topics:
Overview
Security Model
Constants
Types
Reply Codes
Exceptions
Rules and Limits
Examples
The UTL_SMTP protocol consists of a set of commands for an e-mail client to dispatch e-mails to an SMTP server. The UTL_SMTP package provides interfaces to the SMTP commands. For many of the commands, the package provides both a procedural and a functional interface. The functional form returns the reply from the server for processing by the client. The procedural form checks the reply and raises an exception if the reply indicates a transient (400-range reply code) or permanent error (500-range reply code). Otherwise, it discards the reply.
Note that the original SMTP protocol communicates using 7-bit ASCII. Using UTL_SMTP, all text data (in other words, those in VARCHAR2) are converted to US7ASCII before it is sent to the server. Some implementations of SMTP servers that support SMTP extension 8BITMIME [RFC1652] support full 8-bit communication between client and server. The body of the DATA command can be transferred in full 8 bits, but the rest of the SMTP command and response must be in 7 bits. When the target SMTP server supports 8BITMIME extension, users of multibyte databases may convert their non-US7ASCII, multibyte VARCHAR2 data to RAW and use the WRITE_RAW_DATA subprogram to send multibyte data using 8-bit MIME encoding.
UTL_SMTP provides for SMTP communication as specified in RFC821, but does not provide an API to format the content of the message according to RFC 822 (for example, setting the subject of an electronic mail). You must format the message appropriately. In addition, UTL_SMTP does not have the functionality to implement an SMTP server for an e-mail clients to send e-mails using SMTP.
This package is an invoker's rights package. The invoking user must have the connect privilege granted in the access control list assigned to the remote network host to which the user must connect.
Note:
For more information, see Managing Fine-Grained Access in PL/SQL Packages and Types in Oracle Database Security GuideThe UTL_SMTP package uses the constants shown in Table 263-1, "UTL_SMTP Constants".
Table 263-1 UTL_SMTP Constants
| Name | Type | Value | Description |
|---|---|---|---|
|
|
|
|
List of all authentication schemes |
|
|
|
|
List of authentication schemes that |
This is a PL/SQL record type used to represent an SMTP connection.
TYPE connection IS RECORD (
host VARCHAR2(255),
port PLS_INTEGER,
tx_timeout PLS_INTEGER,
private_tcp_con utl_tcp.connection,
private_state PLS_INTEGER);
Table 263-2 CONNECTION Record Type Fields
| Field | Description |
|---|---|
|
|
Name of the remote host when connection is established. |
|
|
Port number of the remote SMTP server connected. |
|
|
Time in seconds that the |
|
|
Private, for implementation use only. You should not modify this field. |
|
|
Private, for implementation use only. You should not modify this field. |
The read-only fields in a connection record are used to return information about the SMTP connection after the connection is successfully made with the OPEN_CONNECTION Functions. Changing the values of these fields has no effect on the connection. The fields private_tcp_con and private_state for implementation use only. You should not modify these fields.
These are PL/SQL record types used to represent an SMTP reply line. Each SMTP reply line consists of a reply code followed by a text message. While a single reply line is expected for most SMTP commands, some SMTP commands expect multiple reply lines. For those situations, a PL/SQL table of reply records is used to represent multiple reply lines.
TYPE reply IS RECORD ( code PLS_INTEGER, text VARCHAR2(508)); TYPE replies IS TABLE OF reply INDEX BY BINARY_INTEGER;
The following is a list of the SMTP reply codes.
| Reply Code | Meaning |
|---|---|
|
|
System status, or system help reply |
|
|
Help message [Information on how to use the receiver or the meaning of a particular non-standard command; this reply is useful only to the human user] |
|
|
|
|
|
|
|
|
Requested mail action okay, completed |
|
|
User not local; forwards to |
|
|
OK, pending messages for node |
|
|
OK, |
|
|
Start mail input; end with |
|
|
Octet-offset is the transaction offset |
|
|
|
|
|
Requested mail action not taken: mailbox unavailable [for example, mailbox busy] |
|
|
Requested action terminated: local error in processing |
|
|
Requested action not taken: insufficient system storage |
|
|
You have no mail. |
|
|
TLS not available due to temporary reason. Encryption required for requested authentication mechanism. |
|
|
Unable to queue messages for node |
|
|
Node |
|
|
Syntax error, command unrecognized (This may include errors such as command line too long.) |
|
|
Syntax error in parameters or arguments |
|
|
Command not implemented |
|
|
Bad sequence of commands |
|
|
Command parameter not implemented |
|
|
|
|
|
Must issue a |
|
|
Authentication mechanism is too weak. |
|
|
Encryption required for requested authentication mechanism. |
|
|
Requested action not taken: mailbox unavailable [for, mailbox not found, no access] |
|
|
User not local; please try |
|
|
Requested mail action terminated: exceeded storage allocation |
|
|
Requested action not taken: mailbox name not allowed [for example, mailbox syntax incorrect] |
|
|
Transaction failed |
SMTP connection is initiated by a call to OPEN_CONNECTION Functions which returns a SMTP connection. After a connection is established, the following calls are required to send a mail:
HELO Function and Procedure - identify the domain of the sender
MAIL Function and Procedure- start a mail, specify the sender
RCPT Function - specify the recipient
OPEN_DATA Function and Procedure- start the mail body
WRITE_RAW_DATA Procedure - write the mail body (multiple calls allowed)
CLOSE_DATA Function and Procedure - close the mail body and send the mail
The SMTP connection is closed by calling QUIT Function and Procedure.
The table lists the exceptions that can be raised by the interface of the UTL_SMTP package. The network error is transferred to a reply code of 421- service not available.
Table 263-5 UTL_SMTP Exceptions
|
|
Raised when an invalid operation is made. In other words, calling API other than the WRITE_DATA Procedure, the WRITE_RAW_DATA Procedure or the CLOSE_DATA Function and Procedure after the OPEN_DATA Function and Procedure is called, or calling |
|
|
Raised when receiving a reply code in 400 range |
|
|
Raised when receiving a reply code in 500 range |
No limitation or range-checking is imposed by the API. However, you must be aware of the following size limitations on various elements of SMTP. Sending data that exceed these limits may result in errors returned by the server.
Table 263-6 SMTP Size Limitation
| Element | Size Limitation |
|---|---|
|
|
Maximum total length of a user name is 64 characters |
|
|
Maximum total length of a domain name or number is 64 characters |
|
|
Maximum total length of a reverse-path or forward-path is 256 characters (including the punctuation and element separators) |
|
|
Maximum total length of a command line including the command word and the |
|
|
Maximum total length of a reply line including the reply code and the |
|
|
Maximum total length of a text line including the |
|
|
Maximum total number of recipients that must be buffered is 100 recipients |
The following example illustrates how UTL_SMTP is used by an application to send e-mail. The application connects to an SMTP server at port 25 and sends a simple text message.
DECLARE
c UTL_SMTP.CONNECTION;
PROCEDURE send_header(name IN VARCHAR2, header IN VARCHAR2) AS
BEGIN
UTL_SMTP.WRITE_DATA(c, name || ': ' || header || UTL_TCP.CRLF);
END;
BEGIN
c := UTL_SMTP.OPEN_CONNECTION('smtp-server.acme.com');
UTL_SMTP.HELO(c, 'foo.com');
UTL_SMTP.MAIL(c, 'sender@foo.com');
UTL_SMTP.RCPT(c, 'recipient@foo.com');
UTL_SMTP.OPEN_DATA(c);
send_header('From', '"Sender" <sender@foo.com>');
send_header('To', '"Recipient" <recipient@foo.com>');
send_header('Subject', 'Hello');
UTL_SMTP.WRITE_DATA(c, UTL_TCP.CRLF || 'Hello, world!');
UTL_SMTP.CLOSE_DATA(c);
UTL_SMTP.QUIT(c);
EXCEPTION
WHEN utl_smtp.transient_error OR utl_smtp.permanent_error THEN
BEGIN
UTL_SMTP.QUIT(c);
EXCEPTION
WHEN UTL_SMTP.TRANSIENT_ERROR OR UTL_SMTP.PERMANENT_ERROR THEN
NULL; -- When the SMTP server is down or unavailable, we don't have
-- a connection to the server. The QUIT call raises an
-- exception that we can ignore.
END;
raise_application_error(-20000,
'Failed to send mail due to the following error: ' || sqlerrm);
END;
Table 263-7 UTL_SMTP Package Subprograms
| Subprogram | Description |
|---|---|
|
Sends the |
|
|
Closes the SMTP connection, causing the current SMTP operation to terminate |
|
|
Closes the data session |
|
|
Performs a generic SMTP command |
|
|
Performs a generic SMTP command and retrieves multiple reply lines |
|
|
Sends the e-mail body |
|
|
Performs the initial handshake with SMTP server using the |
|
|
Performs the initial handshake with SMTP server using the |
|
|
Sends |
|
|
Initiates an e-mail transaction with the server, the destination is a mailbox |
|
|
|
|
|
Opens a connection to an SMTP server |
|
|
Sends the |
|
|
Terminates an SMTP session and disconnects from the server |
|
|
Specifies the recipient of an e-mail message |
|
|
Terminates the current e-mail transaction |
|
|
Sends |
|
|
Verifies the validity of a destination e-mail address |
|
|
Writes a portion of the e-mail message |
|
|
Writes a portion of the e-mail message with |
This subprogram sends the AUTH command to authenticate to the SMTP server. The UTL_SMTP package goes through the user's choices of authentication schemes, skips any that is not supported by the SMTP server and uses the first supported. To determine the schemes the SMTP server supports from its EHLO reply, the user must call the EHLO Function and Procedure. Otherwise, UTL_SMTP uses the first scheme in the list.
UTL_SMTP.AUTH ( c IN OUT NOCOPY connection, username IN VARCHAR2, password IN VARCHAR2, schemes IN VARCHAR2 DEFAULT NON_CLEARTEXT_PASSWORD_SCHEMES) RETURN reply; UTL_SMTP.AUTH ( c IN OUT NOCOPY connection, username IN VARCHAR2, password IN VARCHAR2, schemes IN VARCHAR2 DEFAULT NON_CLEARTEXT_PASSWORD_SCHEMES);
Table 263-8 AUTH Function and Procedure Parameters
| Parameter | Description |
|---|---|
|
|
SMTP connection |
|
|
Username |
|
|
Password |
|
|
Space-separated list of authentication schemes |
Table 263-9 AUTH Function and Procedure Function Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
Currently only PLAIN, LOGIN and CRAM-MD5 authentication schemes are supported by UTL_SMTP.
Since the SMTP server may change the authentication schemes it supports after the SMTP connection is secured by SSL/TLS after the STARTTLS command (for example, adding PLAIN and LOGIN), the caller must call the EHLO Function and Procedure again for UTL_SMTP to update the list after the STARTTLS Function and Procedure is called.
DECLARE
c utl_smtp.connection;
BEGIN
c := utl_smtp.open_connection(
host => 'smtp.example.com',
port => 25,
wallet_path => 'file:/oracle/wallets/smtp_wallet',
wallet_password => 'password',
secure_connection_before_smtp => FALSE);
UTL_SMTP.STARTTLS(c);
UTL_SMTP.AUTH(
c => c,
username => 'scott',
password => 'password'
schemes => utl_smtp.all_schemes);
END;
This procedure closes the SMTP connection, causing the current SMTP operation to terminate. Use this procedure only to cancel an e-mail in the middle of the data session. To end the SMTP connection properly, use the QUIT Function and Procedure.
This subprogram ends the e-mail message by sending the sequence <CR><LF>.<CR><LF> (a single period at the beginning of a line).
UTL_SMTP.CLOSE_DATA ( c IN OUT NOCOPY connection) RETURN reply; UTL_SMTP.CLOSE_DATA ( c IN OUT NOCOPY connection);
Table 263-12 CLOSE_DATA Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
The calls to OPEN_DATA, WRITE_DATA, WRITE_RAW_DATA and CLOSE_DATA must be made in the right order. A program calls OPEN_DATA to send the DATA command to the SMTP server. After that, it can call WRITE_DATA or WRITE_RAW_DATA repeatedly to send the actual data. The data is terminated by calling CLOSE_DATA. After OPEN_DATA is called, the only subprograms that can be called are WRITE_DATA, WRITE_RAW_DATA, or CLOSE_DATA. A call to other subprograms results in an INVALID_OPERATION exception being raised.
CLOSE_DATA must be called only after OPEN_CONNECTION, HELO or EHLO, MAIL, and RCPT have been called. The connection to the SMTP server must be open and a mail transaction must be active when this routine is called.
Note that there is no function form of WRITE_DATA because the SMTP server does not respond until the data-terminator is sent during the call to CLOSE_DATA.
This subprogram performs a generic SMTP command.
UTL_SMTP.COMMAND ( c IN OUT NOCOPY connection, cmd IN VARCHAR2, arg IN VARCHAR2 DEFAULT NULL) RETURN reply; UTL_SMTP.COMMAND ( c IN OUT NOCOPY connection, cmd IN VARCHAR2, arg IN VARCHAR2 DEFAULT NULL);
Table 263-14 COMMAND Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
This function performs a generic SMTP command and retrieves multiple reply lines.
UTL_SMTP.COMMAND_REPLIES ( c IN OUT NOCOPY connection, cmd IN VARCHAR2, arg IN VARCHAR2 DEFAULT NULL) RETURN replies;
Table 263-16 COMMAND_REPLIES Function Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types) |
This subprogram specifies the body of an e-mail message.
UTL_SMTP.DATA ( c IN OUT NOCOPY connection body IN VARCHAR2 CHARACTER SET ANY_CS) RETURN reply; UTL_SMTP.DATA ( c IN OUT NOCOPY connection body IN VARCHAR2 CHARACTER SET ANY_CS);
Table 263-18 DATA Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
The application must ensure that the contents of the body parameter conform to the MIME(RFC822) specification. The DATA routine terminates the message with a <CR><LF>.<CR><LF> sequence (a single period at the beginning of a line), as required by RFC821. It also translates any sequence of <CR><LF>.<CR><LF> (single period) in body to <CR><LF>..<CR><LF> (double period). This conversion provides the transparency as described in Section 4.5.2 of RFC821.
The DATA subprogram must be called only after OPEN_CONNECTION, HELO or EHLO, MAIL and RCPT have been called. The connection to the SMTP server must be open, and a mail transaction must be active when this routine is called.
The expected response from the server is a message beginning with status code 250. The 354 response received from the initial DATA command is not returned to the caller.
This subprogram performs the initial handshake with SMTP server using the EHLO command.
UTL_SMTP.EHLO ( c IN OUT NOCOPY connection, domain IN) RETURN replies; UTL_SMTP.EHLO ( c IN OUT NOCOPY connection, domain IN);
Table 263-20 EHLO Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). |
The EHLO interface is identical to HELO except that it allows the server to return more descriptive information about its configuration. [RFC1869] specifies the format of the information returned, which the PL/SQL application can retrieve using the functional form of this call. For compatibility with HELO, each line of text returned by the server begins with status code 250.
This subprogram performs the initial handshake with SMTP server using the HELO command.
UTL_SMTP.HELO ( c IN OUT NOCOPY connection, domain IN VARCHAR2) RETURN reply; UTL_SMTP.HELO ( c IN OUT NOCOPY connection, domain IN VARCHAR2);
Table 263-22 HELO Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
RFC 821 specifies that the client must identify itself to the server after connecting. This routine performs that identification. The connection must have been opened through a call to OPEN_CONNECTION Functions before calling this routine.
The expected response from the server is a message beginning with status code 250.
This function sends the HELP command.
UTL_SMTP.HELP ( c IN OUT NOCOPY connection, command IN VARCHAR2 DEFAULT NULL) RETURN replies;
Table 263-24 HELP Function Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types) |
This subprogram initiate a mail transaction with the server. The destination is a mailbox.
UTL_SMTP.MAIL ( c IN OUT NOCOPY connection, sender IN VARCHAR2, parameters IN VARCHAR2 DEFAULT NULL) RETURN reply; UTL_SMTP.MAIL ( c IN OUT NOCOPY connection, sender IN VARCHAR2, parameters IN VARCHAR2 DEFAULT NULL);
Table 263-26 MAIL Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
This command does not send the message; it simply begins its preparation. It must be followed by calls to RCPT and DATA to complete the transaction. The connection to the SMTP server must be open and a HELO or EHLO command must have already been sent.
The expected response from the server is a message beginning with status code 250.
This subprogram issues the NULL command.
UTL_SMTP.NOOP ( c IN OUT NOCOPY connection) RETURN reply; UTL_SMTP.NOOP ( c IN OUT NOCOPY connection);
Table 263-28 NOOP Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
This command has no effect except to elicit a successful reply from the server. It can be issued at any time after the connection to the server has been established with OPEN_CONNECTION. The NOOP command can be used to verify that the server is still connected and is listening properly.
This command replies with a single line beginning with status code 250.
These functions open a connection to an SMTP server.
UTL_SMTP.OPEN_CONNECTION ( host IN VARCHAR2, port IN PLS_INTEGER DEFAULT 25, c OUT connection, tx_timeout IN PLS_INTEGER DEFAULT NULL, wallet_path IN VARCHAR2 DEFAULT NULL, wallet_password IN VARCHAR2 DEFAULT NULL, secure_connection_before_smtp IN BOOLEAN DEFAULT FALSE) RETURN reply; UTL_SMTP.OPEN_CONNECTION ( host IN VARCHAR2, port IN PLS_INTEGER DEFAULT 25, tx_timeout IN PLS_INTEGER DEFAULT NULL, wallet_path IN VARCHAR2 DEFAULT NULL, wallet_password IN VARCHAR2 DEFAULT NULL, secure_connection_before_smtp IN BOOLEAN DEFAULT FALSE) RETURN connection;
Table 263-29 OPEN_CONNECTION Functions Parameters
| Parameter | Description |
|---|---|
|
|
Name of the SMTP server host |
|
|
Port number on which SMTP server is listening (usually 25) |
|
|
SMTP connection |
|
|
Time in seconds that the |
|
|
Directory path that contains the Oracle wallet for SSL/TLS. The format is |
|
|
Password to open the wallet. When the wallet is auto-login enabled, the password can be set to |
|
|
If |
Table 263-30 OPEN_CONNECTION Functions Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
The expected response from the server is a message beginning with status code 220.
The version of OPEN_CONNECTION that returns UTL_SMTP.CONNECTION record checks the reply code returned by an SMTP server when the connection is first established. It raises an exception when the reply indicates an error. Otherwise, it discards the reply. If you want to examine the reply, invoke the version of OPEN_CONNECTION that returns REPLY.
tx_timeout is intended to govern both the read operations and the write operations. However, an implementation restriction prevents tx_timeout from governing write operations in the current release.
This subprogram sends the DATA command after which you can use WRITE_DATA and WRITE_RAW_DATA to write a portion of the e-mail message.
UTL_SMTP.OPEN_DATA ( c IN OUT NOCOPY connection) RETURN reply; UTL_SMTP.OPEN_DATA ( c IN OUT NOCOPY connection);
Table 263-32 OPEN_DATA Function and Procedure Function Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
The calls to OPEN_DATA, WRITE_DATA, WRITE_RAW_DATA and CLOSE_DATA must be made in the right order. A program calls OPEN_DATA to send the DATA command to the SMTP server. After that, it can call WRITE_DATA or WRITE_RAW_DATA repeatedly to send the actual data. The data is terminated by calling CLOSE_DATA. After OPEN_DATA is called, the only subprograms that can be called are WRITE_DATA, WRITE_RAW_DATA, or CLOSE_DATA. A call to other subprograms results in an INVALID_OPERATION exception being raised.
OPEN_DATA must be called only after OPEN_CONNECTION, HELO or EHLO, MAIL, and RCPT have been called. The connection to the SMTP server must be open and a mail transaction must be active when this routine is called.
This subprogram terminates an SMTP session and disconnects from the server.
UTL_SMTP.QUIT ( c IN OUT NOCOPY connection) RETURN reply; UTL_SMTP.QUIT ( c IN OUT NOCOPY connection);
Table 263-34 QUIT Function and Procedure Function Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
The QUIT command informs the SMTP server of the client's intent to terminate the session. It then closes the connection established by OPEN_CONNECTION which must have been called before executing this command. If a mail transaction is in progress when QUIT is issued, it is canceled in the same manner as RSET.
The function form of this command returns a single line beginning with the status code 221 on successful termination. In all cases, the connection to the SMTP server is closed. The fields REMOTE_HOST and REMOTE_PORT of c are reset.
This subprogram specifies the recipient of an e-mail message.
UTL_SMTP.RCPT ( c IN OUT NOCOPY connection, recipient IN VARCHAR2, parameters IN VARCHAR2 DEFAULT NULL) RETURN reply; UTL_SMTP.RCPT ( c IN OUT NOCOPY connection, recipient IN VARCHAR2, parameters IN VARCHAR2 DEFAULT NULL);
Table 263-35 RCPT Function and Procedure Parameters
| Parameter | Description |
|---|---|
|
|
SMTP connection |
|
|
E-mail address of the user to which the message is being sent |
|
|
Additional parameters to RCPT command as defined in Section 6 of [RFC1869]. It must follow the format of "XXX=XXX (XXX=XXX ....)". |
Table 263-36 RCPT Function and Procedure Function Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
To send a message to multiple recipients, call this routine multiple times. Each invocation schedules delivery to a single e-mail address. The message transaction must have been begun by a prior call to MAIL, and the connection to the mail server must have been opened and initialized by prior calls to OPEN_CONNECTION and HELO or EHLO respectively.
The expected response from the server is a message beginning with status code 250 or 251.
This subprogram terminates the current mail transaction.
UTL_SMTP.RSET ( c IN OUT NOCOPY connection) RETURN reply; UTL_SMTP.RSET ( c IN OUT NOCOPY connection);
Table 263-38 RSET Function and Procedure Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
This command allows the client to cancel an e-mail message it was in the process of composing. No mail is sent. The client can call RSET at any time after the connection to the SMTP server has been opened by means of OPEN_CONNECTION until DATA or OPEN_DATA is called. Once the e-mail data has been sent, it is too late to prevent the e-mail from being sent.
The server responds to RSET with a message beginning with status code 250.
This subprogram sends the STARTTLS command to secure the SMTP connection using SSL/TLS. SSL/TLS requires an Oracle wallet which must be specified when the connection was opened by the OPEN_CONNECTION Functions.
UTL_SMTP.STARTTLS ( c IN OUT NOCOPY connection) RETURN reply; UTL_SMTP.STARTTLS ( c IN OUT NOCOPY connection);
The STARTTLS command must only be issued on an unencrypted connection and when the SMTP server indicates the support of the command in the reply of the EHLO command. The wallet to be used for encryption must have been specified when the initial SMTP connection was opened by the OPEN_CONNECTION function.
This function verifies the validity of a destination e-mail address.
Table 263-42 VRFY Function Return Values
| Return Value | Description |
|---|---|
|
|
Reply of the command (see REPLY, REPLIES Record Types). In cases where there are multiple replies, the last reply is returned. |
The server attempts to resolve the destination address recipient. If successful, it returns the recipient's full name and fully qualified mailbox path. The connection to the server must have already been established by means of OPEN_CONNECTION and HELO or EHLO before making this request.
Successful verification returns one or more lines beginning with status code 250 or 251.
This procedure writes a portion of the e-mail message. A repeat call to WRITE_DATA appends data to the e-mail message.
The calls to the OPEN_DATA Function and Procedure, WRITE_DATA Procedure, WRITE_RAW_DATA Procedure and CLOSE_DATA Function and Procedure must be made in the correct order. A program calls OPEN_DATA to send the DATA command to the SMTP server. After that, it can call WRITE_DATA or WRITE_RAW_DATA repeatedly to send the actual data. The data is terminated by calling CLOSE_DATA. After OPEN_DATA is called, the only subprograms that can be called are WRITE_DATA, WRITE_RAW_DATA, or CLOSE_DATA. A call to other subprograms results in an INVALID_OPERATION exception being raised.
The application must ensure that the contents of the body parameter conform to the MIME(RFC822) specification. The DATA routine terminates the message with a <CR><LF>.<CR><LF> sequence (a single period at the beginning of a line), as required by RFC821. It also translates any sequence of <CR><LF>.<CR><LF> (single period) in the body to <CR><LF>..<CR><LF> (double period). This conversion provides the transparency as described in Section 4.5.2 of RFC821.
The OPEN_DATA Function and Procedure, WRITE_DATA Procedure, WRITE_RAW_DATA Procedure and CLOSE_DATA Function and Procedure must be called only after OPEN_CONNECTION Functions, HELO Function and Procedure, or EHLO Function and Procedure, MAIL Function and Procedure, and RCPT Function have been called. The connection to the SMTP server must be open and a mail transaction must be active when this routine is called.
Note that there is no function form of the WRITE_DATA Procedure because the SMTP server does not respond until the data-terminator is sent during the call to CLOSE_DATA Function and Procedure.
Text (VARCHAR2) data sent using WRITE_DATA is converted to US7ASCII before it is sent. If the text contains multibyte characters, each multibyte character in the text that cannot be converted to US7ASCII is replaced by a '?' character. If 8BITMIME extension is negotiated with the SMTP server using the EHLO subprogram, multibyte VARCHAR2 data can be sent by first converting the text to RAW using the UTL_RAW package, and then sending the RAW data using WRITE_RAW_DATA.
This procedure writes a portion of the e-mail message. A repeat call to WRITE_RAW_DATA appends data to the e-mail message.
The calls to the OPEN_DATA Function and Procedure, WRITE_DATA Procedure, WRITE_RAW_DATA Procedure and CLOSE_DATA Function and Procedure must be made in the correct order. A program calls OPEN_DATA to send the DATA command to the SMTP server. After that, it can call WRITE_DATA or WRITE_RAW_DATA repeatedly to send the actual data. The data is terminated by calling CLOSE_DATA. After OPEN_DATA is called, the only subprograms that can be called are WRITE_DATA, WRITE_RAW_DATA, or CLOSE_DATA. A call to other subprograms results in an INVALID_OPERATION exception being raised.
The application must ensure that the contents of the body parameter conform to the MIME(RFC822) specification. The DATA routine terminates the message with a <CR><LF>.<CR><LF> sequence (a single period at the beginning of a line), as required by RFC821. It also translates any sequence of <CR><LF>.<CR><LF> (single period) in the body to <CR><LF>..<CR><LF> (double period). This conversion provides the transparency as described in Section 4.5.2 of RFC821.
The OPEN_DATA Function and Procedure, WRITE_DATA Procedure, WRITE_RAW_DATA Procedure and CLOSE_DATA Function and Procedure must be called only after OPEN_CONNECTION Functions, HELO Function and Procedure, or EHLO Function and Procedure, MAIL Function and Procedure, and RCPT Function have been called. The connection to the SMTP server must be open and a mail transaction must be active when this routine is called.
Note that there is no function form of the WRITE_DATA Procedure because the SMTP server does not respond until the data-terminator is sent during the call to CLOSE_DATA Function and Procedure.