API:EPrints/Email - Revision history

Tdb01r at 09:56, 22 January 2013

2013-01-22T09:56:21Z

Tdb01r at 15:25, 16 December 2011

2011-12-16T15:25:59Z

Tdb01r at 10:46, 25 August 2011

2011-08-25T10:46:32Z

Tdb01r at 15:12, 25 February 2010

2010-02-25T15:12:28Z

Tdb01r at 13:20, 25 February 2010

2010-02-25T13:20:10Z

Pm705@zepler.net at 16:34, 12 February 2010

2010-02-12T16:34:06Z

Cjg at 14:04, 24 August 2009

2009-08-24T14:04:01Z

Cjg at 13:08, 20 August 2009

2009-08-20T13:08:44Z

Cjg at 12:51, 20 August 2009

2009-08-20T12:51:55Z

Tdb01r: Removing all content from page

2009-08-12T15:40:44Z

Removing all content from page

@@ Line 8: / Line 8: @@
 '''EPrints::Email''' - Email Utility functions for EPrints.
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
 <!-- 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 -->
-<!-- Pod2Wiki= -->
+: to_email, to_name - who to send it to
-Sends an email.
+: subject - the subject of the message (UTF-8 encoded string)
-Required properties:
+: message - the body of the message as a DOM tree
-session - the current session
+: optional properties:
-langid - the id of the language to send the email in.
+: from_email, from_name - who is sending the email (defaults to the archive admin)
-to_email, to_name - who to send it to
+: sig - the signature file as a DOM tree
-subject - the subject of the message (UTF-8 encoded string)
+: replyto_email, replyto_name
-message - the body of the message as a DOM tree
+: attach - ref to an array of filenames (with full paths) to attach to the message
-optional properties:
+: to_list - ref to an array of additional email addresses to send the email to (note that to_email must be provided)
-from_email, from_name - who is sending the email (defaults to the archive admin)
+: cc_list - ref to an array of email addresses to CC the email to (note that to_email must be provided)
-sig - the signature file as a DOM tree
+: Returns true if mail sending (appears to have) succeeded. False otherwise.
-replyto_email, replyto_name
+: Uses the config. option "send_email" to send the mail, or if that's not defined sends the email via STMP.
-attach - ref to an array of filenames (with full paths) to attach to the message
+: names and the subject should be encoded as utf-8
-Returns true if mail sending (appears to have) succeeded. False otherwise.
+<pre></pre>
-Uses the config. option "send_email" to send the mail, or if that's not defined sends the email via STMP.
+<!-- Pod2Wiki=head_copyright -->
-names and the subject should be encoded as utf-8
+: This file is part of EPrints http://www.eprints.org/.
-<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+: 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.
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
-</div>
+<!-- Pod2Wiki=_postamble_ -->
-<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
+<!-- Edit below this comment -->

@@ 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 -->

← Older revision		Revision as of 10:46, 25 August 2011
Line 60:		Line 60:


		+	<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_copyright -->
		+	==COPYRIGHT==
	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<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>		<span style='display:none'>User Comments</span>

@@ 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]]<div><!-- Edit below this comment -->
+  -->{{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 -->

@@ 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]]<div><!-- Edit below this comment -->
-<!-- Pod2Wiki=head_name --></div>
+<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 ==NAME==
 '''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%; '>
-<h4><span style='display:none'>User Comments</span></h4>
+<span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
-<!-- Pod2Wiki=head_description --></div>
+<!-- Pod2Wiki= -->
 ==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%; '>
-<h4><span style='display:none'>User Comments</span></h4>
+<span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
-<!-- Pod2Wiki=item_send_mail --></div>
+<!-- Pod2Wiki= -->
 ===EPrints::Utils::send_mail( %properties )===
@@ Line 59: / Line 61: @@
 <div style='background-color: #e8e8f; 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>
+<span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

← Older revision		Revision as of 13:08, 20 August 2009
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 => $handle,
		+	langid => "en",
		+	to_email => "test@test.com",
		+	to_name => "Bob Test",
		+	subject => "Recent Test Reports",
		+	message => $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 -->

← Older revision	Revision as of 12:51, 20 August 2009
Line 1:	Line 1:
−	+	wfw

← Older revision		Revision as of 15:40, 12 August 2009
Line 1:		Line 1:
−	~~<!-- Pod2Wiki=_preamble_~~
−	~~This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.~~
−	~~-->{{Pod2Wiki}}{{API:Source\|file=EPrints/Email.pm\|package_name=EPrints::Email}}[[Category:API\|Email]]<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_name -->=NAME=~~
−	~~'''EPrints::Email''' - Email Utility functions for EPrints.~~

−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_description -->=DESCRIPTION=~~
−	~~This package handles sending emails.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_send_mail -->==send_mail==~~
−
−	~~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~~
−
−	~~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~~
−
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=~~
−	~~{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_build_email -->==build_email==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_encode_mime_header -->==encode_mime_header==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_send_mail_via_sendmail -->==send_mail_via_sendmail==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_send_mail_via_smtp -->==send_mail_via_smtp==~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->~~