API:EPrints/Email: Difference between revisions

Revision as of 13:08, 20 August 2009

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.

User Comments

SYNOPSIS

 use EPrints;
 
 # sends an email to Bob Test at test@test.com in English with the 
 # subject "Recent Test Reports"
 EPrints::Email::send_mail( 
     handle => $handle,
     langid => "en",
   to_email => "test@test.com", 
    to_name => "Bob Test", 
    subject => "Recent Test Reports", 
    message => $message_dom,
 );

User Comments

DESCRIPTION

This package handles sending emails.

User Comments

EPrints::Email::send_mail( %properties )

Sends an email.

User Comments

@@ Line 1: / Line 1: @@
-wfw
+<!-- 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.
+ -->
+__NOTOC__
+{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Email.pm|package_name=EPrints::Email}}[[Category:API|Email]]<div><!-- Edit below this comment -->
+<!-- Pod2Wiki=head_name --></div>
+==NAME==
+'''EPrints::Email''' - Email Utility functions for EPrints.
+<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<h4><span style='display:none'>User Comments</span></h4>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki=head_synopsis --></div>
+==SYNOPSIS==
+  use EPrints;
+  # sends an email to Bob Test at test@test.com in English with the
+  # subject "Recent Test Reports"
+  EPrints::Email::send_mail(
+      handle =&gt; $handle,
+      langid =&gt; "en",
+    to_email =&gt; "test@test.com",
+     to_name =&gt; "Bob Test",
+     subject =&gt; "Recent Test Reports",
+     message =&gt; $message_dom,
+  );
+<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<h4><span style='display:none'>User Comments</span></h4>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki=head_description --></div>
+==DESCRIPTION==
+This package handles sending emails.
+<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<h4><span style='display:none'>User Comments</span></h4>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki=item_send_mail --></div>
+===EPrints::Email::send_mail( %properties )===
+Sends an email.
+<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<h4><span style='display:none'>User Comments</span></h4>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->