See METHODS in Mail::Reporter
Option | Defined in | Default |
---|---|---|
access | Mail::Box |
|
body_delayed_type | Mail::Box | |
body_type | Mail::Box | |
coerce_options | Mail::Box |
|
create | Mail::Box | <false> |
directory | Mail::Box::Dir | <derived from folder name> |
extract | Mail::Box |
|
field_type | Mail::Box | undef |
fix_headers | Mail::Box | <false> |
folder | Mail::Box |
|
folderdir | Mail::Box |
|
head_delayed_type | Mail::Box | |
head_type | Mail::Box | |
index | undef | |
index_filename | <foldername> | |
index_type | ||
keep_dups | Mail::Box | <false> |
keep_index | 0 | |
labels | undef | |
labels_filename | <foldername> | |
labels_type | ||
lock_file | Mail::Box | <index_file> |
lock_timeout | Mail::Box | 1 hour |
lock_type | Mail::Box | |
lock_wait | Mail::Box | 10 seconds |
locker | Mail::Box | undef |
log | Mail::Reporter |
|
manager | Mail::Box | undef |
message_type | Mail::Box | <folder-class>::Message |
multipart_type | Mail::Box | |
remove_when_empty | Mail::Box | <true> |
save_on_exit | Mail::Box | <true> |
trace | Mail::Reporter |
|
trusted | Mail::Box | <depends on folder location> |
Append a message to a folder which is not open.
Option | Defined in | Default |
---|---|---|
folder | Mail::Box | <required> |
message | Mail::Box | undef |
messages | Mail::Box | undef |
share | Mail::Box | <false> |
It is impossible to append one or more messages to the folder which is not opened, because locking it failes. The folder may be in use by an other application, or you may need to specify some lock related options (see new()).
The new message could not be written to its new file, for the specific reason.
Option | Defined in | Default |
---|---|---|
folderdir | Mail::Box | undef |
For some reason, it is impossible to create the folder. Check the permissions and the name of the folder. Does the path to the directory to be created exist?
Returns the highest number which is used in the folder to store a file. This method may be called when the folder is read (then this number can be derived without file-system access), but also when the folder is not read (yet).
Create a index reader/writer object.
Create a label reader/writer object.
Option | Defined in | Default |
---|---|---|
messages | Mail::Box | <required> |
renumber | <true> |
It is impossible to get a lock on the folder, which means that the changes can not be made. You may need to tune the lock related options which are available at folder creation.