diff options
| author | Junio C Hamano <gitster@pobox.com> | 2023-05-10 11:59:24 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-05-10 11:59:24 -0700 |
| commit | 7ab2d2049fb91c247b9a764f0f7b6bbac411e5fd (patch) | |
| tree | 9fe7bdfe105914585d07e0f127595ceb797cc3e0 /githooks.html | |
| parent | 8dc18870b81cf54a9c4d1bff419c92da2303162f (diff) | |
| download | git-htmldocs-7ab2d2049fb91c247b9a764f0f7b6bbac411e5fd.tar.gz | |
Autogenerated HTML docs for v2.40.1-552-g91428
Diffstat (limited to 'githooks.html')
| -rw-r--r-- | githooks.html | 27 |
1 files changed, 22 insertions, 5 deletions
diff --git a/githooks.html b/githooks.html index 0a81d1fe0..841c9b84e 100644 --- a/githooks.html +++ b/githooks.html @@ -1286,10 +1286,27 @@ processed by rebase.</p></div> </div>
<div class="sect2">
<h3 id="_sendemail_validate">sendemail-validate</h3>
-<div class="paragraph"><p>This hook is invoked by <a href="git-send-email.html">git-send-email(1)</a>. It takes a single parameter,
-the name of the file that holds the e-mail to be sent. Exiting with a
-non-zero status causes <code>git send-email</code> to abort before sending any
-e-mails.</p></div>
+<div class="paragraph"><p>This hook is invoked by <a href="git-send-email.html">git-send-email(1)</a>.</p></div>
+<div class="paragraph"><p>It takes these command line arguments. They are,
+1. the name of the file which holds the contents of the email to be sent.
+2. The name of the file which holds the SMTP headers of the email.</p></div>
+<div class="paragraph"><p>The SMTP headers are passed in the exact same way as they are passed to the
+user’s Mail Transport Agent (MTA). In effect, the email given to the user’s
+MTA, is the contents of $2 followed by the contents of $1.</p></div>
+<div class="paragraph"><p>An example of a few common headers is shown below. Take notice of the
+capitalization and multi-line tab structure.</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>From: Example <from@example.com>
+To: to@example.com
+Cc: cc@example.com,
+ A <author@example.com>,
+ One <one@example.com>,
+ two@example.com
+Subject: PATCH-STRING</code></pre>
+</div></div>
+<div class="paragraph"><p>Exiting with a non-zero status causes <code>git send-email</code> to abort
+before sending any e-mails.</p></div>
<div class="paragraph"><p>The following environment variables are set when executing the hook.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
@@ -1425,7 +1442,7 @@ running passing "1", "1" should not be possible.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2023-04-25 14:39:23 PDT
+ 2023-05-10 11:57:07 PDT
</div>
</div>
</body>
|