YaBB3::Entities::Recipient - A Private Message Recipient


Name

YaBB3::Entities::Recipient - A Private Message Recipient


Synopsis

Synopsis


Overview

A recipient object represents a recipient of a private message.


Description

The recipient object is a user object with additional information about the message. This information is filled by the Message class where it loads the recipient to a message.


Reference

Use Packages

YaBB3::Entities::User

Exports

  Default   $VERSION
  Optional
  Tags

Package Fields

  $VERSION  The package version number as a float.

Package Subroutines

Object Super Classes

YaBB3::Entities::User

Object Fields

mark_as_read

Indicates if the message this object is associated to was read by this recipient.

to_folder_id

The folder in which the message is stored by this recipient.

Record Fields

Object Methods

Getter and Setter methods for object fields


Author

Torsten Mrotz (tmrotz@yabbforum.com)

Copyright ©2005, YaBB 3 Development Team. All Rights Reserved.
You may distribute this module under the terms of YaBB 3.
 YaBB3::Entities::Recipient - A Private Message Recipient