Skip to content

Commit fe6fb09

Browse files
committed
Merge branch 'ag/doc-send-email'
Documentation updates for "git send-email". * ag/doc-send-email: docs: mention possible options for Proton Mail users docs: add a paragraph explaining the `sendmailCmd` option of sendemail docs: add an OAuth2.0 credential helper for AOL accounts docs: add outlookidfix config option to sendemail documentation docs: link OpenSSL's verify(1) manual page to know about -CAfile and -CApath options
2 parents 0fd2a2e + ac1a32e commit fe6fb09

File tree

2 files changed

+55
-8
lines changed

2 files changed

+55
-8
lines changed

Documentation/config/sendemail.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ sendemail.confirm::
3131
values.
3232

3333
sendemail.mailmap::
34-
If true, makes linkgit:git-send-email[1] assume `--mailmap`,
35-
otherwise assume `--no-mailmap`. False by default.
34+
If `true`, makes linkgit:git-send-email[1] assume `--mailmap`,
35+
otherwise assume `--no-mailmap`. `False` by default.
3636

3737
sendemail.mailmap.file::
3838
The location of a linkgit:git-send-email[1] specific augmenting
@@ -96,6 +96,11 @@ sendemail.xmailer::
9696
linkgit:git-send-email[1] command-line options. See its
9797
documentation for details.
9898

99+
sendemail.outlookidfix::
100+
If `true`, makes linkgit:git-send-email[1] assume `--outlook-id-fix`,
101+
and if `false` assume `--no-outlook-id-fix`. If not specified, it will
102+
behave the same way as if `--outlook-id-fix` is not specified.
103+
99104
sendemail.signedOffCc (deprecated)::
100105
Deprecated alias for `sendemail.signedOffByCc`.
101106

Documentation/git-send-email.adoc

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -280,12 +280,14 @@ must be used for each option.
280280
Path to a store of trusted CA certificates for SMTP SSL/TLS
281281
certificate validation (either a directory that has been processed
282282
by `c_rehash`, or a single file containing one or more PEM format
283-
certificates concatenated together: see verify(1) -CAfile and
284-
-CApath for more information on these). Set it to an empty string
285-
to disable certificate verification. Defaults to the value of the
286-
`sendemail.smtpSSLCertPath` configuration variable, if set, or the
287-
backing SSL library's compiled-in default otherwise (which should
288-
be the best choice on most platforms).
283+
certificates concatenated together: see the description of the
284+
`-CAfile` _<file>_ and the `-CApath` _<dir>_ options of
285+
https://docs.openssl.org/master/man1/openssl-verify/
286+
[OpenSSL's verify(1) manual page] for more information on these).
287+
Set it to an empty string to disable certificate verification.
288+
Defaults to the value of the `sendemail.smtpSSLCertPath` configuration
289+
variable, if set, or the backing SSL library's compiled-in default
290+
otherwise (which should be the best choice on most platforms).
289291

290292
--smtp-user=<user>::
291293
Username for SMTP-AUTH. Default is the value of `sendemail.smtpUser`;
@@ -598,9 +600,20 @@ available online. Community maintained credential helpers are also available:
598600
- https://github.com/AdityaGarg8/git-credential-email[git-credential-yahoo]
599601
(cross platform, dedicated helper for authenticating Yahoo accounts)
600602

603+
- https://github.com/AdityaGarg8/git-credential-email[git-credential-aol]
604+
(cross platform, dedicated helper for authenticating AOL accounts)
605+
601606
You can also see linkgit:gitcredentials[7] for more OAuth based authentication
602607
helpers.
603608

609+
Proton Mail does not provide an SMTP server to send emails. If you are a paid
610+
customer of Proton Mail, you can use
611+
https://proton.me/mail/bridge[Proton Mail Bridge]
612+
officially provided by Proton Mail to create a local SMTP server for sending
613+
emails. For both free and paid users, community maintained projects like
614+
https://github.com/AdityaGarg8/git-credential-email[git-protonmail] can be
615+
used.
616+
604617
Note: the following core Perl modules that may be installed with your
605618
distribution of Perl are required:
606619

@@ -614,6 +627,35 @@ These additional Perl modules are also required:
614627
https://metacpan.org/pod/Authen::SASL[Authen::SASL] and
615628
https://metacpan.org/pod/Mail::Address[Mail::Address].
616629

630+
Exploiting the `sendmailCmd` option of `git send-email`
631+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
632+
633+
Apart from sending emails via an SMTP server, `git send-email` can also send
634+
emails through any application that supports sendmail-like commands. You can
635+
read documentation of `--sendmail-cmd=<command>` above for more information.
636+
This ability can be very useful if you want to use another application as an
637+
SMTP client for `git send-email`, or if your email provider uses proprietary
638+
APIs instead of SMTP to send emails.
639+
640+
As an example, lets see how to configure https://marlam.de/msmtp/[msmtp], a
641+
popular SMTP client found in many Linux distributions. Edit `~/.gitconfig`
642+
to instruct `git-send-email` to use it for sending emails.
643+
644+
----
645+
[sendemail]
646+
sendmailCmd = /usr/bin/msmtp # Change this to the path where msmtp is installed
647+
----
648+
649+
Links of a few such community maintained helpers are:
650+
651+
- https://marlam.de/msmtp/[msmtp]
652+
(popular SMTP client with many features, available for Linux and macOS)
653+
654+
- https://github.com/AdityaGarg8/git-credential-email[git-protonmail]
655+
(cross platform client that can send emails using the ProtonMail API)
656+
657+
- https://github.com/AdityaGarg8/git-credential-email[git-msgraph]
658+
(cross platform client that can send emails using the Microsoft Graph API)
617659

618660
SEE ALSO
619661
--------

0 commit comments

Comments
 (0)