Email#
Fully qualified datatype name of the UML model DDI-CDI 1.0: DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Email
Definition#
An e-mail address which conforms to the internet format (RFC 822) including its type and time period for which it is valid.
Examples#
Diagram#
Diagram
Attributes#
Attributes
Name |
Inherited from |
Description |
Data Type |
Multiplicity |
Default value |
|---|---|---|---|---|---|
effectiveDates |
- own datatype - |
Time period for which the e-mail address is valid. |
0..1 |
||
internetEmail |
- own datatype - |
The email address expressed as a string (should follow the Internet format specification - RFC 5322) e.g. user@server.ext, more complex and flexible examples are also supported by the format. |
String |
0..1 |
|
isPreferred |
- own datatype - |
Set to True if this is the preferred email. |
Boolean |
0..1 |
false |
privacy |
- own datatype - |
Indicates the level of privacy. |
0..1 |
||
typeOfEmail |
- own datatype - |
Code indicating the type of e-mail address. Supports the use of an external controlled vocabulary. (e.g. home, office). |
0..1 |
Usage#
Usage
Type |
Package |
Classifier |
Attribute |
|---|---|---|---|
DataType |
StructuredDataTypes |
Encodings#
Syntax representations / encodings
All syntax representations except the Canonical XMI are provided as reference points for specific implementations, or for use as defaults if sufficient in the form presented.
Fragment for the data type Email (entire model as XMI)
1<packagedElement xmlns:StandardProfile="http://www.omg.org/spec/UML/20131001/StandardProfile"
2 xmlns:uml="http://www.omg.org/spec/UML/20131001"
3 xmlns:xmi="http://www.omg.org/spec/XMI/20131001"
4 xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email"
5 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email"
6 xmi:type="uml:DataType">
7 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-ownedComment"
8 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-ownedComment"
9 xmi:type="uml:Comment">
10 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email"/>
11 <body>Definition
12============
13An e-mail address which conforms to the internet format (RFC 822) including its type and time period for which it is valid.
14
15Examples
16==========
17info@ddialliance.org; ex.ample@somewhere.org</body>
18 </ownedComment>
19 <name>Email</name>
20 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-effectiveDates"
21 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-effectiveDates"
22 xmi:type="uml:Property">
23 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-effectiveDates-ownedComment"
24 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-effectiveDates-ownedComment"
25 xmi:type="uml:Comment">
26 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-effectiveDates"/>
27 <body>Time period for which the e-mail address is valid.</body>
28 </ownedComment>
29 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-effectiveDates-lowerValue"
30 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-effectiveDates-lowerValue"
31 xmi:type="uml:LiteralInteger"/>
32 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-effectiveDates-upperValue"
33 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-effectiveDates-upperValue"
34 xmi:type="uml:LiteralUnlimitedNatural">
35 <value>1</value>
36 </upperValue>
37 <name>effectiveDates</name>
38 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-DateRange"/>
39 </ownedAttribute>
40 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-internetEmail"
41 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-internetEmail"
42 xmi:type="uml:Property">
43 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-internetEmail-ownedComment"
44 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-internetEmail-ownedComment"
45 xmi:type="uml:Comment">
46 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-internetEmail"/>
47 <body>The email address expressed as a string (should follow the Internet format specification - RFC 5322) e.g. user@server.ext, more complex and flexible examples are also supported by the format.</body>
48 </ownedComment>
49 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-internetEmail-lowerValue"
50 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-internetEmail-lowerValue"
51 xmi:type="uml:LiteralInteger"/>
52 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-internetEmail-upperValue"
53 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-internetEmail-upperValue"
54 xmi:type="uml:LiteralUnlimitedNatural">
55 <value>1</value>
56 </upperValue>
57 <name>internetEmail</name>
58 <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#String"
59 xmi:type="uml:PrimitiveType"/>
60 </ownedAttribute>
61 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-isPreferred"
62 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-isPreferred"
63 xmi:type="uml:Property">
64 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-isPreferred-ownedComment"
65 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-isPreferred-ownedComment"
66 xmi:type="uml:Comment">
67 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-isPreferred"/>
68 <body>Set to True if this is the preferred email.</body>
69 </ownedComment>
70 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-isPreferred-lowerValue"
71 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-isPreferred-lowerValue"
72 xmi:type="uml:LiteralInteger"/>
73 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-isPreferred-upperValue"
74 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-isPreferred-upperValue"
75 xmi:type="uml:LiteralUnlimitedNatural">
76 <value>1</value>
77 </upperValue>
78 <name>isPreferred</name>
79 <defaultValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-isPreferred-defaultValue"
80 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-isPreferred-defaultValue"
81 xmi:type="uml:LiteralBoolean">
82 <value>False</value>
83 </defaultValue>
84 <type href="http://www.omg.org/spec/UML/20131001/PrimitiveTypes.xmi#Boolean"
85 xmi:type="uml:PrimitiveType"/>
86 </ownedAttribute>
87 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-privacy"
88 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-privacy"
89 xmi:type="uml:Property">
90 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-privacy-ownedComment"
91 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-privacy-ownedComment"
92 xmi:type="uml:Comment">
93 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-privacy"/>
94 <body>Indicates the level of privacy.</body>
95 </ownedComment>
96 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-privacy-lowerValue"
97 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-privacy-lowerValue"
98 xmi:type="uml:LiteralInteger"/>
99 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-privacy-upperValue"
100 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-privacy-upperValue"
101 xmi:type="uml:LiteralUnlimitedNatural">
102 <value>1</value>
103 </upperValue>
104 <name>privacy</name>
105 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
106 </ownedAttribute>
107 <ownedAttribute xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-typeOfEmail"
108 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-typeOfEmail"
109 xmi:type="uml:Property">
110 <ownedComment xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-typeOfEmail-ownedComment"
111 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-typeOfEmail-ownedComment"
112 xmi:type="uml:Comment">
113 <annotatedElement xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-typeOfEmail"/>
114 <body>Code indicating the type of e-mail address. Supports the use of an external controlled vocabulary. (e.g. home, office).</body>
115 </ownedComment>
116 <lowerValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-typeOfEmail-lowerValue"
117 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-typeOfEmail-lowerValue"
118 xmi:type="uml:LiteralInteger"/>
119 <upperValue xmi:id="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-Email-typeOfEmail-upperValue"
120 xmi:uuid="http://ddialliance.org/Specification/DDI-CDI/1.0/XMI/#Email-typeOfEmail-upperValue"
121 xmi:type="uml:LiteralUnlimitedNatural">
122 <value>1</value>
123 </upperValue>
124 <name>typeOfEmail</name>
125 <type xmi:idref="DDICDIModels-DDICDILibrary-DataTypes-StructuredDataTypes-ControlledVocabularyEntry"/>
126 </ownedAttribute>
127</packagedElement>
Fragment for the data type Email (entire XML Schema)
1<xs:element name="Email"
2 type="EmailXsdType"
3 xml:id="Email">
4 <!-- based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Email -->
5 <xs:annotation>
6 <xs:documentation>Definition
7 ============
8 An e-mail address which conforms to the internet format (RFC 822) including its type and time period for which it is valid.
9
10 Examples
11 ==========
12 info@ddialliance.org; ex.ample@somewhere.org</xs:documentation>
13 </xs:annotation>
14</xs:element>
15<xs:complexType name="EmailXsdType"
16 xml:id="EmailXsdType">
17 <xs:annotation>
18 <xs:documentation>Definition
19 ============
20 An e-mail address which conforms to the internet format (RFC 822) including its type and time period for which it is valid.
21
22 Examples
23 ==========
24 info@ddialliance.org; ex.ample@somewhere.org</xs:documentation>
25 </xs:annotation>
26 <xs:sequence>
27 <xs:element name="effectiveDates"
28 type="DateRangeXsdType"
29 minOccurs="0"
30 maxOccurs="1"
31 xml:id="Email-effectiveDates">
32 <xs:annotation>
33 <xs:documentation>Time period for which the e-mail address is valid.</xs:documentation>
34 </xs:annotation>
35 </xs:element>
36 <xs:element name="internetEmail"
37 type="xs:string"
38 minOccurs="0"
39 maxOccurs="1"
40 xml:id="Email-internetEmail">
41 <xs:annotation>
42 <xs:documentation>The email address expressed as a string (should follow the Internet format specification - RFC 5322) e.g. user@server.ext, more complex and flexible examples are also supported by the format.</xs:documentation>
43 </xs:annotation>
44 </xs:element>
45 <xs:element name="isPreferred"
46 type="xs:boolean"
47 minOccurs="0"
48 maxOccurs="1"
49 xml:id="Email-isPreferred">
50 <xs:annotation>
51 <xs:documentation>Set to True if this is the preferred email.</xs:documentation>
52 </xs:annotation>
53 </xs:element>
54 <xs:element name="privacy"
55 type="ControlledVocabularyEntryXsdType"
56 minOccurs="0"
57 maxOccurs="1"
58 xml:id="Email-privacy">
59 <xs:annotation>
60 <xs:documentation>Indicates the level of privacy.</xs:documentation>
61 </xs:annotation>
62 </xs:element>
63 <xs:element name="typeOfEmail"
64 type="ControlledVocabularyEntryXsdType"
65 minOccurs="0"
66 maxOccurs="1"
67 xml:id="Email-typeOfEmail">
68 <xs:annotation>
69 <xs:documentation>Code indicating the type of e-mail address. Supports the use of an external controlled vocabulary. (e.g. home, office).</xs:documentation>
70 </xs:annotation>
71 </xs:element>
72 </xs:sequence>
73</xs:complexType>
Fragment for the data type Email (entire JSON Schema)
1"dt-Email": {
2 "description": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/Email",
3 "type": ["object"],
4 "properties": {
5 "effectiveDates": {
6 "$comment": "cardinality 0..1 – from cdi:Email",
7 "$ref": "#/defs/dt-DateRange"
8 },
9 "internetEmail": {
10 "$comment": "cardinality 0..1 – from cdi:Email",
11 "$ref": "#/defs/xsd:string"
12 },
13 "isPreferred": {
14 "$comment": "cardinality 0..1 – from cdi:Email",
15 "$ref": "#/defs/xsd:boolean"
16 },
17 "privacy": {
18 "$comment": "cardinality 0..1 – from cdi:Email",
19 "$ref": "#/defs/dt-ControlledVocabularyEntry"
20 },
21 "typeOfEmail": {
22 "$comment": "cardinality 0..1 – from cdi:Email",
23 "$ref": "#/defs/dt-ControlledVocabularyEntry"
24 },
25 "@type": {
26 "const": "Email"
27 }
28 },
29 "required": ["@type"],
30 "additionalProperties": false
31},
Fragment for the data type Email (main ontology)
1# datatype Email
2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Email
3cdi:Email
4 a rdfs:Class, owl:Class, ucmis:StructuredDataType;
5 rdfs:label "Email";
6 rdfs:comment "Definition\n============\nAn e-mail address which conforms to the internet format (RFC 822) including its type and time period for which it is valid.\n\nExamples\n==========\ninfo@ddialliance.org; ex.ample@somewhere.org"@en;
7
8 owl:hasKey (cdi:Email-effectiveDates cdi:Email-internetEmail cdi:Email-isPreferred cdi:Email-privacy cdi:Email-typeOfEmail);
9.
10
11cdi:Email-effectiveDates
12 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
13 rdfs:label "effectiveDates";
14 rdfs:comment "Time period for which the e-mail address is valid."@en;
15 rdfs:domain cdi:Email;
16 rdfs:range cdi:DateRange;
17.
18
19cdi:Email-internetEmail
20 a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
21 rdfs:label "internetEmail";
22 rdfs:comment "The email address expressed as a string (should follow the Internet format specification - RFC 5322) e.g. user@server.ext, more complex and flexible examples are also supported by the format."@en;
23 rdfs:domain cdi:Email;
24 rdfs:range xsd:string;
25.
26
27cdi:Email-isPreferred
28 a rdf:Property, owl:DatatypeProperty, ucmis:Attribute;
29 rdfs:label "isPreferred";
30 rdfs:comment "Set to True if this is the preferred email."@en;
31 rdfs:domain cdi:Email;
32 rdfs:range xsd:boolean;
33.
34
35cdi:Email-privacy
36 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
37 rdfs:label "privacy";
38 rdfs:comment "Indicates the level of privacy."@en;
39 rdfs:domain cdi:Email;
40 rdfs:range cdi:ControlledVocabularyEntry;
41.
42
43cdi:Email-typeOfEmail
44 a rdf:Property, owl:ObjectProperty, ucmis:Attribute;
45 rdfs:label "typeOfEmail";
46 rdfs:comment "Code indicating the type of e-mail address. Supports the use of an external controlled vocabulary. (e.g. home, office)."@en;
47 rdfs:domain cdi:Email;
48 rdfs:range cdi:ControlledVocabularyEntry;
49.
Fragment for the data type Email (entire JSON-LD)
1{
2 "@context": [
3 {
4 "cdi": "http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/",
5 "xsd": "http://www.w3.org/2001/XMLSchema#",
6
7 "effectiveDates": {
8 "@id": "cdi:Email-effectiveDates",
9 "@type": "@id",
10 "@context": "DateRange.jsonld"
11 },
12 "internetEmail": {
13 "@id": "cdi:Email-internetEmail",
14 "@type": "xsd:string"
15 },
16 "isPreferred": {
17 "@id": "cdi:Email-isPreferred",
18 "@type": "xsd:boolean"
19 },
20 "privacy": {
21 "@id": "cdi:Email-privacy",
22 "@type": "@id",
23 "@context": "ControlledVocabularyEntry.jsonld"
24 },
25 "typeOfEmail": {
26 "@id": "cdi:Email-typeOfEmail",
27 "@type": "@id",
28 "@context": "ControlledVocabularyEntry.jsonld"
29 },
30
31 " comment ": "tag:json-should-support-trailing-commas"
32 }
33 ],
34 "generatedBy": "This code was generated by the Eclipse Acceleo project UCMIS M2T on 2025-08-29 14:34:56.",
35 "basedOn": "based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Email"
36}
Fragment for the data type Email (entire SHACL - Shapes Constraint Language)
1# datatype Email
2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Email
3<#Email> a sh:NodeShape;
4 sh:targetClass cdi:Email;
5 sh:message "See http://ddialliance.org/Specification/DDI-CDI/1.0/RDF/Email";
6 sh:closed true;
7 sh:ignoredProperties ( owl:sameAs );
8 sh:property [
9 sh:path rdf:type;
10 sh:in ( cdi:Email
11 ) ;
12 ];
13 # attributes
14 sh:property <#Email-effectiveDates>;
15 sh:property <#Email-internetEmail>;
16 sh:property <#Email-isPreferred>;
17 sh:property <#Email-privacy>;
18 sh:property <#Email-typeOfEmail>;
19
20
21
22.
23
24<#Email-effectiveDates> a sh:PropertyShape ;
25 sh:path cdi:Email-effectiveDates;
26 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
27 cdi:DateRange
28
29 ) ]];
30 sh:maxCount 1;
31.
32<#Email-internetEmail> a sh:PropertyShape ;
33 sh:path cdi:Email-internetEmail;
34 sh:datatype xsd:string;
35 sh:maxCount 1;
36.
37<#Email-isPreferred> a sh:PropertyShape ;
38 sh:path cdi:Email-isPreferred;
39 sh:datatype xsd:boolean;
40 sh:maxCount 1;
41.
42<#Email-privacy> a sh:PropertyShape ;
43 sh:path cdi:Email-privacy;
44 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
45 cdi:ControlledVocabularyEntry
46
47 ) ]];
48 sh:maxCount 1;
49.
50<#Email-typeOfEmail> a sh:PropertyShape ;
51 sh:path cdi:Email-typeOfEmail;
52 sh:node [ sh:property [ sh:path rdf:type; sh:minCount 1; sh:in (
53 cdi:ControlledVocabularyEntry
54
55 ) ]];
56 sh:maxCount 1;
57.
Fragment for the data type Email (entire ShEx - Shape Expressions)
1# datatype Email
2# based on the UML data type DDICDIModels::DDICDILibrary::DataTypes::StructuredDataTypes::Email
3cdi:EmailShape CLOSED {
4 a [cdi:Email];
5 cdi:Email-effectiveDates @cdi:DateRangeShape?;
6 cdi:Email-internetEmail xsd:string?;
7 cdi:Email-isPreferred xsd:boolean?;
8 cdi:Email-privacy @cdi:ControlledVocabularyEntryShape?;
9 cdi:Email-typeOfEmail @cdi:ControlledVocabularyEntryShape?;
10 }