Extensible Provisioning Protocol Email Forwarding Mapping
                      <epp-emailforwarding-03.txt>


Abstract

This document describes and Extensible Provisioning Protocol (EPP) mapping
for the provisioning and management of Email Forwarding objects stored in a
shared central repositary. Specified in XML, the mapping defines EPP command
syntax and semantics as applied to Email Forwarding objects.

1. Introduction

The Registry Operator will provide an email forwarding service enabling
firstname@lastname.name email addresses to be registered on second-level
.NAME domain-names.

The service will accept incoming email to a firstname@lastname.name address
and will forward that mail to an address specified by the user. The service
will only offer incoming messages to registered users, and will not provide
outgoing SMTP relaying for the forwarding users.

As Email Forwarding Objects are very similar to Domain Names, and there all
ready exists an EPP-mapping for Domain Names [EPP-D], this document will
only describe the differences between the two mappings.

[EPP] provides a complete description of EPP command and response
structures. A thorough understanding of the base protocol specification is
necessary to understand the mapping described in this document.

2. Changes in the Email Forwarding Mapping

The necessary changes from the Domain Name mapping are discussed in the
following subsections.

2.1 EPP <create> Command

As Email Forwarding does not depend on any nameservers, the EPP <create>
command does not have a name server part, <emailforwarding:ns>. This command
is covered in section 3.2.1 of the EPP-mapping of Domain Names [EPP-D].

Another change for the <create> command is the addition of the following
mandatory child element:

- An <emailforwarding:forwardto> that contains the email address
  to forward to.

2.2 EPP <update> Command

As Email Forwarding does not depend on any nameservers, the EPP <update>
command does not have a name server part, <emailforwarding:ns>. This command
is covered in section 3.2.5 of the EPP-mapping of Domain Names [EPP-D].

Another change for the <update> command is the addition of the following
child element in the <emailforwarding:chg> element:

- An <emailforwarding:forwardto> that contains the email address
  to forward to.

2.3 EPP <info> Command

As Email Forwarding does not depend on any nameservers, and you cannot
create any host objects hierarchically under the emailforwarding object,
the EPP <info> command response does not have the name server part,
<emailforwarding:ns>, or the host part, <emailforwarding:host>. This command
is covered in section 3.1.2 of the EPP-mapping of Domain Names [EPP-D].

Another change for the <info> command is the addition of the following child
element in the response data element:

- An <emailforwarding:forwardto> that contains the email address
  to forward to.

3. Formal Syntax

An EPP object mapping is specified in XML Schema notation.  The formal
syntax presented here is a complete schema representation of the
object mapping suitable for automated validation of EPP XML instances.


<?xml version="1.0" encoding="UTF-8"?>

<schema targetNamespace="urn:iana:xml:ns:emailforwarding"
        xmlns:emailforwarding="urn:iana:xml:ns:emailforwarding"
        xmlns:epp="urn:iana:xml:ns:epp"
        xmlns:eppcom="urn:iana:xml:ns:eppcom"
        xmlns="http://www.w3.org/2001/XMLSchema"
        elementFormDefault="qualified">

<!--
Import common element types.
-->
  <import namespace="urn:iana:xml:ns:eppcom"
          schemaLocation="eppcom.xsd"/>
  <import namespace="urn:iana:xml:ns:epp"
          schemaLocation="epp.xsd"/>

  <annotation>
    <documentation>
      Extensible Provisioning Protocol v1.0
      emailforwarding provisioning schema.
    </documentation>
  </annotation>

<!--
Types used within an EPP greeting.
-->
  <element name="svc"/>

<!--
Child elements found in EPP commands.
-->
  <element name="check" type="emailforwarding:mNameType"/>
  <element name="create" type="emailforwarding:createType"/>
  <element name="delete" type="emailforwarding:sNameType"/>
  <element name="info" type="emailforwarding:sNameType"/>
  <element name="renew" type="emailforwarding:renewType"/>
  <element name="transfer" type="emailforwarding:transferType"/>
  <element name="update" type="emailforwarding:updateType"/>

