Mail::Message::Replace::MailInternet(3)

User Contributed Perl Documentation

Mail::Message::Replace::MailInternet(3)

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.

Extends "DESCRIPTION" in Mail::Message.

OVERLOADED¶

METHODS¶

Extends "METHODS" in Mail::Message.

Constructors¶

Extends "Constructors" in Mail::Message.

$obj->clone(%options)

Inherited, see "Constructors" in Mail::Message

$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] )

 -Option    --Defined in     --Default
  Body                         undef
  FoldLength                   79
  Header                       undef
  MailFrom                     'KEEP'
  Modify                       0
  body        Mail::Message    undef
  body_type   Mail::Message    Mail::Message::Body::Lines
  deleted     Mail::Message    <false>
  field_type  Mail::Message    undef
  head        Mail::Message    undef
  head_type   Mail::Message    Mail::Message::Replace::MailHeader
  labels      Mail::Message    {}
  log         Mail::Reporter   'WARNINGS'
  messageId   Mail::Message    undef
  modified    Mail::Message    <false>
  trace       Mail::Reporter   'WARNINGS'
  trusted     Mail::Message    <false>

Body => \@lines: Array of "\n" terminated lines. If not specified, the lines will be read from $arg.
FoldLength => INTEGER: Number of characters permitted on any refolded header line. Passed to Mail::Message::Replace::MailHeader::new(FoldLength).
Header => OBJECT: The Mail::Header object, which is passed here, is a fake one as well... It is translated into a new(head). If not given, the header will be parsed from the $arg.
MailFrom => 'IGNORE'|'ERROR'|'COERCE'|'KEEP': What to do with leading ""From "" lines in e-mail data. Passed to Mail::Message::Replace::MailHeader::new(MailFrom).
Modify => BOOLEAN: Whether to re-fold all the incoming fields. Passed to Mail::Message::Replace::MailHeader::new(Modify).
body => OBJECT
body_type => CLASS
deleted => BOOLEAN
field_type => CLASS
head => OBJECT
head_type => CLASS
labels => ARRAY|HASH
log => LEVEL
messageId => STRING
modified => BOOLEAN
trace => LEVEL
trusted => BOOLEAN

example: replace traditional Mail::Internet by this wrapper

  # was
  use Mail::Internet;
  my $mi = Mail::Internet->new(@options);
  # becomes
  use Mail::Message::Replace::MailInternet;
  my $mi = Mail::Internet->new(@options);

Attributes¶

$obj->MailFrom( [STRING] ): Your email address.

Constructing a message¶

Extends "Constructing a message" in Mail::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>] )

Inherited, see "Constructing a message" in Mail::Message::Construct::Bounce

Mail::Message::Replace::MailInternet->build( [$message|$part|$body], $content )

Inherited, see "Constructing a message" in Mail::Message::Construct::Build

Mail::Message::Replace::MailInternet->buildFromBody($body, [$head], $headers)

Inherited, see "Constructing a message" in Mail::Message::Construct::Build

$obj->extract(\@lines|$fh)

Read header and body from an ARRAY or $fh

$obj->forward(%options)

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->forwardAttach(%options)

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->forwardEncapsulate(%options)

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->forwardInline(%options)

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->forwardNo(%options)

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->forwardPostlude()

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->forwardPrelude()

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->forwardSubject(STRING)

Inherited, see "Constructing a message" in Mail::Message::Construct::Forward

$obj->read(\@lines|$fh, %options)

Mail::Message::Replace::MailInternet->read(\@lines|$fh, %options)

Read header and body from the specified ARRAY or $fh. 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(\@lines|$fh)

Read only the message's body from the ARRAY or $fh.

$obj->read_header(\@lines|$fh)

Read only the message's header from the ARRAY or $fh

$obj->rebuild(%options)

Inherited, see "Constructing a message" in Mail::Message::Construct::Rebuild

$obj->reply(%options)

BE WARNED: the main job for creating a reply is done by Mail::Message::reply(), which may produce a result which is compatible, but may be different from Mail::Internet's version.

 -Option         --Defined in                     --Default
  Bcc              Mail::Message::Construct::Reply  undef
  Cc               Mail::Message::Construct::Reply  <'cc' in current>
  Exclude                                           []
  From             Mail::Message::Construct::Reply  <'to' in current>
  Inline                                            >
  Keep                                              []
  Message-ID       Mail::Message::Construct::Reply  <uniquely generated>
  ReplyAll                                          <false>
  Subject          Mail::Message::Construct::Reply  replySubject()
  To               Mail::Message::Construct::Reply  <sender in current>
  body             Mail::Message::Construct::Reply  undef
  group_reply      Mail::Message::Construct::Reply  <true>
  header_template                                   $ENV{HOME}/.mailhdr
  include          Mail::Message::Construct::Reply  'INLINE'
  max_signature    Mail::Message::Construct::Reply  10
  message_type     Mail::Message::Construct::Reply  Mail::Message
  postlude         Mail::Message::Construct::Reply  undef
  prelude          Mail::Message::Construct::Reply  undef
  quote            Mail::Message::Construct::Reply  '> '
  signature        Mail::Message::Construct::Reply  undef
  strip_signature  Mail::Message::Construct::Reply  qr/^--\s/

Bcc => ADDRESSES
Cc => ADDRESSES
Exclude => \@names: Remove the fields with the specified names from the produced reply message.
From => ADDRESSES
Inline => STRING: Quotation STRING, which is translated into reply(quote). The normal default of "quote" is "> ", in stead of ">".
Keep => \@names: Copy all header fields with the specified NAMES from the source to the reply message.
Message-ID => STRING
ReplyAll => BOOLEAN: Reply to the group? Translated into reply(group_reply), which has as default the exact oposite of this option, being "true".
Subject => STRING|CODE
To => ADDRESSES
body => BODY
group_reply => BOOLEAN
header_template => $filename|"undef": Read the return header from the template file. When this is explicitly set to "undef", or the file does not exist, then a header will be created.
include => 'NO'|'INLINE'|'ATTACH'
max_signature => INTEGER
message_type => CLASS
postlude => BODY|LINES
prelude => BODY|LINES
quote => CODE|STRING
signature => BODY|MESSAGE
strip_signature => REGEXP|STRING|CODE

$obj->replyPrelude( [STRING|$field|$address|ARRAY-$of-$things] )

Inherited, see "Constructing a message" in Mail::Message::Construct::Reply

$obj->replySubject(STRING)

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

Inherited, see "Constructing a message" in Mail::Message::Construct::Reply

$obj->sign(%options)

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

 -Option   --Default
  File       undef
  Signature  ''

File => $filename: Specifies a filename where the signature is in.
Signature => STRING|\@lines: The signature in memory.

The message¶

Extends "The message" in Mail::Message.

$obj->container()

Inherited, see "The message" in Mail::Message

$obj->isDummy()

Inherited, see "The message" in Mail::Message

$obj->isPart()

Inherited, see "The message" in Mail::Message

$obj->messageId()

Inherited, see "The message" in Mail::Message

$obj->nntppost(%options)

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

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

Debug => BOOLEAN
Host => $hostname
Port => INTEGER

$obj->partNumber(): Inherited, see "The message" in Mail::Message
$obj->print( [$fh] ): Prints the whole message to the specified $fh, 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(): Inherited, see "The message" in Mail::Message
$obj->toplevel(): Inherited, see "The message" in Mail::Message
$obj->write( [$fh] ): Inherited, see "The message" in Mail::Message

The header¶

Extends "The header" in Mail::Message.

$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()