EmailInformation (Objekt): Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
| Zeile 3: | Zeile 3: | ||
==Beschreibung== | ==Beschreibung== | ||
| − | Das EmailInformation-Objekt | + | Das EmailInformation-Objekt enthält eine Email-Adresse, die von dem [[EmailValidator|EmailValidator-Service]] in regelmäßigen Abständen geprüft wird. Das Ergebnis der Prüfung wird in dem <code>emailStatus-Feld</code> abgelegt. |
Folgende Stati können sich durch eine Validierung ergeben: | Folgende Stati können sich durch eine Validierung ergeben: | ||
;valid | ;valid | ||
| − | :Die Email- | + | :Die Email-Adresse ist gültig |
;invalid | ;invalid | ||
| − | :Die Email- | + | :Die Email-Adresse ist ungültig |
;trylater | ;trylater | ||
| − | :Die Email- | + | :Die Email-Adresse muss zu einem späteren Zeitpunkt erneut geprüft werden, da der zuständige Email-Server zur Zeit keine Anfragen entgegen nimmt. |
;timeout | ;timeout | ||
| − | :Bei der Prüfung der Email- | + | :Bei der Prüfung der Email-Adresse konnte der zuständige Email-Server zwar erreicht werden, aber die Antwortzeit des Servers war zu lang. |
;refused | ;refused | ||
| − | :Der für die Email- | + | :Der für die Email-Adresse zuständige Email-Server konnte nicht erreicht werden. |
;unknown | ;unknown | ||
| − | :Die Email- | + | :Die Email-Adresse konnte auf Grund eines unbekannten Fehlers nicht geprüft werden. |
;ignore | ;ignore | ||
| − | :Dieser Status wird nicht vom EmailValidator-Service gesetzt, sondern kann | + | :Dieser Status wird nicht vom EmailValidator-Service gesetzt, sondern kann beispielsweise wie folgt gesetzt werden. Dies hat zur Folge, dass die Email-Adresse nicht überprüft wird. |
<source lang="xml"> | <source lang="xml"> | ||
| Zeile 33: | Zeile 33: | ||
| − | Da die Stati <code>trylater</code>, <code>timeout</code>, <code>refused</code> und <code> | + | Da die Stati <code>trylater</code>, <code>timeout</code>, <code>refused</code> und <code>unknown</code> temporär auftreten können, werden diese zunächst in dem Feld <code>lastValidationEmailStatus</code> gesetzt. Erst wenn bei einer darauf folgenden Überprüfung dieser Status erneut ermittelt auftritt, wird auch das Feld <code>emailStatus</code> mit diesem Status gesetzt. |
==Attribute== | ==Attribute== | ||
| Zeile 77: | Zeile 77: | ||
| lastValidationEmailStatus | | lastValidationEmailStatus | ||
| [[String]] | | [[String]] | ||
| − | | Vorläufiges Prüfungsergebnis, | + | | Vorläufiges Prüfungsergebnis, das erst bei einer erneuten Prüfung bestätigt werden muss. Bestätigt werden müssen folgende Stati: <code>trylater, timeout, refused, unknown</code>. |
| 1 | | 1 | ||
|}trylater | |}trylater | ||
Version vom 11. Februar 2009, 18:10 Uhr
Name
EmailInformation - Validierbare Email-Adresse
Beschreibung
Das EmailInformation-Objekt enthält eine Email-Adresse, die von dem EmailValidator-Service in regelmäßigen Abständen geprüft wird. Das Ergebnis der Prüfung wird in dem emailStatus-Feld abgelegt.
Folgende Stati können sich durch eine Validierung ergeben:
- valid
- Die Email-Adresse ist gültig
- invalid
- Die Email-Adresse ist ungültig
- trylater
- Die Email-Adresse muss zu einem späteren Zeitpunkt erneut geprüft werden, da der zuständige Email-Server zur Zeit keine Anfragen entgegen nimmt.
- timeout
- Bei der Prüfung der Email-Adresse konnte der zuständige Email-Server zwar erreicht werden, aber die Antwortzeit des Servers war zu lang.
- refused
- Der für die Email-Adresse zuständige Email-Server konnte nicht erreicht werden.
- unknown
- Die Email-Adresse konnte auf Grund eines unbekannten Fehlers nicht geprüft werden.
- ignore
- Dieser Status wird nicht vom EmailValidator-Service gesetzt, sondern kann beispielsweise wie folgt gesetzt werden. Dies hat zur Folge, dass die Email-Adresse nicht überprüft wird.
<sp:text name="sp:email" type="emailStatus">
Da die Stati trylater, timeout, refused und unknown temporär auftreten können, werden diese zunächst in dem Feld lastValidationEmailStatus gesetzt. Erst wenn bei einer darauf folgenden Überprüfung dieser Status erneut ermittelt auftritt, wird auch das Feld emailStatus mit diesem Status gesetzt.
Attribute
| Attribut | Type | Beschreibung | ab IES Version |
|---|---|---|---|
| id | ID | ID des Objektes | 1 |
| field | Variable | Variablenname des Objektes | 1 |
| root | Element | Root-Element dieser Information | 1 |
| locale | Locale | Sprache, für die die Information gilt | 1 |
| isEmpty | Boolean | true, wenn der Counter noch nicht gestartet ist
|
1 |
| String | Email-Addresse | 1 | |
| emailStatus | String | Status der Email-Adresse. Folgende Stati sind möglich: valid, invalid, trylater, timeout, refused, unknown, ignore.
|
1 |
| lastValidationEmailStatus | String | Vorläufiges Prüfungsergebnis, das erst bei einer erneuten Prüfung bestätigt werden muss. Bestätigt werden müssen folgende Stati: trylater, timeout, refused, unknown.
|
1 |
trylater