Merge branch 'stable'

[stgit] / stgit / commands / mail.py

diff --git a/stgit/commands/mail.py b/stgit/commands/mail.py
index d758b9c810bad171a90faad49ad958ffbc3b7792..b4d4e18acce6d4ef5ba4b66db60c96404f9822f2 100644 (file)
--- a/stgit/commands/mail.py
+++ b/stgit/commands/mail.py
@@ -15,122 +15,177 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 """
 
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 """
 

-import sys, os, re, time, smtplib, email.Utils
+import sys, os, re, time, datetime, socket, smtplib, getpass
+import email, email.Utils, email.Header

 from optparse import OptionParser, make_option
 from optparse import OptionParser, make_option

-from time import gmtime, strftime

 
 from stgit.commands.common import *
 from stgit.utils import *
 
 from stgit.commands.common import *
 from stgit.utils import *

-from stgit import stack, git
+from stgit.out import *
+from stgit import stack, git, version, templates

 from stgit.config import config
 
 
 help = 'send a patch or series of patches by e-mail'
 from stgit.config import config
 
 
 help = 'send a patch or series of patches by e-mail'

-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
-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.
+usage = r"""%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
+
+Send a patch or a range of patches by e-mail using the SMTP server
+specified by the 'stgit.smtpserver' configuration option, or the
+'--smtp-server' command line 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
+'~/.stgit/templates/patchmail.tmpl' or
+'/usr/share/stgit/templates/patchmail.tmpl'). A patch can be sent as
+attachment using the --attach option in which case the 'mailattch.tmpl'
+template will be used instead of 'patchmail.tmpl'.
+
+The To/Cc/Bcc addresses can either be added to the template file or
+passed via the corresponding command line options. They can be e-mail
+addresses or aliases which are automatically expanded to the values
+stored in the [mail "alias"] section of GIT configuration files.
+
+A preamble e-mail can be sent using the '--cover' and/or
+'--edit-cover' options. The first allows the user to specify a file to
+be used as a template. The latter option will invoke the editor on the
+specified file (defaulting to '.git/covermail.tmpl' or
+'~/.stgit/templates/covermail.tmpl' or
+'/usr/share/stgit/templates/covermail.tmpl').
+
+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:
 
 SMTP authentication is also possible with '--smtp-user' and
 '--smtp-password' options, also available as configuration settings:

-'smtpuser' and 'smtppassword'.
+'smtpuser' and 'smtppassword'. TLS encryption can be enabled by
+'--smtp-tls' option and 'smtptls' setting.

 
 

-The template e-mail headers and body must be separated by
-'%(endofheaders)s' variable, which is replaced by StGIT with
-additional headers and a blank line. The patch e-mail template accepts
-the following variables:
+The following variables are accepted by both the preamble and the
+patch e-mail templates:

 
 

-  %(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
-  %(diff)s         - unified diff of the patch

   %(diffstat)s     - diff statistics
   %(diffstat)s     - diff statistics

-  %(date)s         - current date/time
+  %(number)s       - empty if only one patch is sent or ' patchnr/totalnr'

   %(patchnr)s      - patch number
   %(patchnr)s      - patch number

+  %(sender)s       - 'sender'  or 'authname <authemail>' as per the config file

   %(totalnr)s      - total number of patches to be sent
   %(totalnr)s      - total number of patches to be sent

-  %(number)s       - empty if only one patch is sent or ' patchnr/totalnr'
-  %(authname)s     - author's name
-  %(authemail)s    - author's email
+  %(version)s      - ' version' string passed on the command line (or empty)
+
+In addition to the common variables, the preamble e-mail template
+accepts the following:
+
+  %(shortlog)s     - first line of each patch description, listed by author
+
+In addition to the common variables, the patch e-mail template accepts
+the following:
+

   %(authdate)s     - patch creation date
   %(authdate)s     - patch creation date

-  %(commname)s     - committer's name
+  %(authemail)s    - author's email
+  %(authname)s     - author's name

   %(commemail)s    - committer's e-mail
   %(commemail)s    - committer's e-mail

+  %(commname)s     - committer's name
+  %(diff)s         - unified diff of the patch
+  %(fromauth)s     - 'From: author\n\n' if different from sender
+  %(longdescr)s    - the rest of the patch description, after the first line
+  %(patch)s        - patch name
+  %(prefix)s       - 'prefix ' string passed on the command line
+  %(shortdescr)s   - the first line of the patch description"""

 
 

