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.
107 # most mail servers generate the Date: header, but not all...
108 sub format_2822_time
{
110 my @localtm = localtime($time);
111 my @gmttm = gmtime($time);
112 my $localmin = $localtm[1] + $localtm[2] * 60;
113 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
114 if ($localtm[0] != $gmttm[0]) {
115 die "local zone differs from GMT by a non-minute interval\n";
117 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
119 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
121 } elsif ($gmttm[6] != $localtm[6]) {
122 die "local time offset greater than or equal to 24 hours\n";
124 my $offset = $localmin - $gmtmin;
125 my $offhour = $offset / 60;
126 my $offmin = abs($offset % 60);
127 if (abs($offhour) >= 24) {
128 die ("local time offset greater than or equal to 24 hours\n");
131 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
132 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
134 qw(Jan Feb Mar Apr May Jun
135 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
140 ($offset >= 0) ?
'+' : '-',
146 my $have_email_valid = eval { require Email
::Valid
; 1 };
150 sub unique_email_list
(@
);
151 sub cleanup_compose_files
();
153 # Constants (essentially)
154 my $compose_filename = ".msg.$$";
156 # Variables we fill in automatically, or via prompting:
157 my (@to,@cc,@initial_cc,@bcclist,@xh,
158 $initial_reply_to,$initial_subject,@files,$author,$sender,$compose,$time);
163 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
165 my $repo = Git
->repository();
167 new Term
::ReadLine
'git-send-email';
170 $term = new FakeTerm
"$@: going non-interactive";
173 # Behavior modification variables
174 my ($quiet, $dry_run) = (0, 0);
176 # Variables with corresponding config settings
177 my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
178 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_authpass, $smtp_ssl);
179 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
181 my %config_bool_settings = (
182 "thread" => [\
$thread, 1],
183 "chainreplyto" => [\
$chain_reply_to, 1],
184 "suppressfrom" => [\
$suppress_from, 0],
185 "signedoffcc" => [\
$signed_off_cc, 1],
186 "smtpssl" => [\
$smtp_ssl, 0],
189 my %config_settings = (
190 "smtpserver" => \
$smtp_server,
191 "smtpserverport" => \
$smtp_server_port,
192 "smtpuser" => \
$smtp_authuser,
193 "smtppass" => \
$smtp_authpass,
196 "aliasfiletype" => \
$aliasfiletype,
198 "aliasesfile" => \
@alias_files,
201 # Begin by accumulating all the variables (defined above), that we will end up
202 # needing, first, from the command line:
204 my $rc = GetOptions
("sender|from=s" => \
$sender,
205 "in-reply-to=s" => \
$initial_reply_to,
206 "subject=s" => \
$initial_subject,
208 "cc=s" => \
@initial_cc,
209 "bcc=s" => \
@bcclist,
210 "chain-reply-to!" => \
$chain_reply_to,
211 "smtp-server=s" => \
$smtp_server,
212 "smtp-server-port=s" => \
$smtp_server_port,
213 "smtp-user=s" => \
$smtp_authuser,
214 "smtp-pass=s" => \
$smtp_authpass,
215 "smtp-ssl!" => \
$smtp_ssl,
216 "identity=s" => \
$identity,
217 "compose" => \
$compose,
219 "cc-cmd=s" => \
$cc_cmd,
220 "suppress-from!" => \
$suppress_from,
221 "signed-off-cc|signed-off-by-cc!" => \
$signed_off_cc,
222 "dry-run" => \
$dry_run,
223 "envelope-sender=s" => \
$envelope_sender,
224 "thread!" => \
$thread,
231 # Now, let's fill any that aren't set in with defaults:
236 foreach my $setting (keys %config_bool_settings) {
237 my $target = $config_bool_settings{$setting}->[0];
238 $$target = $repo->config_bool("$prefix.$setting") unless (defined $$target);
241 foreach my $setting (keys %config_settings) {
242 my $target = $config_settings{$setting};
243 if (ref($target) eq "ARRAY") {
245 my @values = $repo->config("$prefix.$setting");
246 @
$target = @values if (@values && defined $values[0]);
250 $$target = $repo->config("$prefix.$setting") unless (defined $$target);
255 # read configuration from [sendemail "$identity"], fall back on [sendemail]
256 $identity = $repo->config("sendemail.identity") unless (defined $identity);
257 read_config
("sendemail.$identity") if (defined $identity);
258 read_config
("sendemail");
260 # fall back on builtin bool defaults
261 foreach my $setting (values %config_bool_settings) {
262 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
265 my ($repoauthor) = $repo->ident_person('author');
266 my ($repocommitter) = $repo->ident_person('committer');
268 # Verify the user input
270 foreach my $entry (@to) {
271 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
274 foreach my $entry (@initial_cc) {
275 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
278 foreach my $entry (@bcclist) {
279 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
284 # multiline formats can be supported in the future
285 mutt
=> sub { my $fh = shift; while (<$fh>) {
286 if (/^\s*alias\s+(\S+)\s+(.*)$/) {
287 my ($alias, $addr) = ($1, $2);
288 $addr =~ s/#.*$//; # mutt allows # comments
289 # commas delimit multiple addresses
290 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
292 mailrc
=> sub { my $fh = shift; while (<$fh>) {
293 if (/^alias\s+(\S+)\s+(.*)$/) {
294 # spaces delimit multiple addresses
295 $aliases{$1} = [ split(/\s+/, $2) ];
297 pine
=> sub { my $fh = shift; while (<$fh>) {
298 if (/^(\S+)\t.*\t(.*)$/) {
299 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
301 gnus
=> sub { my $fh = shift; while (<$fh>) {
302 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
303 $aliases{$1} = [ $2 ];
307 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
308 foreach my $file (@alias_files) {
309 open my $fh, '<', $file or die "opening $file: $!\n";
310 $parse_alias{$aliasfiletype}->($fh);
315 ($sender) = expand_aliases
($sender) if defined $sender;
318 if (!defined $sender) {
319 $sender = $repoauthor || $repocommitter;
321 $_ = $term->readline("Who should the emails appear to be from? [$sender] ");
322 } while (!defined $_);
324 $sender = $_ if ($_);
325 print "Emails will be sent from: ", $sender, "\n";
331 $_ = $term->readline("Who should the emails be sent to? ",
333 } while (!defined $_);
335 push @to, split /,/, $to;
344 @cur = map { $aliases{$_} ? @
{$aliases{$_}} : $_ } @last;
345 } while (join(',',@cur) ne join(',',@last));
349 @to = expand_aliases
(@to);
350 @to = (map { sanitize_address
($_) } @to);
351 @initial_cc = expand_aliases
(@initial_cc);
352 @bcclist = expand_aliases
(@bcclist);
354 if (!defined $initial_subject && $compose) {
356 $_ = $term->readline("What subject should the initial email start with? ",
358 } while (!defined $_);
359 $initial_subject = $_;
363 if ($thread && !defined $initial_reply_to && $prompting) {
365 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
367 } while (!defined $_);
369 $initial_reply_to = $_;
372 $initial_reply_to =~ s/^\s*<?/</;
373 $initial_reply_to =~ s/>?\s*$/>/;
375 if (!defined $smtp_server) {
376 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
382 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
386 # Note that this does not need to be secure, but we will make a small
387 # effort to have it be unique
388 open(C
,">",$compose_filename)
389 or die "Failed to open for writing $compose_filename: $!";
390 print C
"From $sender # This line is ignored.\n";
391 printf C
"Subject: %s\n\n", $initial_subject;
393 GIT: Please enter your email below.
394 GIT: Lines beginning in "GIT: " will be removed.
395 GIT: Consider including an overall diffstat or table of contents
396 GIT: for the patch you are writing.
401 my $editor = $ENV{GIT_EDITOR
} || $repo->config("core.editor") || $ENV{VISUAL
} || $ENV{EDITOR
} || "vi";
402 system($editor, $compose_filename);
404 open(C2
,">",$compose_filename . ".final")
405 or die "Failed to open $compose_filename.final : " . $!;
407 open(C
,"<",$compose_filename)
408 or die "Failed to open $compose_filename : " . $!;
418 $_ = $term->readline("Send this email? (y|n) ");
419 } while (!defined $_);
421 if (uc substr($_,0,1) ne 'Y') {
422 cleanup_compose_files
();
426 @files = ($compose_filename . ".final");
430 # Now that all the defaults are set, process the rest of the command line
431 # arguments and collect up the files that need to be processed.
435 or die "Failed to opendir $f: $!";
437 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
444 print STDERR
"Skipping $f - not found.\n";
450 print $_,"\n" for (@files);
453 print STDERR
"\nNo patch files specified!\n\n";
457 # Variables we set as part of the loop over files
458 our ($message_id, %mail, $subject, $reply_to, $references, $message);
460 sub extract_valid_address
{
462 my $local_part_regexp = '[^<>"\s@]+';
463 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
465 # check for a local address:
466 return $address if ($address =~ /^($local_part_regexp)$/);
468 $address =~ s/^\s*<(.*)>\s*$/$1/;
469 if ($have_email_valid) {
470 return scalar Email
::Valid
->address($address);
472 # less robust/correct than the monster regexp in Email::Valid,
473 # but still does a 99% job, and one less dependency
474 $address =~ /($local_part_regexp\@$domain_regexp)/;
479 # Usually don't need to change anything below here.
481 # we make a "fake" message id by taking the current number
482 # of seconds since the beginning of Unix time and tacking on
483 # a random number to the end, in case we are called quicker than
484 # 1 second since the last time we were called.
486 # We'll setup a template for the message id, using the "from" address:
488 my ($message_id_stamp, $message_id_serial);
492 if (!defined $message_id_stamp) {
493 $message_id_stamp = sprintf("%s-%s", time, $$);
494 $message_id_serial = 0;
496 $message_id_serial++;
497 $uniq = "$message_id_stamp-$message_id_serial";
500 for ($sender, $repocommitter, $repoauthor) {
501 $du_part = extract_valid_address
(sanitize_address
($_));
502 last if (defined $du_part and $du_part ne '');
504 if (not defined $du_part or $du_part eq '') {
505 use Sys
::Hostname
qw();
506 $du_part = 'user@' . Sys
::Hostname
::hostname
();
508 my $message_id_template = "<%s-git-send-email-%s>";
509 $message_id = sprintf($message_id_template, $uniq, $du_part);
510 #print "new message id = $message_id\n"; # Was useful for debugging
515 $time = time - scalar $#files;
517 sub unquote_rfc2047
{
520 if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) {
523 s/=([0-9A-F]{2})/chr(hex($1))/eg;
525 return wantarray ?
($_, $encoding) : $_;
528 # use the simplest quoting being able to handle the recipient
531 my ($recipient) = @_;
532 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
534 if (not $recipient_name) {
538 # if recipient_name is already quoted, do nothing
539 if ($recipient_name =~ /^(".*"|=\?utf-8\?q\?.*\?=)$/) {
543 # rfc2047 is needed if a non-ascii char is included
544 if ($recipient_name =~ /[^[:ascii:]]/) {
545 $recipient_name =~ s/([^-a-zA-Z0-9!*+\/])/sprintf
("=%02X", ord($1))/eg
;
546 $recipient_name =~ s/(.*)/=\?utf-8\?q\?$1\?=/;
549 # double quotes are needed if specials or CTLs are included
550 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
551 $recipient_name =~ s/(["\\\r])/\\$1/;
552 $recipient_name = "\"$recipient_name\"";
555 return "$recipient_name $recipient_addr";
561 my @recipients = unique_email_list
(@to);
562 @cc = (grep { my $cc = extract_valid_address
($_);
563 not grep { $cc eq $_ } @recipients
565 map { sanitize_address
($_) }
567 my $to = join (",\n\t", @recipients);
568 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
569 @recipients = (map { extract_valid_address
($_) } @recipients);
570 my $date = format_2822_time
($time++);
571 my $gitversion = '@@GIT_VERSION@@';
572 if ($gitversion =~ m/..GIT_VERSION../) {
573 $gitversion = Git
::version
();
576 my $cc = join(", ", unique_email_list
(@cc));
579 $ccline = "\nCc: $cc";
581 my $sanitized_sender = sanitize_address
($sender);
584 my $header = "From: $sanitized_sender
588 Message-Id: $message_id
589 X-Mailer: git-send-email $gitversion
591 if ($thread && $reply_to) {
593 $header .= "In-Reply-To: $reply_to\n";
594 $header .= "References: $references\n";
597 $header .= join("\n", @xh) . "\n";
600 my @sendmail_parameters = ('-i', @recipients);
601 my $raw_from = $sanitized_sender;
602 $raw_from = $envelope_sender if (defined $envelope_sender);
603 $raw_from = extract_valid_address
($raw_from);
604 unshift (@sendmail_parameters,
605 '-f', $raw_from) if(defined $envelope_sender);
608 # We don't want to send the email.
609 } elsif ($smtp_server =~ m
#^/#) {
610 my $pid = open my $sm, '|-';
611 defined $pid or die $!;
613 exec($smtp_server, @sendmail_parameters) or die $!;
615 print $sm "$header\n$message";
619 if (!defined $smtp_server) {
620 die "The required SMTP server is not properly defined."
624 $smtp_server_port ||= 465; # ssmtp
625 require Net
::SMTP
::SSL
;
626 $smtp ||= Net
::SMTP
::SSL
->new($smtp_server, Port
=> $smtp_server_port);
630 $smtp ||= Net
::SMTP
->new((defined $smtp_server_port)
631 ?
"$smtp_server:$smtp_server_port"
636 die "Unable to initialize SMTP properly. Is there something wrong with your config?";
639 if ((defined $smtp_authuser) && (defined $smtp_authpass)) {
640 $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
642 $smtp->mail( $raw_from ) or die $smtp->message;
643 $smtp->to( @recipients ) or die $smtp->message;
644 $smtp->data or die $smtp->message;
645 $smtp->datasend("$header\n$message") or die $smtp->message;
646 $smtp->dataend() or die $smtp->message;
647 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
650 printf (($dry_run ?
"Dry-" : "")."Sent %s\n", $subject);
652 print (($dry_run ?
"Dry-" : "")."OK. Log says:\n");
653 if ($smtp_server !~ m
#^/#) {
654 print "Server: $smtp_server\n";
655 print "MAIL FROM:<$raw_from>\n";
656 print "RCPT TO:".join(',',(map { "<$_>" } @recipients))."\n";
658 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
662 print "Result: ", $smtp->code, ' ',
663 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
665 print "Result: OK\n";
670 $reply_to = $initial_reply_to;
671 $references = $initial_reply_to || '';
672 $subject = $initial_subject;
674 foreach my $t (@files) {
675 open(F
,"<",$t) or die "can't open file $t";
679 my $has_content_type;
683 my $input_format = undef;
689 $input_format = 'mbox';
693 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
694 $input_format = 'mbox';
697 if (defined $input_format && $input_format eq 'mbox') {
698 if (/^Subject:\s+(.*)$/) {
701 } elsif (/^(Cc|From):\s+(.*)$/) {
702 if (unquote_rfc2047
($2) eq $sender) {
703 next if ($suppress_from);
705 elsif ($1 eq 'From') {
706 ($author, $author_encoding)
707 = unquote_rfc2047
($2);
709 printf("(mbox) Adding cc: %s from line '%s'\n",
710 $2, $_) unless $quiet;
713 elsif (/^Content-type:/i) {
714 $has_content_type = 1;
715 if (/charset="?[^ "]+/) {
720 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
726 # "send lots of email" format,
729 # So let's support that, too.
730 $input_format = 'lots';
732 printf("(non-mbox) Adding cc: %s from line '%s'\n",
733 $_, $_) unless $quiet;
737 } elsif (!defined $subject) {
742 # A whitespace line will terminate the headers
748 if (/^(Signed-off-by|Cc): (.*)$/i && $signed_off_cc) {
751 next if ($c eq $sender and $suppress_from);
753 printf("(sob) Adding cc: %s from line '%s'\n",
754 $c, $_) unless $quiet;
760 if (defined $cc_cmd) {
761 open(F
, "$cc_cmd $t |")
762 or die "(cc-cmd) Could not execute '$cc_cmd'";
767 next if ($c eq $sender and $suppress_from);
769 printf("(cc-cmd) Adding cc: %s from: '%s'\n",
770 $c, $cc_cmd) unless $quiet;
773 or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
776 if (defined $author) {
777 $message = "From: $author\n\n$message";
778 if (defined $author_encoding) {
779 if ($has_content_type) {
780 if ($body_encoding eq $author_encoding) {
781 # ok, we already have the right encoding
784 # uh oh, we should re-encode
790 "Content-Type: text/plain; charset=$author_encoding",
791 'Content-Transfer-Encoding: 8bit';
798 # set up for the next message
799 if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
800 $reply_to = $message_id;
801 if (length $references > 0) {
802 $references .= "\n $message_id";
804 $references = "$message_id";
810 cleanup_compose_files
();
813 sub cleanup_compose_files
() {
814 unlink($compose_filename, $compose_filename . ".final");
818 $smtp->quit if $smtp;
820 sub unique_email_list
(@
) {
824 foreach my $entry (@_) {
825 if (my $clean = extract_valid_address
($entry)) {
827 next if $seen{$clean}++;
828 push @emails, $entry;
830 print STDERR
"W: unable to extract a valid address",