The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Mail-Box-2.066
River stage one • 8 direct dependents • 8 total dependents
16 ++
/ Mail::Message::Replace::MailInternet

NAME

Mail::Message::Replace::MailInternet - fake Mail::Internet

INHERITANCE

 Mail::Message::Replace::MailInternet
   is a Mail::Message
   is a Mail::Reporter

SYNOPSIS

 !!! BETA !!!

 # change
 use Mail::Internet;
 # into
 use Mail::Message::Replace::MailInternet;
 # in existing code, and the code should still work, but
 # with the Mail::Message features.

DESCRIPTION

This module is a wrapper around a Mail::Message, which simulates a Mail::Internet object. The name-space of that module is hijacked and many methods are added.

Most methods will work without any change, but you may need to have a look at your smtpsend() and send() calls.

OVERLOADED

METHODS

Constructors

$obj->clone(OPTIONS)

$obj->dup

    Duplicate the message. The result will again be a Mail::Internet compatible object.

$obj->empty

    Remove all data from this object. Very dangerous!

Mail::Message::Replace::MailInternet->new([ARG], [OPTIONS])

Attributes

$obj->MailFrom([STRING])

    Your email address.

Constructing a message

$obj->add_signature([FILENAME])

    Replaced by sign(), but still usable. FILENAME is the file which contains the signature, which defaults to $ENV{HOME}/.signature.

$obj->bounce([RG-OBJECT|OPTIONS])

Mail::Message::Replace::MailInternet->build([MESSAGE|PART|BODY], CONTENT)

Mail::Message::Replace::MailInternet->buildFromBody(BODY, [HEAD], HEADERS)

$obj->extract(ARRAY or FILEHANDLE)

    Read header and body from an ARRAY or FILEHANDLE

$obj->forward(OPTIONS)

$obj->forwardAttach(OPTIONS)

$obj->forwardEncapsulate(OPTIONS)

$obj->forwardInline(OPTIONS)

$obj->forwardNo(OPTIONS)

$obj->forwardPostlude

$obj->forwardPrelude

$obj->forwardSubject(STRING)

$obj->read(ARRAY|FILEHANDLE, OPTIONS)

Mail::Message::Replace::MailInternet->read(ARRAY|FILEHANDLE, OPTIONS)

    Read header and body from the specified ARRAY or FILEHANDLE. When used as object method, Mail::Message::read() is called, to be MailBox compliant. As class method, the Mail::Internet compatible read is called. OPTIONS are only available in the first case.

    -Option --Defined in --Default body_type Mail::Message::Construct::Read undef strip_status_fields Mail::Message::Construct::Read <true>

    . body_type CLASS

    . strip_status_fields BOOLEAN

$obj->read_body(ARRAY|FILEHANDLE)

    Read only the message's body from the ARRAY or FILEHANDLE.

$obj->read_header(ARRAY|FILEHANDLE)

    Read only the message's header from the ARRAY or FILEHANDLE

$obj->rebuild(OPTIONS)

$obj->reply(OPTIONS)

$obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])

$obj->replySubject(STRING)

Mail::Message::Replace::MailInternet->replySubject(STRING)

$obj->sign(OPTIONS)

    Add a signature (a few extra lines) to the message.

    -Option --Defined in --Default File undef Signature ''

    . File FILENAME

      Specifies a filename where the signature is in.

    . Signature STRING|ARRAY-OF-LINES

      The signature in memory.

The message

$obj->container

$obj->isDummy

$obj->isPart

$obj->messageId

$obj->nntppost(OPTIONS)

    Send an NNTP message (newsgroup message), which is equivalent to Mail::Transport::NNTP or Mail::Message::send() with via 'nntp'.

    -Option--Defined in --Default Debug <false> Host <from Net::Config> Port 119

    . Debug BOOLEAN

    . Host HOSTNAME

    . Port INTEGER

$obj->print([FILEHANDLE])

    Prints the whole message to the specified FILEHANDLE, which default to STDOUT. This calls Mail::Message::print().

$obj->send(TYPE, OPTIONS)

    Send via Mail Transfer Agents (MUA). These will be handled by various Mail::Transport::Send extensions. The test TYPE is not supported.

$obj->size

$obj->toplevel

$obj->write([FILEHANDLE])

The header

$obj->add(LINES)

    Add header lines, which simply calls Mail::Message::Head::add() on the header for each specified LINE. The last added LINE is returned.

$obj->bcc

$obj->cc

$obj->clean_header

$obj->combine(TAG, [WITH])

    Not implemented, because I see no use for it.

$obj->date

$obj->delete(NAME, [INDEX]])

$obj->destinations

$obj->fold([LENGTH])

$obj->fold_length([[TAG], LENGTH])

$obj->from

$obj->get(NAME, [INDEX])

    Get all the header fields with the specified NAME. In scalar context, only the first fitting NAME is returned. Even when only one NAME is specified, multiple lines may be returned: some fields appear more than once in a header. Calls Mail::Message::Replace::MailHeader::get()

