EmailInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(10 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
−
Das EmailInformation-Objekt enhtält eine Email-Addresse, die von dem EmailValidator-Service in regelmäßigen Abständen geprüft wird. Das Ergebnis der Prüfung wird in dem <code>emailStatus-Feld</code> abgelegt.
+
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-Addresse ist gültig
+
:Die Email-Adresse ist gültig
  
 
;invalid
 
;invalid
−
:Die Email-Addresse ist ungültig
+
:Die Email-Adresse ist ungültig
  
 
;trylater
 
;trylater
−
:Die Email-Addresse muß zu einem späteren Zeitpunkt erneut geprüft werden, da der Zuständige Email-Server zur Zeit keine anfragen entgegen nimmt.
+
: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-Addresse konnte der Zuständige Email-Server zwar erreicht werden, aber die Antwortzeit des Servers war zu lang.
+
: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-Addresse zuständige Email-Server konnte nicht erreicht werden.
+
:Der für die Email-Adresse zuständige Email-Server konnte nicht erreicht werden.
  
 
;unknown
 
;unknown
−
:Die Email-Addresse konnte auf Grund eines unbekannten Fehlers nicht geprüft werden.
+
: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 beispielswiese wie folgt gesetzt werden. Dies hat zur Folge, dass die Email-Adresse nicht überprüft wird.
+
: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 trylater, timeout, refused und unkown temporär auftreten können werden diese zunächst in dem Feld lastValidationEmailStatus gesetzt. Erst wenn bei einer darauf folgenden Überprüfung wieder dieser Status ermittelt wird, wird auch das Feld emailStatus mit diesem Status gesetzt.
+
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==
−
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 46: Zeile 46:
 
|-
 
|-
 
| field
 
| field
−
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 1
 
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| root
 
| root
 
| [[Element]]
 
| [[Element]]
 
| Root-Element dieser Information
 
| Root-Element dieser Information
 +
| 1
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 
| 1
 
| 1
 
|-
 
|-
Zeile 67: Zeile 77:
 
| email
 
| email
 
| [[String]]
 
| [[String]]
−
| Email-Addresse
+
| Email-Adresse
 
| 1
 
| 1
 
|-
 
|-
Zeile 77: Zeile 87:
 
| lastValidationEmailStatus
 
| lastValidationEmailStatus
 
| [[String]]
 
| [[String]]
−
| Vorläufiges Prüfungsergebnis, dass erst bei einert erneuten Prüfung bstätigt werden muß. Bestätig werden müssen folgende Stati: <code>trylater, timeout, refused, unknown</code>.
+
| 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
 +
 +
==Methoden==
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>toXip([[Boolean]] emptyFields)</code>
 +
| String
 +
| Erzeugt XML-Daten im XIP-Format für dieses Objekt
 +
| 2.14
 
|}
 
|}
  
 +
;<code>[[String]] toXip([[Boolean]] emptyFields)</code>
 +
:Erzeugt XML-Daten im XIP-Format für dieses Objekt.
 +
:;Parameter
 +
::;<code>Boolean emptyFields</code>
 +
:::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
 +
:;Rückgabewert
 +
::;String
 +
:::XML-Daten im XIP-Format
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
−
[[Category:Qualität_des_Inhalts_prüfen]]
 
−
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 4. November 2015, 13:11 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 String Variablenname des Objektes 1
lastField String Variablenname des Objektes ohne Struktur-Date 2.13
root Element Root-Element dieser Information 1
parent ID ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein 1
locale Locale Sprache, für die die Information gilt 1
isEmpty Boolean true, wenn der Counter noch nicht gestartet ist 1
email String Email-Adresse 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

Methoden

Methode Rückgabewert Beschreibung ab IES Version
toXip(Boolean emptyFields) String Erzeugt XML-Daten im XIP-Format für dieses Objekt 2.14
String toXip(Boolean emptyFields)
Erzeugt XML-Daten im XIP-Format für dieses Objekt.
Parameter
Boolean emptyFields
Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
Rückgabewert
String
XML-Daten im XIP-Format
Abgerufen von „https://wiki.sitepark.com/index.php?title=EmailInformation_(Objekt)&oldid=7772“