/usr/share/perl5/Mail/Box/Dbx.pod is in libmail-box-perl 2.120-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 | =encoding utf8
=head1 NAME
Mail::Box::Dbx - read Outlook Express folders
=head1 INHERITANCE
Mail::Box::Dbx
is a Mail::Box::File
is a Mail::Box
is a Mail::Reporter
=head1 SYNOPSIS
use Mail::Box::Dbx;
my $folder = Mail::Box::Dbx->new(...);
=head1 DESCRIPTION
This documentation describes how to read from Outlook Express (dbx)
folders. Even on Unix/Linux, you can access these folders to
read the data, or copy it to a different format. Modifying of
xbd files is not supported.
These dbx folders are accessed using Mail::Transport::Dbx which
is distributed via CPAN as separate package. This C<MAil::Transport::Dbx>
module is based on the open source library named C<libpst>, which can
be found at L<http://alioth.debian.org/projects/libpst/>. The library does
not support writing of dbx files, and therefore limits the possibilities
of this package.
Extends L<"DESCRIPTION" in Mail::Box::File|Mail::Box::File/"DESCRIPTION">.
=head1 OVERLOADED
Extends L<"OVERLOADED" in Mail::Box::File|Mail::Box::File/"OVERLOADED">.
=over 4
=item overload: B<"">
Inherited, see L<Mail::Box/"OVERLOADED">
=item overload: B<@{}>
Inherited, see L<Mail::Box/"OVERLOADED">
=item overload: B<cmp>
Inherited, see L<Mail::Box/"OVERLOADED">
=back
=head1 METHODS
Extends L<"METHODS" in Mail::Box::File|Mail::Box::File/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Mail::Box::File|Mail::Box::File/"Constructors">.
=over 4
=item Mail::Box::Dbx-E<gt>B<new>(%options)
-Option --Defined in --Default
access Mail::Box always 'r'
body_delayed_type Mail::Box Mail::Message::Body::Delayed
body_type Mail::Box::File <see description>
coerce_options Mail::Box []
create Mail::Box not implemented
extract Mail::Box 10240
field_type Mail::Box undef
fix_headers Mail::Box <false>
folder Mail::Box =Folders.dbx
folderdir Mail::Box .
head_delayed_type Mail::Box Mail::Message::Head::Delayed
head_type Mail::Box Mail::Message::Head::Complete
keep_dups Mail::Box <false>
lock_extension Mail::Box::File '.lock'
lock_file Mail::Box <foldername><lock-extension>
lock_timeout Mail::Box 1 hour
lock_type Mail::Box 'NONE'
lock_wait Mail::Box 10 seconds
locker Mail::Box undef
log Mail::Reporter 'WARNINGS'
manager Mail::Box undef
message_type Mail::Box Mail::Box::Dbx::Message
multipart_type Mail::Box Mail::Message::Body::Multipart
remove_when_empty Mail::Box not implemented
save_on_exit Mail::Box not implemented
trace Mail::Reporter 'WARNINGS'
trusted Mail::Box <depends on folder location>
write_policy Mail::Box::File not implemented
=over 2
=item access => MODE
=item body_delayed_type => CLASS
=item body_type => CLASS|CODE
=item coerce_options => ARRAY
=item create => BOOLEAN
=item extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'
=item field_type => CLASS
=item fix_headers => BOOLEAN
=item folder => FOLDERNAME
=item folderdir => DIRECTORY
=item head_delayed_type => CLASS
=item head_type => CLASS
=item keep_dups => BOOLEAN
=item lock_extension => FILENAME|STRING
=item lock_file => FILENAME
=item lock_timeout => SECONDS
=item lock_type => CLASS|STRING|ARRAY
=item lock_wait => SECONDS
=item locker => OBJECT
=item log => LEVEL
=item manager => MANAGER
=item message_type => CLASS
=item multipart_type => CLASS
=item remove_when_empty => BOOLEAN
=item save_on_exit => BOOLEAN
=item trace => LEVEL
=item trusted => BOOLEAN
=item write_policy => 'REPLACE'|'INPLACE'|undef
=back
=back
=head2 The folder
Extends L<"The folder" in Mail::Box::File|Mail::Box::File/"The folder">.
=over 4
=item $obj-E<gt>B<addMessage>($message, %options)
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<addMessages>(@messages)
Inherited, see L<Mail::Box/"The folder">
=item Mail::Box::Dbx-E<gt>B<appendMessages>(%options)
Inherited, see L<Mail::Box::File/"METHODS">
=item $obj-E<gt>B<close>(%options)
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<copyTo>($folder, %options)
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<delete>(%options)
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<filename>()
Inherited, see L<Mail::Box::File/"The folder">
=item $obj-E<gt>B<folderdir>( [$directory] )
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<name>()
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<organization>()
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<size>()
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<type>()
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<update>(%options)
Inherited, see L<Mail::Box/"The folder">
=item $obj-E<gt>B<url>()
Inherited, see L<Mail::Box/"The folder">
=back
=head2 Folder flags
Extends L<"Folder flags" in Mail::Box::File|Mail::Box::File/"Folder flags">.
=over 4
=item $obj-E<gt>B<access>()
Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<isModified>()
Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<modified>( [BOOLEAN] )
Inherited, see L<Mail::Box/"Folder flags">
=item $obj-E<gt>B<writable>()
Inherited, see L<Mail::Box/"Folder flags">
=back
=head2 The messages
Extends L<"The messages" in Mail::Box::File|Mail::Box::File/"The messages">.
=over 4
=item $obj-E<gt>B<current>( [$number|$message|$message_id] )
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<find>($message_id)
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<findFirstLabeled>( $label, [BOOLEAN, [$msgs]] )
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<message>( $index, [$message] )
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageId>( $message_id, [$message] )
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messageIds>()
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<messages>( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<nrMessages>(%options)
Inherited, see L<Mail::Box/"The messages">
=item $obj-E<gt>B<scanForMessages>($message, $message_ids, $timespan, $window)
Inherited, see L<Mail::Box/"The messages">
=back
=head2 Sub-folders
Extends L<"Sub-folders" in Mail::Box::File|Mail::Box::File/"Sub-folders">.
=over 4
=item $obj-E<gt>B<listSubFolders>(%options)
=item Mail::Box::Dbx-E<gt>B<listSubFolders>(%options)
It is advised to set the C<check> flag, because dbx folder often list
large amounts of folder names which do not really exist. However, checking
does consume some time.
-Option --Defined in --Default
check Mail::Box <false>
folder Mail::Box <from calling object>
folderdir Mail::Box <from folder>
skip_empty Mail::Box <false>
=over 2
=item check => BOOLEAN
=item folder => FOLDERNAME
=item folderdir => DIRECTORY
=item skip_empty => BOOL
=back
=item $obj-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
=item Mail::Box::Dbx-E<gt>B<nameOfSubFolder>( $subname, [$parentname] )
Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<openRelatedFolder>(%options)
Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<openSubFolder>($subname, %options)
Inherited, see L<Mail::Box/"Sub-folders">
=item $obj-E<gt>B<topFolderWithMessages>()
=item Mail::Box::Dbx-E<gt>B<topFolderWithMessages>()
Inherited, see L<Mail::Box/"Sub-folders">
=back
=head2 Internals
Extends L<"Internals" in Mail::Box::File|Mail::Box::File/"Internals">.
=over 4
=item $obj-E<gt>B<coerce>($message, %options)
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<create>($foldername, %options)
=item Mail::Box::Dbx-E<gt>B<create>($foldername, %options)
Creation is not supported for dbx folders.
-Option --Defined in--Default
folderdir Mail::Box undef
=over 2
=item folderdir => DIRECTORY
=back
=item $obj-E<gt>B<determineBodyType>($message, $head)
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<folderToFilename>($foldername, $folderdir)
=item Mail::Box::Dbx-E<gt>B<folderToFilename>($foldername, $folderdir)
Translate a folder name into a filename, using the
$folderdir value to replace a leading C<=>.
=item Mail::Box::Dbx-E<gt>B<foundIn>( [$foldername], %options )
If no $foldername is specified, then the value of the C<folder> option
is taken. A dbx folder is a file which name ends on C<.dbx> (case
insensitive).
-Option --Defined in --Default
folder undef
folderdir Mail::Box undef
=over 2
=item folder => FOLDERNAME
=item folderdir => DIRECTORY
=back
=item $obj-E<gt>B<lineSeparator>( [<STRING|'CR'|'LF'|'CRLF'>] )
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<locker>()
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<messageCreateOptions>( [$type, $config] )
Inherited, see L<Mail::Box::File/"Internals">
=item $obj-E<gt>B<moveAwaySubFolder>($directory, $extension)
Inherited, see L<Mail::Box::File/"Internals">
=item $obj-E<gt>B<parser>()
The parsing of messages is a combined job for the Mail::Transport::Dbx
module (to get the right data) and L<read()|Mail::Box/"Internals">. Asking for the parser
will provide the transporter object. If asked more than once, each time
the same object will be returned.
=item $obj-E<gt>B<read>(%options)
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<readMessages>(%options)
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<storeMessage>($message)
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<toBeThreaded>($messages)
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<toBeUnthreaded>($messages)
Inherited, see L<Mail::Box/"Internals">
=item $obj-E<gt>B<updateMessages>(%options)
Inherited, see L<Mail::Box::File/"Internals">
=item $obj-E<gt>B<write>(%options)
Inherited, see L<Mail::Box::File/"Internals">
=item $obj-E<gt>B<writeMessages>(%options)
Inherited, see L<Mail::Box/"Internals">
=back
=head2 Other methods
Extends L<"Other methods" in Mail::Box::File|Mail::Box::File/"Other methods">.
=over 4
=item $obj-E<gt>B<timespan2seconds>($time)
=item Mail::Box::Dbx-E<gt>B<timespan2seconds>($time)
Inherited, see L<Mail::Box/"Other methods">
=back
=head2 Error handling
Extends L<"Error handling" in Mail::Box::File|Mail::Box::File/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>($object)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
=item Mail::Box::Dbx-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>( [$level, [$strings]] )
=item Mail::Box::Dbx-E<gt>B<log>( [$level, [$strings]] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>($level)
=item Mail::Box::Dbx-E<gt>B<logPriority>($level)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
Extends L<"Cleanup" in Mail::Box::File|Mail::Box::File/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
Inherited, see L<Mail::Box/"Cleanup">
=back
=head2 DETAILS
Extends L<"DETAILS" in Mail::Box::File|Mail::Box::File/"DETAILS">.
=head1 DETAILS
Extends L<"DETAILS" in Mail::Box::File|Mail::Box::File/"DETAILS">.
=head2 Different kinds of folders
Extends L<"Different kinds of folders" in Mail::Box::File|Mail::Box::File/"Different kinds of folders">.
=head2 Available folder types
Extends L<"Available folder types" in Mail::Box::File|Mail::Box::File/"Available folder types">.
=head2 Folder class implementation
Extends L<"Folder class implementation" in Mail::Box::File|Mail::Box::File/"Folder class implementation">.
=head2 How DBX folders work
DBX files are create by Outlook Express. I can not tell you too much
about it, because me (as author) never use Windows or MicroSoft tools.
Still, it is possible to access some Outlook created folders from Unix.
The folder structure for dbx starts with a single C<Folders.dbx>
file. This folder contains names of sub-folders. Each folder can
either contain messages, or contains sub-folders. Combinations are
not possible.
=head2 This implementation
The ol2mbox project (see L<http://sourceforge.net/project/ol2mbox/>)
has created a C<libdbx> which can read dbx files using nearly any
operating system. You can simply transport a dbx file from Windows
to Unix/Linux and the read all the messages from it.
Tassilo von Parseval wrote a Perl wrapper around this C-library,
and distributes it as Mail::Transport::Dbx. Although it named in
one the MailBox namespaces, it is a separate product, because it
requires a C compiler. Besides, the module will have its own life.
=head2 Converting DBX folders to MBOX
The title of this section is to attract your attension, but is does
not describe anything special related to DBX or MBOX: you can convert
any kind of mail folder into another with the following code.
B<. Example: converting folders>
my $from = Mail::Box::Dbx->new(folder => 'Folder.dbx')
or exit;
my $to = Mail::Box::Mbox->new(folder => '/tmp/mbox',
access => 'w', create => 1) or die;
$from->copyTo($to);
=head1 DIAGNOSTICS
=over 4
=item Error: Cannot append messages to folder file $filename: $!
Appending messages to a not-opened file-organized folder may fail when the
operating system does not allow write access to the file at hand.
=item Error: Cannot move away sub-folder $dir
=item Error: Cannot read dbx folder file $filename.
=item Warning: Cannot remove folder $name file $filename: $!
Writing an empty folder will usually cause that folder to be removed,
which fails for the indicated reason. L<new(remove_when_empty)|Mail::Box/"Constructors">
=item Warning: Cannot remove folder $name file $filename: $!
Writing an empty folder will usually cause that folder to be removed,
which fails for the indicated reason. L<new(remove_when_empty)|Mail::Box/"Constructors">
controls whether the empty folder will removed; setting it to false
(C<0>) may be needed to avoid this message.
=item Error: Cannot replace $filename by $tempname, to update folder $name: $!
The replace policy wrote a new folder file to update the existing, but
was unable to give the final touch: replacing the old version of the
folder file for the indicated reason.
=item Warning: Changes not written to read-only folder $self.
You have opened the folder read-only --which is the default set
by L<new(access)|Mail::Box/"Constructors">--, made modifications, and now want to close it.
Set L<close(force)|Mail::Box/"The folder"> if you want to overrule the access mode, or close
the folder with L<close(write)|Mail::Box/"The folder"> set to C<NEVER>.
=item Error: Copying failed for one message.
For some reason, for instance disc full, removed by external process, or
read-protection, it is impossible to copy one of the messages. Copying will
proceed for the other messages.
=item Warning: Dbx folders are read-only.
=item Error: Destination folder $name is not writable.
The folder where the messages are copied to is not opened with write
access (see L<new(access)|Mail::Box/"Constructors">). This has no relation with write permission
to the folder which is controled by your operating system.
=item Warning: Different messages with id $msgid
The message id is discovered more than once within the same folder, but the
content of the message seems to be different. This should not be possible:
each message must be unique.
=item Error: File too short to get write message $nr ($size, $need)
Mail::Box is lazy: it tries to leave messages in the folders until they
are used, which saves time and memory usage. When this message appears,
something is terribly wrong: some lazy message are needed for updating the
folder, but they cannot be retrieved from the original file anymore. In
this case, messages can be lost.
This message does appear regularly on Windows systems when using the
'replace' write policy. Please help to find the cause, probably something
to do with Windows incorrectly handling multiple filehandles open in the
same file.
=item Error: Folder $name not deleted: not writable.
The folder must be opened with write access via L<new(access)|Mail::Box/"Constructors">, otherwise
removing it will be refused. So, you may have write-access according to
the operating system, but that will not automatically mean that this
C<delete> method permits you to. The reverse remark is valid as well.
=item Error: Invalid timespan '$timespan' specified.
The string does not follow the strict rules of the time span syntax which
is permitted as parameter.
=item Warning: Message-id '$msgid' does not contain a domain.
According to the RFCs, message-ids need to contain a unique random part,
then an C<@>, and then a domain name. This is made to avoid the creation
of two messages with the same id. The warning emerges when the C<@> is
missing from the string.
=item Error: Package $package does not implement $method.
Fatal error: the specific package (or one of its superclasses) does not
implement this method where it should. This message means that some other
related classes do implement this method however the class at hand does
not. Probably you should investigate this and probably inform the author
of the package.
=item Error: Unable to create subfolder $name of $folder.
The copy includes the subfolders, but for some reason it was not possible
to copy one of these. Copying will proceed for all other sub-folders.
=item Error: Unable to update folder $self.
When a folder is to be written, both replace and inplace write policies are
tried, If both fail, the whole update fails. You may see other, related,
error messages to indicate the real problem.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.120,
built on September 21, 2016. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2016 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|