Class org.omus.msg.Mail

Implemented Interfaces

iObservable iMessageHandler

Description

Cette classe gère des objets Mail. Chaque client a deux mailBox : outBox and inBox. La référence à celles-ci s'obtient via User.

Evénements auxquels s'abonner :

Cette classe est aggrémentée par composition des méthodes des sources d'événements (EventDispatcher). Elle est aggrémentée par composition de la classe MessageHandler.

See Also

Field Index

row

Method Index

new Mail()
addHandler(), addListener(), countListeners(), getAttachment(), getDate(), getMailbox(), getRecipient(), getSender(), getSubject(), handleMessage(), init(), isLoaded(), isUnread(), loadAttachment(), mark(), remove(), removeAllListeners(), removeListener(), send(), toLog(), toString()

Constructor Detail

Mail

public function Mail(subj:String)

L'objet Mail dispose des méthodes d'EventDispatcher et de celles de MessageHandler par composition.

Parameters

subjSujet du mail.

See Also

Field Detail

row

public row:Object
Conteneur des données du message courant.

Method Detail

toString

public function toString():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet

init

public function init(box:Mailbox, row:Object):Void

Initailisation d'un message.

getMailbox

public function getMailbox():Mailbox

Renvoie la boîte de réception du message courant.

Return

Une référence à Mailbox entrante ou sortante.

getSubject

public function getSubject():String

Renvoie le sujet du message courant.

Return

Le sujet sous forme de chaîne.

getSender

public function getSender():String

Renvoie l'envoyeur du message courant.

Return

Le nom du membre.

getRecipient

public function getRecipient():String

Renvoie le destinataire du message courant.

Return

Le nom de l'utilisateur destinataire.

getAttachment

public function getAttachment():Object

Renvoie le message joint comprenant notamment le body du message. Celui-ci se chargera à la demande avec la méthode loadAttachment.

Return

L'attachement joint au message courant. Tous les types du framework Oregano sont permis.

See Also

getDate

public function getDate():Date

Renvoie la date d'envoi du message courant.

Return

Une date d'envoi.

isUnread

public function isUnread():Boolean

Renvoie l'état de lecture du message courant.

Return

true si le message n'est pas lu.

isLoaded

public function isLoaded():Boolean

Renseigne l'état de chargment de l'attachement du message courant.

Return

true si l'attachement est chargé sur le poste client.

send

public function send(recipient:String):Void

Envoi du message courant. Une copie est placée automatiquement dans l'outBox.

Parameters

recipientLe nom du destinataire.

loadAttachment

public function loadAttachment():Void

Charge le message joint du Mail courant.

remove

public function remove():Void

Supprime ce message de la boîte auquel il appartient.

mark

public function mark(asRead:Boolean):Void

Signale le message comme lu / non lu.

Parameters

asReadtrue si lu, false pour non lu.

addListener

public function addListener(listener:Object):Boolean

Ajoute un nouvel observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

addListener() in org.omus.util.iObservable

removeListener

public function removeListener(listener:Object):Boolean

Supprime un observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

removeListener() in org.omus.util.iObservable

removeAllListeners

public function removeAllListeners():Void

Supprime tous les abonnés.

Specified By

removeAllListeners() in org.omus.util.iObservable

countListeners

public function countListeners():Number

Retourne le nombre d'observateurs.

Return

Le nombre d'observateurs enregistrés.

Specified By

countListeners() in org.omus.util.iObservable

handleMessage

public function handleMessage(env:Envelope):Void

Active la gestion d'un type de message par accusé de réception en fonction du contenu de son enveloppe.

Parameters

envUne référence à l'enveloppe.

Specified By

handleMessage() in org.omus.msg.iMessageHandler

addHandler

public function addHandler(subject:String, methodName:String):Void

Rajoute un gestionnaire chargé d'intercepter la réponse du serveur suite à un message soumis. Forme d'accusé de réception (callback).

Parameters

subjectLe type de message.
methodNameLe nom de l'événement gérant un type de message.

Specified By

addHandler() in org.omus.msg.iMessageHandler

toLog

static public function toLog():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet.