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.
28 my ($class, $reason) = @_;
29 return bless \
$reason, shift;
33 die "Cannot use readline on FakeTerm: $$self";
40 git-send-email [options] <file | directory>...
42 --from Specify the "From:" line of the email to be sent.
44 --to Specify the primary "To:" line of the email.
46 --cc Specify an initial "Cc:" list for the entire series
49 --bcc Specify a list of email addresses that should be Bcc:
52 --compose Use \$EDITOR to edit an introductory message for the
55 --subject Specify the initial "Subject:" line.
56 Only necessary if --compose is also set. If --compose
57 is not set, this will be prompted for.
59 --in-reply-to Specify the first "In-Reply-To:" header line.
60 Only used if --compose is also set. If --compose is not
61 set, this will be prompted for.
63 --chain-reply-to If set, the replies will all be to the previous
64 email sent, rather than to the first email sent.
67 --no-signed-off-cc Suppress the automatic addition of email addresses
68 that appear in Signed-off-by: or Cc: lines to the cc:
69 list. Note: Using this option is not recommended.
71 --smtp-server If set, specifies the outgoing SMTP server to use.
72 Defaults to localhost.
74 --suppress-from Suppress sending emails to yourself if your address
75 appears in a From: line.
77 --quiet Make git-send-email less verbose. One line per email
78 should be all that is output.
84 # most mail servers generate the Date: header, but not all...
85 sub format_2822_time
{
87 my @localtm = localtime($time);
88 my @gmttm = gmtime($time);
89 my $localmin = $localtm[1] + $localtm[2] * 60;
90 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
91 if ($localtm[0] != $gmttm[0]) {
92 die "local zone differs from GMT by a non-minute interval\n";
94 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
96 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
98 } elsif ($gmttm[6] != $localtm[6]) {
99 die "local time offset greater than or equal to 24 hours\n";
101 my $offset = $localmin - $gmtmin;
102 my $offhour = $offset / 60;
103 my $offmin = abs($offset % 60);
104 if (abs($offhour) >= 24) {
105 die ("local time offset greater than or equal to 24 hours\n");
108 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
109 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
111 qw(Jan Feb Mar Apr May Jun
112 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
117 ($offset >= 0) ?
'+' : '-',
123 my $have_email_valid = eval { require Email
::Valid
; 1 };
126 sub unique_email_list
(@
);
127 sub cleanup_compose_files
();
129 # Constants (essentially)
130 my $compose_filename = ".msg.$$";
132 # Variables we fill in automatically, or via prompting:
133 my (@to,@cc,@initial_cc,@bcclist,@xh,
134 $initial_reply_to,$initial_subject,@files,$from,$compose,$time);
136 # Behavior modification variables
137 my ($chain_reply_to, $quiet, $suppress_from, $no_signed_off_cc,
138 $dry_run) = (1, 0, 0, 0, 0);
142 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
144 my $repo = Git
->repository();
146 new Term
::ReadLine
'git-send-email';
149 $term = new FakeTerm
"$@: going non-interactive";
152 my $def_chain = $repo->config_boolean('sendemail.chainreplyto');
153 if ($def_chain and $def_chain eq 'false') {
157 @bcclist = $repo->config('sendemail.bcc');
158 if (!@bcclist or !$bcclist[0]) {
162 # Begin by accumulating all the variables (defined above), that we will end up
163 # needing, first, from the command line:
165 my $rc = GetOptions
("from=s" => \
$from,
166 "in-reply-to=s" => \
$initial_reply_to,
167 "subject=s" => \
$initial_subject,
169 "cc=s" => \
@initial_cc,
170 "bcc=s" => \
@bcclist,
171 "chain-reply-to!" => \
$chain_reply_to,
172 "smtp-server=s" => \
$smtp_server,
173 "compose" => \
$compose,
175 "suppress-from" => \
$suppress_from,
176 "no-signed-off-cc|no-signed-off-by-cc" => \
$no_signed_off_cc,
177 "dry-run" => \
$dry_run,
184 # Verify the user input
186 foreach my $entry (@to) {
187 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
190 foreach my $entry (@initial_cc) {
191 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
194 foreach my $entry (@bcclist) {
195 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
198 # Now, let's fill any that aren't set in with defaults:
200 my ($author) = $repo->ident_person('author');
201 my ($committer) = $repo->ident_person('committer');
204 my @alias_files = $repo->config('sendemail.aliasesfile');
205 my $aliasfiletype = $repo->config('sendemail.aliasfiletype');
207 # multiline formats can be supported in the future
208 mutt
=> sub { my $fh = shift; while (<$fh>) {
209 if (/^alias\s+(\S+)\s+(.*)$/) {
210 my ($alias, $addr) = ($1, $2);
211 $addr =~ s/#.*$//; # mutt allows # comments
212 # commas delimit multiple addresses
213 $aliases{$alias} = [ split(/\s*,\s*/, $addr) ];
215 mailrc
=> sub { my $fh = shift; while (<$fh>) {
216 if (/^alias\s+(\S+)\s+(.*)$/) {
217 # spaces delimit multiple addresses
218 $aliases{$1} = [ split(/\s+/, $2) ];
220 pine
=> sub { my $fh = shift; while (<$fh>) {
221 if (/^(\S+)\s+(.*)$/) {
222 $aliases{$1} = [ split(/\s*,\s*/, $2) ];
224 gnus
=> sub { my $fh = shift; while (<$fh>) {
225 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
226 $aliases{$1} = [ $2 ];
230 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
231 foreach my $file (@alias_files) {
232 open my $fh, '<', $file or die "opening $file: $!\n";
233 $parse_alias{$aliasfiletype}->($fh);
239 if (!defined $from) {
240 $from = $author || $committer;
242 $_ = $term->readline("Who should the emails appear to be from? [$from] ");
243 } while (!defined $_);
246 print "Emails will be sent from: ", $from, "\n";
252 $_ = $term->readline("Who should the emails be sent to? ",
254 } while (!defined $_);
256 push @to, split /,/, $to;
265 @cur = map { $aliases{$_} ? @
{$aliases{$_}} : $_ } @last;
266 } while (join(',',@cur) ne join(',',@last));
270 @to = expand_aliases
(@to);
271 @initial_cc = expand_aliases
(@initial_cc);
272 @bcclist = expand_aliases
(@bcclist);
274 if (!defined $initial_subject && $compose) {
276 $_ = $term->readline("What subject should the emails start with? ",
278 } while (!defined $_);
279 $initial_subject = $_;
283 if (!defined $initial_reply_to && $prompting) {
285 $_= $term->readline("Message-ID to be used as In-Reply-To for the first email? ",
287 } while (!defined $_);
289 $initial_reply_to = $_;
290 $initial_reply_to =~ s/(^\s+|\s+$)//g;
294 $smtp_server = $repo->config('sendemail.smtpserver');
297 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
303 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
307 # Note that this does not need to be secure, but we will make a small
308 # effort to have it be unique
309 open(C
,">",$compose_filename)
310 or die "Failed to open for writing $compose_filename: $!";
311 print C
"From $from # This line is ignored.\n";
312 printf C
"Subject: %s\n\n", $initial_subject;
314 GIT: Please enter your email below.
315 GIT: Lines beginning in "GIT: " will be removed.
316 GIT: Consider including an overall diffstat or table of contents
317 GIT: for the patch you are writing.
322 my $editor = $ENV{EDITOR
};
323 $editor = 'vi' unless defined $editor;
324 system($editor, $compose_filename);
326 open(C2
,">",$compose_filename . ".final")
327 or die "Failed to open $compose_filename.final : " . $!;
329 open(C
,"<",$compose_filename)
330 or die "Failed to open $compose_filename : " . $!;
340 $_ = $term->readline("Send this email? (y|n) ");
341 } while (!defined $_);
343 if (uc substr($_,0,1) ne 'Y') {
344 cleanup_compose_files
();
348 @files = ($compose_filename . ".final");
352 # Now that all the defaults are set, process the rest of the command line
353 # arguments and collect up the files that need to be processed.
357 or die "Failed to opendir $f: $!";
359 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
366 print STDERR
"Skipping $f - not found.\n";
372 print $_,"\n" for (@files);
375 print STDERR
"\nNo patch files specified!\n\n";
379 # Variables we set as part of the loop over files
380 our ($message_id, $cc, %mail, $subject, $reply_to, $references, $message);
382 sub extract_valid_address
{
384 my $local_part_regexp = '[^<>"\s@]+';
385 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
387 # check for a local address:
388 return $address if ($address =~ /^($local_part_regexp)$/);
390 if ($have_email_valid) {
391 return scalar Email
::Valid
->address($address);
393 # less robust/correct than the monster regexp in Email::Valid,
394 # but still does a 99% job, and one less dependency
395 $address =~ /($local_part_regexp\@$domain_regexp)/;
400 # Usually don't need to change anything below here.
402 # we make a "fake" message id by taking the current number
403 # of seconds since the beginning of Unix time and tacking on
404 # a random number to the end, in case we are called quicker than
405 # 1 second since the last time we were called.
407 # We'll setup a template for the message id, using the "from" address:
408 my $message_id_from = extract_valid_address
($from);
409 my $message_id_template = "<%s-git-send-email-$message_id_from>";
414 my $pseudo_rand = int (rand(4200));
415 $message_id = sprintf $message_id_template, "$date$pseudo_rand";
416 #print "new message id = $message_id\n"; # Was useful for debugging
422 $time = time - scalar $#files;
424 sub unquote_rfc2047
{
426 if (s/=\?utf-8\?q\?(.*)\?=/$1/g) {
428 s/=([0-9A-F]{2})/chr(hex($1))/eg;
435 my @recipients = unique_email_list
(@to);
436 my $to = join (",\n\t", @recipients);
437 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
438 my $date = format_2822_time
($time++);
439 my $gitversion = '@@GIT_VERSION@@';
440 if ($gitversion =~ m/..GIT_VERSION../) {
441 $gitversion = Git
::version
();
444 my ($author_name) = ($from =~ /^(.*?)\s+</);
445 if ($author_name && $author_name =~ /\./ && $author_name !~ /^".*"$/) {
446 my ($name, $addr) = ($from =~ /^(.*?)(\s+<.*)/);
447 $from = "\"$name\"$addr";
449 my $header = "From: $from
454 Message-Id: $message_id
455 X-Mailer: git-send-email $gitversion
459 $header .= "In-Reply-To: $reply_to\n";
460 $header .= "References: $references\n";
463 $header .= join("\n", @xh) . "\n";
467 # We don't want to send the email.
468 } elsif ($smtp_server =~ m
#^/#) {
469 my $pid = open my $sm, '|-';
470 defined $pid or die $!;
472 exec($smtp_server,'-i',
473 map { extract_valid_address
($_) }
474 @recipients) or die $!;
476 print $sm "$header\n$message";
480 $smtp ||= Net
::SMTP
->new( $smtp_server );
481 $smtp->mail( $from ) or die $smtp->message;
482 $smtp->to( @recipients ) or die $smtp->message;
483 $smtp->data or die $smtp->message;
484 $smtp->datasend("$header\n$message") or die $smtp->message;
485 $smtp->dataend() or die $smtp->message;
486 $smtp->ok or die "Failed to send $subject\n".$smtp->message;
489 printf "Sent %s\n", $subject;
491 print "OK. Log says:\nDate: $date\n";
493 print "Server: $smtp_server\n";
495 print "Sendmail: $smtp_server\n";
497 print "From: $from\nSubject: $subject\nCc: $cc\nTo: $to\n\n";
499 print "Result: ", $smtp->code, ' ',
500 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
502 print "Result: OK\n";
507 $reply_to = $initial_reply_to;
508 $references = $initial_reply_to || '';
510 $subject = $initial_subject;
512 foreach my $t (@files) {
513 open(F
,"<",$t) or die "can't open file $t";
515 my $author_not_sender = undef;
518 my $input_format = undef;
524 $input_format = 'mbox';
528 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
529 $input_format = 'mbox';
532 if (defined $input_format && $input_format eq 'mbox') {
533 if (/^Subject:\s+(.*)$/) {
536 } elsif (/^(Cc|From):\s+(.*)$/) {
538 next if ($suppress_from);
540 elsif ($1 eq 'From') {
541 $author_not_sender = $2;
543 printf("(mbox) Adding cc: %s from line '%s'\n",
544 $2, $_) unless $quiet;
547 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
553 # "send lots of email" format,
556 # So let's support that, too.
557 $input_format = 'lots';
559 printf("(non-mbox) Adding cc: %s from line '%s'\n",
560 $_, $_) unless $quiet;
564 } elsif (!defined $subject) {
569 # A whitespace line will terminate the headers
575 if (/^(Signed-off-by|Cc): (.*)$/i && !$no_signed_off_cc) {
579 printf("(sob) Adding cc: %s from line '%s'\n",
580 $c, $_) unless $quiet;
585 if (defined $author_not_sender) {
586 $author_not_sender = unquote_rfc2047
($author_not_sender);
587 $message = "From: $author_not_sender\n\n$message";
590 $cc = join(", ", unique_email_list
(@cc));
594 # set up for the next message
595 if ($chain_reply_to || !defined $reply_to || length($reply_to) == 0) {
596 $reply_to = $message_id;
597 if (length $references > 0) {
598 $references .= "\n $message_id";
600 $references = "$message_id";
607 cleanup_compose_files
();
610 sub cleanup_compose_files
() {
611 unlink($compose_filename, $compose_filename . ".final");
615 $smtp->quit if $smtp;
617 sub unique_email_list
(@
) {
621 foreach my $entry (@_) {
622 if (my $clean = extract_valid_address
($entry)) {
624 next if $seen{$clean}++;
625 push @emails, $entry;
627 print STDERR
"W: unable to extract a valid address",