CleanCode Perl Libraries
Multi-Lingual Library Maintainability
available: Perl not available: Java not available: JavaScript not available: Certified
Class
not available: Testable
Class
not available: Standalone
Mode
not available: Diagnostic
Enabled

NAME

Net::SimpleMail - Provides basic e-mail function.

SYNOPSIS

        use Net::SimpleMail;
        my $sendmail = getMailer();
        $success = sendMessage($sendmail, $subject, $body, $from, $recipient, $bcc);

REQUIRES

Perl5.005

EXPORTS

Default: getMailer, sendMessage

Optional: none

DESCRIPTION

This is a simple e-mailing support module.

FUNCTIONS

getMailer

getMailer()

Searches for one of several standard Unix/Linux mail programs that may be used to send an e-mail and returns the program name with an absolute path, suitable for passing to sendMessage.

This subroutine is adapted from the test_server.pl program from Webside Fx (http://www.4webmasters.us).

Returns:

available mail program or undef if none found

sendMessage

sendMessage(mailprog, subject, body, sender, recipient, bcc)

Send email from $sender to $recipient with the specified $subject and $body.

Parameters:

mailprog - string; executable mail program (acquired from getMailer)

subject - string; contents of subject field

body - string; body of email

sender - string; sender email address

recipient - string; recipient email address

bcc - string; blind carbon copy email address

Returns:

1 if successful in communicating to the mail program; 0 otherwise. Note that this in way indicates success or failure of the e-mail transmission to the recipient(s)!

BUGS

None

AUTHOR

Michael Sorens

VERSION

$Revision: 8 $ $Date: 2006-12-19 21:13:43 -0800 (Tue, 19 Dec 2006) $

SINCE

CleanCode 0.9.05

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 175:

=back doesn't take any parameters, but you said =back -- end of FUNCTION section


CleanCode Perl Libraries Copyright © 2001-2013 Michael Sorens - Revised 2013.06.30 Get CleanCode at SourceForge.net. Fast, secure and Free Open Source software downloads