<!--
Child elements of the <create> command.
-->
  <complexType name="createType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="period" type="emailforwarding:periodType"
       minOccurs="0"/>
      <element name="forwardto" type="normalizedString"/>
      <element name="registrant" type="eppcom:clIDType"
       minOccurs="0"/>
      <element name="contact" type="emailforwarding:contactType"
       minOccurs="0" maxOccurs="unbounded"/>
      <element name="authInfo" type="eppcom:authInfoType"/>
    </sequence>
  </complexType>

  <complexType name="periodType">
    <simpleContent>
      <extension base="emailforwarding:pLimitType">
        <attribute name="unit" type="emailforwarding:pUnitType"
         use="required"/>
      </extension>
    </simpleContent>
  </complexType>

  <simpleType name="pLimitType">
    <restriction base="unsignedShort">
      <minInclusive value="1"/>
      <maxInclusive value="99"/>
    </restriction>
  </simpleType>

  <simpleType name="pUnitType">
    <restriction base="token">
      <enumeration value="y"/>
      <enumeration value="m"/>
    </restriction>
  </simpleType>

  <complexType name="contactType">
    <simpleContent>
      <extension base="eppcom:clIDType">
        <attribute name="type" type="emailforwarding:contactAttrType"
         use="optional"/>
      </extension>
    </simpleContent>
  </complexType>

  <simpleType name="contactAttrType">
    <restriction base="token">
      <enumeration value="admin"/>
      <enumeration value="billing"/>
      <enumeration value="tech"/>
    </restriction>
  </simpleType>

<!--
Child element of commands that require a single name.
-->
  <complexType name="sNameType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
    </sequence>
  </complexType>

<!--
Child element of commands that accept multiple names.
-->
  <complexType name="mNameType">
    <sequence>
      <element name="name" type="eppcom:labelType"
       maxOccurs="unbounded"/>
    </sequence>
  </complexType>

<!--
Child elements of the <renew> command.
-->
  <complexType name="renewType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="curExpDate" type="date"/>
      <element name="period" type="emailforwarding:periodType"
       minOccurs="0"/>
    </sequence>
  </complexType>

<!--
Child elements of the <transfer> command.
-->
  <complexType name="transferType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="period" type="emailforwarding:periodType"
       minOccurs="0"/>
      <element name="authInfo" type="eppcom:authInfoType"
       minOccurs="0"/>
    </sequence>
  </complexType>

<!--
Child elements of the <update> command.
-->
  <complexType name="updateType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <choice minOccurs="1" maxOccurs="3">
        <element name="add" type="emailforwarding:addRemType"
         minOccurs="0"/>
        <element name="rem" type="emailforwarding:addRemType"
         minOccurs="0"/>
        <element name="chg" type="emailforwarding:chgType"
         minOccurs="0"/>
       </choice>
    </sequence>
  </complexType>

<!--
Data elements that can be added or removed.
-->
  <complexType name="addRemType">
    <choice minOccurs="1" maxOccurs="3">
      <element name="contact" type="emailforwarding:contactType"
       minOccurs="0" maxOccurs="unbounded"/>
      <element name="status" type="emailforwarding:statusType"
       minOccurs="0" maxOccurs="14"/>
    </choice>
  </complexType>

<!--
Data elements that can be changed.
-->
  <complexType name="chgType">
    <sequence>
      <element name="forwardto" type="normalizedString"/>
      <element name="registrant" type="eppcom:clIDType"
       minOccurs="0"/>
      <element name="authInfo" type="eppcom:authInfoType"
       minOccurs="0"/>
    </sequence>
  </complexType>

