Thorsten Schwander > TeX-AutoTeX > TeX::AutoTeX::Mail

Download:
TeX-AutoTeX-v0.906.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.5.2.4   Source  

NAME ^

TeX::AutoTeX::Mail - email handling for TeX::AutoTeX process messages

DESCRIPTION ^

Mail routines for TeX::AutoTeX. TeX::AutoTeX can be instructed to mail notification of various failure conditions to specific email addresses.

HISTORY ^

 AutoTeX automatic TeX processing system
 Copyright (c) 1994-2006 arXiv.org and contributors

 AutoTeX is supplied under the GNU Public License and comes
 with ABSOLUTELY NO WARRANTY; see COPYING for more details.

 AutoTeX is an automatic TeX processing system designed to
 process TeX/LaTeX/AMSTeX/etc source code of papers submitted
 to the arXiv.org (nee xxx.lanl.gov) e-print archive. The
 portable part of this code has been extracted and is made
 available in the hope that it will be useful to other projects
 and that the input of others will benefit arXiv.org.

 Code developed and contributed to by Tanmoy Bhattacharya, Rob
 Hartill, Mark Doyle, Thorsten Schwander, and Simeon Warner.
 Refactored to separate generic code from arXiv.org specific code
 by Stephen Marsh, Michael Fromerth, and Simeon Warner 2005/2006.

 Major cleanups and algorithmic improvements/corrections by
 Thorsten Schwander 2006 - 2011

METHODS ^

new($identifier)

Instantiates a TeX::AutoTeX::Mail object. The optional $identifier will be used in mail subject lines, which is useful when AutoTeX is deployed for automated processing in a repository context.

send_notification($to, $subject, $message, $reply_to)

Send mail message to the address specified. The parameter names should be self explanatory.

Returns undef on success, error message otherwise.

send_failure($subject, ...)

Convenience method calling send_notification with the configured address for failure messages as recipient.

send_tex_admin($subject, ...)

Convenience method calling send_notification with the configured TeX installation maintainer as delivery address.

DIAGNOSTICS ^

send_notification() returns undef on success and an informative message on various errors

CONFIGURATION AND ENVIRONMENT ^

The following configuration variables from TeX::AutoTeX::Config are used

$TEX_ADMIN_ADDRESS

Recipient for specific TeX issues.

$MAIL_FAILURES_ADDRESS

Recipient for processing failures or other error conditions.

$SENDMAIL

Full PATH to the sendmail executable.

DEPENDENCIES ^

The mail commands opens a pipe into sendmail, and the command syntax used here is tailored with sendmail in mind. Other MTAs may require a different setup.

BUGS AND LIMITATIONS ^

Please report bugs to www-admin

AUTHOR ^

See history above. Current maintainer: Thorsten Schwander for arXiv.org

LICENSE AND COPYRIGHT ^

Copyright (c) 2007 - 2011 arxiv.org http://arxiv.org/help/contact

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

syntax highlighting: