Mail::Util(3)                                  User Contributed Perl Documentation                                 Mail::Util(3)



NAME
       Mail::Util - mail utility functions

INHERITANCE
        Mail::Util
          is a Exporter

SYNOPSIS
         use Mail::Util qw( ... );

DESCRIPTION
       This package provides several mail related utility functions. Any function required must by explicitly listed on the use
       line to be exported into the calling package.

FUNCTIONS
       mailaddress

           Return a guess at the current users mail address. The user can force the return value by setting the MAILADDRESS
           environment variable.

           WARNING: When not supplied via the environment variable, <mailaddress> looks at various configuration files and other
           environmental data. Although this seems to be smart behavior, this is not predictable enough (IMHO) to be used.
           Please set the MAILADDRESS explicitly, and do not trust on the "automatic detection", even when that produces a
           correct address (on the moment)

           example:

            # in your main script
            $ENV{MAILADDRESS} = 'meATexample.com';

            # everywhere else
            use Mail::Util 'mailaddress';
            print mailaddress;

       maildomain

           Attempt to determine the current uers mail domain string via the following methods

           o   Look for the MAILDOMAIN enviroment variable, which can be set from outside the program.  This is by far the best
               way to configure the domain.

           o   Look for a sendmail.cf file and extract DH parameter

           o   Look for a smail config file and usr the first host defined in hostname(s)

           o   Try an SMTP connect (if Net::SMTP exists) first to mailhost then localhost

           o   Use value from Net::Domain::domainname (if Net::Domain exists)

           WARNING: On modern machines, there is only one good way to provide information to this method: the first; always
           explicitly configure the MAILDOMAIN.

           example:

            # in your main script
            $ENV{MAILDOMAIN} = 'example.com';

            # everywhere else
            use Mail::Util 'maildomain';
            print maildomain;

       read_mbox(FILE)

           Read FILE, a binmail mailbox file, and return a list of  references.  Each reference is a reference to an array
           containg one message.

           WARNING: This method does not quote lines which accidentally also start with the message separator "From", so this
           implementation can be considered broken.  See Mail::Box::Mbox

SEE ALSO
       This module is part of the MailTools distribution, http://perl.overmeer.net/mailtools/.

AUTHORS
       The MailTools bundle was developed by Graham Barr.  Later, Mark Overmeer took over maintenance without commitment to
       further development.

       Mail::Cap by Gisle Aas <aasAToslonett.no>.  Mail::Field::AddrList by Peter Orbaek <poeATcit.dk>.  Mail::Mailer and
       Mail::Send by Tim Bunce <Tim.BunceATig.uk>.  For other contributors see ChangeLog.

LICENSE
       Copyrights 1995-2000 Graham Barr <gbarrATpobox.com> and 2001-2007 Mark Overmeer <perlATovermeer.net>.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html



perl v5.12.2                                               2010-10-01                                              Mail::Util(3)