From fde83cc767eacfb1456ee1dd25d83426cfdc0a88 Mon Sep 17 00:00:00 2001 From: Georg Lauterbach <44545919+georglauterbach@users.noreply.github.com> Date: Wed, 10 Jan 2024 11:18:16 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com> --- test/helper/sending.bash | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/test/helper/sending.bash b/test/helper/sending.bash index c36f06af..2eab57a1 100644 --- a/test/helper/sending.bash +++ b/test/helper/sending.bash @@ -110,12 +110,13 @@ function _send_email() { # No. 2 is especially useful in case you send more than one email in a single # test file and need to assert certain log entries for each mail individually. # -# The first argument has to be the name of the variable that the e-mail ID is stored -# in. The second argument **can** be the flag `--expect-rejection`. If this flag is supplied, -# the function does not check whether the whole mail delivery transaction was successful and -# it will also query the queue ID differently. Be warned though that it must still be possible -# to `grep` for the Message-ID that Postfix generated in the mail log; otherwise this function -# fails. The rest of the arguments are the same as `_send_email`. +# The first argument has to be the name of the variable that the e-mail ID is stored in. +# The second argument **can** be the flag `--expect-rejection`. +# - If this flag is supplied, the function does not check whether the whole mail delivery +# transaction was successful. Additionally the queue ID will be retrieved differently. +# - CAUTION: It must still be possible to `grep` for the Message-ID that Postfix +# generated in the mail log; otherwise this function fails. +# The rest of the arguments are the same as `_send_email`. # # ## Attention #