<!--
Child response elements.
-->
  <element name="chkData" type="emailforwarding:chkDataType"/>
  <element name="creData" type="emailforwarding:creDataType"/>
  <element name="infData" type="emailforwarding:infDataType"/>
  <element name="trnData" type="emailforwarding:trnDataType"/>

<!--
<check> response elements.
-->
  <complexType name="chkDataType">
    <sequence>
      <element name="cd" type="emailforwarding:checkType"
       maxOccurs="unbounded"/>
    </sequence>
  </complexType>

  <complexType name="checkType">
    <simpleContent>
      <extension base = "eppcom:labelType">
        <attribute name="x" type="eppcom:checkType"
         use="required"/>
      </extension>
    </simpleContent>
  </complexType>

<!--
<create> and <renew> response elements.
-->
  <complexType name="creDataType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="exDate" type="dateTime"
       minOccurs="0"/>
    </sequence>
  </complexType>

<!--
<info> response elements.
-->
  <complexType name="infDataType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="status" type="emailforwarding:statusType"
       maxOccurs="14"/>
      <element name="forwardto" type="normalizedString"/>
      <element name="registrant" type="emailforwarding:contactType"
       minOccurs="0"/>
      <element name="contact" type="emailforwarding:contactType"
       minOccurs="0" maxOccurs="unbounded"/>
      <element name="clID" type="eppcom:clIDType"/>
      <element name="crID" type="eppcom:clIDType"/>
      <element name="crDate" type="dateTime"/>
      <element name="upID" type="eppcom:clIDType"
       minOccurs="0"/>
      <element name="upDate" type="dateTime"
       minOccurs="0"/>
      <element name="exDate" type="dateTime"
       minOccurs="0"/>
      <element name="trDate" type="dateTime"
       minOccurs="0"/>
      <element name="authInfo" type="eppcom:authInfoType"/>
    </sequence>
  </complexType>

<!--
Status is a combination of attributes and an optional human-readable
message that may be expressed in languages other than English.
-->
  <complexType name="statusType">
    <simpleContent>
      <extension base="normalizedString">
        <attribute name="s" type="emailforwarding:statusValueType"
         use="required"/>
        <attribute name="lang" type="language"
         use="optional" default="en"/>
      </extension>
    </simpleContent>
  </complexType>

  <simpleType name="statusValueType">
    <restriction base="token">
      <enumeration value="clientDeleteProhibited"/>
      <enumeration value="clientHold"/>
      <enumeration value="clientRenewProhibited"/>
      <enumeration value="clientTransferProhibited"/>
      <enumeration value="clientUpdateProhibited"/>
      <enumeration value="inactive"/>
      <enumeration value="ok"/>
      <enumeration value="pendingDelete"/>
      <enumeration value="pendingTransfer"/>
      <enumeration value="pendingVerification"/>
      <enumeration value="serverDeleteProhibited"/>
      <enumeration value="serverHold"/>
      <enumeration value="serverRenewProhibited"/>
      <enumeration value="serverTransferProhibited"/>
      <enumeration value="serverUpdateProhibited"/>
    </restriction>
  </simpleType>

<!--
<transfer> response elements.
-->
  <complexType name="trnDataType">
    <sequence>
      <element name="name" type="eppcom:labelType"/>
      <element name="trStatus" type="eppcom:trStatusType"/>
      <element name="reID" type="eppcom:clIDType"/>
      <element name="reDate" type="dateTime"/>
      <element name="acID" type="eppcom:clIDType"/>
      <element name="acDate" type="dateTime"/>
      <element name="exDate" type="dateTime"
       minOccurs="0"/>
    </sequence>
  </complexType>

<!--
End of schema.
-->
</schema>


4. References

[EPP] S. Hollenbeck: "Extensible Provisioning Protocol", draft-ietf-
provreg-epp-03.txt, work in progress.

[EPP-D] S. Hollenbeck: "Extensible Provisioning Protocol Domain Name
Mapping", draft-ietf-provreg-epp-domain-01.txt, work in progress.