/usr/share/perl5/Mail/Box/Manage/User.pod is in libmail-box-perl 2.099-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 | =head1 NAME
Mail::Box::Manage::User - manage the folders of a user
=head1 INHERITANCE
Mail::Box::Manage::User
is a Mail::Box::Manager
is a Mail::Reporter
=head1 SYNOPSIS
use Mail::Box::Manage::User;
use User::Identity;
my $id = User::Identity->new(...);
my $user = Mail::Box::Manage::User->new
( identity => $id
, folderdir => "$ENV{HOME}/Mail"
, inbox => $ENV{MAIL}
);
my $inbox = $user->open($user->inbox);
my $top = $user->topfolder;
=head1 DESCRIPTION
Where the L<Mail::Box::Manager|Mail::Box::Manager> takes care of some set of open folder,
this extension will add knowledge about some related person. At the
same time, it will try to cache some information about that person's
folder files.
=head1 METHODS
=head2 Constructors
=over 4
=item Mail::Box::Manage::User-E<gt>B<new>(ARGS)
Use L<new(default_folder_type)|Mail::Box::Manager/"METHODS"> to explicitly state which kind of folders
you use.
-Option --Defined in --Default
autodetect Mail::Box::Manager undef
collection_type Mail::Box::Collection
default_folder_type Mail::Box::Manager 'mbox'
delimiter "/"
folder_id_type Mail::Box::Identity
folder_types Mail::Box::Manager <all standard types>
folderdir Mail::Box::Manager [ '.' ]
folderdirs Mail::Box::Manager <synonym for C<folderdir>>
identity <required>
inbox undef
log Mail::Reporter 'WARNINGS'
topfolder_name '='
trace Mail::Reporter 'WARNINGS'
=over 2
=item autodetect => TYPE|ARRAY-OF-TYPES
=item collection_type => CLASS
Subfolders grouped together.
=item default_folder_type => NAME|CLASS
=item delimiter => STRING
The separator used in folder names. This doesn't need to be the
same as your directory system is using.
=item folder_id_type => CLASS|OBJECT
=item folder_types => NEW-TYPE | ARRAY-OF-NEW-TYPES
=item folderdir => DIRECTORY
=item folderdirs => [DIRECTORIES]
=item identity => OBJECT
The main difference between the L<Mail::Box::Manager|Mail::Box::Manager> and this class, is
the concept of some person (or virtual person) who's files are being
administered by this object. The OBJECT is an L<User::Identity|User::Identity>.
The smallest identity that will do:
C<< my $id = User::Identity->new('myname') >>
=item inbox => NAME
The name of the user's inbox.
=item log => LEVEL
=item topfolder_name => STRING
=item trace => LEVEL
=back
=back
=head2 Attributes
=over 4
=item $obj-E<gt>B<defaultFolderType>
See L<Mail::Box::Manager/"Attributes">
=item $obj-E<gt>B<folderTypes>
See L<Mail::Box::Manager/"Attributes">
=item $obj-E<gt>B<folderdir>
See L<Mail::Box::Manager/"Attributes">
=item $obj-E<gt>B<identity>
Returns a L<User::Identity|User::Identity> object.
=item $obj-E<gt>B<inbox>([NAME])
(Set and) get the NAME of the mailbox which is considered the folder
for incoming mail. In many protocols, this folder is handled separately.
For instance in IMAP this is the only case-insensitive folder name.
=item $obj-E<gt>B<registerType>(TYPE, CLASS [,OPTIONS])
See L<Mail::Box::Manager/"Attributes">
=back
=head2 Manage open folders
=over 4
=item $obj-E<gt>B<close>(FOLDER, OPTIONS)
See L<Mail::Box::Manager/"Manage open folders">
=item $obj-E<gt>B<closeAllFolders>(, OPTIONS)
See L<Mail::Box::Manager/"Manage open folders">
=item $obj-E<gt>B<isOpenFolder>(FOLDER)
See L<Mail::Box::Manager/"Manage open folders">
=item $obj-E<gt>B<open>([FOLDERNAME], OPTIONS)
See L<Mail::Box::Manager/"Manage open folders">
=item $obj-E<gt>B<openFolders>
See L<Mail::Box::Manager/"Manage open folders">
=back
=head2 Manage existing folders
=over 4
=item $obj-E<gt>B<create>(NAME, OPTIONS)
Creates a new folder with the specified name. An folder's administrative
structure (L<Mail::Box::Identity|Mail::Box::Identity>) is returned, but the folder is not
opened.
In the accidental case that the folder already
exists, a warning will be issued, and an empty list/undef returned.
The OPTIONS are passed to L<Mail::Box::create()|Mail::Box/"Internals"> of your default folder
type, except for the options intended for this method itself.
-Option --Default
create_real <true>
create_supers <false>
deleted <false>
id_options []
=over 2
=item create_real => BOOLEAN
When this option is false, the pysical folder will not be created, but
only the administration is updated.
=item create_supers => BOOLEAN
When you create a folder where upper hierarchy level are missing, they
will be created as well.
=item deleted => BOOLEAN
The folder starts as deleted.
=item id_options => ARRAY
Values passed to the instantiated L<Mail::Box::Identity|Mail::Box::Identity>. That object
is very picky about the initiation values it accepts.
=back
=item $obj-E<gt>B<delete>(NAME)
Remove all signs from the folder on the file-system. Messages still in
the folder will be removed. This method returns a true value when the
folder has been removed or not found, so "false" means failure.
It is also possible to delete a folder using C<< $folder->delete >>,
which will call this method here. OPTIONS, which are used for some
other folder types, will be ignored here: the user's index contains the
required details.
-Option --Defined in --Default
recursive Mail::Box::Manager <folder's default>
=over 2
=item recursive => BOOLEAN
=back
example: how to delete a folder
print "no xyz (anymore)\n" if $user->delete('xyz');
=item $obj-E<gt>B<folder>(NAME)
Returns the folder description, a L<Mail::Box::Identity|Mail::Box::Identity>.
=item $obj-E<gt>B<folderCollection>(NAME)
Returns a pair: the folder collection (L<Mail::Box::Collection|Mail::Box::Collection>) and
the base name of NAME.
=item $obj-E<gt>B<rename>(OLDNAME, NEWNAME, OPTIONS)
Rename the folder with name OLDNAME to NEWNAME. Both names are full
pathnames.
-Option --Default
create_supers <false>
=over 2
=item create_supers => BOOLEAN
When you rename a folder to a place where upper hierarchy levels are
missing, they will get be defined, but with the deleted flag set.
=back
=item $obj-E<gt>B<topfolder>
Returns the top folder of the user's mailbox storage.
=back
=head2 Move messages to folders
=over 4
=item $obj-E<gt>B<appendMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
See L<Mail::Box::Manager/"Move messages to folders">
=item $obj-E<gt>B<copyMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
See L<Mail::Box::Manager/"Move messages to folders">
=item $obj-E<gt>B<moveMessage>([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)
See L<Mail::Box::Manager/"Move messages to folders">
=back
=head2 Manage message threads
=over 4
=item $obj-E<gt>B<threads>([FOLDERS], OPTIONS)
See L<Mail::Box::Manager/"Manage message threads">
=back
=head2 Internals
=over 4
=item $obj-E<gt>B<decodeFolderURL>(URL)
See L<Mail::Box::Manager/"Internals">
=item $obj-E<gt>B<toBeThreaded>(FOLDER, MESSAGES)
See L<Mail::Box::Manager/"Internals">
=item $obj-E<gt>B<toBeUnthreaded>(FOLDER, MESSAGES)
See L<Mail::Box::Manager/"Internals">
=back
=head2 Error handling
=over 4
=item $obj-E<gt>B<AUTOLOAD>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>(OBJECT)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Box::Manage::User-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
=item Mail::Box::Manage::User-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Box::Manage::User-E<gt>B<logPriority>(LEVEL)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
=over 4
=item $obj-E<gt>B<DESTROY>
See L<Mail::Reporter/"Cleanup">
=item $obj-E<gt>B<inGlobalDestruction>
See L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: Cannot create $name: higher levels missing
Unless you set L<create(create_supers)|Mail::Box::Manage::User/"Manage existing folders">, all higher level folders must
exist before this new one can be created.
=item Error: Cannot rename $name to $new: higher levels missing
Unless you set L<create(create_supers)|Mail::Box::Manage::User/"Manage existing folders">, all higher level folders must
exist before this new one can be created.
=item Error: Folder $name is already open.
You cannot ask the manager for a folder which is already open. In some
older releases (before MailBox 2.049), this was permitted, but then
behaviour changed, because many nasty side-effects are to be expected.
For instance, an L<Mail::Box::update()|Mail::Box/"The folder"> on one folder handle would
influence the second, probably unexpectedly.
=item Error: Folder $name is not a Mail::Box; cannot add a message.
The folder where the message should be appended to is an object which is
not a folder type which extends L<Mail::Box|Mail::Box>. Probably, it is not a folder
at all.
=item Warning: Folder does not exist, failed opening $type folder $name.
The folder does not exist and creating is not permitted (see
L<open(create)|Mail::Box::Manager/"Manage open folders">) or did not succeed. When you do not have sufficient
access rights to the folder (for instance wrong password for POP3),
this warning will be produced as well.
The manager tried to open a folder of the specified type. It may help
to explicitly state the type of your folder with the C<type> option.
There will probably be another warning or error message which is related
to this report and provides more details about its cause. You may also
have a look at L<new(autodetect)|Mail::Box::Manager/"METHODS"> and L<new(folder_types)|Mail::Box::Manager/"METHODS">.
=item Warning: Folder type $type is unknown, using autodetect.
The specified folder type (see L<open(type)|Mail::Box::Manager/"Manage open folders">, possibly derived from
the folder name when specified as url) is not known to the manager.
This may mean that you forgot to require the L<Mail::Box|Mail::Box> extension
which implements this folder type, but probably it is a typo. Usually,
the manager is able to figure-out which type to use by itself.
=item Error: Illegal folder URL '$url'.
The folder name was specified as URL, but not according to the syntax.
See L<decodeFolderURL()|Mail::Box::Manager/"Internals"> for an description of the syntax.
=item Error: No foldername specified to open.
C<open()> needs a folder name as first argument (before the list of options),
or with the C<folder> option within the list. If no name was found, the
MAIL environment variable is checked. When even that does not result in
a usable folder, then this error is produced. The error may be caused by
an accidental odd-length option list.
=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 remove folder $dir
=item Error: Use appendMessage() to add messages which are not in a folder.
You do not need to copy this message into the folder, because you do
not share the message between folders.
=item Warning: Use moveMessage() or copyMessage() to move between open folders.
The message is already part of a folder, and now it should be appended
to a different folder. You need to decide between copy or move, which
both will clone the message (not the body, because they are immutable).
=item Warning: Will never create a folder $name without having write access.
You have set L<open(create)|Mail::Box::Manager/"Manage open folders">, but only want to read the folder. Create is
only useful for folders which have write or append access modes
(see L<Mail::Box::new(access)|Mail::Box/"Constructors">).
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.099,
built on July 07, 2011. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2011 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>
|