Email extends Accessible, ActionEdgeSource, CanBeSynced, ContainsFunctions, ContainsOperations, ContainsValues, ContainsWires, Message, Wireable

A Message sent as an e-mail message to a particular recipient.

An Email is designed to be used in the composition and delivery of mail messages. An Email may specify five directly contained Values, all of which must be type string . If the following Email attributes are defined as Values, they may be set at runtime to programmatically control the sender, recipient or subject of the Email:

from, representing the e-mail address of the sender. This Value must be set for an Email to be sent.
fromName, representing a human-readable name of the sender. This Value is optional.
to, representing the e-mail address of the receiver. This Value must be set for an Email to be sent.
toName, representing a human-readable name of the receiver. This Value is optional.
subject, representing the subject of the mail message. This Value must be set for an Email to be sent.

An Email contains the Operation send, which will attempt to deliver the current Email instance as described by BuiltinOperation. When an Email is composed, the body of the Email will be composed of all contained Values and their values at the time the Email was sent. The format of this body may use a custom template if this template is specified.

An Email contains the Events onSent and onFailure. These events are triggered once an Email has been successfully delivered and when an Email is unsuccessfully received, as discussed in Event.

An IAML model instance may contain any number of Emails. The storage semantics for a Email follow the storage semantics for its containing scope, similar to the storage semantics for the Frame element.

[Email.html]

Examples

EmailChangeProperties.iaml (source)
- Changing the various Values of an Emailat runtime. [EmailChangeProperties]
EmailExplicit.iaml (source)
- Sending an Email after clicking a Button. [EmailExplicit]
EmailSetWire.iaml (source)
- Using a custom PHP template for rendering Emails. [testCustomTemplate()]

Implementation Notes

If a PHP file called CUSTOM_ROOT/templates/ id.php isreadable at runtime, this template file will be used to render the Email insteadof the default template. [testCustomTemplate()]
If an Email fails to send, the onFailure Event is executed. [EmailEvents]
If an Email sends successfully, the onSent Event is executed. [EmailEvents]
An Email with any 'to' address ending in @example will instantly fail; it will not even attempt to be sent. [Definitions]
Currently, success and failure events are only considered when they occur directly after the Email is sent. [EmailCallbackSend]
The storage semantics for an Email follows the storage semantics of its parent Scope. [Definitions]
The default template for a sent Email contains a list of all of its contained Values and Label values. [Definitions]
To construct the content of an Email, a custom template may be specified in templates/ID.php; otherwise, a default builtin template is generated. [Definitions]
An Email has a BuiltinOperation named 'send'. [Email]
An Email has a BuiltinOperation named 'send'. [Contents]

Inference Rules

Emails have an Event named onFailure. [emails]
Emails have an Event named onSent. [emails]
An Email contains a Value named 'from'. [emails]
An Email contains a Value named 'fromName'. [emails]
An Email contains a Value named 'subject'. [emails]
An Email contains a Value named 'to'. [emails]
An Email contains a Value named 'toName'. [emails]
An InputForm connected to a Map with a SetWire will create a MapPoint in the target map for every InputTextField in the source form with the same name. [set-wires]
An InputForm connected to an Email with a SetWire will create a Label in the target Email for every InputTextField in the source form with the same name. [set-wires]
An InputForm connected to an Email with a SetWire will create a Label in the target Email for every Label in the source form with the same name. [set-wires]
Accessible elements have an Event named onAccess. [events] [from Accessible]
A SetWire connecting an CanBeSynced object to a DomainIterator will create sub- SetWires between every contained CanBeSynced object to every contained object within the contained DomainInstance which have matching names. [set-wires] [from CanBeSynced]
A SetWire connecting an DomainIterator to a CanBeSynced object will create sub- SetWires between every contained object within the contained DomainInstance to every contained CanBeSynced object which have matching names. [set-wires] [from CanBeSynced]
A SetWire connecting two objects will create sub- SetWires between every contained object within these parent objects which have matching names. [set-wires] [from CanBeSynced]
When a Changeable element is connected to an CanBeSynced element by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
When a CanBeSynced element is connected to an CanBeSynced element by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
When an InputTextField is connected to a CanBeSynced element by an instant SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
A SyncWire connecting an DomainIterator to a CanBeSynced object will create sub- SyncWires between every contained object within the contained DomainInstance to every contained CanBeSynced object which have matching names. [sync-wires] [from CanBeSynced]
A SyncWire connecting two objects will create sub- SyncWires between every contained object within these parent objects which have matching names. [sync-wires] [from CanBeSynced]
For elements connected by a SyncWire, the onAccess Event executing the 'init' Operation will only execute if the source fieldValue can be cast successfully. [casting] [from CanBeSynced]
For elements connected by a SyncWire, the onAccess Event will only call the 'validate' Operation if the relevant fieldValue is set. [casting] [from CanBeSynced]
When a CanBeSynced element is connected to an CanBeSynced element by a SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires] [from CanBeSynced]
When an InputTextField is connected to a CanBeSynced element by an instant SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires] [from CanBeSynced]

