Skip to content

Commit 47f32cc

Browse files
drgrice1drgrice1
authored
Merge pull request #1496 from mgage/main-smpt-test
modifications to allow 'Return-Path' to be specified to be used for r…
2 parents cfb690a + 2bd3ece commit 47f32cc

4 files changed

Lines changed: 84 additions & 65 deletions

File tree

‎conf/site.conf.dist‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,16 @@ $mail{smtpServer} = ''; # e.g. 'mail.yourschool.edu' or 'localhost'
287287
# message. It can really be anything, but some mail servers require it contain
288288
# a valid mail domain, or at least be well-formed.
289289
$mail{smtpSender} = ''; # e.g. 'webwork@yourserver.yourschool.edu'
290-
291290
# Be sure to use single quotes for the address or the @ sign will be interpreted as an array.
291+
#
292+
293+
$mail{set_return_path} = ''; #sets the return_path to the From: field (sender's email address)
294+
# The return path is used to send error messages about bounced emails
295+
# "noreply\@$mail{smtpServer}" discards error messages,
296+
# using $mail{smtpSender} would deliver error messages to that address.
297+
# The default setting should be adjusted for local domain
298+
# Leaving the return path blank triggers the default which results in Return-Path being set to the email of the sender.
299+
#
292300

293301
# Seconds to wait before timing out when connecting to the SMTP server.
294302
# the default is 120 seconds.

‎lib/WeBWorK/ContentGenerator/Feedback.pm‎

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -217,28 +217,27 @@ sub body {
217217
$remote_port = "UNKNOWN" unless defined $remote_port;
218218
}
219219

220-
# my $transport = Email::Sender::Transport::SMTP->new({
221-
# host => $ce->{mail}->{smtpServer},
222-
# ssl => $ce->{mail}->{tls_allowed}//1, ## turn on ssl security
223-
# timeout => $ce->{mail}->{smtpTimeout}
224-
# });
225-
#
226-
# $transport->port($ce->{mail}->{smtpPort}) if defined $ce->{mail}->{smtpPort};
227220

228-
# createEmailSenderTransportSMTP is defined in ContentGenerator
221+
# createEmailSenderTransportSMTP is defined in ContentGenerator
229222
my $email_address = $user->email_address;
230223
my $transport = $self->createEmailSenderTransportSMTP();
224+
my $return_path_for_errors = $ce->{mail}->{set_return_path};
225+
# return_path_for_errors is the address used to report returned email. It is an argument
226+
# used in sendmail() (aka Email::Simple::sendmail).
227+
# For arcane historical reasons sendmail actually sets the field "MAIL FROM" and the smtp server then
228+
# uses that to set "Return-Path".
229+
# references:
230+
# stackoverflow:
231+
# https://stackoverflow.com/questions/1235534/what-is-the-behavior-difference-between-return-path-reply-to-and-from
232+
# Email::Simple: https://metacpan.org/pod/Email::Sender::Manual::QuickStart#envelope-information
233+
231234
my $email = Email::Simple->create(header => [
232235
"To" => join(",", @recipients),
233236
"From" => $sender,
234237
"Subject" => $subject,
235238
"Content-Type" => "text/plain; charset=UTF-8"
236239
]);
237240

238-
# my $header = Email::Simple::Header->new;
239-
# $header->header_set("To",);
240-
# $header->header_set("From",$user->email_address);
241-
# $header->header_set("Subject",$subject);
242241

243242
## extra headers
244243
$email->header_set("X-Remote-Host: ",$remote_host);
@@ -294,29 +293,20 @@ $emailableURL
294293
$email->body_set(Encode::encode("UTF-8",$msg));
295294

