From 6c9e167dcc6686bc726d49fb189f27dde8dbf8f3 Mon Sep 17 00:00:00 2001
From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Date: Thu, 17 Jun 2021 14:47:07 +0100
Subject: [PATCH] Bug 28581: Enhance POD for EnqueueLetter

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
---
 C4/Letters.pm | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/C4/Letters.pm b/C4/Letters.pm
index 7637302785..bcd418b33e 100644
--- a/C4/Letters.pm
+++ b/C4/Letters.pm
@@ -929,11 +929,19 @@ sub _parseletter {
   my $success = EnqueueLetter( { letter => $letter, 
         borrowernumber => '12', message_transport_type => 'email' } )
 
-places a letter in the message_queue database table, which will
+Places a letter in the message_queue database table, which will
 eventually get processed (sent) by the process_message_queue.pl
 cronjob when it calls SendQueuedMessages.
 
-return message_id on success
+Return message_id on success
+
+Parameters
+* letter - required; A letter hashref as returned from GetPreparedLetter
+* message_transport_type - required; One of the available mtts
+* borrowernumber - optional if 'to_address' is passed; The borrowernumber of the patron we enqueuing the notice for
+* to_address - optional if 'borrowernumber' is passed; The destination email address for the notice (defaults to patron->notice_email_address)
+* from_address - optional; The from address for the notice, defaults to patron->library->from_email_address
+* reply_address - optional; The reply address for the notice, defaults to patron->library->reply_to
 
 =cut
 
@@ -1370,6 +1378,8 @@ sub _send_message_by_email {
         $branch_returnpath = $library->branchreturnpath;
     }
 
+    # NOTE: Patron may not be defined above so branch_email may be undefined still
+    # so we need to fallback to KohaAdminEmailAddress as a last resort.
     my $from_address =
          $message->{'from_address'}
       || $branch_email
-- 
2.20.1