-For the preamble e-mail template, only the %(maintainer)s, %(date)s,
-%(endofheaders)s, %(patchnr)s, %(totalnr)s and %(number)s variables
-are supported."""
-
+directory = DirectoryHasRepository()

 options = [make_option('-a', '--all',
                        help = 'e-mail all the applied patches',
                        action = 'store_true'),
 options = [make_option('-a', '--all',
                        help = 'e-mail all the applied patches',
                        action = 'store_true'),

-           make_option('-r', '--range',
-                       metavar = '[PATCH1][:[PATCH2]]',
-                       help = 'e-mail patches between PATCH1 and PATCH2'),

            make_option('--to',
            make_option('--to',

-                       help = 'Add TO to the To: list'),
+                       help = 'add TO to the To: list',
+                       action = 'append'),

            make_option('--cc',
            make_option('--cc',

-                       help = 'Add CC to the Cc: list'),
+                       help = 'add CC to the Cc: list',
+                       action = 'append'),

            make_option('--bcc',
            make_option('--bcc',

-                       help = 'Add BCC to the Bcc: list'),
+                       help = 'add BCC to the Bcc: list',
+                       action = 'append'),
+           make_option('--auto',
+                       help = 'automatically cc the patch signers',
+                       action = 'store_true'),
+           make_option('--noreply',
+                       help = 'do not send subsequent messages as replies',
+                       action = 'store_true'),
+           make_option('--unrelated',
+                       help = 'send patches without sequence numbering',
+                       action = 'store_true'),
+           make_option('--attach',
+                       help = 'send a patch as attachment',
+                       action = 'store_true'),
+           make_option('-v', '--version', metavar = 'VERSION',
+                       help = 'add VERSION to the [PATCH ...] prefix'),
+           make_option('--prefix', metavar = 'PREFIX',
+                       help = 'add PREFIX to the [... PATCH ...] prefix'),

            make_option('-t', '--template', metavar = 'FILE',
                        help = 'use FILE as the message template'),
            make_option('-t', '--template', metavar = 'FILE',
                        help = 'use FILE as the message template'),

-           make_option('-f', '--first', metavar = 'FILE',
-                       help = 'send FILE as the first message'),
+           make_option('-c', '--cover', metavar = 'FILE',
+                       help = 'send FILE as the cover message'),
+           make_option('-e', '--edit-cover',
+                       help = 'edit the cover message before sending',
+                       action = 'store_true'),
+           make_option('-E', '--edit-patches',
+                       help = 'edit each patch before sending',
+                       action = 'store_true'),

            make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS',
                        help = 'sleep for SECONDS between e-mails sending'),
            make_option('--refid',
            make_option('-s', '--sleep', type = 'int', metavar = 'SECONDS',
                        help = 'sleep for SECONDS between e-mails sending'),
            make_option('--refid',

-                       help = 'Use REFID as the reference id'),
+                       help = 'use REFID as the reference id'),
+           make_option('--smtp-server', metavar = 'HOST[:PORT]',
+                       help = 'SMTP server to use for sending mail'),

            make_option('-u', '--smtp-user', metavar = 'USER',
                        help = 'username for SMTP authentication'),
            make_option('-p', '--smtp-password', metavar = 'PASSWORD',
            make_option('-u', '--smtp-user', metavar = 'USER',
                        help = 'username for SMTP authentication'),
            make_option('-p', '--smtp-password', metavar = 'PASSWORD',

-                       help = 'username for SMTP authentication')]
+                       help = 'username for SMTP authentication'),
+           make_option('-T', '--smtp-tls',
+                       help = 'use SMTP with TLS encryption',
+                       action = 'store_true'),
+           make_option('-b', '--branch',
+                       help = 'use BRANCH instead of the default one'),
+           make_option('-m', '--mbox',
+                       help = 'generate an mbox file instead of sending',
+                       action = 'store_true')
+           ] + make_diff_opts_option()

 
 
 
 

-def __get_maintainer():
+def __get_sender():

     """Return the 'authname <authemail>' string as read from the
     configuration file
     """
     """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
