Mail/email

From KWICK! Developer Wiki

Jump to: navigation, search

Beschreibung

Aufzurufende Url: /email/?FOLDER/?PAGE

Hinweis: In der Url mit einem ? (Fragezeichen) gekennzeichnete Pfade sind optionale Parameter, welche nicht bei jedem Aufruf erforderlich sind. Beachte bitte, dass die Reihenfolge der Parameter in jedem Fall eingehalten werden muss.

Soll beispielswiese der zweite optionale Parameter verwendet werden, so muss der Erste zwangsläufig mit angegeben werden, damit die Reihenfolge erhalten bleibt.

Liefert die Ordneransicht eines Mail-Ordners. Der Platzhalter ?FOLDER steht hierbei für den Ordnernamen des abzurufenden Ordners, sowie ?PAGE für die zu betrachtende Seite.

Parameter

Keine.

Rückgabe

Name Beschreibung
page Aktuell abgefragte Seite, falls es mehrere Seiten gibt. Die erste Seite ist Seite 0, die zweite 1, und so weiter.
maxPage Die Maximale Seitennummer, falls es mehrere Seiten gibt. Bei 5 Seiten beispielsweise 4.
folders Ein JSON-Array, welches für jeden Ordner ein JSON-Objekt mit folgenden Werten enthält.
Name Beschreibung
messages Gesamtzahl der Mails im Ordner.
unseen Anzahl der ungelesenen Mails im Ordner.
status Status des Ordners im HTML-Format.
name System-Ordnername. Dieser Ordnername kann als Wert für den URI-Parameter ?folder verwendet werden.
beautyname Schönerer Ordnername, zur Anzeige besser geeignet.
deletable True, wenn der Ordner vom Benutzer gelöscht werden kann, andernfalls false.
attr Attribut-Bitmaske zum bestimmen der Ordnerattribute anhand von PHP IMAP.
messages Ein JSON-Array, welches die Mails in der aktuellen Ordneransicht, also im angegebenen Ordner und auf der entsprechenden Seite, als JSON-Objekte enthält.
Name Beschreibung
is_read True, wenn die Mail gelesen wurde, andernfalls false.
is_answered True, wenn die Mail beantwortet wurde, andernfalls false.
is_forwarded True, wenn die Mail weitergeleitet wurde, andernfalls false.
date Empfangsdatum nach DIN 5008 im Format TT.MM.JJJJ.
time Empfangsdatum und -zeit als UNIX-Zeitstempel.
from_username Name des Absenders.
is_user True, falls die Mail von einem registrierten Mitglied kam.
subject Betreffzeile der E-Mail.
mail_id Eindeutige Mail-ID für die Mail in diesem Ordner.
vcard Visitenkarte (vcard) eines Mitglieds. Siehe User/username.
selected System-Ordnername der aktuellen Rückgabe.
Personal tools