The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Net-Fritz-Phonebook-0.02
River stage zero No dependents
1 ++
/ Net::Fritz::PhonebookEntry

NAME

Net::Fritz::PhonebookEntry - a Fritz!Box phone book entry

ACCESSORS

phonebook

A weak reference to the phone book containing this entry

uniqueid

An opaque value assigned by the Fritz!Box to this entry

phonebookIndex

The index in the phonebook

This is used for entry deletion. I haven't tested whether the FritzBox renumbers items while deleting, so the best approach is likely to delete multiple items starting with the highest-numbered item.

category

The category of this entry

Numeric value, default 0

numbers

Arrayref of the telephone numbers associated with this entry. The elements will be Net::Fritz::PhonebookEntry::Numbers.

email_addresses

Arrayref of the email addresses associated with this entry. The elements will be Net::Fritz::PhonebookEntry::Email objects.

name

The name displayed in the phone book. This will likely be the name of a person.

ringtoneidx

The index of the ringtone to use for this entry?

imageURL

HTTP URL to image for this contact

This must be on the same protocol and host as the Fritz!Box device the phone book resides on!

$contact->build_structure

  my $struct = $contact->build_structure;
  XMLout( $struct );

Returns the contact as a structured hashref that XML::Simple will serialize to the appropriate XML to write a contact.

$contact->add_number( $number, $type='home' )

  $contact->add_number('555-12345');
  $contact->add_number('555-12346', 'fax_work');

Adds a number to the entry. No check is made whether that number is already associated with that phone book entry. You can alternatively pass in a l<Net::Fritz::PhonebookEntry::Number> object.

$contact->add_email( $mail )

  $contact->add_email('example@example.com');

Adds an email address to the entry. No check is made whether that address is already associated with that phone book entry. You can alternatively pass in a l<Net::Fritz::PhonebookEntry::Email> object.

$contact->create()

  $contact->create(); # save to Fritz!Box
  $contact->create(phonebook => $other_phonebook);

Creates the contact in the phonebook given at creation or in the call. The allowed options are

phonebook_id

The id of the phonebook to use

phonebook

The phonebook object to use

If neither the id nor the object are given, the phonebook

REPOSITORY

The public repository of this module is https://github.com/Corion/Net-Fritz-Phonebook.

SUPPORT

The public support forum of this module is https://perlmonks.org/.

BUG TRACKER

Please report bugs in this module via the RT CPAN bug queue at https://rt.cpan.org/Public/Dist/Display.html?Name=Net-Fritz-Phonebook or via mail to net-fritz-phonebook-Bugs@rt.cpan.org.

AUTHOR

Max Maischein corion@cpan.org

COPYRIGHT (c)

Copyright 2017 by Max Maischein corion@cpan.org.

LICENSE

This module is released under the same terms as Perl itself.