+    sender=config.get('stgit.sender')
+    if not sender:
+        try:
+            sender = str(git.user())
+        except git.GitException:
+            sender = str(git.author())
+
+    if not sender:
+        raise CmdException, 'unknown sender details'
+
+    return address_or_alias(sender)

 
 

-def __parse_addresses(string):
+def __parse_addresses(msg):

     """Return a two elements tuple: (from, [to])
     """
     """Return a two elements tuple: (from, [to])
     """

-    def __addr_list(string):
-        return re.split('.*?([\w\.]+@[\w\.]+)', string)[1:-1:2]
-
-    from_addr_list = []
-    to_addr_list = []
-    for line in string.split('\n'):
-        if re.match('from:\s+', line, re.I):
-            from_addr_list += __addr_list(line)
-        elif re.match('(to|cc|bcc):\s+', line, re.I):
-            to_addr_list += __addr_list(line)
-
-    if len(from_addr_list) != 1:
+    def __addr_list(msg, header):
+        return [name_addr[1] for name_addr in
+                email.Utils.getaddresses(msg.get_all(header, []))]
+
+    from_addr_list = __addr_list(msg, 'From')
+    if len(from_addr_list) == 0:

         raise CmdException, 'No "From" address'
         raise CmdException, 'No "From" address'

+
+    to_addr_list = __addr_list(msg, 'To') + __addr_list(msg, 'Cc') \
+                   + __addr_list(msg, 'Bcc')

     if len(to_addr_list) == 0:
         raise CmdException, 'No "To/Cc/Bcc" addresses'
 
     return (from_addr_list[0], to_addr_list)
 
 def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
     if len(to_addr_list) == 0:
         raise CmdException, 'No "To/Cc/Bcc" addresses'
 
     return (from_addr_list[0], to_addr_list)
 
 def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,

-                   smtpuser, smtppassword):
+                   smtpuser, smtppassword, use_tls):

     """Send the message using the given SMTP server
     """
     try:
     """Send the message using the given SMTP server
     """
     try:


@@ -142,9 +197,16 @@ def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
     try:
         if smtpuser and smtppassword:
             s.ehlo()
     try:
         if smtpuser and smtppassword:
             s.ehlo()

+            if use_tls:
+                if not hasattr(socket, 'ssl'):
+                    raise CmdException,  "cannot use TLS - no SSL support in Python"
+                s.starttls()
+                s.ehlo()

             s.login(smtpuser, smtppassword)
 
             s.login(smtpuser, smtppassword)
 

-        s.sendmail(from_addr, to_addr_list, msg)
+        result = s.sendmail(from_addr, to_addr_list, msg)
+        if len(result):
+            print "mail server refused delivery for the following recipients: %s" % result

         # give recipients a chance of receiving patches in the correct order
         time.sleep(sleep)
     except Exception, err:
         # give recipients a chance of receiving patches in the correct order
         time.sleep(sleep)
     except Exception, err:


@@ -152,38 +214,158 @@ def __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
 
     s.quit()
 
 
     s.quit()
 

-def __build_first(tmpl, total_nr, msg_id, options):
-    """Build the first message (series description) to be sent via SMTP
+def __build_address_headers(msg, options, extra_cc = []):
+    """Build the address headers and check existing headers in the
+    template.

     """
     """

