Partager via

EmailTemplate

  • Article

Represents a FIM email template that is used for sending automated emails.

The emails sent are grabbed by the activity and handed over to the Resolver for resolution of the Lookup grammar.

Schema

<?xml version="1.0"?><xs:schema xmlns:rm="https://schemas.microsoft.com/2006/11/ResourceManagement" targetNamespace="https://schemas.microsoft.com/2006/11/ResourceManagement" version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="EmailTemplate">
    <xs:sequence>
      <xs:element minOccurs="0" name="ObjectID" type="rm:ReferenceType" />
      <xs:element minOccurs="1" name="ObjectType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="CreatedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Creator" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="MVObjectID">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DeletedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Description">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DetectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="DisplayName">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ExpectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="ExpirationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Locale">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ResourceTime" type="xs:dateTime" />
      <xs:element minOccurs="1" name="EmailBody" type="xs:string" />
      <xs:element minOccurs="1" name="EmailSubject">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="EmailTemplateType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value="^(Approval|Complete|Denied|Notification|Timeout)$" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Properties

The following table lists the properties of the EmailTemplate resource:

Value Description

EmailBody

Required string property. Email body in HTML format with unresolved Lookup grammar. There is no limit to the string length of the Body property.

EmailSubject

Required string property. Text string with unresolved Lookup grammar. The maximum length of the string is 448 characters.

EmailTemplateType

Required string property. See EmailTemplateType property table for possible values.

EmailTemplateType Property

Value Description

Approval

Indicates EmailTemplate of TemplateType Approval.

Complete

Indicates EmailTemplate of TemplateType Complete.

Denied

Indicates EmailTemplate of TemplateType Denied.

Escalation

Indicates EmailTemplate of TemplateType Escalation.

Notification

Indicates EmailTemplate of TemplateType Notification.

Timeout

Indicates EmailTemplate of TemplateType Timeout.

Parent Elements

None

Remarks

All of the resource types in FIM have the same attribute bindings as the Resource type by default. For more information, see Forefront Identity Manager Schema.

Remarks

Warning

It is possible to unintentionally disclose information about a request by adding information about the request to an EmailTemplate used by an activity (for example, ApprovalActivity). Information included on the template will be sent to the email recipients without performing a check that they have the rights to view that information. The FIM administrator is encouraged to respect the organization's policy regarding which information to include in templates.

See Also

Concepts

How to: Retrieve the FIM Service Schema Using WS-MetadataExchange
Schema Data Types

Other Resources

Forefront Identity Manager Schema