$obj->guessTimestamp

$obj->head([HEAD])

    Returns the head of the message, or creates an empty one if none is defined. The HEAD argument, which sets the header, is not available for Mail::Internet, but is there to be compatible with the head method of Mail::Message.

$obj->header([ARRAY])

$obj->nrLines

$obj->print_header(FILEHANDLE)

$obj->replace(TAG, LINE, [INDEX])

$obj->sender

$obj->study(FIELDNAME)

$obj->subject

$obj->tidy_headers

    No effect anymore (always performed).

$obj->timestamp

$obj->to

The body

$obj->body([ARRAY-OF-LINES|LIST-OF-LINES])

    Returns an array of lines, representing the body. With arguments, a new body will be created. In Mail::Internet, the body is not an object but a simple array.

    BE WARNED: this overrules the Mail::Message::body() method, which may cause some confusion. Use bodyObject() to get access to that body's data.

$obj->bodyObject([BODY])

$obj->decoded(OPTIONS)

$obj->encode(OPTIONS)

$obj->isMultipart

$obj->isNested

$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])

$obj->print_body([FILEHANDLE])

$obj->remove_sig([NRLINES])

$obj->smtpsend(OPTIONS)

    This method is calling Mail::Message::send() via smtp, which is implemented in Mail::Transport::SMTP. The implementation is slightly different, so this method is not 100% compliant.

    -Option --Defined in --Default Debug <false> Hello <helo_domain from Net::Config> Host $ENV{SMTPHOSTS} or from Net::Config MailFrom $ENV{MAILADDRESS} or $ENV{USER} Port 25

    . Debug BOOLEAN

    . Hello STRING

    . Host HOSTNAME

      Only the first detected HOSTNAME is taken, so differs from the original implementation.

    . MailFrom STRING

      Your e-mail address. This simulated Mail::Internet object does not try to create an e-mail address from the sendmail configuration file, because that is generally a bad idea in environments with virtual hosts, as we have now-adays.

    . Port INTEGER

$obj->tidy_body

    Removes blank lines from begin and end of the body.

Flags

$obj->deleted([BOOLEAN])

$obj->isDeleted

$obj->isModified

$obj->label(LABEL|PAIRS)

$obj->labels

$obj->labelsToStatus

$obj->modified([BOOLEAN])

$obj->statusToLabels

The whole message as text

$obj->as_mbox_string

    Returns the whole message as one string, which can be included in an MBOX folder (while not using Mail::Box::Mbox). Lines in the body which start with From are escaped with an >.

$obj->file

$obj->lines

$obj->printStructure([FILEHANDLE|undef],[INDENT])

$obj->string

The nasty bits

$obj->isa(CLASS)

Mail::Message::Replace::MailInternet->isa(CLASS)

    Of course, the isa() class inheritance check should not see our nasty trick.

Internals

$obj->clonedFrom

Mail::Message::Replace::MailInternet->coerce(MESSAGE)

    Coerce (adapt type) of the specified MESSAGE (anything Mail::Message::coerce() accepts) into an Mail::Internet simulating object.

$obj->isDelayed

$obj->readBody(PARSER, HEAD [, BODYTYPE])

$obj->readFromParser(PARSER, [BODYTYPE])

$obj->readHead(PARSER [,CLASS])

$obj->recursiveRebuildPart(PART, OPTIONS)

$obj->storeBody(BODY)

$obj->takeMessageId([STRING])

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Replace::MailInternet->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Replace::MailInternet->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Message::Replace::MailInternet->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->shortSize([VALUE])

Mail::Message::Replace::MailInternet->shortSize([VALUE])

$obj->shortString

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->destruct

$obj->inGlobalDestruction

DIAGNOSTICS

Error: Cannot include forward source as $include.

Unknown alternative for the forward(include). Valid choices are NO, INLINE, ATTACH, and ENCAPSULATE.

Error: Mail::Internet does not support this kind of data

The ARGS data can only be a file handle or an ARRAY. Other data types are not supported (see read() if you want to have more).

Error: Method bounce requires To, Cc, or Bcc

The message bounce() method forwards a received message off to someone else without modification; you must specified it's new destination. If you have the urge not to specify any destination, you probably are looking for reply(). When you wish to modify the content, use forward().

Error: Method forwardAttach requires a preamble

Error: Method forwardEncapsulate requires a preamble

Error: No address to create forwarded to.

If a forward message is created, a destination address must be specified.

Error: No rebuild rule $name defined.

Error: Only build() Mail::Message's; they are not in a folder yet

You may wish to construct a message to be stored in a some kind of folder, but you need to do that in two steps. First, create a normal Mail::Message, and then add it to the folder. During this Mail::Box::addMessage() process, the message will get coerce()-d into the right message type, adding storage information and the like.

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.

DETAILS

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

Distribution version 2.066. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.