-    maintainer = __get_maintainer()
-    if not maintainer:
-        maintainer = ''
+    def __replace_header(header, addr):
+        if addr:
+            crt_addr = msg[header]
+            del msg[header]
+
+            if crt_addr:
+                msg[header] = address_or_alias(', '.join([crt_addr, addr]))
+            else:
+                msg[header] = address_or_alias(addr)
+
+    to_addr = ''
+    cc_addr = ''
+    bcc_addr = ''
+
+    autobcc = config.get('stgit.autobcc') or ''

 
 

-    headers_end = ''

     if options.to:
     if options.to:

-        headers_end += 'To: %s\n' % options.to
+        to_addr = ', '.join(options.to)

     if options.cc:
     if options.cc:

-        headers_end += 'Cc: %s\n' % options.cc
+        cc_addr = ', '.join(options.cc + extra_cc)
+        cc_addr = ', '.join(options.cc + extra_cc)
+    elif extra_cc:
+        cc_addr = ', '.join(extra_cc)

     if options.bcc:
     if options.bcc:

-        headers_end += 'Bcc: %s\n' % options.bcc
-    headers_end += 'Message-Id: %s\n' % msg_id
+        bcc_addr = ', '.join(options.bcc + [autobcc])
+    elif autobcc:
+        bcc_addr = autobcc

 
 

-    total_nr_str = str(total_nr)
+    __replace_header('To', to_addr)
+    __replace_header('Cc', cc_addr)
+    __replace_header('Bcc', bcc_addr)
+
+def __get_signers_list(msg):
+    """Return the address list generated from signed-off-by and
+    acked-by lines in the message.
+    """
+    addr_list = []
+
+    r = re.compile('^(signed-off-by|acked-by|cc):\s+(.+)$', re.I)
+    for line in msg.split('\n'):
+        m = r.match(line)
+        if m:
+            addr_list.append(m.expand('\g<2>'))
+
+    return addr_list
+
+def __build_extra_headers(msg, msg_id, ref_id = None):
+    """Build extra email headers and encoding
+    """
+    del msg['Date']
+    msg['Date'] = email.Utils.formatdate(localtime = True)
+    msg['Message-ID'] = msg_id
+    if ref_id:
+        # make sure the ref id has the angle brackets
+        ref_id = '<%s>' % ref_id.strip(' \t\n<>')
+        msg['In-Reply-To'] = ref_id
+        msg['References'] = ref_id
+    msg['User-Agent'] = 'StGIT/%s' % version.version
+
+def __encode_message(msg):
+    # 7 or 8 bit encoding
+    charset = email.Charset.Charset('utf-8')
+    charset.body_encoding = None
+
+    # encode headers
+    for header, value in msg.items():
+        words = []
+        for word in value.split(' '):
+            try:
+                uword = unicode(word, 'utf-8')
+            except UnicodeDecodeError:
+                # maybe we should try a different encoding or report
+                # the error. At the moment, we just ignore it
+                pass
+            words.append(email.Header.Header(uword).encode())
+        new_val = ' '.join(words)
+        msg.replace_header(header, new_val)
+
+    # encode the body and set the MIME and encoding headers
+    if msg.is_multipart():
+        for p in msg.get_payload():
+            p.set_charset(charset)
+    else:
+        msg.set_charset(charset)
+
+def __edit_message(msg):
+    fname = '.stgitmail.txt'
+
+    # create the initial file
+    f = file(fname, 'w')
+    f.write(msg)
+    f.close()
+
+    call_editor(fname)
+
+    # read the message back
+    f = file(fname)
+    msg = f.read()
+    f.close()
+
+    return msg
+
+def __build_cover(tmpl, patches, msg_id, options):
+    """Build the cover message (series description) to be sent via SMTP
+    """
+    sender = __get_sender()
+
+    if options.version:
+        version_str = ' %s' % options.version
+    else:
+        version_str = ''
+
+    if options.prefix:
+        prefix_str = options.prefix + ' '
+    else:
+        confprefix = config.get('stgit.mail.prefix')
+        if confprefix:
+            prefix_str = confprefix + ' '
+        else:
+            prefix_str = ''
+        
+    total_nr_str = str(len(patches))

     patch_nr_str = '0'.zfill(len(total_nr_str))
     patch_nr_str = '0'.zfill(len(total_nr_str))

