Previous Topic

Next Topic

Book Contents

The Vrfy Element

<Vrfy> is the top-level element for defining verifiers. It has one sub-element and four attributes: version (required), uid, name, and disable.

attribute: version

Value: string

All verifiers require the version attribute. It specifies the version of the VrfyXML syntax the given document is written in. All future versions of the application will be backwardly compatible.

attribute: uid

Value: string

The uid is the unique identifier of the verifier and is required for updating verifiers. It is not required for adding a verifier.

attribute: name

Value: string

The name is a user-friendly identity of the verifier. It is used to identify the verifier in the Administrator Dashboard, and is optional. If used, it need not be unique.

attribute: disable

Value: true/false

Setting disable to "true" makes the verifier unavailable for use. The verifier will still be stored in the database but switched off.

sub-element: <MetaData>

The <MetaData> sub-element is read-only and used by the application to store information. Do not modify the content of the <MetaData> sub-element when updating a verifier. <Vrfy> may contain any number of <MetaData> sub-elements. The <Vrfy> element also contains exactly one verifier type element (such as <LDAP> or <RcptTo>).

The following example shows only the structure of the document-level <Vrfy> element along with its attributes and a single <MetaData> sub-element.

<Vrfy version = "101.4635"

name = "My Favorite Verifier"

uid = "64378E86-A459-11DD-1273-09173F13E4C5">

<MetaData>

<Editable>true</Editable>

</MetaData>

</Vrfy>