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.
82 --smtp-user The username for SMTP-AUTH.
84 --smtp-pass The password for SMTP-AUTH.
86 --smtp-ssl If set, connects to the SMTP server using SSL.
88 --suppress-from Suppress sending emails to yourself if your address
89 appears in a From: line. Defaults to off.
91 --thread Specify that the "In-Reply-To:" header should be set on all
92 emails. Defaults to on.
94 --quiet Make git-send-email less verbose. One line per email
95 should be all that is output.
97 --dry-run Do everything except actually send the emails.
99 --envelope-sender Specify the envelope sender used to send the emails.
105 # most mail servers generate the Date: header, but not all...
106 sub format_2822_time
{
108 my @localtm = localtime($time);
109 my @gmttm = gmtime($time);
110 my $localmin = $localtm[1] + $localtm[2] * 60;
111 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
112 if ($localtm[0] != $gmttm[0]) {
113 die "local zone differs from GMT by a non-minute interval\n";
115 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
117 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
119 } elsif ($gmttm[6] != $localtm[6]) {
120 die "local time offset greater than or equal to 24 hours\n";
122 my $offset = $localmin - $gmtmin;
123 my $offhour = $offset / 60;
124 my $offmin = abs($offset % 60);
125 if (abs($offhour) >= 24) {
126 die ("local time offset greater than or equal to 24 hours\n");
129 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
130 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
132 qw(Jan Feb Mar Apr May Jun
133 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
138 ($offset >= 0) ?
'+' : '-',
144 my $have_email_valid = eval { require Email
::Valid
; 1 };
147 sub unique_email_list
(@
);
148 sub cleanup_compose_files
();
150 # Constants (essentially)
151 my $compose_filename = ".msg.$$";
153 # Variables we fill in automatically, or via prompting:
154 my (@to,@cc,@initial_cc,@bcclist,@xh,
155 $initial_reply_to,$initial_subject,@files,$author,$sender,$compose,$time);
160 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
162 my $repo = Git
->repository();
164 new Term
::ReadLine
'git-send-email';
167 $term = new FakeTerm
"$@: going non-interactive";
170 # Behavior modification variables
171 my ($quiet, $dry_run) = (0, 0);
173 # Variables with corresponding config settings
174 my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
175 my ($smtp_server, $smtp_authuser, $smtp_authpass, $smtp_ssl);
176 my ($identity, $aliasfiletype, @alias_files);
178 my %config_bool_settings = (
179 "thread" => [\
$thread, 1],
180 "chainreplyto" => [\
$chain_reply_to, 1],
181 "suppressfrom" => [\
$suppress_from, 0],
182 "signedoffcc" => [\
$signed_off_cc, 1],
183 "smtpssl" => [\
$smtp_ssl, 0],
186 my %config_settings = (
187 "smtpserver" => \
$smtp_server,
188 "smtpuser" => \
$smtp_authuser,
189 "smtppass" => \
$smtp_authpass,
191 "aliasfiletype" => \
$aliasfiletype,
193 "aliasesfile" => \
@alias_files,
196 # Begin by accumulating all the variables (defined above), that we will end up
197 # needing, first, from the command line:
199 my $rc = GetOptions
("sender|from=s" => \
$sender,
200 "in-reply-to=s" => \
$initial_reply_to,
201 "subject=s" => \
$initial_subject,
203 "cc=s" => \
@initial_cc,
204 "bcc=s" => \
@bcclist,
205 "chain-reply-to!" => \
$chain_reply_to,
206 "smtp-server=s" => \
$smtp_server,
207 "smtp-user=s" => \
$smtp_authuser,
208 "smtp-pass=s" => \
$smtp_authpass,
209 "smtp-ssl!" => \
$smtp_ssl,
210 "identity=s" => \
$identity,
211 "compose" => \
$compose,
213 "cc-cmd=s" => \
$cc_cmd,
214 "suppress-from!" => \
$suppress_from,
215 "signed-off-cc|signed-off-by-cc!" => \
$signed_off_cc,
216 "dry-run" => \
$dry_run,
217 "envelope-sender=s" => \
$envelope_sender,
218 "thread!" => \
$thread,
225 # Now, let's fill any that aren't set in with defaults:
230 foreach my $setting (keys %config_bool_settings) {
231 my $target = $config_bool_settings{$setting}->[0];
232 $$target = $repo->config_bool("$prefix.$setting") unless (defined $$target);
235 foreach my $setting (keys %config_settings) {
236 my $target = $config_settings{$setting};
237 if (ref($target) eq "ARRAY") {
239 my @values = $repo->config("$prefix.$setting");
240 @
$target = @values if (@values && defined $values[0]);
244 $$target = $repo->config("$prefix.$setting") unless (defined $$target);
249 # read configuration from [sendemail "$identity"], fall back on [sendemail]
250 $identity = $repo->config("sendemail.identity") unless (defined $identity);
251 read_config
("sendemail.$identity") if (defined $identity);
252 read_config
("sendemail");
254 # fall back on builtin bool defaults
255 foreach my $setting (values %config_bool_settings) {
256 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
259 my ($repoauthor) = $repo->ident_person('author');
260 my ($repocommitter) = $repo->ident_person('committer');
262 # Verify the user input
264 foreach my $entry (@to) {
265 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
268 foreach my $entry (@initial_cc) {
269 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
272 foreach my $entry (@bcclist) {
273 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
278 # multiline formats can be supported in the future
279 mutt
=> sub { my $fh = shift; while (<$fh>) {
280 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
281 my ($alias, $addr) = ($1, $2);
282 $addr =~ s/#.*$//; # mutt allows # comments
283 # commas delimit multiple addresses
284 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
286 mailrc
=> sub { my $fh = shift; while (<$fh>) {
287 if (/^alias\s+(\S+)\s+(.*)$/) {
288 # spaces delimit multiple addresses
289 $aliases{$1} = [ split(/\s+/, $2) ];
291 pine
=> sub { my $fh = shift; while (<$fh>) {
292 if (/^(\S+)\t.*\t(.*)$/) {
293 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
295 gnus
=> sub { my $fh = shift; while (<$fh>) {
296 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
297 $aliases{$1} = [ $2 ];
301 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
302 foreach my $file (@alias_files) {
303 open my $fh, '<', $file or die "opening $file: $!\n";
304 $parse_alias{$aliasfiletype}->($fh);
309 ($sender) = expand_aliases
($sender) if defined $sender;
312 if (!defined $sender) {
313 $sender = $repoauthor || $repocommitter;
315 $_ = $term->readline("Who should the emails appear to be from? [$sender] ");
316 } while (!defined $_);
318 $sender = $_ if ($_);
319 print "Emails will be sent from: ", $sender, "\n";
325 $_ = $term->readline("Who should the emails be sent to? ",
327 } while (!defined $_);
329 push @to, split /,/, $to;
338 @cur = map { $aliases{$_} ? @
{$aliases{$_}} : $_ } @last;
339 } while (join(',',@cur) ne join(',',@last));
343 @to = expand_aliases
(@to);
344 @to = (map { sanitize_address
($_) } @to);
345 @initial_cc = expand_aliases
(@initial_cc);
346 @bcclist = expand_aliases
(@bcclist);
348 if (!defined $initial_subject && $compose) {
350 $_ = $term->readline("What subject should the emails start with? ",
352 } while (!defined $_);
353 $initial_subject = $_;
357 if ($thread && !defined $initial_reply_to && $prompting) {
359 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
361 } while (!defined $_);
363 $initial_reply_to = $_;
364 $initial_reply_to =~ s/^\s+<?/</;
365 $initial_reply_to =~ s/>?\s+$/>/;
368 if (!defined $smtp_server) {
369 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
375 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
379 # Note that this does not need to be secure, but we will make a small
380 # effort to have it be unique
381 open(C
,">",$compose_filename)
382 or die "Failed to open for writing $compose_filename: $!";
383 print C
"From $sender # This line is ignored.\n";
384 printf C
"Subject: %s\n\n", $initial_subject;
386 GIT: Please enter your email below.
387 GIT: Lines beginning in "GIT: " will be removed.
388 GIT: Consider including an overall diffstat or table of contents
389 GIT: for the patch you are writing.
394 my $editor = $ENV{GIT_EDITOR
} || $repo->config("core.editor") || $ENV{VISUAL
} || $ENV{EDITOR
} || "vi";
395 system($editor, $compose_filename);
397 open(C2
,">",$compose_filename . ".final")
398 or die "Failed to open $compose_filename.final : " . $!;
400 open(C
,"<",$compose_filename)
401 or die "Failed to open $compose_filename : " . $!;
411 $_ = $term->readline("Send this email? (y|n) ");
412 } while (!defined $_);
414 if (uc substr($_,0,1) ne 'Y') {
415 cleanup_compose_files
();
419 @files = ($compose_filename . ".final");
423 # Now that all the defaults are set, process the rest of the command line
424 # arguments and collect up the files that need to be processed.
428 or die "Failed to opendir $f: $!";
430 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
437 print STDERR
"Skipping $f - not found.\n";
443 print $_,"\n" for (@files);
446 print STDERR
"\nNo patch files specified!\n\n";
450 # Variables we set as part of the loop over files
451 our ($message_id, %mail, $subject, $reply_to, $references, $message);
453 sub extract_valid_address
{
455 my $local_part_regexp = '[^<>"\s@]+';
456 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
458 # check for a local address:
459 return $address if ($address =~ /^($local_part_regexp)$/);
461 $address =~ s/^\s*<(.*)>\s*$/$1/;
462 if ($have_email_valid) {
463 return scalar Email
::Valid
->address($address);
465 # less robust/correct than the monster regexp in Email::Valid,
466 # but still does a 99% job, and one less dependency
467 $address =~ /($local_part_regexp\@$domain_regexp)/;
472 # Usually don't need to change anything below here.
474 # we make a "fake" message id by taking the current number
475 # of seconds since the beginning of Unix time and tacking on
476 # a random number to the end, in case we are called quicker than
477 # 1 second since the last time we were called.
479 # We'll setup a template for the message id, using the "from" address:
481 my ($message_id_stamp, $message_id_serial);
485 if (!defined $message_id_stamp) {
486 $message_id_stamp = sprintf("%s-%s", time, $$);
487 $message_id_serial = 0;
489 $message_id_serial++;
490 $uniq = "$message_id_stamp-$message_id_serial";
493 for ($sender, $repocommitter, $repoauthor) {
494 $du_part = extract_valid_address
(sanitize_address
($_));
495 last if (defined $du_part and $du_part ne '');
497 if (not defined $du_part or $du_part eq '') {
498 use Sys
::Hostname
qw();
499 $du_part = 'user@' . Sys
::Hostname
::hostname
();
501 my $message_id_template = "<%s-git-send-email-%s>";
502 $message_id = sprintf($message_id_template, $uniq, $du_part);
503 #print "new message id = $message_id\n"; # Was useful for debugging
508 $time = time - scalar $#files;
510 sub unquote_rfc2047
{
512 if (s/=\?utf-8\?q\?(.*)\?=/$1/g) {
514 s/=([0-9A-F]{2})/chr(hex($1))/eg;
519 # use the simplest quoting being able to handle the recipient
522 my ($recipient) = @_;
523 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
525 if (not $recipient_name) {
529 # if recipient_name is already quoted, do nothing
530 if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) {
534 # rfc2047 is needed if a non-ascii char is included
535 if ($recipient_name =~ /[^[:ascii:]]/) {
536 $recipient_name =~ s/([^-a-zA-Z0-9!*+\/])/sprintf
("=%02X", ord($1))/eg
;
537 $recipient_name =~ s/(.*)/=\?utf-8\?q\?$1\?=/;
540 # double quotes are needed if specials or CTLs are included
541 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
542 $recipient_name =~ s/(["\\\r])/\\$1/;
543 $recipient_name = "\"$recipient_name\"";
546 return "$recipient_name $recipient_addr";
552 my @recipients = unique_email_list
(@to);
553 @cc = (map { sanitize_address
($_) } @cc);
554 my $to = join (",\n\t", @recipients);
555 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
556 @recipients = (map { extract_valid_address
($_) } @recipients);
557 my $date = format_2822_time
($time++);
558 my $gitversion = '@@GIT_VERSION@@';
559 if ($gitversion =~ m/..GIT_VERSION../) {
560 $gitversion = Git
::version
();
563 my $cc = join(", ", unique_email_list
(@cc));
566 $ccline = "\nCc: $cc";
568 my $sanitized_sender = sanitize_address
($sender);
571 my $header = "From: $sanitized_sender
575 Message-Id: $message_id
576 X-Mailer: git-send-email $gitversion
578 if ($thread && $reply_to) {
580 $header .= "In-Reply-To: $reply_to\n";
581 $header .= "References: $references\n";
584 $header .= join("\n", @xh) . "\n";
587 my @sendmail_parameters = ('-i', @recipients);
588 my $raw_from = $sanitized_sender;
589 $raw_from = $envelope_sender if (defined $envelope_sender);
590 $raw_from = extract_valid_address
($raw_from);
591 unshift (@sendmail_parameters,
592 '-f', $raw_from) if(defined $envelope_sender);
595 # We don't want to send the email.
596 } elsif ($smtp_server =~ m
#^/#) {
597 my $pid = open my $sm, '|-';
598 defined $pid or die $!;
600 exec($smtp_server, @sendmail_parameters) or die $!;
602 print $sm "$header\n$message";
606 require Net
::SMTP
::SSL
;
607 $smtp ||= Net
::SMTP
::SSL
->new( $smtp_server, Port
=> 465 );
611 $smtp ||= Net
::SMTP
->new( $smtp_server );
613 $smtp->auth( $smtp_authuser, $smtp_authpass )
614 or die $smtp->message if (defined $smtp_authuser);
615 $smtp->mail( $raw_from ) or die $smtp->message;
616 $smtp->to( @recipients ) or die $smtp->message;
617 $smtp->data or die $smtp->message;
618 $smtp->datasend("$header\n$message") or die $smtp->message;
619 $smtp->dataend() or die $smtp->message;
620 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
623 printf (($dry_run ?
"Dry-" : "")."Sent %s\n", $subject);
625 print (($dry_run ?
"Dry-" : "")."OK. Log says:\nDate: $date\n");
626 if ($smtp_server !~ m
#^/#) {
627 print "Server: $smtp_server\n";
628 print "MAIL FROM:<$raw_from>\n";
629 print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
631 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
633 print "From: $sanitized_sender\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
635 print "Result: ", $smtp->code, ' ',
636 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
638 print "Result: OK\n";
643 $reply_to = $initial_reply_to;
644 $references = $initial_reply_to || '';
645 $subject = $initial_subject;
647 foreach my $t (@files) {
648 open(F
,"<",$t) or die "can't open file $t";
653 my $input_format = undef;
659 $input_format = 'mbox';
663 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
664 $input_format = 'mbox';
667 if (defined $input_format && $input_format eq 'mbox') {
668 if (/^Subject:\s+(.*)$/) {
671 } elsif (/^(Cc|From):\s+(.*)$/) {
672 if (unquote_rfc2047
($2) eq $sender) {
673 next if ($suppress_from);
675 elsif ($1 eq 'From') {
676 $author = unquote_rfc2047
($2);
678 printf("(mbox) Adding cc: %s from line '%s'\n",
679 $2, $_) unless $quiet;
682 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
688 # "send lots of email" format,
691 # So let's support that, too.
692 $input_format = 'lots';
694 printf("(non-mbox) Adding cc: %s from line '%s'\n",
695 $_, $_) unless $quiet;
699 } elsif (!defined $subject) {
704 # A whitespace line will terminate the headers
710 if (/^(Signed-off-by|Cc): (.*)$/i && $signed_off_cc) {
714 printf("(sob) Adding cc: %s from line '%s'\n",
715 $c, $_) unless $quiet;
721 if (defined $cc_cmd) {
722 open(F
, "$cc_cmd $t |")
723 or die "(cc-cmd) Could not execute '$cc_cmd'";
729 printf("(cc-cmd) Adding cc: %s from: '%s'\n",
730 $c, $cc_cmd) unless $quiet;
733 or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
736 if (defined $author) {
737 $message = "From: $author\n\n$message";
742 # set up for the next message
743 if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
744 $reply_to = $message_id;
745 if (length $references > 0) {
746 $references .= "\n $message_id";
748 $references = "$message_id";
754 cleanup_compose_files
();
757 sub cleanup_compose_files
() {
758 unlink($compose_filename, $compose_filename . ".final");
762 $smtp->quit if $smtp;
764 sub unique_email_list
(@
) {
768 foreach my $entry (@_) {
769 if (my $clean = extract_valid_address
($entry)) {
771 next if $seen{$clean}++;
772 push @emails, $entry;
774 print STDERR
"W: unable to extract a valid address",