-    if total_nr > 1:
+    if len(patches) > 1:

         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
     else:
         number_str = ''
 
         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
     else:
         number_str = ''
 

-    tmpl_dict = {'maintainer':   maintainer,
-                 'endofheaders': headers_end,
-                 'date':         email.Utils.formatdate(localtime = True),
+    tmpl_dict = {'sender':       sender,
+                 # for backward template compatibility
+                 'maintainer':   sender,
+                 # for backward template compatibility
+                 'endofheaders': '',
+                 # for backward template compatibility
+                 'date':         '',
+                 'version':      version_str,
+                 'prefix':      prefix_str,

                  'patchnr':      patch_nr_str,
                  'totalnr':      total_nr_str,
                  'patchnr':      patch_nr_str,
                  'totalnr':      total_nr_str,

-                 'number':       number_str}
+                 'number':       number_str,
+                 'shortlog':     stack.shortlog(crt_series.get_patch(p)
+                                                for p in patches),
+                 'diffstat':     git.diffstat(git.diff(
+                     rev1 = git_id(crt_series, '%s//bottom' % patches[0]),
+                     rev2 = git_id(crt_series, '%s//top' % patches[-1])))}

 
     try:
 
     try:

-        msg = tmpl % tmpl_dict
+        msg_string = tmpl % tmpl_dict

     except KeyError, err:
         raise CmdException, 'Unknown patch template variable: %s' \
               % err
     except KeyError, err:
         raise CmdException, 'Unknown patch template variable: %s' \
               % err


@@ -191,6 +373,19 @@ def __build_first(tmpl, total_nr, msg_id, options):
         raise CmdException, 'Only "%(name)s" variables are ' \
               'supported in the patch template'
 
         raise CmdException, 'Only "%(name)s" variables are ' \
               'supported in the patch template'
 

+    if options.edit_cover:
+        msg_string = __edit_message(msg_string)
+
+    # The Python email message
+    try:
+        msg = email.message_from_string(msg_string)
+    except Exception, ex:
+        raise CmdException, 'template parsing error: %s' % str(ex)
+
+    __build_address_headers(msg, options)
+    __build_extra_headers(msg, msg_id, options.refid)
+    __encode_message(msg)
+

     return msg
 
 def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
     return msg
 
 def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):


@@ -198,60 +393,84 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
     """
     p = crt_series.get_patch(patch)
 
     """
     p = crt_series.get_patch(patch)
 

-    descr = p.get_description().strip()
-    descr_lines = descr.split('\n')
+    if p.get_description():
+        descr = p.get_description().strip()
+    else:
+        # provide a place holder and force the edit message option on
+        descr = '<empty message>'
+        options.edit_patches = True

 
 

+    descr_lines = descr.split('\n')

     short_descr = descr_lines[0].rstrip()
     short_descr = descr_lines[0].rstrip()

-    long_descr = reduce(lambda x, y: x + '\n' + y,
-                        descr_lines[1:], '').lstrip()
+    long_descr = '\n'.join(descr_lines[1:]).lstrip()

 
 

-    maintainer = __get_maintainer()
-    if not maintainer:
-        maintainer = '%s <%s>' % (p.get_commname(), p.get_commemail())
+    authname = p.get_authname();
+    authemail = p.get_authemail();
+    commname = p.get_commname();
+    commemail = 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
+    sender = __get_sender()
+
+    fromauth = '%s <%s>' % (authname, authemail)
+    if fromauth != sender:
+        fromauth = 'From: %s\n\n' % fromauth
+    else:
+        fromauth = ''
+
+    if options.version:
+        version_str = ' %s' % options.version
+    else:
+        version_str = ''
+
+    if options.prefix:
+        prefix_str = options.prefix + ' '
+    else:
+        confprefix = config.get('stgit.mail.prefix')
+        if confprefix:
+            prefix_str = confprefix + ' '
+        else:
+            prefix_str = ''

 
     total_nr_str = str(total_nr)
     patch_nr_str = str(patch_nr).zfill(len(total_nr_str))
 
     total_nr_str = str(total_nr)
     patch_nr_str = str(patch_nr).zfill(len(total_nr_str))

