smfi_setmlreply(3N) smfi_setmlreply(3N)
NAME
smfi_setmlreply() - sets default SMTP error reply code to a multi-line response
SYNOPSIS
PARAMETERS
ctx Specifies the opaque context structure.
rcode Specifies the 3-digit (RFC 821/2821) SMTP reply code, as a null-terminated string.
rcode must not be a NULL value, and must be a valid or reply code.
xcode Specifies the extended (RFC 1893 or 2034) reply code. An xcode must conform to RFC 1893/2034 code. If xcode is set to NULL, an
extended code is not used.
Specifies the remaining arguments, which are single lines of text.
A maximum of 32 arguments can be specified. These arguments are used as the text part of the SMTP reply. The list must be termi-
nated with a NULL value.
DESCRIPTION
The routine directly sets the SMTP error reply code for a connection.
Only and replies are accepted.
The list of arguments in must be terminated with a NULL value.
is used on subsequent errors from the filter. can be called from any of the functions other than
Notes
o Values passed to are not checked for standards compliance.
o The message parameter must contain only printable characters; other characters may lead to undefined behavior. For example, a CR or LF
will cause the call to fail, single (percentage) characters will cause the text to be ignored. If a is required in a string, use the
format.
o For more information on reply codes and their meanings, see RFC 821, 2821, 1893, and 2034.
o If the reply code, that is, rcode, is given a code but is used for the message, the custom reply is not used.
Similarly, if rcode is given a code but is used for the message, the custom reply is not used.
In neither of the last two cases, an error is returned to the Milter and silently ignores the reply code.
o If the Milter returns and sets the reply code to '421', the SMTP server terminates the SMTP session with a '421' error code.
RETURN VALUE
fails and returns for the following reasons:
o Invalid rcode or xcode argument value.
o Memory-allocation failure.
o Carriage return or line feed in a text line.
o Length of any text line is more than the value(980).
o More than 32 lines of text replies are provided.
returns on successful completion.
EXAMPLES
Consider the following sample code:
The following is the SMTP response of the sample code:
AUTHOR
The routine was developed by the Sendmail Inc.
SEE ALSO
smfi_getsymval(3N), smfi_getpriv(3N), smfi_setreply(3N), smfi_setpriv(3N).
on
smfi_setmlreply(3N)