NAME
Mail::Box::IMAP4::Message - one message on a IMAP4 server
CLASS INHERITANCE
Mail::Box::IMAP4::Message is a Mail::Box::Net::Message is a Mail::Box::Message is a Mail::Message is a Mail::Reporter
SYNOPSIS
my $folder = new Mail::Box::IMAP4 ...
my $message = $folder->message(10);
DESCRIPTION
A Mail::Box::IMAP4::Message represents one message on a IMAP4 server, maintained by a Mail::Box::IMAP4 folder. Each message is stored as separate entity on the server, and maybe temporarily in your program as well.
METHODS
Initiation
- new OPTIONS
-
OPTION DEFAULT body undef body_type 'Mail::Message::Body::Lines'; deleted <false> field_type undef folder <required> head undef head_type 'Mail::Message::Head::Complete' log 'WARNINGS' messageId undef modified <false> size undef trace 'WARNINGS' trusted <false> unique <unique string>
- body => OBJECT
-
See Mail::Message::new(body)
- body_type => CODE|CLASS
-
See Mail::Box::Message::new(body_type)
- deleted => BOOLEAN
-
See Mail::Box::Message::new(deleted)
- field_type => CLASS
-
See Mail::Message::new(field_type)
- folder => FOLDER
-
See Mail::Box::Message::new(folder)
- head => OBJECT
-
See Mail::Message::new(head)
- head_type => CLASS
-
See Mail::Message::new(head_type)
- log => LEVEL
-
See Mail::Reporter::new(log)
- messageId => STRING
-
See Mail::Message::new(messageId)
- modified => BOOLEAN
-
See Mail::Message::new(modified)
- size => INTEGER
-
See Mail::Box::Message::new(size)
- trace => LEVEL
-
See Mail::Reporter::new(trace)
- trusted => BOOLEAN
-
See Mail::Message::new(trusted)
- unique => STRING
-
See Mail::Box::Net::Message::new(unique)
- unique [STRING]
-
See Mail::Box::Net::Message::unique()
Constructing a Message
- bounce [RG-OBJECT|OPTIONS]
-
See Mail::Message::Construct::bounce()
- build [MESSAGE|BODY], CONTENT
-
See Mail::Message::Construct::build()
- buildFromBody BODY, HEADERS
-
See Mail::Message::Construct::buildFromBody()
- coerce MESSAGE
-
See Mail::Box::Message::coerce()
- forward OPTIONS
-
See Mail::Message::Construct::forward()
- forwardPostlude
-
See Mail::Message::Construct::forwardPostlude()
- forwardPrelude
-
See Mail::Message::Construct::forwardPrelude()
- forwardSubject STRING
-
See Mail::Message::Construct::forwardSubject()
- read FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS
-
See Mail::Message::Construct::read()
-
See Mail::Message::Construct::reply()
- replyPrelude [STRING|FIELD|ADDRESS]
-
See Mail::Message::Construct::replyPrelude()
- replySubject STRING
-
See Mail::Message::Construct::replySubject()
The Message
- clone
-
See Mail::Message::clone()
- copyTo FOLDER
-
See Mail::Box::Message::copyTo()
- folder [FOLDER]
-
See Mail::Box::Message::folder()
- isDummy
-
See Mail::Message::isDummy()
- isPart
-
See Mail::Message::isPart()
- messageId
-
See Mail::Message::messageId()
- modified [BOOLEAN]
-
See Mail::Message::modified()
- moveTo FOLDER
-
See Mail::Box::Message::moveTo()
- parent
-
See Mail::Message::parent()
- print [FILEHANDLE]
-
See Mail::Message::print()
- send [MAILER], OPTIONS
-
See Mail::Message::send()
- seqnr [INTEGER]
-
See Mail::Box::Message::seqnr()
- size
-
Returns the size of this message. If the message is still on the remote server, POP is used to ask for the size. When the message is already loaded onto the local system, the size of the parsed message is taken. These sizes can differ because the difference in line-ending representation.
- toplevel
-
See Mail::Message::toplevel()
The Header
Header Shortcuts
- bcc
-
See Mail::Message::bcc()
- cc
-
See Mail::Message::cc()
- date
-
See Mail::Message::date()
- destinations
-
See Mail::Message::destinations()
- from
-
See Mail::Message::from()
- get FIELD
-
See Mail::Message::get()
- guessTimestamp
-
See Mail::Message::guessTimestamp()
- nrLines
-
See Mail::Message::nrLines()
- sender
-
See Mail::Message::sender()
- subject
-
See Mail::Message::subject()
- timestamp
-
See Mail::Message::timestamp()
- to
-
See Mail::Message::to()
The Body
- body [BODY]
-
See Mail::Message::body()
- decoded OPTIONS
-
See Mail::Message::decoded()
- encode OPTIONS
-
See Mail::Message::encode()
- isMultipart
-
See Mail::Message::isMultipart()
- parts ['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER]
-
See Mail::Message::parts()
Access to the Message
- file
-
See Mail::Message::Construct::file()
- lines
-
See Mail::Message::Construct::lines()
- string
-
See Mail::Message::Construct::string()
Labels
- delete
-
See Mail::Box::Message::delete()
- deleted [BOOLEAN]
-
See Mail::Box::Message::deleted()
- label LABEL, [VALUE, [LABEL, VALUE, ...]]
-
With only one argument, the value related to LABEL is returned. With more that one argument, the list is interpreted a LABEL-VALUE pairs to be set.
The IMAP protocol defines its own names for the labels, which must be set imediately to inform other IMAP clients which may have the same folder open. Some labels are translated to the corresponding IMAP system labels.
- labels
-
See Mail::Message::labels()
Reading and Writing [internals]
- DESTROY
-
See Mail::Message::DESTROY()
- diskDelete
-
See Mail::Box::Message::diskDelete()
- isDelayed
-
See Mail::Message::isDelayed()
- labelsToStatus
-
See Mail::Message::labelsToStatus()
- readBody PARSER, HEAD [, BODYTYPE]
-
See Mail::Box::Message::readBody()
- readFromParser PARSER, [BODYTYPE]
-
See Mail::Message::readFromParser()
- readHead PARSER [,CLASS]
-
See Mail::Message::readHead()
- statusToLabels
-
See Mail::Message::statusToLabels()
- storeBody BODY
-
See Mail::Message::storeBody()
- takeMessageId [STRING]
-
See Mail::Message::takeMessageId()
Logging and Tracing
- defaultTrace [LEVEL, [LEVEL]
-
See Mail::Reporter::defaultTrace()
- errors
-
See Mail::Reporter::errors()
- log [LEVEL [,STRINGS]]
-
See Mail::Reporter::log()
- printStructure [FILEHANDLE][, INDENT]
-
See Mail::Message::Construct::printStructure()
- report [LEVEL]
-
See Mail::Reporter::report()
- reportAll [LEVEL]
-
See Mail::Reporter::reportAll()
- shortString
-
See Mail::Box::Message::shortString()
- trace [LEVEL]
-
See Mail::Reporter::trace()
- warnings
-
See Mail::Reporter::warnings()
Other Methods
- AUTOLOAD
-
See Mail::Reporter::AUTOLOAD()
- inGlobalDestruction
-
See Mail::Reporter::inGlobalDestruction()
- logPriority LEVEL
-
See Mail::Reporter::logPriority()
- logSettings
-
See Mail::Reporter::logSettings()
- notImplemented
-
See Mail::Reporter::notImplemented()
SEE ALSO
A good start to read is Mail::Box-Overview. More documentation and a mailinglist are available from the project's website at http://perl.overmeer.net/mailbox/.
AUTHOR
Written by Mark Overmeer (mark@overmeer.net) with the help of many. See the ChangeLog for details.
VERSION
This code is beta, version 2.032.
Copyright (c) 2001-2002 by the authors. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.