usage = """%prog [options] [<patch>]
Send a patch or a range of patches (defaulting to the applied patches)
-by e-mail using the 'smtpserver' configuration option. The From/To/Cc
-addresses and the e-mail format are generated from the template file
-passed as argument to '--template' (defaulting to
-.git/patchmail.tmpl). A preamble e-mail can also be sent using the
-'--first' option (no default template).
-
-All the subsequent e-mails appear as replies to the first e-mail sent
-(either the preamble or the first patch). E-mails can be seen as
-replies to a different e-mail by using the '--refid' option.
+by e-mail using the 'smtpserver' configuration option. The From
+address and the e-mail format are generated from the template file
+passed as argument to '--template' (defaulting to .git/patchmail.tmpl
+or /usr/share/stgit/templates/patchmail.tmpl). The To/Cc/Bcc addresses
+can either be added to the template file or passed via the
+corresponding command line options.
+
+A preamble e-mail can be sent using the '--first' option. All the
+subsequent e-mails appear as replies to the first e-mail sent (either
+the preamble or the first patch). E-mails can be seen as replies to a
+different e-mail by using the '--refid' option.
SMTP authentication is also possible with '--smtp-user' and
'--smtp-password' options, also available as configuration settings:
the following variables:
%(patch)s - patch name
+ %(maintainer)s - 'authname <authemail>' as read from the config file
%(shortdescr)s - the first line of the patch description
%(longdescr)s - the rest of the patch description, after the first line
%(endofheaders)s - delimiter between e-mail headers and body
%(commname)s - committer's name
%(commemail)s - committer's e-mail
-For the preamble e-mail template, only the %(date)s, %(endofheaders)s
-and %(totalnr)s variables are supported."""
+For the preamble e-mail template, only the %(maintainer)s, %(date)s,
+%(endofheaders)s and %(totalnr)s variables are supported."""
options = [make_option('-a', '--all',
help = 'e-mail all the applied patches',
make_option('-r', '--range',
metavar = '[PATCH1][:[PATCH2]]',
help = 'e-mail patches between PATCH1 and PATCH2'),
+ make_option('--to',
+ help = 'Add TO to the To: list'),
+ make_option('--cc',
+ help = 'Add CC to the Cc: list'),
+ make_option('--bcc',
+ help = 'Add BCC to the Bcc: list'),
make_option('-t', '--template', metavar = 'FILE',
help = 'use FILE as the message template'),
make_option('-f', '--first', metavar = 'FILE',
help = 'username for SMTP authentication')]
+def __get_maintainer():
+ """Return the 'authname <authemail>' string as read from the
+ configuration file
+ """
+ if config.has_option('stgit', 'authname') \
+ and config.has_option('stgit', 'authemail'):
+ return '%s <%s>' % (config.get('stgit', 'authname'),
+ config.get('stgit', 'authemail'))
+ else:
+ return None
+
def __parse_addresses(string):
"""Return a two elements tuple: (from, [to])
"""
s.quit()
-def __build_first(tmpl, total_nr, msg_id):
+def __build_first(tmpl, total_nr, msg_id, options):
"""Build the first message (series description) to be sent via SMTP
"""
- headers_end = 'Message-Id: %s\n' % (msg_id)
+ maintainer = __get_maintainer()
+ if not maintainer:
+ maintainer = ''
+
+ headers_end = ''
+ if options.to:
+ headers_end += 'To: %s\n' % options.to
+ if options.cc:
+ headers_end += 'Cc: %s\n' % options.cc
+ if options.bcc:
+ headers_end += 'Bcc: %s\n' % options.bcc
+ headers_end += 'Message-Id: %s\n' % msg_id
+
total_nr_str = str(total_nr)
- tmpl_dict = {'endofheaders': headers_end,
+ tmpl_dict = {'maintainer': maintainer,
+ 'endofheaders': headers_end,
'date': email.Utils.formatdate(localtime = True),
'totalnr': total_nr_str}
return msg
-
-def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id = None):
+def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
"""Build the message to be sent via SMTP
"""
p = crt_series.get_patch(patch)
long_descr = reduce(lambda x, y: x + '\n' + y,
descr_lines[1:], '').lstrip()
- headers_end = 'Message-Id: %s\n' % (msg_id)
+ maintainer = __get_maintainer()
+ if not maintainer:
+ maintainer = '%s <%s>' % (p.get_commname(), p.get_commemail())
+
+ headers_end = ''
+ if options.to:
+ headers_end += 'To: %s\n' % options.to
+ if options.cc:
+ headers_end += 'Cc: %s\n' % options.cc
+ if options.bcc:
+ headers_end += 'Bcc: %s\n' % options.bcc
+ headers_end += 'Message-Id: %s\n' % msg_id
if ref_id:
- headers_end += "In-Reply-To: %s\n" % (ref_id)
- headers_end += "References: %s\n" % (ref_id)
+ headers_end += "In-Reply-To: %s\n" % ref_id
+ headers_end += "References: %s\n" % ref_id
total_nr_str = str(total_nr)
patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
tmpl_dict = {'patch': patch,
+ 'maintainer': maintainer,
'shortdescr': short_descr,
'longdescr': long_descr,
'endofheaders': headers_end,
return msg
-
def func(parser, options, args):
"""Send the patches by e-mail using the patchmail.tmpl file as
a template
# send the first message (if any)
if options.first:
tmpl = file(options.first).read()
- from_addr, to_addr_list = __parse_addresses(tmpl)
msg_id = email.Utils.make_msgid('stgit')
- msg = __build_first(tmpl, total_nr, msg_id)
+ msg = __build_first(tmpl, total_nr, msg_id, options)
+ from_addr, to_addr_list = __parse_addresses(msg)
# subsequent e-mails are seen as replies to the first one
ref_id = msg_id
# send the patches
if options.template:
- tfile = options.template
+ tfile_list = [options.template]
else:
- tfile = os.path.join(git.base_dir, 'patchmail.tmpl')
- tmpl = file(tfile).read()
-
- from_addr, to_addr_list = __parse_addresses(tmpl)
+ tfile_list = []
+
+ tfile_list += [os.path.join(git.base_dir, 'patchmail.tmpl'),
+ os.path.join(sys.prefix,
+ 'share/stgit/templates/patchmail.tmpl')]
+ tmpl = None
+ for tfile in tfile_list:
+ if os.path.isfile(tfile):
+ tmpl = file(tfile).read()
+ break
+ if not tmpl:
+ raise CmdException, 'No e-mail template file: %s or %s' \
+ % (tfile_list[-1], tfile_list[-2])
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)
+ msg = __build_message(tmpl, p, patch_nr, total_nr, msg_id, ref_id,
+ options)
+ from_addr, to_addr_list = __parse_addresses(msg)
+
# subsequent e-mails are seen as replies to the first one
if not ref_id:
ref_id = msg_id