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