Constraints

"Some of the ECARules defined for this trigger may not be executed, as an unconditional navigation will occur due to the priority order, halting ECARule execution" [Checks.chk] [from ActionEdgeSource]
"You should not have a contained Property named 'fieldValue', unless it is contained within the fieldValue containment feature" [Checks.chk] [from ContainsValues]

Attributes

from : EString (optional)
The sender e-mail address for this Email.
fromName : EString (optional)
The sender name for this Email, which is optional.
subject : EString (optional)
The subject for this Email.
to : EString (optional)
The recipient e-mail address for this Email.
toName : EString (optional)
The recipient name for this Email, which is optional.

Inherited Attributes

generatedRule : EString (optional)
To assist in debugging, this attribute may be populated with the name of the model completion rule that created this element. More extensive traceability support may be provided in the future.
id : EString (optional)
A unique identifier for this model element. Should be globally unique.
isGenerated : EBoolean (optional)
Set to true if the current element has been generated.
name : EString (optional)
A non-unique string that names a given object.
overridden : EBoolean (optional)
If a GeneratesElements is overridden, then this element will not generate any elements directly.
overriddenNames : EString (optional)
When applying model completion, no NamedElements with these names will be generated by this element.

Children

buttons : [0...*] Button
Within an Email, all Buttons will be represented as hyperlinks.
labels : [0...*] Label
Within an Email, all Labels will be represented as text labels.
onFailure : [0...1] Event
This Event is triggered if the sent e-mail has failed to arrive at its destination, which may occur at any point after it is sent.
onSent : [0...1] Event
This Event is triggered when the Email is sent, however it is not guaranteed that it has been successfully sent.

Inherited Children

conditionEdges : [0...*] SimpleCondition
A list of contained SimpleConditions.
constraintEdges : [0...*] ConstraintEdge
A list of contained ConstraintEdges.
ecaRules : [0...*] ECARule
A list of contained ECARules.
extendsEdges : [0...*] ExtendsEdge
A list of contained ExecutionEdges.
functions : [0...*] Function
A list of contained Functions.
onAccess : [0...1] Event
This Event is executed whenever it is accessed, which may occur many times within a single request.
operations : [0...*] Operation
A list of contained Operations.
parameterEdges : [0...*] Parameter
A list of contained Parameters.
providesEdges : [0...*] ProvidesEdge
A list of contained ProvidesEdges.
requiresEdges : [0...*] RequiresEdge
A list of contained RequiresEdges.
schemaEdges : [0...*] SchemaEdge
A list of contained SchemaEdges.
selectEdges : [0...*] SelectEdge
A list of contained SelectEdges.
values : [0...*] Value
A list of contained Values.
wires : [0...*] Wire
A list of contained Wires.

Email extends Accessible, ActionEdgeSource, CanBeSynced, ContainsFunctions, ContainsOperations, ContainsValues, ContainsWires, Message, Wireable

Examples

Implementation Notes

Inference Rules

Constraints

Attributes

Inherited Attributes

Children

Inherited Children

References

Inherited References

Extensions

Inherited Extensions