API:EPrints/Email: Difference between revisions

Latest revision as of 09:56, 22 January 2013

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::Email - Email Utility functions for EPrints.

DESCRIPTION

This package handles sending emails.

EPrints::Utils::send_mail( %properties )

Sends an email.

Required properties:

session - the current session

langid - the id of the language to send the email in.

to_email, to_name - who to send it to

subject - the subject of the message (UTF-8 encoded string)

message - the body of the message as a DOM tree

optional properties:

from_email, from_name - who is sending the email (defaults to the archive admin)

sig - the signature file as a DOM tree

replyto_email, replyto_name

attach - ref to an array of filenames (with full paths) to attach to the message

to_list - ref to an array of additional email addresses to send the email to (note that to_email must be provided)

cc_list - ref to an array of email addresses to CC the email to (note that to_email must be provided)

Returns true if mail sending (appears to have) succeeded. False otherwise.

Uses the config. option "send_email" to send the mail, or if that's not defined sends the email via STMP.

names and the subject should be encoded as utf-8

COPYRIGHT

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.

@@ Line 1: / Line 1: @@
 <!-- Pod2Wiki=_preamble_
 This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
-  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Email.pm|package_name=EPrints::Email}}[[Category:API|EMAIL]][[Category:API:EPrints/Email|EMAIL]]<div><!-- Edit below this comment -->
+  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Email.pm|package_name=EPrints::Email}}[[Category:API|EMAIL]][[Category:API:EPrints/Email|EMAIL]]<div><!-- Edit below this comment -->
@@ Line 8: / Line 8: @@
 '''EPrints::Email''' - Email Utility functions for EPrints.
-<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
-<span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
-</div>
 <!-- Pod2Wiki=head_description -->
 ==DESCRIPTION==
 This package handles sending emails.
-<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+* EPrints::Utils::send_mail( %properties )
-<span style='display:none'>User Comments</span>
+: Sends an email.
-<!-- Edit below this comment -->
+: Required properties:
+: session - the current session
+: langid - the id of the language to send the email in.
+: to_email, to_name - who to send it to
+: subject - the subject of the message (UTF-8 encoded string)
-<!-- Pod2Wiki= -->
+: message - the body of the message as a DOM tree
-</div>
-<!-- Pod2Wiki=item_send_mail -->
-===EPrints::Utils::send_mail( %properties )===
-Sends an email.
+: optional properties:
-Required properties:
+: from_email, from_name - who is sending the email (defaults to the archive admin)
-session - the current session
+: sig - the signature file as a DOM tree
-langid - the id of the language to send the email in.
+: replyto_email, replyto_name
-to_email, to_name - who to send it to
+: attach - ref to an array of filenames (with full paths) to attach to the message
-subject - the subject of the message (UTF-8 encoded string)
+: to_list - ref to an array of additional email addresses to send the email to (note that to_email must be provided)
-message - the body of the message as a DOM tree
+: cc_list - ref to an array of email addresses to CC the email to (note that to_email must be provided)
-optional properties:
+: Returns true if mail sending (appears to have) succeeded. False otherwise.
-from_email, from_name - who is sending the email (defaults to the archive admin)
+: Uses the config. option "send_email" to send the mail, or if that's not defined sends the email via STMP.
-sig - the signature file as a DOM tree
+: names and the subject should be encoded as utf-8
-replyto_email, replyto_name
+<pre></pre>
-attach - ref to an array of filenames (with full paths) to attach to the message
+<!-- Pod2Wiki=head_copyright -->
+==COPYRIGHT==
+: Copyright 2000-2011 University of Southampton.
-Returns true if mail sending (appears to have) succeeded. False otherwise.
+: This file is part of EPrints http://www.eprints.org/.
-Uses the config. option "send_email" to send the mail, or if that's not defined sends the email via STMP.
+: EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-names and the subject should be encoded as utf-8
+: EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
+: You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
-<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
-<span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
-</div>
+<!-- Pod2Wiki=_postamble_ -->
-<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
+<!-- Edit below this comment -->