RFC2047-encode email headers
PATCH 1/1 RFC2047-encode email headers
From: Karl Hasselström <[email protected]>
Having non-ascii characters in email headers is illegal, but StGIT currently does not care. I'm often bitten by this, since my name doesn't fit in ascii.
This patch implements an encoding pass just before the email is sent over the wire -- in particular, it comes after any interactive editing and templates and such, so the user should never have to see the rfc2047 encoding.
NOTE: The rfc2047 encoder needs to know the encoding of the input string. This patch hard-codes this to utf8, since that should be by far the most common non-ascii encoding, and since utf8 is already the hardcoded character set for the email body. In the long run, we probably want to get this from the locale, or from a command line switch, or both.
---
stgit/commands/mail.py | 45 +++++++++++++++++++++++++++++++++++++++++---- 1 files changed, 41 insertions(+), 4 deletions(-)
stgit/commands/mail.py +41 -4
@@ -15,7 +15,7 @@ along with this program; if not, write t Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -import sys, os, re, time, datetime, smtplib, email.Utils +import sys, os, re, time, datetime, smtplib, email.Header, email.Utils from optparse import OptionParser, make_option from stgit.commands.common import *
@@ -403,6 +403,42 @@ def __build_message(tmpl, patch, patch_n return msg.strip('\n') +def encode_header(s, enc): + """Take an entire e-mail header line, encoded in enc, and + rfc2047-encode it.""" + def trans(s): + return str(email.Header.Header(unicode(s, enc))) + words = s.split(' ') + first_encode = len(words) + last_encode = -1 + for i in xrange(len(words)): + ew = trans(words[i]) + if ew != words[i]: + first_encode = min(first_encode, i) + last_encode = max(last_encode, i) + if first_encode <= last_encode: + return ' '.join(filter( + None, + [' '.join(words[:first_encode]), + trans(' '.join(words[first_encode:last_encode+1])), + ' '.join(words[last_encode+1:])])) + else: + return s + +def encode_headers(msg, enc): + """rfc2047-encode the headers of msg, assuming it is encoded in + enc.""" + in_header = True + lines = [] + for line in msg.splitlines(True): + if in_header: + if line.strip(): + line = encode_header(line, enc) + else: + in_header = False + lines.append(line) + return ''.join(lines) + def func(parser, options, args): """Send the patches by e-mail using the patchmail.tmpl file as a template
@@ -461,7 +497,8 @@ def func(parser, options, args): raise CmdException, 'No cover message template file found' msg_id = email.Utils.make_msgid('stgit') - msg = __build_cover(tmpl, total_nr, msg_id, options) + msg = encode_headers(__build_cover(tmpl, total_nr, msg_id, options), + 'UTF-8') from_addr, to_addr_list = __parse_addresses(msg) # subsequent e-mails are seen as replies to the first one
@@ -487,8 +524,8 @@ def func(parser, options, args): for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)): msg_id = email.Utils.make_msgid('stgit') - msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id, - options) + msg = encode_headers(__build_message(tmpl, p, patch_nr, total_nr, + msg_id, ref_id, options), 'UTF-8') from_addr, to_addr_list = __parse_addresses(msg) # subsequent e-mails are seen as replies to the first one
Quoted 1 line · Karl Hasselström
From: Karl Hasselström <[email protected]>
OK, this patch did what it was supposed to do -- which was to encode the mail headers properly -- but StGIT still generates an 8-bit encoded body, and vger doesn't seem to like that (see the X-Warning:
headers it added to the patch mail). That's another fix for another day.
Catalin, if you take this patch, I'd appreciate it if you made double sure that my name doesn't have garbage in it. (It may very well be that the copy of the patch sent to you personally is unharmed; it all works fine when I send patches to myself. vger is the only mail server I have seen that has this problem.)
Signature · 2 lines
Karl Hasselström, [email protected] www.treskal.com/kalle
cover Make "stg mail" behave better with non-ascii characters
These two patches teach "stg mail" to ref2047-escape non-ascii characters in the mail headers (not doing so is illegal), and QP-encodes the body (leaving it as 8bit is not well received by some mail severs, notably vger).
The first patch is a resend, this time hopefully with my name intact.
Signature · 2 lines
Karl Hasselström, [email protected] www.treskal.com/kalle
PATCH 1/2 RFC2047-encode email headers
From: Karl Hasselström <[email protected]>
Having non-ascii characters in email headers is illegal, but StGIT currently does not care. I'm often bitten by this, since my name doesn't fit in ascii.
This patch implements an encoding pass just before the email is sent over the wire -- in particular, it comes after any interactive editing and templates and such, so the user should never have to see the rfc2047 encoding.
NOTE: The rfc2047 encoder needs to know the encoding of the input string. This patch hard-codes this to utf8, since that should be by far the most common non-ascii encoding, and since utf8 is already the hardcoded character set for the email body. In the long run, we probably want to get this from the locale, or from a command line switch, or both.
---
stgit/commands/mail.py | 45 +++++++++++++++++++++++++++++++++++++++++---- 1 files changed, 41 insertions(+), 4 deletions(-)
stgit/commands/mail.py +41 -4
@@ -15,7 +15,7 @@ along with this program; if not, write t Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -import sys, os, re, time, datetime, smtplib, email.Utils +import sys, os, re, time, datetime, smtplib, email.Header, email.Utils from optparse import OptionParser, make_option from stgit.commands.common import *
@@ -403,6 +403,42 @@ def __build_message(tmpl, patch, patch_n return msg.strip('\n') +def encode_header(s, enc): + """Take an entire e-mail header line, encoded in enc, and + rfc2047-encode it.""" + def trans(s): + return str(email.Header.Header(unicode(s, enc))) + words = s.split(' ') + first_encode = len(words) + last_encode = -1 + for i in xrange(len(words)): + ew = trans(words[i]) + if ew != words[i]: + first_encode = min(first_encode, i) + last_encode = max(last_encode, i) + if first_encode <= last_encode: + return ' '.join(filter( + None, + [' '.join(words[:first_encode]), + trans(' '.join(words[first_encode:last_encode+1])), + ' '.join(words[last_encode+1:])])) + else: + return s + +def encode_headers(msg, enc): + """rfc2047-encode the headers of msg, assuming it is encoded in + enc.""" + in_header = True + lines = [] + for line in msg.splitlines(True): + if in_header: + if line.strip(): + line = encode_header(line, enc) + else: + in_header = False + lines.append(line) + return ''.join(lines) + def func(parser, options, args): """Send the patches by e-mail using the patchmail.tmpl file as a template
@@ -461,7 +497,8 @@ def func(parser, options, args): raise CmdException, 'No cover message template file found' msg_id = email.Utils.make_msgid('stgit') - msg = __build_cover(tmpl, total_nr, msg_id, options) + msg = encode_headers(__build_cover(tmpl, total_nr, msg_id, options), + 'UTF-8') from_addr, to_addr_list = __parse_addresses(msg) # subsequent e-mails are seen as replies to the first one
@@ -487,8 +524,8 @@ def func(parser, options, args): for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)): msg_id = email.Utils.make_msgid('stgit') - msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id, - options) + msg = encode_headers(__build_message(tmpl, p, patch_nr, total_nr, + msg_id, ref_id, options), 'UTF-8') from_addr, to_addr_list = __parse_addresses(msg) # subsequent e-mails are seen as replies to the first one
PATCH 2/2 QP-encode email body
In reply to Karl HasselströmFrom: Karl Hasselström <[email protected]>
Some mail servers dislike the 8bit transfer encoding, so use quoted-printable instead.
---
stgit/commands/mail.py | 16 +++++++++------- 1 files changed, 9 insertions(+), 7 deletions(-)
stgit/commands/mail.py +9 -7
@@ -15,7 +15,7 @@ along with this program; if not, write t Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -import sys, os, re, time, datetime, smtplib, email.Header, email.Utils +import sys, os, re, time, datetime, quopri, smtplib, email.Header, email.Utils from optparse import OptionParser, make_option from stgit.commands.common import *
@@ -253,7 +253,7 @@ def __build_extra_headers(): """Build extra headers like content-type etc. """ headers = 'Content-Type: text/plain; charset=utf-8; format=fixed\n' - headers += 'Content-Transfer-Encoding: 8bit\n' + headers += 'Content-Transfer-Encoding: quoted-printable\n' headers += 'User-Agent: StGIT/%s\n' % version.version return headers
@@ -425,9 +425,9 @@ def encode_header(s, enc): else: return s -def encode_headers(msg, enc): - """rfc2047-encode the headers of msg, assuming it is encoded in - enc.""" +def encode_message(msg, enc): + """rfc2047-encode the headers of msg, and quoted-printable-encode + the body. msg is assumed to be encoded in enc.""" in_header = True lines = [] for line in msg.splitlines(True):
@@ -436,6 +436,8 @@ def encode_headers(msg, enc): line = encode_header(line, enc) else: in_header = False + else: + line = quopri.encodestring(line) lines.append(line) return ''.join(lines)
@@ -497,7 +499,7 @@ def func(parser, options, args): raise CmdException, 'No cover message template file found' msg_id = email.Utils.make_msgid('stgit') - msg = encode_headers(__build_cover(tmpl, total_nr, msg_id, options), + msg = encode_message(__build_cover(tmpl, total_nr, msg_id, options), 'UTF-8') from_addr, to_addr_list = __parse_addresses(msg)
@@ -524,7 +526,7 @@ def func(parser, options, args): for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)): msg_id = email.Utils.make_msgid('stgit') - msg = encode_headers(__build_message(tmpl, p, patch_nr, total_nr, + msg = encode_message(__build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id, options), 'UTF-8') from_addr, to_addr_list = __parse_addresses(msg)