Skip to content

troubleshooting.rst

Latest commit

 

History

History
78 lines (66 loc) · 3.18 KB

troubleshooting.rst

File metadata and controls

78 lines (66 loc) · 3.18 KB

Troubleshooting issues with git-multimail: a FAQ

How to check that git-multimail is properly set up?

Since version 1.4.0, git-multimail allows a simple self-checking of its configuration: run it with the environment variable GIT_MULTIMAIL_CHECK_SETUP set to a non-empty string. You should get something like this:

$ GIT_MULTIMAIL_CHECK_SETUP=true /home/moy/dev/git-multimail/git-multimail/git_multimail.py
Environment values:
    administrator : 'the administrator of this repository'
    charset : 'utf-8'
    emailprefix : '[git-multimail] '
    fqdn : 'anie'
    projectdesc : 'UNNAMED PROJECT'
    pusher : 'moy'
    repo_path : '/home/moy/dev/git-multimail'
    repo_shortname : 'git-multimail'

Now, checking that git-multimail's standard input is properly set ...
Please type some text and then press Return
foo
You have just entered:
foo
git-multimail seems properly set up.

If you forgot to set an important variable, you may get instead:

$ GIT_MULTIMAIL_CHECK_SETUP=true /home/moy/dev/git-multimail/git-multimail/git_multimail.py
No email recipients configured!

Do not set $GIT_MULTIMAIL_CHECK_SETUP other than for testing your configuration: it would disable the hook completely.

Git is not using the right address in the From/To/Reply-To field

First, make sure that git-multimail actually uses what you think it is using. A lot happens to your email (especially when posting to a mailing-list) between the time git_multimail.py sends it and the time it reaches your inbox.

A simple test (to do on a test repository, do not use in production as it would disable email sending): change your post-receive hook to call git_multimail.py with the --stdout option, and try to push to the repository. You should see something like:

Counting objects: 3, done.
Writing objects: 100% (3/3), 263 bytes | 0 bytes/s, done.
Total 3 (delta 0), reused 0 (delta 0)
remote: Sending notification emails to: foo.bar@example.com
remote: ===========================================================================
remote: Date: Mon, 25 Apr 2016 18:39:59 +0200
remote: To: foo.bar@example.com
remote: Subject: [git] branch master updated: foo
remote: MIME-Version: 1.0
remote: Content-Type: text/plain; charset=utf-8
remote: Content-Transfer-Encoding: 8bit
remote: Message-ID: <20160425163959.2311.20498@anie>
remote: From: Auth Or <Foo.Bar@example.com>
remote: Reply-To: Auth Or <Foo.Bar@example.com>
remote: X-Git-Host: example
...
remote: --
remote: To stop receiving notification emails like this one, please contact
remote: the administrator of this repository.
remote: ===========================================================================
To /path/to/repo
   6278f04..e173f20  master -> master

Note: this does not include the sender (Return-Path: header), as it is not part of the message content but passed to the mailer. Some mailer show the Sender: field instead of the From: field (for example, Zimbra Webmail shows From: <sender-field> on behalf of <from-field>).