-    if total_nr > 1:
+    if not options.unrelated and total_nr > 1:

         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
     else:
         number_str = ''
 
         number_str = ' %s/%s' % (patch_nr_str, total_nr_str)
     else:
         number_str = ''
 

+    diff = git.diff(rev1 = git_id(crt_series, '%s//bottom' % patch),
+                    rev2 = git_id(crt_series, '%s//top' % patch),
+                    diff_flags = options.diff_flags)

     tmpl_dict = {'patch':        patch,
     tmpl_dict = {'patch':        patch,

-                 'maintainer':   maintainer,
+                 'sender':       sender,
+                 # for backward template compatibility
+                 'maintainer':   sender,

                  'shortdescr':   short_descr,
                  'longdescr':    long_descr,
                  'shortdescr':   short_descr,
                  'longdescr':    long_descr,

-                 'endofheaders': headers_end,
-                 'diff':         git.diff(rev1 = git_id('%s/bottom' % patch),
-                                          rev2 = git_id('%s/top' % patch)),
-                 'diffstat':     git.diffstat(rev1 = git_id('%s/bottom'%patch),
-                                              rev2 = git_id('%s/top' % patch)),
-                 'date':         email.Utils.formatdate(localtime = True),
+                 # for backward template compatibility
+                 'endofheaders': '',
+                 'diff':         diff,
+                 'diffstat':     git.diffstat(diff),
+                 # for backward template compatibility
+                 'date':         '',
+                 'version':      version_str,
+                 'prefix':       prefix_str,

                  'patchnr':      patch_nr_str,
                  'totalnr':      total_nr_str,
                  'number':       number_str,
                  'patchnr':      patch_nr_str,
                  'totalnr':      total_nr_str,
                  'number':       number_str,

-                 'authname':     p.get_authname(),
-                 'authemail':    p.get_authemail(),
+                 'fromauth':     fromauth,
+                 'authname':     authname,
+                 'authemail':    authemail,

                  'authdate':     p.get_authdate(),
                  'authdate':     p.get_authdate(),

-                 'commname':     p.get_commname(),
-                 'commemail':    p.get_commemail()}
+                 'commname':     commname,
+                 'commemail':    commemail}
+    # change None to ''

     for key in tmpl_dict:
         if not tmpl_dict[key]:
             tmpl_dict[key] = ''
 
     try:
     for key in tmpl_dict:
         if not tmpl_dict[key]:
             tmpl_dict[key] = ''
 
     try:

-        msg = tmpl % tmpl_dict
+        msg_string = tmpl % tmpl_dict

     except KeyError, err:
         raise CmdException, 'Unknown patch template variable: %s' \
               % err
     except KeyError, err:
         raise CmdException, 'Unknown patch template variable: %s' \
               % err


@@ -259,126 +478,114 @@ def __build_message(tmpl, patch, patch_nr, total_nr, msg_id, ref_id, options):
         raise CmdException, 'Only "%(name)s" variables are ' \
               'supported in the patch template'
 
         raise CmdException, 'Only "%(name)s" variables are ' \
               'supported in the patch template'
 

