.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.15)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Text::vCard::Addressbook 3pm"
.TH Text::vCard::Addressbook 3pm "2011-01-11" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Text::vCard::Addressbook \- a package to parse, edit and create multiple vCards (RFC 2426)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Text::vCard::Addressbook;
\&
\&  my $address_book = Text::vCard::Addressbook\->new({
\&        \*(Aqsource_file\*(Aq => \*(Aq/path/to/address.vcf\*(Aq,
\&  });
\&
\&  foreach my $vcard ($address_book\->vcards()) {
\&        print "Got card for " . $vcard\->fullname() . "\en";
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package provides an \s-1API\s0 to reading / editing and creating
multiple vCards. A vCard is an electronic business card. This package has
been developed based on rfc2426.
.PP
You will find that many applications (Apple Address book, \s-1MS\s0 Outlook,
Evolution etc) can export and import vCards.
.SH "READING IN VCARDS"
.IX Header "READING IN VCARDS"
.SS "\fIload()\fP"
.IX Subsection "load()"
.Vb 1
\&  use Text::vCard::Addressbook;
\&
\&  # Read in from a list of files
\&  my $address_book = Text::vCard::Addressbook\->load( [\*(Aqfoo.vCard\*(Aq, \*(AqAddresses.vcf\*(Aq]);
.Ve
.PP
This method will croak if it is unable to read in any of the files.
.SS "\fIimport_data()\fP"
.IX Subsection "import_data()"
.Vb 1
\&  $address_book\->import_data($value);
.Ve
.PP
This method imports data directly from a string.
.SS "\fInew()\fP"
.IX Subsection "new()"
.Vb 4
\&  # Read in from just one file
\&  my $address_book = Text::vCard::Addressbook\->new({
\&        \*(Aqsource_file\*(Aq => \*(Aq/path/to/address.vcf\*(Aq,
\&  });
.Ve
.PP
This method will croak if it is unable to read in the source_file.
.PP
.Vb 4
\&  # File already in a string
\&  my $address_book = Text::vCard::Addressbook\->new({
\&        \*(Aqsource_text\*(Aq => $source_text,
\&  });
\&
\&  # Create a new address book
\&  my $address_book = Text::vCard::Addressbook\->new();
.Ve
.PP
Looping through all vcards in an address book.
.PP
.Vb 3
\&  foreach my $vcard ($address_book\->vcards()) {
\&        $vcard\->...;
\&  }
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "\fIadd_vcard()\fP"
.IX Subsection "add_vcard()"
.Vb 1
\&  my $vcard = $address_book\->add_vcard();
.Ve
.PP
This method creates a new empty Text::vCard object, stores it in the
address book and return it so you can add data to it.
.SS "\fIvcards()\fP"
.IX Subsection "vcards()"
.Vb 2
\&  my $vcards = $address_book\->vcards();
\&  my @vcards = $address_book\->vcards();
.Ve
.PP
This method returns a reference to an array or an array of
vcards in this address book. This could be an empty list
if there are no entries in the address book.
.SS "\fIset_encoding()\fP"
.IX Subsection "set_encoding()"
.Vb 1
\&  $address_book\->add_vcard(\*(Aqutf\-8\*(Aq);
.Ve
.PP
This method will add the string ';charset=utf\-8' to each and 
every vCard entry. That does help in connection with e.g. an iPhone...
.SS "\fIexport()\fP"
.IX Subsection "export()"
.Vb 1
\&  my $vcf_file = $address_book\->export()
.Ve
.PP
This method returns the vcard data in the vcf file format.
.PP
Please note there is no validation, you must ensure
that the correct nodes (\s-1FN\s0,N,VERSION) are already added
to each vcard if you want to comply with \s-1RFC\s0 2426.
.PP
This might not escape the results correctly
at the moment.
.SH "AUTHOR"
.IX Header "AUTHOR"
Leo Lapworth, LLAP@cuckoo.org
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003 Leo Lapworth. All rights reserved.
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
The authors of Text::vFile::asData for making my life so much easier.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Text::vCard, Text::vCard::Node