3 # Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
4 # Copyright 2005 Ryan Anderson <ryan@michonline.com>
8 # Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com>
10 # Sends a collection of emails to the given email addresses, disturbingly fast.
12 # Supports two formats:
13 # 1. mbox format files (ignoring most headers and MIME formatting - this is designed for sending patches)
14 # 2. The original format support by Greg's script:
15 # first line of the message is who to CC,
16 # and second line is the subject of the message.
27 $SIG{INT
} = sub { print color
("reset"), "\n"; exit };
31 my ($class, $reason) = @_;
32 return bless \
$reason, shift;
36 die "Cannot use readline on FakeTerm: $$self";
43 git-send-email [options] <file | directory>...
45 --from Specify the "From:" line of the email to be sent.
47 --to Specify the primary "To:" line of the email.
49 --cc Specify an initial "Cc:" list for the entire series
52 --cc-cmd Specify a command to execute per file which adds
53 per file specific cc address entries
55 --bcc Specify a list of email addresses that should be Bcc:
58 --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
59 an introductory message for the patch series.
61 --subject Specify the initial "Subject:" line.
62 Only necessary if --compose is also set. If --compose
63 is not set, this will be prompted for.
65 --in-reply-to Specify the first "In-Reply-To:" header line.
66 Only used if --compose is also set. If --compose is not
67 set, this will be prompted for.
69 --chain-reply-to If set, the replies will all be to the previous
70 email sent, rather than to the first email sent.
73 --signed-off-cc Automatically add email addresses that appear in
74 Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
76 --identity The configuration identity, a subsection to prioritise over
79 --smtp-server If set, specifies the outgoing SMTP server to use.
80 Defaults to localhost. Port number can be specified here with
81 hostname:port format or by using --smtp-server-port option.
83 --smtp-server-port Specify a port on the outgoing SMTP server to connect to.
85 --smtp-user The username for SMTP-AUTH.
87 --smtp-pass The password for SMTP-AUTH.
89 --smtp-ssl If set, connects to the SMTP server using SSL.
91 --suppress-from Suppress sending emails to yourself. Defaults to off.
93 --thread Specify that the "In-Reply-To:" header should be set on all
94 emails. Defaults to on.
96 --quiet Make git-send-email less verbose. One line per email
97 should be all that is output.
99 --dry-run Do everything except actually send the emails.
101 --envelope-sender Specify the envelope sender used to send the emails.
103 --no-validate Don't perform any sanity checks on patches.
109 # most mail servers generate the Date: header, but not all...
110 sub format_2822_time
{
112 my @localtm = localtime($time);
113 my @gmttm = gmtime($time);
114 my $localmin = $localtm[1] + $localtm[2] * 60;
115 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
116 if ($localtm[0] != $gmttm[0]) {
117 die "local zone differs from GMT by a non-minute interval\n";
119 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
121 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
123 } elsif ($gmttm[6] != $localtm[6]) {
124 die "local time offset greater than or equal to 24 hours\n";
126 my $offset = $localmin - $gmtmin;
127 my $offhour = $offset / 60;
128 my $offmin = abs($offset % 60);
129 if (abs($offhour) >= 24) {
130 die ("local time offset greater than or equal to 24 hours\n");
133 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
134 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
136 qw(Jan Feb Mar Apr May Jun
137 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
142 ($offset >= 0) ?
'+' : '-',
148 my $have_email_valid = eval { require Email
::Valid
; 1 };
152 sub unique_email_list
(@
);
153 sub cleanup_compose_files
();
155 # Constants (essentially)
156 my $compose_filename = ".msg.$$";
158 # Variables we fill in automatically, or via prompting:
159 my (@to,@cc,@initial_cc,@bcclist,@xh,
160 $initial_reply_to,$initial_subject,@files,$author,$sender,$compose,$time);
165 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
167 my $repo = Git
->repository();
169 new Term
::ReadLine
'git-send-email';
172 $term = new FakeTerm
"$@: going non-interactive";
175 # Behavior modification variables
176 my ($quiet, $dry_run) = (0, 0);
178 # Variables with corresponding config settings
179 my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
180 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_authpass, $smtp_ssl);
181 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
184 my %config_bool_settings = (
185 "thread" => [\
$thread, 1],
186 "chainreplyto" => [\
$chain_reply_to, 1],
187 "suppressfrom" => [\
$suppress_from, 0],
188 "signedoffcc" => [\
$signed_off_cc, 1],
189 "smtpssl" => [\
$smtp_ssl, 0],
192 my %config_settings = (
193 "smtpserver" => \
$smtp_server,
194 "smtpserverport" => \
$smtp_server_port,
195 "smtpuser" => \
$smtp_authuser,
196 "smtppass" => \
$smtp_authpass,
199 "aliasfiletype" => \
$aliasfiletype,
201 "aliasesfile" => \
@alias_files,
204 # Begin by accumulating all the variables (defined above), that we will end up
205 # needing, first, from the command line:
207 my $rc = GetOptions
("sender|from=s" => \
$sender,
208 "in-reply-to=s" => \
$initial_reply_to,
209 "subject=s" => \
$initial_subject,
211 "cc=s" => \
@initial_cc,
212 "bcc=s" => \
@bcclist,
213 "chain-reply-to!" => \
$chain_reply_to,
214 "smtp-server=s" => \
$smtp_server,
215 "smtp-server-port=s" => \
$smtp_server_port,
216 "smtp-user=s" => \
$smtp_authuser,
217 "smtp-pass=s" => \
$smtp_authpass,
218 "smtp-ssl!" => \
$smtp_ssl,
219 "identity=s" => \
$identity,
220 "compose" => \
$compose,
222 "cc-cmd=s" => \
$cc_cmd,
223 "suppress-from!" => \
$suppress_from,
224 "signed-off-cc|signed-off-by-cc!" => \
$signed_off_cc,
225 "dry-run" => \
$dry_run,
226 "envelope-sender=s" => \
$envelope_sender,
227 "thread!" => \
$thread,
228 "no-validate" => \
$no_validate,
235 # Now, let's fill any that aren't set in with defaults:
240 foreach my $setting (keys %config_bool_settings) {
241 my $target = $config_bool_settings{$setting}->[0];
242 $$target = $repo->config_bool("$prefix.$setting") unless (defined $$target);
245 foreach my $setting (keys %config_settings) {
246 my $target = $config_settings{$setting};
247 if (ref($target) eq "ARRAY") {
249 my @values = $repo->config("$prefix.$setting");
250 @
$target = @values if (@values && defined $values[0]);
254 $$target = $repo->config("$prefix.$setting") unless (defined $$target);
259 # read configuration from [sendemail "$identity"], fall back on [sendemail]
260 $identity = $repo->config("sendemail.identity") unless (defined $identity);
261 read_config
("sendemail.$identity") if (defined $identity);
262 read_config
("sendemail");
264 # fall back on builtin bool defaults
265 foreach my $setting (values %config_bool_settings) {
266 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
269 my ($repoauthor) = $repo->ident_person('author');
270 my ($repocommitter) = $repo->ident_person('committer');
272 # Verify the user input
274 foreach my $entry (@to) {
275 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
278 foreach my $entry (@initial_cc) {
279 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
282 foreach my $entry (@bcclist) {
283 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
288 # multiline formats can be supported in the future
289 mutt
=> sub { my $fh = shift; while (<$fh>) {
290 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
291 my ($alias, $addr) = ($1, $2);
292 $addr =~ s/#.*$//; # mutt allows # comments
293 # commas delimit multiple addresses
294 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
296 mailrc
=> sub { my $fh = shift; while (<$fh>) {
297 if (/^alias\s+(\S+)\s+(.*)$/) {
298 # spaces delimit multiple addresses
299 $aliases{$1} = [ split(/\s+/, $2) ];
301 pine
=> sub { my $fh = shift; while (<$fh>) {
302 if (/^(\S+)\t.*\t(.*)$/) {
303 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
305 gnus
=> sub { my $fh = shift; while (<$fh>) {
306 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
307 $aliases{$1} = [ $2 ];
311 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
312 foreach my $file (@alias_files) {
313 open my $fh, '<', $file or die "opening $file: $!\n";
314 $parse_alias{$aliasfiletype}->($fh);
319 ($sender) = expand_aliases
($sender) if defined $sender;
321 # Now that all the defaults are set, process the rest of the command line
322 # arguments and collect up the files that need to be processed.
326 or die "Failed to opendir $f: $!";
328 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
335 print STDERR
"Skipping $f - not found.\n";
340 foreach my $f (@files) {
341 my $error = validate_patch
($f);
342 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
348 print $_,"\n" for (@files);
351 print STDERR
"\nNo patch files specified!\n\n";
356 if (!defined $sender) {
357 $sender = $repoauthor || $repocommitter;
359 $_ = $term->readline("Who should the emails appear to be from? [$sender] ");
360 } while (!defined $_);
362 $sender = $_ if ($_);
363 print "Emails will be sent from: ", $sender, "\n";
369 $_ = $term->readline("Who should the emails be sent to? ",
371 } while (!defined $_);
373 push @to, split /,/, $to;
382 @cur = map { $aliases{$_} ? @
{$aliases{$_}} : $_ } @last;
383 } while (join(',',@cur) ne join(',',@last));
387 @to = expand_aliases
(@to);
388 @to = (map { sanitize_address
($_) } @to);
389 @initial_cc = expand_aliases
(@initial_cc);
390 @bcclist = expand_aliases
(@bcclist);
392 if (!defined $initial_subject && $compose) {
394 $_ = $term->readline("What subject should the initial email start with? ",
396 } while (!defined $_);
397 $initial_subject = $_;
401 if ($thread && !defined $initial_reply_to && $prompting) {
403 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
405 } while (!defined $_);
407 $initial_reply_to = $_;
409 if (defined $initial_reply_to && $_ ne "") {
410 $initial_reply_to =~ s/^\s*<?/</;
411 $initial_reply_to =~ s/>?\s*$/>/;
414 if (!defined $smtp_server) {
415 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
421 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
425 # Note that this does not need to be secure, but we will make a small
426 # effort to have it be unique
427 open(C
,">",$compose_filename)
428 or die "Failed to open for writing $compose_filename: $!";
429 print C
"From $sender # This line is ignored.\n";
430 printf C
"Subject: %s\n\n", $initial_subject;
432 GIT: Please enter your email below.
433 GIT: Lines beginning in "GIT: " will be removed.
434 GIT: Consider including an overall diffstat or table of contents
435 GIT: for the patch you are writing.
440 my $editor = $ENV{GIT_EDITOR
} || $repo->config("core.editor") || $ENV{VISUAL
} || $ENV{EDITOR
} || "vi";
441 system('sh', '-c', '$0 $@', $editor, $compose_filename);
443 open(C2
,">",$compose_filename . ".final")
444 or die "Failed to open $compose_filename.final : " . $!;
446 open(C
,"<",$compose_filename)
447 or die "Failed to open $compose_filename : " . $!;
457 $_ = $term->readline("Send this email? (y|n) ");
458 } while (!defined $_);
460 if (uc substr($_,0,1) ne 'Y') {
461 cleanup_compose_files
();
465 @files = ($compose_filename . ".final", @files);
468 # Variables we set as part of the loop over files
469 our ($message_id, %mail, $subject, $reply_to, $references, $message);
471 sub extract_valid_address
{
473 my $local_part_regexp = '[^<>"\s@]+';
474 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
476 # check for a local address:
477 return $address if ($address =~ /^($local_part_regexp)$/);
479 $address =~ s/^\s*<(.*)>\s*$/$1/;
480 if ($have_email_valid) {
481 return scalar Email
::Valid
->address($address);
483 # less robust/correct than the monster regexp in Email::Valid,
484 # but still does a 99% job, and one less dependency
485 $address =~ /($local_part_regexp\@$domain_regexp)/;
490 # Usually don't need to change anything below here.
492 # we make a "fake" message id by taking the current number
493 # of seconds since the beginning of Unix time and tacking on
494 # a random number to the end, in case we are called quicker than
495 # 1 second since the last time we were called.
497 # We'll setup a template for the message id, using the "from" address:
499 my ($message_id_stamp, $message_id_serial);
503 if (!defined $message_id_stamp) {
504 $message_id_stamp = sprintf("%s-%s", time, $$);
505 $message_id_serial = 0;
507 $message_id_serial++;
508 $uniq = "$message_id_stamp-$message_id_serial";
511 for ($sender, $repocommitter, $repoauthor) {
512 $du_part = extract_valid_address
(sanitize_address
($_));
513 last if (defined $du_part and $du_part ne '');
515 if (not defined $du_part or $du_part eq '') {
516 use Sys
::Hostname
qw();
517 $du_part = 'user@' . Sys
::Hostname
::hostname
();
519 my $message_id_template = "<%s-git-send-email-%s>";
520 $message_id = sprintf($message_id_template, $uniq, $du_part);
521 #print "new message id = $message_id\n"; # Was useful for debugging
526 $time = time - scalar $#files;
528 sub unquote_rfc2047
{
531 if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) {
534 s/=([0-9A-F]{2})/chr(hex($1))/eg;
536 return wantarray ?
($_, $encoding) : $_;
539 # use the simplest quoting being able to handle the recipient
542 my ($recipient) = @_;
543 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
545 if (not $recipient_name) {
549 # if recipient_name is already quoted, do nothing
550 if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) {
554 # rfc2047 is needed if a non-ascii char is included
555 if ($recipient_name =~ /[^[:ascii:]]/) {
556 $recipient_name =~ s/([^-a-zA-Z0-9!*+\/])/sprintf
("=%02X", ord($1))/eg
;
557 $recipient_name =~ s/(.*)/=\?utf-8\?q\?$1\?=/;
560 # double quotes are needed if specials or CTLs are included
561 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
562 $recipient_name =~ s/(["\\\r])/\\$1/;
563 $recipient_name = "\"$recipient_name\"";
566 return "$recipient_name $recipient_addr";
572 my @recipients = unique_email_list
(@to);
573 @cc = (grep { my $cc = extract_valid_address
($_);
574 not grep { $cc eq $_ } @recipients
576 map { sanitize_address
($_) }
578 my $to = join (",\n\t", @recipients);
579 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
580 @recipients = (map { extract_valid_address
($_) } @recipients);
581 my $date = format_2822_time
($time++);
582 my $gitversion = '@@GIT_VERSION@@';
583 if ($gitversion =~ m/..GIT_VERSION../) {
584 $gitversion = Git
::version
();
587 my $cc = join(", ", unique_email_list
(@cc));
590 $ccline = "\nCc: $cc";
592 my $sanitized_sender = sanitize_address
($sender);
593 make_message_id
() unless defined($message_id);
595 my $header = "From: $sanitized_sender
599 Message-Id: $message_id
600 X-Mailer: git-send-email $gitversion
602 if ($thread && $reply_to) {
604 $header .= "In-Reply-To: $reply_to\n";
605 $header .= "References: $references\n";
608 $header .= join("\n", @xh) . "\n";
611 my @sendmail_parameters = ('-i', @recipients);
612 my $raw_from = $sanitized_sender;
613 $raw_from = $envelope_sender if (defined $envelope_sender);
614 $raw_from = extract_valid_address
($raw_from);
615 unshift (@sendmail_parameters,
616 '-f', $raw_from) if(defined $envelope_sender);
619 # We don't want to send the email.
620 } elsif ($smtp_server =~ m
#^/#) {
621 my $pid = open my $sm, '|-';
622 defined $pid or die $!;
624 exec($smtp_server, @sendmail_parameters) or die $!;
626 print $sm "$header\n$message";
630 if (!defined $smtp_server) {
631 die "The required SMTP server is not properly defined."
635 $smtp_server_port ||= 465; # ssmtp
636 require Net
::SMTP
::SSL
;
637 $smtp ||= Net
::SMTP
::SSL
->new($smtp_server, Port
=> $smtp_server_port);
641 $smtp ||= Net
::SMTP
->new((defined $smtp_server_port)
642 ?
"$smtp_server:$smtp_server_port"
647 die "Unable to initialize SMTP properly. Is there something wrong with your config?";
650 if ((defined $smtp_authuser) && (defined $smtp_authpass)) {
651 $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
653 $smtp->mail( $raw_from ) or die $smtp->message;
654 $smtp->to( @recipients ) or die $smtp->message;
655 $smtp->data or die $smtp->message;
656 $smtp->datasend("$header\n$message") or die $smtp->message;
657 $smtp->dataend() or die $smtp->message;
658 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
661 printf (($dry_run ?
"Dry-" : "")."Sent %s\n", $subject);
663 print (($dry_run ?
"Dry-" : "")."OK. Log says:\n");
664 if ($smtp_server !~ m
#^/#) {
665 print "Server: $smtp_server\n";
666 print "MAIL FROM:<$raw_from>\n";
667 print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
669 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
673 print "Result: ", $smtp->code, ' ',
674 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
676 print "Result: OK\n";
681 $reply_to = $initial_reply_to;
682 $references = $initial_reply_to || '';
683 $subject = $initial_subject;
685 foreach my $t (@files) {
686 open(F
,"<",$t) or die "can't open file $t";
690 my $has_content_type;
694 my $input_format = undef;
700 $input_format = 'mbox';
704 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
705 $input_format = 'mbox';
708 if (defined $input_format && $input_format eq 'mbox') {
709 if (/^Subject:\s+(.*)$/) {
712 } elsif (/^(Cc|From):\s+(.*)$/) {
713 if (unquote_rfc2047
($2) eq $sender) {
714 next if ($suppress_from);
716 elsif ($1 eq 'From') {
717 ($author, $author_encoding)
718 = unquote_rfc2047
($2);
720 printf("(mbox) Adding cc: %s from line '%s'\n",
721 $2, $_) unless $quiet;
724 elsif (/^Content-type:/i) {
725 $has_content_type = 1;
726 if (/charset="?[^ "]+/) {
731 elsif (/^Message-Id: (.*)/i) {
734 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
740 # "send lots of email" format,
743 # So let's support that, too.
744 $input_format = 'lots';
746 printf("(non-mbox) Adding cc: %s from line '%s'\n",
747 $_, $_) unless $quiet;
751 } elsif (!defined $subject) {
756 # A whitespace line will terminate the headers
762 if (/^(Signed-off-by|Cc): (.*)$/i && $signed_off_cc) {
765 next if ($c eq $sender and $suppress_from);
767 printf("(sob) Adding cc: %s from line '%s'\n",
768 $c, $_) unless $quiet;
774 if (defined $cc_cmd) {
775 open(F
, "$cc_cmd $t |")
776 or die "(cc-cmd) Could not execute '$cc_cmd'";
781 next if ($c eq $sender and $suppress_from);
783 printf("(cc-cmd) Adding cc: %s from: '%s'\n",
784 $c, $cc_cmd) unless $quiet;
787 or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
790 if (defined $author) {
791 $message = "From: $author\n\n$message";
792 if (defined $author_encoding) {
793 if ($has_content_type) {
794 if ($body_encoding eq $author_encoding) {
795 # ok, we already have the right encoding
798 # uh oh, we should re-encode
804 "Content-Type: text/plain; charset=$author_encoding",
805 'Content-Transfer-Encoding: 8bit';
812 # set up for the next message
813 if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
814 $reply_to = $message_id;
815 if (length $references > 0) {
816 $references .= "\n $message_id";
818 $references = "$message_id";
825 cleanup_compose_files
();
828 sub cleanup_compose_files
() {
829 unlink($compose_filename, $compose_filename . ".final");
833 $smtp->quit if $smtp;
835 sub unique_email_list
(@
) {
839 foreach my $entry (@_) {
840 if (my $clean = extract_valid_address
($entry)) {
842 next if $seen{$clean}++;
843 push @emails, $entry;
845 print STDERR
"W: unable to extract a valid address",
854 open(my $fh, '<', $fn)
855 or die "unable to open $fn: $!\n";
856 while (my $line = <$fh>) {
857 if (length($line) > 998) {
858 return "$.: patch contains a line longer than 998 characters";