Package com.saxonica.functions.extfn

Class SendMail

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.extfn.SendMail

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

public class SendMail
extends SystemFunction

This class implements the extension function saxon:send-mail(). This function provides the functionality to construct and send email messages.

Field Summary

Fields

Modifier and Type	Field	Description
static OptionsParameter	OPTION_DETAILS

Constructor Summary

Constructors

Constructor	Description
SendMail()

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] arguments)	Invoke the function
int	getSpecialProperties(Expression[] arguments)	Determine the special properties of this function.

Methods inherited from class net.sf.saxon.functions.SystemFunction

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.Function

getGenre

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, concatenate, containsNode, materialize

Methods inherited from interface net.sf.saxon.om.Item

getLength, head, isStreamed, itemAt, iterate, reduce, subsequence

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Field Detail

OPTION_DETAILS

public static OptionsParameter OPTION_DETAILS

Constructor Detail

SendMail

public SendMail()

Method Detail

getSpecialProperties

public int getSpecialProperties(Expression[] arguments)

Determine the special properties of this function. The general rule is that a system function call is non-creative unless more details are defined in a subclass.

Overrides:

getSpecialProperties in class SystemFunction

Parameters:

arguments - the actual arguments supplied in a call to the function

call

public Sequence call(XPathContext context,
                     Sequence[] arguments)
              throws XPathException

Description copied from interface: Function

Invoke the function

Parameters:

context - the XPath dynamic evaluation context

arguments - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function