+    if options.edit_patches:
+        msg_string = __edit_message(msg_string)
+
+    # The Python email message
+    try:
+        msg = email.message_from_string(msg_string)
+    except Exception, ex:
+        raise CmdException, 'template parsing error: %s' % str(ex)
+
+    if options.auto:
+        extra_cc = __get_signers_list(descr)
+    else:
+        extra_cc = []
+
+    __build_address_headers(msg, options, extra_cc)
+    __build_extra_headers(msg, msg_id, ref_id)
+    __encode_message(msg)
+

     return msg
 
 def func(parser, options, args):
     """Send the patches by e-mail using the patchmail.tmpl file as
     a template
     """
     return msg
 
 def func(parser, options, args):
     """Send the patches by e-mail using the patchmail.tmpl file as
     a template
     """

-    if len(args) > 1:
-        parser.error('incorrect number of arguments')
-
-    if not config.has_option('stgit', 'smtpserver'):
-        raise CmdException, 'smtpserver not defined'
-    smtpserver = config.get('stgit', 'smtpserver')
-
-    smtpuser = None
-    smtppassword = None
-    if config.has_option('stgit', 'smtpuser'):
-        smtpuser = config.get('stgit', 'smtpuser')
-    if config.has_option('stgit', 'smtppassword'):
-        smtppassword = config.get('stgit', 'smtppassword')
+    smtpserver = options.smtp_server or config.get('stgit.smtpserver')

 
     applied = crt_series.get_applied()
 
 
     applied = crt_series.get_applied()
 

-    if len(args) == 1:
-        if args[0] in applied:
-            patches = [args[0]]
-        else:
-            raise CmdException, 'Patch "%s" not applied' % args[0]
-    elif options.all:
+    if options.all:

         patches = applied
         patches = applied

-    elif options.range:
-        boundaries = options.range.split(':')
-        if len(boundaries) == 1:
-            start = boundaries[0]
-            stop = boundaries[0]
-        elif len(boundaries) == 2:
-            if boundaries[0] == '':
-                start = applied[0]
-            else:
-                start = boundaries[0]
-            if boundaries[1] == '':
-                stop = applied[-1]
-            else:
-                stop = boundaries[1]
-        else:
-            raise CmdException, 'incorrect parameters to "--range"'
-
-        if start in applied:
-            start_idx = applied.index(start)
-        else:
-            raise CmdException, 'Patch "%s" not applied' % start
-        if stop in applied:
-            stop_idx = applied.index(stop) + 1
-        else:
-            raise CmdException, 'Patch "%s" not applied' % stop
-
-        if start_idx >= stop_idx:
-            raise CmdException, 'Incorrect patch range order'
-
-        patches = applied[start_idx:stop_idx]
+    elif len(args) >= 1:
+        unapplied = crt_series.get_unapplied()
+        patches = parse_patches(args, applied + unapplied, len(applied))

     else:
         raise CmdException, 'Incorrect options. Unknown patches to send'
 
     else:
         raise CmdException, 'Incorrect options. Unknown patches to send'
 

-    if options.smtp_password:
-        smtppassword = options.smtp_password
+    out.start('Checking the validity of the patches')
+    for p in patches:
+        if crt_series.empty_patch(p):
+            raise CmdException, 'Cannot send empty patch "%s"' % p
+    out.done()

 
 

-    if options.smtp_user:
-        smtpuser = options.smtp_user
+    smtppassword = options.smtp_password or config.get('stgit.smtppassword')
+    smtpuser = options.smtp_user or config.get('stgit.smtpuser')
+    smtpusetls = options.smtp_tls or config.get('stgit.smtptls') == 'yes'

 
     if (smtppassword and not smtpuser):
         raise CmdException, 'SMTP password supplied, username needed'
 
     if (smtppassword and not smtpuser):
         raise CmdException, 'SMTP password supplied, username needed'

+    if (smtpusetls and not smtpuser):
+        raise CmdException, 'SMTP over TLS requested, username needed'

     if (smtpuser and not smtppassword):
     if (smtpuser and not smtppassword):

-        raise CmdException, 'SMTP username supplied, password needed'
+        smtppassword = getpass.getpass("Please enter SMTP password: ")

 
     total_nr = len(patches)
     if total_nr == 0:
         raise CmdException, 'No patches to send'
 
 
     total_nr = len(patches)
     if total_nr == 0:
         raise CmdException, 'No patches to send'
 

