Next:
Yawns::News
Previous:
Yawns::Mailer
 [Table of Contents]

Yawns::Messages



NAME

Yawns::Messages - A module for dealing with user-messaging.

SYNOPSIS

    #!/usr/bin/perl -w

    use Yawns::Messages;
    use strict;

    my $msg   = Yawns::Messages->new( username => $username );

    my ( $new, $total) = $msg->messageCounts();

    my $i = 0;
    while( $i < $total )
    {
      my ( $to, $from, $text ) = $msg->getMessage( $i );
      $i += 1;
    }

DESCRIPTION

This module deals with the static "about" pages we contain.

new

  Create a new instance of this object.

send

  Send a new message to a user.

messageCounts

  Get the total of the messages.

getMessage

  Return an individual message.

  TODO: Caching.

markRead

  Mark a message as read.

markReplied

  Mark a message a replied..

getMessages

  Return an array of all the messages for the given user.

deleteMessage

  Delete a given message.

deleteOldMessages

  Delete messages older than the given number of days

deleteByUser

  Delete all messages for the given user.

invalidateCache

  Clean any cached content we might have.

AUTHOR

Steve Kemp

http://www.steve.org.uk/

LICENSE

Copyright (c) 2005,2006 by Steve Kemp. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license.


[Top] Generated by HTML::FromPod 0.49 on Tue Jan 6 03:03:57 2009