Net::ICal::Attendee - represents an attendee or organizer of a meeting


Net-ICal documentation  | view source Contained in the Net-ICal distribution.

Index


NAME

Top

Net::ICal::Attendee -- represents an attendee or organizer of a meeting

SYNOPSIS

Top

  use Net::ICal;
  $a = new Net::ICal::Attendee('mailto:alice@example.com');
  $a = new Net::ICal::Attendee('mailto:alice@example.com',
				cn => 'Alice Anders',
                role => 'REQ-PARTICIPANT');

DESCRIPTION

Top

Net::ICal::Attendee provides an interface to manipulate attendee data in iCalendar (RFC2445) format.

METHODS

Top

new($calid, $hash)

New will take a string and optional key-value pairs. The string is the calender user address of the Attendee (usually a mailto uri).

    $a = new Net::ICal::Attendee('mailto:alice@example.com');
    $a = new Net::ICal::Attendee('mailto:alice@example.com',
                                  cn => 'Alice Anders',
                                  role => 'REQ-PARTICIPANT');

Meaningful hash keys are:

* cn - common name - the name most people use for this attendee.
* cutype - type of user this attendee represents. Meaningful values are INDIVIDUAL, GROUP, ROOM, RESOURCE, UNKNOWN.
* delegated_from - the user who delegated a meeting request to this attendee.
* delegated_to - the user who's been delegated to handle meeting requests for this attendee.
* dir - a URI that gives a directory entry associated with the user.
* partstat - whether this attendee will actually be at a meeting. Meaningful values are NEEDS-ACTION, ACCEPTED, DECLINED, TENTATIVE, DELEGATED, COMPLETED, or IN-PROCESS.
* role - how this attendee will participate in a meeting. Meaningful values are REQ-PARTICIPANT, OPT-PARTICIPANT, NON-PARTICIPANT, and CHAIR.
* rsvp - should the user send back a response to this request? Valid values are TRUE and FALSE. FALSE is the default.
* sent_by - specifies a user who is acting on behalf of this attendee; for example, a secretary for his/her boss, or a parent for his/her 10-year-old.

To understand more about the uses for each of these properties, read the source for this module and and look at RFC2445.

sub new { my ($class, $value, %args) = @_;

   $args{content} = $value;

   #TODO: rsvp should default to false; see rfc2445 4.2.17 and SF bug 424101

   my $self = _create ($class, %args);

   return undef unless $self;

   return undef unless $self->validate;

   return $self;
}

validate

Returns 1 for valid attendee data, undef for invalid.

SEE ALSO

Top

More documentation pointers can be found in Net::ICal.


Net-ICal documentation  | view source Contained in the Net-ICal distribution.