296295
try {
297-
sendmail($email,{transport => $transport});
296+
if ($return_path_for_errors) {
297+
sendmail($email,{transport => $transport, from=>$return_path_for_errors});
298+
}
299+
else {
300+
sendmail($email,{transport => $transport});
301+
}
302+
298303
print CGI::p($r->maketext("Your message was sent successfully."));
299304
print CGI::p(CGI::a({-href => $returnURL}, $r->maketext("Return to your work")));
300305
print CGI::pre(wrap("", "", $feedback));
301306
} catch {
302307
$self->feedbackForm($user, $returnURL,
303308
"Failed to send message: $_");
304309
};
305-
306-
307-
# Close returns the mailer object on success, a negative value on failure,
308-
# zero if mailer was not opened.
309-
# my $result = $mailer->Close;
310-
311-
# if (ref $result) {
312-
# # print confirmation
313-
# print CGI::p("Your message was sent successfully.");
314-
# print CGI::p(CGI::a({-href => $returnURL}, "Return to your work"));
315-
# print CGI::pre(wrap("", "", $feedback));
316-
# } else {
317-
# $self->feedbackForm($user, $returnURL,
318-
# "Failed to send message ($result): $Mail::Sender::Error");
319-
# }
320310
} else {
321311
# just print the feedback form, with no message
322312
$self->feedbackForm($user, $returnURL, "");

‎lib/WeBWorK/ContentGenerator/Instructor/SendMail.pm‎

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -880,16 +880,19 @@ sub mail_message_to_recipients {
880880

881881
my $msg = eval { $self->process_message($ur,$rh_merge_data) };
882882
$error_messages .= "There were errors in processing user $recipient, merge file $merge_file. \n$@\n" if $@;
883-
#warn "message is ok";
884-
# my $transport = Email::Sender::Transport::SMTP->new({
885-
# host => $ce->{mail}->{smtpServer},
886-
# ssl => $ce->{mail}->{tls_allowed}//1, ## turn on ssl security
887-
# timeout => $ce->{mail}->{smtpTimeout}
888-
# });
889-
#
890-
891-
# createEmailSenderTransportSMTP is defined in ContentGenerator
892-
my $transport = $self->createEmailSenderTransportSMTP();
883+
884+
my $transport = $self->createEmailSenderTransportSMTP();
885+
my $return_path_for_errors = $ce->{mail}->{set_return_path};
886+
# createEmailSenderTransportSMTP is defined in ContentGenerator
887+
# return_path_for_errors is the address used to report returned email. It is an argument
888+
# used in sendmail() (aka Email::Simple::sendmail).
889+
# For arcane historical reasons sendmail actually sets the field "MAIL FROM" and the smtp server then
890+
# uses that to set "Return-Path".
891+
# references:
892+
# stackoverflow:
893+
# https://stackoverflow.com/questions/1235534/what-is-the-behavior-difference-between-return-path-reply-to-and-from
894+
# Email::Simple: https://metacpan.org/pod/Email::Sender::Manual::QuickStart#envelope-information
895+
893896
my $email = Email::Simple->create(
894897
header => [
895898
To => $ur->email_address,
@@ -902,7 +905,12 @@ sub mail_message_to_recipients {
902905

903906

904907
try {
905-
sendmail($email,{transport => $transport});
908+
if ($return_path_for_errors) {
909+
sendmail($email,{transport => $transport, from=>$return_path_for_errors});
910+
}
911+
else {
912+
sendmail($email,{transport => $transport});
913+
}
906914
debug "email sent successfully to " . $ur->email_address;
907915
} catch {
908916
debug "error sending email: $_";
@@ -936,16 +944,10 @@ sub email_notification {
936944

937945
my $mailing_errors = "";
938946

939-
# my $transport = Email::Sender::Transport::SMTP->new({
940-
# host => $ce->{mail}->{smtpServer},
941-
# ssl => $ce->{mail}->{tls_allowed}//1, ## turn on ssl security
942-
# timeout => $ce->{mail}->{smtpTimeout}
943-
# });
944-
#
945-
# $transport->port($ce->{mail}->{smtpPort}) if defined $ce->{mail}->{smtpPort};
946-
# createEmailSenderTransportSMTP is defined in ContentGenerator
947+
# createEmailSenderTransportSMTP is defined in ContentGenerator
947948
my $transport = $self->createEmailSenderTransportSMTP();
948949

950+
my $return_path_for_errors = $ce->{mail}->{set_return_path};
949951
my $email = Email::Simple->create(
950952
header => [
951953
To => $self->{defaultFrom},
@@ -958,7 +960,12 @@ sub email_notification {
958960
$email->header_set("X-Remote-Host: ",$self->{remote_host});
959961

960962
try {
961-
sendmail($email,{transport => $transport});
963+
if ($return_path_for_errors) {
964+
sendmail($email,{transport => $transport, from=>$return_path_for_errors});
965+
}
966+
else {
967+
sendmail($email,{transport => $transport});
968+
}
962969
} catch {
963970
warn "Error sending email: $_";
964971
next;
@@ -1022,7 +1029,7 @@ sub process_message {
10221029
my $endCol = @COL;
10231030
# for safety, only evaluate special variables
10241031
my $msg = $text;
1025-
$msg =~ s/\$SID/$SID/ge;
1032+
$msg =~ s/\$SID/$SID/ge;
10261033
$msg =~ s/\$LN/$LN/ge;
10271034
$msg =~ s/\$FN/$FN/ge;
10281035
$msg =~ s/\$STATUS/$STATUS/ge;

‎lib/WeBWorK/ContentGenerator/ProblemUtil/ProblemUtil.pm‎

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -614,24 +614,33 @@ sub jitar_send_warning_email {
614614
# at present, this does not seem to be necessary.
615615

616616

617-
# createEmailSenderTransportSMTP is defined in ContentGenerator
618-
my $transport = $self->createEmailSenderTransportSMTP();
619-
my $email = Email::Simple->create(header => [
617+
my $transport = $self->createEmailSenderTransportSMTP();
618+
my $return_path_for_errors = $ce->{mail}->{set_return_path};
619+
# createEmailSenderTransportSMTP is defined in ContentGenerator
620+
# return_path_for_errors is the address used to report returned email. It is an argument
621+
# used in sendmail() (aka Email::Simple::sendmail).
622+
# For arcane historical reasons sendmail actually sets the field "MAIL FROM" and the smtp server then
623+
# uses that to set "Return-Path".
624+
# references:
625+
# stackoverflow:
626+
# https://stackoverflow.com/questions/1235534/what-is-the-behavior-difference-between-return-path-reply-to-and-from
627+
# Email::Simple: https://metacpan.org/pod/Email::Sender::Manual::QuickStart#envelope-information
628+
629+
my $email = Email::Simple->create(header => [
620630
"To" => join(",", @recipients),
621631
"From" => $sender,
622632
"Subject" => $subject,
623633
"Content-Type" => "text/plain; charset=UTF-8"
624634
]);
625-
626-
## extra headers
627-
$email->header_set("X-WeBWorK-Course: ",$courseID) if defined $courseID;
628-
if ($user) {
629-
$email->header_set("X-WeBWorK-User: ",$user->user_id);
630-
$email->header_set("X-WeBWorK-Section: ",$user->section);
631-
$email->header_set("X-WeBWorK-Recitation: ",$user->recitation);
632-
}
633-
$email->header_set("X-WeBWorK-Set: ",$setID) if defined $setID;
634-
$email->header_set("X-WeBWorK-Problem: ",$problemID) if defined $problemID;
635+
## extra headers
636+
$email->header_set("X-WeBWorK-Course: ",$courseID) if defined $courseID;
637+
if ($user) {
638+
$email->header_set("X-WeBWorK-User: ",$user->user_id);
639+
$email->header_set("X-WeBWorK-Section: ",$user->section);
640+
$email->header_set("X-WeBWorK-Recitation: ",$user->recitation);
641+
}
642+
$email->header_set("X-WeBWorK-Set: ",$setID) if defined $setID;
643+
$email->header_set("X-WeBWorK-Problem: ",$problemID) if defined $problemID;
635644

636645
my $full_name = $user->full_name;
637646
my $email_address = $user->email_address;
@@ -663,8 +672,13 @@ Comment: $comment
663672
## try to send the email
664673

665674
try {
666-
sendmail($email,{transport => $transport});
667-
debug("Successfully sent JITAR alert message");
675+
if ($return_path_for_errors) {
676+
sendmail($email,{transport => $transport, from=>$return_path_for_errors});
677+
}
678+
else {
679+
sendmail($email,{transport => $transport});
680+
}
681+
debug("Successfully sent JITAR alert message");
668682
} catch {
669683
$r->log_error("Failed to send JITAR alert message: $_");
670684
};

0 commit comments

Comments
 (0)