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 use File::Temp qw/ tempdir tempfile /;
28 use File::Spec::Functions qw(catfile);
32 Getopt::Long::Configure qw/ pass_through /;
36 my ($class, $reason) = @_;
37 return bless \$reason, shift;
41 die "Cannot use readline on FakeTerm: $$self";
48 git send-email [options] <file | directory | rev-list options >
51 --from <str> * Email From:
52 --[no-]to <str> * Email To:
53 --[no-]cc <str> * Email Cc:
54 --[no-]bcc <str> * Email Bcc:
55 --subject <str> * Email "Subject:"
56 --in-reply-to <str> * Email "In-Reply-To:"
57 --[no-]annotate * Review each patch that will be sent in an editor.
58 --compose * Open an editor for introduction.
59 --compose-encoding <str> * Encoding to assume for introduction.
60 --8bit-encoding <str> * Encoding to assume 8bit mails if undeclared
63 --envelope-sender <str> * Email envelope sender.
64 --smtp-server <str:int> * Outgoing SMTP server to use. The port
65 is optional. Default 'localhost'.
66 --smtp-server-option <str> * Outgoing SMTP server option to use.
67 --smtp-server-port <int> * Outgoing SMTP server port.
68 --smtp-user <str> * Username for SMTP-AUTH.
69 --smtp-pass <str> * Password for SMTP-AUTH; not necessary.
70 --smtp-encryption <str> * tls or ssl; anything else disables.
71 --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
72 --smtp-ssl-cert-path <str> * Path to ca-certificates (either directory or file).
73 Pass an empty string to disable certificate
75 --smtp-domain <str> * The domain name sent to HELO/EHLO handshake
76 --smtp-debug <0|1> * Disable, enable Net::SMTP debug.
79 --identity <str> * Use the sendemail.<id> options.
80 --to-cmd <str> * Email To: via `<str> \$patch_path`
81 --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
82 --suppress-cc <str> * author, self, sob, cc, cccmd, body, bodycc, all.
83 --[no-]signed-off-by-cc * Send to Signed-off-by: addresses. Default on.
84 --[no-]suppress-from * Send to self. Default off.
85 --[no-]chain-reply-to * Chain In-Reply-To: fields. Default off.
86 --[no-]thread * Use In-Reply-To: field. Default on.
89 --confirm <str> * Confirm recipients before sending;
90 auto, cc, compose, always, or never.
91 --quiet * Output one line of info per email.
92 --dry-run * Don't actually send the emails.
93 --[no-]validate * Perform patch sanity checks. Default on.
94 --[no-]format-patch * understand any non optional arguments as
95 `git format-patch` ones.
96 --force * Send even if safety checks would prevent it.
102 # most mail servers generate the Date: header, but not all...
103 sub format_2822_time {
105 my @localtm = localtime($time);
106 my @gmttm = gmtime($time);
107 my $localmin = $localtm[1] + $localtm[2] * 60;
108 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
109 if ($localtm[0] != $gmttm[0]) {
110 die "local zone differs from GMT by a non-minute interval\n";
112 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
114 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
116 } elsif ($gmttm[6] != $localtm[6]) {
117 die "local time offset greater than or equal to 24 hours\n";
119 my $offset = $localmin - $gmtmin;
120 my $offhour = $offset / 60;
121 my $offmin = abs($offset % 60);
122 if (abs($offhour) >= 24) {
123 die ("local time offset greater than or equal to 24 hours\n");
126 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
127 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
129 qw(Jan Feb Mar Apr May Jun
130 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
135 ($offset >= 0) ? '+' : '-',
141 my $have_email_valid = eval { require Email::Valid; 1 };
142 my $have_mail_address = eval { require Mail::Address; 1 };
146 # Regexes for RFC 2047 productions.
147 my $re_token = qr/[^][()<>@,;:\\"\/?.= \000-\037\177-\377]+/;
148 my $re_encoded_text = qr/[^? \000-\037\177-\377]+/;
149 my $re_encoded_word = qr/=\?($re_token)\?($re_token)\?($re_encoded_text)\?=/;
151 # Variables we fill in automatically, or via prompting:
152 my (@to,$no_to,@initial_to,@cc,$no_cc,@initial_cc,@bcclist,$no_bcc,@xh,
153 $initial_reply_to,$initial_subject,@files,
154 $author,$sender,$smtp_authpass,$annotate,$compose,$time);
159 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
161 my $repo = eval { Git->repository() };
162 my @repo = $repo ? ($repo) : ();
164 $ENV{"GIT_SEND_EMAIL_NOTTY"}
165 ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
166 : new Term::ReadLine 'git-send-email';
169 $term = new FakeTerm "$@: going non-interactive";
172 # Behavior modification variables
173 my ($quiet, $dry_run) = (0, 0);
175 my $compose_filename;
178 # Handle interactive edition of files.
183 if (!defined($editor)) {
184 $editor = Git::command_oneline('var', 'GIT_EDITOR');
186 if (defined($multiedit) && !$multiedit) {
188 system('sh', '-c', $editor.' "$@"', $editor, $_);
189 if (($? & 127) || ($? >> 8)) {
190 die("the editor exited uncleanly, aborting everything");
194 system('sh', '-c', $editor.' "$@"', $editor, @_);
195 if (($? & 127) || ($? >> 8)) {
196 die("the editor exited uncleanly, aborting everything");
201 # Variables with corresponding config settings
202 my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc);
203 my ($to_cmd, $cc_cmd);
204 my ($smtp_server, $smtp_server_port, @smtp_server_options);
205 my ($smtp_authuser, $smtp_encryption, $smtp_ssl_cert_path);
206 my ($identity, $aliasfiletype, @alias_files, $smtp_domain);
207 my ($validate, $confirm);
209 my ($auto_8bit_encoding);
210 my ($compose_encoding);
212 my ($debug_net_smtp) = 0; # Net::SMTP, see send_message()
214 my %config_bool_settings = (
215 "thread" => [\$thread, 1],
216 "chainreplyto" => [\$chain_reply_to, 0],
217 "suppressfrom" => [\$suppress_from, undef],
218 "signedoffbycc" => [\$signed_off_by_cc, undef],
219 "signedoffcc" => [\$signed_off_by_cc, undef], # Deprecated
220 "validate" => [\$validate, 1],
221 "multiedit" => [\$multiedit, undef],
222 "annotate" => [\$annotate, undef]
225 my %config_settings = (
226 "smtpserver" => \$smtp_server,
227 "smtpserverport" => \$smtp_server_port,
228 "smtpserveroption" => \@smtp_server_options,
229 "smtpuser" => \$smtp_authuser,
230 "smtppass" => \$smtp_authpass,
231 "smtpsslcertpath" => \$smtp_ssl_cert_path,
232 "smtpdomain" => \$smtp_domain,
233 "to" => \@initial_to,
235 "cc" => \@initial_cc,
237 "aliasfiletype" => \$aliasfiletype,
239 "suppresscc" => \@suppress_cc,
240 "envelopesender" => \$envelope_sender,
241 "confirm" => \$confirm,
243 "assume8bitencoding" => \$auto_8bit_encoding,
244 "composeencoding" => \$compose_encoding,
247 my %config_path_settings = (
248 "aliasesfile" => \@alias_files,
251 # Handle Uncouth Termination
255 print color("reset"), "\n";
257 # SMTP password masked
260 # tmp files from --compose
261 if (defined $compose_filename) {
262 if (-e $compose_filename) {
263 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
265 if (-e ($compose_filename . ".final")) {
266 print "'$compose_filename.final' contains the composed email.\n"
273 $SIG{TERM} = \&signal_handler;
274 $SIG{INT} = \&signal_handler;
276 # Begin by accumulating all the variables (defined above), that we will end up
277 # needing, first, from the command line:
280 my $rc = GetOptions("h" => \$help,
281 "sender|from=s" => \$sender,
282 "in-reply-to=s" => \$initial_reply_to,
283 "subject=s" => \$initial_subject,
284 "to=s" => \@initial_to,
285 "to-cmd=s" => \$to_cmd,
287 "cc=s" => \@initial_cc,
289 "bcc=s" => \@bcclist,
290 "no-bcc" => \$no_bcc,
291 "chain-reply-to!" => \$chain_reply_to,
292 "smtp-server=s" => \$smtp_server,
293 "smtp-server-option=s" => \@smtp_server_options,
294 "smtp-server-port=s" => \$smtp_server_port,
295 "smtp-user=s" => \$smtp_authuser,
296 "smtp-pass:s" => \$smtp_authpass,
297 "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
298 "smtp-encryption=s" => \$smtp_encryption,
299 "smtp-ssl-cert-path=s" => \$smtp_ssl_cert_path,
300 "smtp-debug:i" => \$debug_net_smtp,
301 "smtp-domain:s" => \$smtp_domain,
302 "identity=s" => \$identity,
303 "annotate!" => \$annotate,
304 "compose" => \$compose,
306 "cc-cmd=s" => \$cc_cmd,
307 "suppress-from!" => \$suppress_from,
308 "suppress-cc=s" => \@suppress_cc,
309 "signed-off-cc|signed-off-by-cc!" => \$signed_off_by_cc,
310 "confirm=s" => \$confirm,
311 "dry-run" => \$dry_run,
312 "envelope-sender=s" => \$envelope_sender,
313 "thread!" => \$thread,
314 "validate!" => \$validate,
315 "format-patch!" => \$format_patch,
316 "8bit-encoding=s" => \$auto_8bit_encoding,
317 "compose-encoding=s" => \$compose_encoding,
326 die "Cannot run git format-patch from outside a repository\n"
327 if $format_patch and not $repo;
329 # Now, let's fill any that aren't set in with defaults:
334 foreach my $setting (keys %config_bool_settings) {
335 my $target = $config_bool_settings{$setting}->[0];
336 $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
339 foreach my $setting (keys %config_path_settings) {
340 my $target = $config_path_settings{$setting};
341 if (ref($target) eq "ARRAY") {
343 my @values = Git::config_path(@repo, "$prefix.$setting");
344 @$target = @values if (@values && defined $values[0]);
348 $$target = Git::config_path(@repo, "$prefix.$setting") unless (defined $$target);
352 foreach my $setting (keys %config_settings) {
353 my $target = $config_settings{$setting};
354 next if $setting eq "to" and defined $no_to;
355 next if $setting eq "cc" and defined $no_cc;
356 next if $setting eq "bcc" and defined $no_bcc;
357 if (ref($target) eq "ARRAY") {
359 my @values = Git::config(@repo, "$prefix.$setting");
360 @$target = @values if (@values && defined $values[0]);
364 $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
368 if (!defined $smtp_encryption) {
369 my $enc = Git::config(@repo, "$prefix.smtpencryption");
371 $smtp_encryption = $enc;
372 } elsif (Git::config_bool(@repo, "$prefix.smtpssl")) {
373 $smtp_encryption = 'ssl';
378 # read configuration from [sendemail "$identity"], fall back on [sendemail]
379 $identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
380 read_config("sendemail.$identity") if (defined $identity);
381 read_config("sendemail");
383 # fall back on builtin bool defaults
384 foreach my $setting (values %config_bool_settings) {
385 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
388 # 'default' encryption is none -- this only prevents a warning
389 $smtp_encryption = '' unless (defined $smtp_encryption);
391 # Set CC suppressions
394 foreach my $entry (@suppress_cc) {
395 die "Unknown --suppress-cc field: '$entry'\n"
396 unless $entry =~ /^(?:all|cccmd|cc|author|self|sob|body|bodycc)$/;
397 $suppress_cc{$entry} = 1;
401 if ($suppress_cc{'all'}) {
402 foreach my $entry (qw (cccmd cc author self sob body bodycc)) {
403 $suppress_cc{$entry} = 1;
405 delete $suppress_cc{'all'};
408 # If explicit old-style ones are specified, they trump --suppress-cc.
409 $suppress_cc{'self'} = $suppress_from if defined $suppress_from;
410 $suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
412 if ($suppress_cc{'body'}) {
413 foreach my $entry (qw (sob bodycc)) {
414 $suppress_cc{$entry} = 1;
416 delete $suppress_cc{'body'};
419 # Set confirm's default value
420 my $confirm_unconfigured = !defined $confirm;
421 if ($confirm_unconfigured) {
422 $confirm = scalar %suppress_cc ? 'compose' : 'auto';
424 die "Unknown --confirm setting: '$confirm'\n"
425 unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
427 # Debugging, print out the suppressions.
429 print "suppressions:\n";
430 foreach my $entry (keys %suppress_cc) {
431 printf " %-5s -> $suppress_cc{$entry}\n", $entry;
435 my ($repoauthor, $repocommitter);
436 ($repoauthor) = Git::ident_person(@repo, 'author');
437 ($repocommitter) = Git::ident_person(@repo, 'committer');
439 # Verify the user input
441 foreach my $entry (@initial_to) {
442 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
445 foreach my $entry (@initial_cc) {
446 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
449 foreach my $entry (@bcclist) {
450 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
453 sub parse_address_line {
454 if ($have_mail_address) {
455 return map { $_->format } Mail::Address->parse($_[0]);
457 return split_addrs($_[0]);
462 return quotewords('\s*,\s*', 1, @_);
467 # multiline formats can be supported in the future
468 mutt => sub { my $fh = shift; while (<$fh>) {
469 if (/^\s*alias\s+(?:-group\s+\S+\s+)*(\S+)\s+(.*)$/) {
470 my ($alias, $addr) = ($1, $2);
471 $addr =~ s/#.*$//; # mutt allows # comments
472 # commas delimit multiple addresses
473 $aliases{$alias} = [ split_addrs($addr) ];
475 mailrc => sub { my $fh = shift; while (<$fh>) {
476 if (/^alias\s+(\S+)\s+(.*)$/) {
477 # spaces delimit multiple addresses
478 $aliases{$1} = [ quotewords('\s+', 0, $2) ];
480 pine => sub { my $fh = shift; my $f='\t[^\t]*';
481 for (my $x = ''; defined($x); $x = $_) {
483 $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
484 $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
485 $aliases{$1} = [ split_addrs($2) ];
487 elm => sub { my $fh = shift;
489 if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
490 my ($alias, $addr) = ($1, $2);
491 $aliases{$alias} = [ split_addrs($addr) ];
495 gnus => sub { my $fh = shift; while (<$fh>) {
496 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
497 $aliases{$1} = [ $2 ];
501 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
502 foreach my $file (@alias_files) {
503 open my $fh, '<', $file or die "opening $file: $!\n";
504 $parse_alias{$aliasfiletype}->($fh);
509 ($sender) = expand_aliases($sender) if defined $sender;
511 # is_format_patch_arg($f) returns 0 if $f names a patch, or 1 if
512 # $f is a revision list specification to be passed to format-patch.
513 sub is_format_patch_arg {
517 $repo->command('rev-parse', '--verify', '--quiet', $f);
518 if (defined($format_patch)) {
519 return $format_patch;
522 File '$f' exists but it could also be the range of commits
523 to produce patches for. Please disambiguate by...
525 * Saying "./$f" if you mean a file; or
526 * Giving --format-patch option if you mean a range.
528 } catch Git::Error::Command with {
529 # Not a valid revision. Treat it as a filename.
534 # Now that all the defaults are set, process the rest of the command line
535 # arguments and collect up the files that need to be processed.
537 while (defined(my $f = shift @ARGV)) {
539 push @rev_list_opts, "--", @ARGV;
541 } elsif (-d $f and !is_format_patch_arg($f)) {
543 or die "Failed to opendir $f: $!";
545 push @files, grep { -f $_ } map { catfile($f, $_) }
548 } elsif ((-f $f or -p $f) and !is_format_patch_arg($f)) {
551 push @rev_list_opts, $f;
555 if (@rev_list_opts) {
556 die "Cannot run git format-patch from outside a repository\n"
558 push @files, $repo->command('format-patch', '-o', tempdir(CLEANUP => 1), @rev_list_opts);
562 foreach my $f (@files) {
564 my $error = validate_patch($f);
565 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
572 print $_,"\n" for (@files);
575 print STDERR "\nNo patch files specified!\n\n";
579 sub get_patch_subject {
581 open (my $fh, '<', $fn);
582 while (my $line = <$fh>) {
583 next unless ($line =~ /^Subject: (.*)$/);
588 die "No subject line in $fn ?";
592 # Note that this does not need to be secure, but we will make a small
593 # effort to have it be unique
594 $compose_filename = ($repo ?
595 tempfile(".gitsendemail.msg.XXXXXX", DIR => $repo->repo_path()) :
596 tempfile(".gitsendemail.msg.XXXXXX", DIR => "."))[1];
597 open my $c, ">", $compose_filename
598 or die "Failed to open for writing $compose_filename: $!";
601 my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
602 my $tpl_subject = $initial_subject || '';
603 my $tpl_reply_to = $initial_reply_to || '';
606 From $tpl_sender # This line is ignored.
607 GIT: Lines beginning in "GIT:" will be removed.
608 GIT: Consider including an overall diffstat or table of contents
609 GIT: for the patch you are writing.
611 GIT: Clear the body content if you don't wish to send a summary.
613 Subject: $tpl_subject
614 In-Reply-To: $tpl_reply_to
618 print $c get_patch_subject($f);
623 do_edit($compose_filename, @files);
625 do_edit($compose_filename);
628 open my $c2, ">", $compose_filename . ".final"
629 or die "Failed to open $compose_filename.final : " . $!;
631 open $c, "<", $compose_filename
632 or die "Failed to open $compose_filename : " . $!;
634 my $need_8bit_cte = file_has_nonascii($compose_filename);
636 my $summary_empty = 1;
637 if (!defined $compose_encoding) {
638 $compose_encoding = "UTF-8";
643 $summary_empty = 0 unless (/^\n$/);
646 if ($need_8bit_cte) {
647 print $c2 "MIME-Version: 1.0\n",
648 "Content-Type: text/plain; ",
649 "charset=$compose_encoding\n",
650 "Content-Transfer-Encoding: 8bit\n";
652 } elsif (/^MIME-Version:/i) {
654 } elsif (/^Subject:\s*(.+)\s*$/i) {
655 $initial_subject = $1;
656 my $subject = $initial_subject;
658 quote_subject($subject, $compose_encoding) .
660 } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
661 $initial_reply_to = $1;
663 } elsif (/^From:\s*(.+)\s*$/i) {
666 } elsif (/^(?:To|Cc|Bcc):/i) {
667 print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
675 if ($summary_empty) {
676 print "Summary email is empty, skipping it\n";
679 } elsif ($annotate) {
684 my ($prompt, %arg) = @_;
685 my $valid_re = $arg{valid_re};
686 my $default = $arg{default};
687 my $confirm_only = $arg{confirm_only};
690 return defined $default ? $default : undef
691 unless defined $term->IN and defined fileno($term->IN) and
692 defined $term->OUT and defined fileno($term->OUT);
694 $resp = $term->readline($prompt);
695 if (!defined $resp) { # EOF
697 return defined $default ? $default : undef;
699 if ($resp eq '' and defined $default) {
702 if (!defined $valid_re or $resp =~ /$valid_re/) {
706 my $yesno = $term->readline("Are you sure you want to use <$resp> [y/N]? ");
707 if (defined $yesno && $yesno =~ /y/i) {
717 sub file_declares_8bit_cte {
719 open (my $fh, '<', $fn);
720 while (my $line = <$fh>) {
721 last if ($line =~ /^$/);
722 return 1 if ($line =~ /^Content-Transfer-Encoding: .*8bit.*$/);
728 foreach my $f (@files) {
729 next unless (body_or_subject_has_nonascii($f)
730 && !file_declares_8bit_cte($f));
731 $broken_encoding{$f} = 1;
734 if (!defined $auto_8bit_encoding && scalar %broken_encoding) {
735 print "The following files are 8bit, but do not declare " .
736 "a Content-Transfer-Encoding.\n";
737 foreach my $f (sort keys %broken_encoding) {
740 $auto_8bit_encoding = ask("Which 8bit encoding should I declare [UTF-8]? ",
746 if (get_patch_subject($f) =~ /\Q*** SUBJECT HERE ***\E/) {
747 die "Refusing to send because the patch\n\t$f\n"
748 . "has the template subject '*** SUBJECT HERE ***'. "
749 . "Pass --force if you really want to send.\n";
754 if (!defined $sender) {
755 $sender = $repoauthor || $repocommitter || '';
758 # $sender could be an already sanitized address
759 # (e.g. sendemail.from could be manually sanitized by user).
760 # But it's a no-op to run sanitize_address on an already sanitized address.
761 $sender = sanitize_address($sender);
764 if (!@initial_to && !defined $to_cmd) {
765 my $to = ask("Who should the emails be sent to (if any)? ",
767 valid_re => qr/\@.*\./, confirm_only => 1);
768 push @initial_to, parse_address_line($to) if defined $to; # sanitized/validated later
773 return map { expand_one_alias($_) } @_;
776 my %EXPANDED_ALIASES;
777 sub expand_one_alias {
779 if ($EXPANDED_ALIASES{$alias}) {
780 die "fatal: alias '$alias' expands to itself\n";
782 local $EXPANDED_ALIASES{$alias} = 1;
783 return $aliases{$alias} ? expand_aliases(@{$aliases{$alias}}) : $alias;
786 @initial_to = expand_aliases(@initial_to);
787 @initial_to = validate_address_list(sanitize_address_list(@initial_to));
788 @initial_cc = expand_aliases(@initial_cc);
789 @initial_cc = validate_address_list(sanitize_address_list(@initial_cc));
790 @bcclist = expand_aliases(@bcclist);
791 @bcclist = validate_address_list(sanitize_address_list(@bcclist));
793 if ($thread && !defined $initial_reply_to && $prompting) {
794 $initial_reply_to = ask(
795 "Message-ID to be used as In-Reply-To for the first email (if any)? ",
797 valid_re => qr/\@.*\./, confirm_only => 1);
799 if (defined $initial_reply_to) {
800 $initial_reply_to =~ s/^\s*<?//;
801 $initial_reply_to =~ s/>?\s*$//;
802 $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
805 if (!defined $smtp_server) {
806 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
812 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
815 if ($compose && $compose > 0) {
816 @files = ($compose_filename . ".final", @files);
819 # Variables we set as part of the loop over files
820 our ($message_id, %mail, $subject, $reply_to, $references, $message,
821 $needs_confirm, $message_num, $ask_default);
823 sub extract_valid_address {
825 my $local_part_regexp = qr/[^<>"\s@]+/;
826 my $domain_regexp = qr/[^.<>"\s@]+(?:\.[^.<>"\s@]+)+/;
828 # check for a local address:
829 return $address if ($address =~ /^($local_part_regexp)$/);
831 $address =~ s/^\s*<(.*)>\s*$/$1/;
832 if ($have_email_valid) {
833 return scalar Email::Valid->address($address);
836 # less robust/correct than the monster regexp in Email::Valid,
837 # but still does a 99% job, and one less dependency
838 return $1 if $address =~ /($local_part_regexp\@$domain_regexp)/;
842 sub extract_valid_address_or_die {
844 $address = extract_valid_address($address);
845 die "error: unable to extract a valid address from: $address\n"
850 sub validate_address {
852 while (!extract_valid_address($address)) {
853 print STDERR "error: unable to extract a valid address from: $address\n";
854 $_ = ask("What to do with this address? ([q]uit|[d]rop|[e]dit): ",
855 valid_re => qr/^(?:quit|q|drop|d|edit|e)/i,
860 cleanup_compose_files();
863 $address = ask("Who should the email be sent to (if any)? ",
865 valid_re => qr/\@.*\./, confirm_only => 1);
870 sub validate_address_list {
871 return (grep { defined $_ }
872 map { validate_address($_) } @_);
875 # Usually don't need to change anything below here.
877 # we make a "fake" message id by taking the current number
878 # of seconds since the beginning of Unix time and tacking on
879 # a random number to the end, in case we are called quicker than
880 # 1 second since the last time we were called.
882 # We'll setup a template for the message id, using the "from" address:
884 my ($message_id_stamp, $message_id_serial);
885 sub make_message_id {
887 if (!defined $message_id_stamp) {
888 $message_id_stamp = sprintf("%s-%s", time, $$);
889 $message_id_serial = 0;
891 $message_id_serial++;
892 $uniq = "$message_id_stamp-$message_id_serial";
895 for ($sender, $repocommitter, $repoauthor) {
896 $du_part = extract_valid_address(sanitize_address($_));
897 last if (defined $du_part and $du_part ne '');
899 if (not defined $du_part or $du_part eq '') {
900 require Sys::Hostname;
901 $du_part = 'user@' . Sys::Hostname::hostname();
903 my $message_id_template = "<%s-git-send-email-%s>";
904 $message_id = sprintf($message_id_template, $uniq, $du_part);
905 #print "new message id = $message_id\n"; # Was useful for debugging
910 $time = time - scalar $#files;
912 sub unquote_rfc2047 {
919 if ($encoding eq 'q' || $encoding eq 'Q') {
921 $text =~ s/=([0-9A-F]{2})/chr(hex($1))/egi;
924 $&; # other encodings not supported yet
927 return wantarray ? ($_, $charset) : $_;
932 my $encoding = shift || 'UTF-8';
933 s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg;
934 s/(.*)/=\?$encoding\?q\?$1\?=/;
938 sub is_rfc2047_quoted {
941 $s =~ m/^(?:"[[:ascii:]]*"|$re_encoded_word)$/o;
944 sub subject_needs_rfc2047_quoting {
947 return ($s =~ /[^[:ascii:]]/) || ($s =~ /=\?/);
951 local $subject = shift;
952 my $encoding = shift || 'UTF-8';
954 if (subject_needs_rfc2047_quoting($subject)) {
955 return quote_rfc2047($subject, $encoding);
960 # use the simplest quoting being able to handle the recipient
961 sub sanitize_address {
962 my ($recipient) = @_;
964 # remove garbage after email address
965 $recipient =~ s/(.*>).*$/$1/;
967 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
969 if (not $recipient_name) {
973 # if recipient_name is already quoted, do nothing
974 if (is_rfc2047_quoted($recipient_name)) {
978 # rfc2047 is needed if a non-ascii char is included
979 if ($recipient_name =~ /[^[:ascii:]]/) {
980 $recipient_name =~ s/^"(.*)"$/$1/;
981 $recipient_name = quote_rfc2047($recipient_name);
984 # double quotes are needed if specials or CTLs are included
985 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
986 $recipient_name =~ s/(["\\\r])/\\$1/g;
987 $recipient_name = qq["$recipient_name"];
990 return "$recipient_name $recipient_addr";
994 sub sanitize_address_list {
995 return (map { sanitize_address($_) } @_);
998 # Returns the local Fully Qualified Domain Name (FQDN) if available.
1000 # Tightly configured MTAa require that a caller sends a real DNS
1001 # domain name that corresponds the IP address in the HELO/EHLO
1002 # handshake. This is used to verify the connection and prevent
1003 # spammers from trying to hide their identity. If the DNS and IP don't
1004 # match, the receiveing MTA may deny the connection.
1006 # Here is a deny example of Net::SMTP with the default "localhost.localdomain"
1008 # Net::SMTP=GLOB(0x267ec28)>>> EHLO localhost.localdomain
1009 # Net::SMTP=GLOB(0x267ec28)<<< 550 EHLO argument does not match calling host
1011 # This maildomain*() code is based on ideas in Perl library Test::Reporter
1012 # /usr/share/perl5/Test/Reporter/Mail/Util.pm ==> sub _maildomain ()
1016 return defined $domain && !($^O eq 'darwin' && $domain =~ /\.local$/) && $domain =~ /\./;
1019 sub maildomain_net {
1022 if (eval { require Net::Domain; 1 }) {
1023 my $domain = Net::Domain::domainname();
1024 $maildomain = $domain if valid_fqdn($domain);
1030 sub maildomain_mta {
1033 if (eval { require Net::SMTP; 1 }) {
1034 for my $host (qw(mailhost localhost)) {
1035 my $smtp = Net::SMTP->new($host);
1036 if (defined $smtp) {
1037 my $domain = $smtp->domain;
1040 $maildomain = $domain if valid_fqdn($domain);
1042 last if $maildomain;
1051 return maildomain_net() || maildomain_mta() || 'localhost.localdomain';
1054 sub smtp_host_string {
1055 if (defined $smtp_server_port) {
1056 return "$smtp_server:$smtp_server_port";
1058 return $smtp_server;
1062 # Returns 1 if authentication succeeded or was not necessary
1063 # (smtp_user was not specified), and 0 otherwise.
1065 sub smtp_auth_maybe {
1066 if (!defined $smtp_authuser || $auth) {
1070 # Workaround AUTH PLAIN/LOGIN interaction defect
1071 # with Authen::SASL::Cyrus
1073 require Authen::SASL;
1074 Authen::SASL->import(qw(Perl));
1077 # TODO: Authentication may fail not because credentials were
1078 # invalid but due to other reasons, in which we should not
1079 # reject credentials.
1080 $auth = Git::credential({
1081 'protocol' => 'smtp',
1082 'host' => smtp_host_string(),
1083 'username' => $smtp_authuser,
1084 # if there's no password, "git credential fill" will
1085 # give us one, otherwise it'll just pass this one.
1086 'password' => $smtp_authpass
1089 return !!$smtp->auth($cred->{'username'}, $cred->{'password'});
1095 sub ssl_verify_params {
1097 require IO::Socket::SSL;
1098 IO::Socket::SSL->import(qw/SSL_VERIFY_PEER SSL_VERIFY_NONE/);
1101 print STDERR "Not using SSL_VERIFY_PEER due to out-of-date IO::Socket::SSL.\n";
1105 if (!defined $smtp_ssl_cert_path) {
1106 # use the OpenSSL defaults
1107 return (SSL_verify_mode => SSL_VERIFY_PEER());
1110 if ($smtp_ssl_cert_path eq "") {
1111 return (SSL_verify_mode => SSL_VERIFY_NONE());
1112 } elsif (-d $smtp_ssl_cert_path) {
1113 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1114 SSL_ca_path => $smtp_ssl_cert_path);
1115 } elsif (-f $smtp_ssl_cert_path) {
1116 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1117 SSL_ca_file => $smtp_ssl_cert_path);
1119 print STDERR "Not using SSL_VERIFY_PEER because the CA path does not exist.\n";
1120 return (SSL_verify_mode => SSL_VERIFY_NONE());
1124 # Returns 1 if the message was sent, and 0 otherwise.
1125 # In actuality, the whole program dies when there
1126 # is an error sending a message.
1129 my @recipients = unique_email_list(@to);
1130 @cc = (grep { my $cc = extract_valid_address_or_die($_);
1131 not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
1134 my $to = join (",\n\t", @recipients);
1135 @recipients = unique_email_list(@recipients,@cc,@bcclist);
1136 @recipients = (map { extract_valid_address_or_die($_) } @recipients);
1137 my $date = format_2822_time($time++);
1138 my $gitversion = '@@GIT_VERSION@@';
1139 if ($gitversion =~ m/..GIT_VERSION../) {
1140 $gitversion = Git::version();
1143 my $cc = join(",\n\t", unique_email_list(@cc));
1146 $ccline = "\nCc: $cc";
1148 make_message_id() unless defined($message_id);
1150 my $header = "From: $sender
1154 Message-Id: $message_id
1155 X-Mailer: git-send-email $gitversion
1159 $header .= "In-Reply-To: $reply_to\n";
1160 $header .= "References: $references\n";
1163 $header .= join("\n", @xh) . "\n";
1166 my @sendmail_parameters = ('-i', @recipients);
1167 my $raw_from = $sender;
1168 if (defined $envelope_sender && $envelope_sender ne "auto") {
1169 $raw_from = $envelope_sender;
1171 $raw_from = extract_valid_address($raw_from);
1172 unshift (@sendmail_parameters,
1173 '-f', $raw_from) if(defined $envelope_sender);
1175 if ($needs_confirm && !$dry_run) {
1176 print "\n$header\n";
1177 if ($needs_confirm eq "inform") {
1178 $confirm_unconfigured = 0; # squelch this message for the rest of this run
1179 $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
1180 print " The Cc list above has been expanded by additional\n";
1181 print " addresses found in the patch commit message. By default\n";
1182 print " send-email prompts before sending whenever this occurs.\n";
1183 print " This behavior is controlled by the sendemail.confirm\n";
1184 print " configuration setting.\n";
1186 print " For additional information, run 'git send-email --help'.\n";
1187 print " To retain the current behavior, but squelch this message,\n";
1188 print " run 'git config --global sendemail.confirm auto'.\n\n";
1190 $_ = ask("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
1191 valid_re => qr/^(?:yes|y|no|n|quit|q|all|a)/i,
1192 default => $ask_default);
1193 die "Send this email reply required" unless defined $_;
1197 cleanup_compose_files();
1204 unshift (@sendmail_parameters, @smtp_server_options);
1207 # We don't want to send the email.
1208 } elsif ($smtp_server =~ m#^/#) {
1209 my $pid = open my $sm, '|-';
1210 defined $pid or die $!;
1212 exec($smtp_server, @sendmail_parameters) or die $!;
1214 print $sm "$header\n$message";
1215 close $sm or die $!;
1218 if (!defined $smtp_server) {
1219 die "The required SMTP server is not properly defined."
1222 if ($smtp_encryption eq 'ssl') {
1223 $smtp_server_port ||= 465; # ssmtp
1224 require Net::SMTP::SSL;
1225 $smtp_domain ||= maildomain();
1226 require IO::Socket::SSL;
1227 # Net::SMTP::SSL->new() does not forward any SSL options
1228 IO::Socket::SSL::set_client_defaults(
1229 ssl_verify_params());
1230 $smtp ||= Net::SMTP::SSL->new($smtp_server,
1231 Hello => $smtp_domain,
1232 Port => $smtp_server_port,
1233 Debug => $debug_net_smtp);
1237 $smtp_domain ||= maildomain();
1238 $smtp_server_port ||= 25;
1239 $smtp ||= Net::SMTP->new($smtp_server,
1240 Hello => $smtp_domain,
1241 Debug => $debug_net_smtp,
1242 Port => $smtp_server_port);
1243 if ($smtp_encryption eq 'tls' && $smtp) {
1244 require Net::SMTP::SSL;
1245 $smtp->command('STARTTLS');
1247 if ($smtp->code == 220) {
1248 $smtp = Net::SMTP::SSL->start_SSL($smtp,
1249 ssl_verify_params())
1250 or die "STARTTLS failed! ".IO::Socket::SSL::errstr();
1251 $smtp_encryption = '';
1252 # Send EHLO again to receive fresh
1253 # supported commands
1254 $smtp->hello($smtp_domain);
1256 die "Server does not support STARTTLS! ".$smtp->message;
1262 die "Unable to initialize SMTP properly. Check config and use --smtp-debug. ",
1263 "VALUES: server=$smtp_server ",
1264 "encryption=$smtp_encryption ",
1265 "hello=$smtp_domain",
1266 defined $smtp_server_port ? " port=$smtp_server_port" : "";
1269 smtp_auth_maybe or die $smtp->message;
1271 $smtp->mail( $raw_from ) or die $smtp->message;
1272 $smtp->to( @recipients ) or die $smtp->message;
1273 $smtp->data or die $smtp->message;
1274 $smtp->datasend("$header\n$message") or die $smtp->message;
1275 $smtp->dataend() or die $smtp->message;
1276 $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
1279 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
1281 print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
1282 if ($smtp_server !~ m#^/#) {
1283 print "Server: $smtp_server\n";
1284 print "MAIL FROM:<$raw_from>\n";
1285 foreach my $entry (@recipients) {
1286 print "RCPT TO:<$entry>\n";
1289 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
1291 print $header, "\n";
1293 print "Result: ", $smtp->code, ' ',
1294 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
1296 print "Result: OK\n";
1303 $reply_to = $initial_reply_to;
1304 $references = $initial_reply_to || '';
1305 $subject = $initial_subject;
1308 foreach my $t (@files) {
1309 open my $fh, "<", $t or die "can't open file $t";
1312 my $sauthor = undef;
1313 my $author_encoding;
1314 my $has_content_type;
1319 my $input_format = undef;
1323 # First unfold multiline header fields
1326 if (/^\s+\S/ and @header) {
1327 chomp($header[$#header]);
1329 $header[$#header] .= $_;
1334 # Now parse the header
1337 $input_format = 'mbox';
1341 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1342 $input_format = 'mbox';
1345 if (defined $input_format && $input_format eq 'mbox') {
1346 if (/^Subject:\s+(.*)$/i) {
1349 elsif (/^From:\s+(.*)$/i) {
1350 ($author, $author_encoding) = unquote_rfc2047($1);
1351 $sauthor = sanitize_address($author);
1352 next if $suppress_cc{'author'};
1353 next if $suppress_cc{'self'} and $sauthor eq $sender;
1354 printf("(mbox) Adding cc: %s from line '%s'\n",
1355 $1, $_) unless $quiet;
1358 elsif (/^To:\s+(.*)$/i) {
1359 foreach my $addr (parse_address_line($1)) {
1360 printf("(mbox) Adding to: %s from line '%s'\n",
1361 $addr, $_) unless $quiet;
1365 elsif (/^Cc:\s+(.*)$/i) {
1366 foreach my $addr (parse_address_line($1)) {
1367 my $qaddr = unquote_rfc2047($addr);
1368 my $saddr = sanitize_address($qaddr);
1369 if ($saddr eq $sender) {
1370 next if ($suppress_cc{'self'});
1372 next if ($suppress_cc{'cc'});
1374 printf("(mbox) Adding cc: %s from line '%s'\n",
1375 $addr, $_) unless $quiet;
1379 elsif (/^Content-type:/i) {
1380 $has_content_type = 1;
1381 if (/charset="?([^ "]+)/) {
1382 $body_encoding = $1;
1386 elsif (/^Message-Id: (.*)/i) {
1389 elsif (!/^Date:\s/i && /^[-A-Za-z]+:\s+\S/) {
1394 # In the traditional
1395 # "send lots of email" format,
1398 # So let's support that, too.
1399 $input_format = 'lots';
1400 if (@cc == 0 && !$suppress_cc{'cc'}) {
1401 printf("(non-mbox) Adding cc: %s from line '%s'\n",
1402 $_, $_) unless $quiet;
1404 } elsif (!defined $subject) {
1409 # Now parse the message body
1412 if (/^(Signed-off-by|Cc): (.*)$/i) {
1414 my ($what, $c) = ($1, $2);
1416 my $sc = sanitize_address($c);
1417 if ($sc eq $sender) {
1418 next if ($suppress_cc{'self'});
1420 next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1421 next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1424 printf("(body) Adding cc: %s from line '%s'\n",
1425 $c, $_) unless $quiet;
1430 push @to, recipients_cmd("to-cmd", "to", $to_cmd, $t)
1432 push @cc, recipients_cmd("cc-cmd", "cc", $cc_cmd, $t)
1433 if defined $cc_cmd && !$suppress_cc{'cccmd'};
1435 if ($broken_encoding{$t} && !$has_content_type) {
1436 $has_content_type = 1;
1437 push @xh, "MIME-Version: 1.0",
1438 "Content-Type: text/plain; charset=$auto_8bit_encoding",
1439 "Content-Transfer-Encoding: 8bit";
1440 $body_encoding = $auto_8bit_encoding;
1443 if ($broken_encoding{$t} && !is_rfc2047_quoted($subject)) {
1444 $subject = quote_subject($subject, $auto_8bit_encoding);
1447 if (defined $sauthor and $sauthor ne $sender) {
1448 $message = "From: $author\n\n$message";
1449 if (defined $author_encoding) {
1450 if ($has_content_type) {
1451 if ($body_encoding eq $author_encoding) {
1452 # ok, we already have the right encoding
1455 # uh oh, we should re-encode
1459 $has_content_type = 1;
1461 'MIME-Version: 1.0',
1462 "Content-Type: text/plain; charset=$author_encoding",
1463 'Content-Transfer-Encoding: 8bit';
1469 $confirm eq "always" or
1470 ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1471 ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1472 $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1474 @to = validate_address_list(sanitize_address_list(@to));
1475 @cc = validate_address_list(sanitize_address_list(@cc));
1477 @to = (@initial_to, @to);
1478 @cc = (@initial_cc, @cc);
1480 my $message_was_sent = send_message();
1482 # set up for the next message
1483 if ($thread && $message_was_sent &&
1484 ($chain_reply_to || !defined $reply_to || length($reply_to) == 0 ||
1485 $message_num == 1)) {
1486 $reply_to = $message_id;
1487 if (length $references > 0) {
1488 $references .= "\n $message_id";
1490 $references = "$message_id";
1493 $message_id = undef;
1496 # Execute a command (e.g. $to_cmd) to get a list of email addresses
1497 # and return a results array
1498 sub recipients_cmd {
1499 my ($prefix, $what, $cmd, $file) = @_;
1502 open my $fh, "-|", "$cmd \Q$file\E"
1503 or die "($prefix) Could not execute '$cmd'";
1504 while (my $address = <$fh>) {
1505 $address =~ s/^\s*//g;
1506 $address =~ s/\s*$//g;
1507 $address = sanitize_address($address);
1508 next if ($address eq $sender and $suppress_cc{'self'});
1509 push @addresses, $address;
1510 printf("($prefix) Adding %s: %s from: '%s'\n",
1511 $what, $address, $cmd) unless $quiet;
1514 or die "($prefix) failed to close pipe to '$cmd'";
1518 cleanup_compose_files();
1520 sub cleanup_compose_files {
1521 unlink($compose_filename, $compose_filename . ".final") if $compose;
1524 $smtp->quit if $smtp;
1526 sub unique_email_list {
1530 foreach my $entry (@_) {
1531 my $clean = extract_valid_address_or_die($entry);
1532 $seen{$clean} ||= 0;
1533 next if $seen{$clean}++;
1534 push @emails, $entry;
1539 sub validate_patch {
1541 open(my $fh, '<', $fn)
1542 or die "unable to open $fn: $!\n";
1543 while (my $line = <$fh>) {
1544 if (length($line) > 998) {
1545 return "$.: patch contains a line longer than 998 characters";
1551 sub file_has_nonascii {
1553 open(my $fh, '<', $fn)
1554 or die "unable to open $fn: $!\n";
1555 while (my $line = <$fh>) {
1556 return 1 if $line =~ /[^[:ascii:]]/;
1561 sub body_or_subject_has_nonascii {
1563 open(my $fh, '<', $fn)
1564 or die "unable to open $fn: $!\n";
1565 while (my $line = <$fh>) {
1566 last if $line =~ /^$/;
1567 return 1 if $line =~ /^Subject.*[^[:ascii:]]/;
1569 while (my $line = <$fh>) {
1570 return 1 if $line =~ /[^[:ascii:]]/;