-    ref_id = options.refid
-
-    if options.sleep != None:
-        sleep = options.sleep
+    if options.refid:
+        if options.noreply or options.unrelated:
+            raise CmdException, \
+                  '--refid option not allowed with --noreply or --unrelated'
+        ref_id = options.refid

     else:
     else:

-        sleep = 2
+        ref_id = None

 
 

-    # send the first message (if any)
-    if options.first:
-        tmpl = file(options.first).read()
+    sleep = options.sleep or config.getint('stgit.smtpdelay')
+
+    # send the cover message (if any)
+    if options.cover or options.edit_cover:
+        if options.unrelated:
+            raise CmdException, 'cover sending not allowed with --unrelated'
+
+        # find the template file
+        if options.cover:
+            tmpl = file(options.cover).read()
+        else:
+            tmpl = templates.get_template('covermail.tmpl')
+            if not tmpl:
+                raise CmdException, 'No cover message template file found'

 
         msg_id = email.Utils.make_msgid('stgit')
 
         msg_id = email.Utils.make_msgid('stgit')

-        msg = __build_first(tmpl, total_nr, msg_id, options)
+        msg = __build_cover(tmpl, patches, msg_id, options)

         from_addr, to_addr_list = __parse_addresses(msg)
 
         from_addr, to_addr_list = __parse_addresses(msg)
 

-        # subsequent e-mails are seen as replies to the first one
-        ref_id = msg_id
+        msg_string = msg.as_string(options.mbox)

 
 

-        print 'Sending file "%s"...' % options.first,
-        sys.stdout.flush()
-
-        __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
-                       smtpuser, smtppassword)
+        # subsequent e-mails are seen as replies to the first one
+        if not options.noreply:
+            ref_id = msg_id

 
 

-        print 'done'
+        if options.mbox:
+            out.stdout_raw(msg_string + '\n')
+        else:
+            out.start('Sending the cover message')
+            __send_message(smtpserver, from_addr, to_addr_list, msg_string,
+                           sleep, smtpuser, smtppassword, smtpusetls)
+            out.done()

 
     # send the patches
     if options.template:
 
     # send the patches
     if options.template:

-        tfile_list = [options.template]
+        tmpl = file(options.template).read()

     else:
     else:

-        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])
+        if options.attach:
+            tmpl = templates.get_template('mailattch.tmpl')
+        else:
+            tmpl = templates.get_template('patchmail.tmpl')
+        if not tmpl:
+            raise CmdException, 'No e-mail template file found'

 
     for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)):
         msg_id = email.Utils.make_msgid('stgit')
 
     for (p, patch_nr) in zip(patches, range(1, len(patches) + 1)):
         msg_id = email.Utils.make_msgid('stgit')


@@ -386,14 +593,16 @@ def func(parser, options, args):
                               options)
         from_addr, to_addr_list = __parse_addresses(msg)
 
                               options)
         from_addr, to_addr_list = __parse_addresses(msg)
 

+        msg_string = msg.as_string(options.mbox)
+

         # subsequent e-mails are seen as replies to the first one
         # subsequent e-mails are seen as replies to the first one

-        if not ref_id:
+        if not options.noreply and not options.unrelated and not ref_id:

             ref_id = msg_id
 
             ref_id = msg_id
 

-        print 'Sending patch "%s"...' % p,
-        sys.stdout.flush()
-
-        __send_message(smtpserver, from_addr, to_addr_list, msg, sleep,
-                       smtpuser, smtppassword)
-
-        print 'done'
+        if options.mbox:
+            out.stdout_raw(msg_string + '\n')
+        else:
+            out.start('Sending patch "%s"' % p)
+            __send_message(smtpserver, from_addr, to_addr_list, msg_string,
+                           sleep, smtpuser, smtppassword, smtpusetls)
+            out.done()