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-]xmailer * Add "X-Mailer:" header (default).
58 --[no-]annotate * Review each patch that will be sent in an editor.
59 --compose * Open an editor for introduction.
60 --compose-encoding <str> * Encoding to assume for introduction.
61 --8bit-encoding <str> * Encoding to assume 8bit mails if undeclared
64 --envelope-sender <str> * Email envelope sender.
65 --smtp-server <str:int> * Outgoing SMTP server to use. The port
66 is optional. Default 'localhost'.
67 --smtp-server-option <str> * Outgoing SMTP server option to use.
68 --smtp-server-port <int> * Outgoing SMTP server port.
69 --smtp-user <str> * Username for SMTP-AUTH.
70 --smtp-pass <str> * Password for SMTP-AUTH; not necessary.
71 --smtp-encryption <str> * tls or ssl; anything else disables.
72 --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
73 --smtp-ssl-cert-path <str> * Path to ca-certificates (either directory or file).
74 Pass an empty string to disable certificate
76 --smtp-domain <str> * The domain name sent to HELO/EHLO handshake
77 --smtp-debug <0|1> * Disable, enable Net::SMTP debug.
80 --identity <str> * Use the sendemail.<id> options.
81 --to-cmd <str> * Email To: via `<str> \$patch_path`
82 --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
83 --suppress-cc <str> * author, self, sob, cc, cccmd, body, bodycc, all.
84 --[no-]cc-cover * Email Cc: addresses in the cover letter.
85 --[no-]to-cover * Email To: addresses in the cover letter.
86 --[no-]signed-off-by-cc * Send to Signed-off-by: addresses. Default on.
87 --[no-]suppress-from * Send to self. Default off.
88 --[no-]chain-reply-to * Chain In-Reply-To: fields. Default off.
89 --[no-]thread * Use In-Reply-To: field. Default on.
92 --confirm <str> * Confirm recipients before sending;
93 auto, cc, compose, always, or never.
94 --quiet * Output one line of info per email.
95 --dry-run * Don't actually send the emails.
96 --[no-]validate * Perform patch sanity checks. Default on.
97 --[no-]format-patch * understand any non optional arguments as
98 `git format-patch` ones.
99 --force * Send even if safety checks would prevent it.
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 };
145 my $have_mail_address = eval { require Mail::Address; 1 };
149 # Variables we fill in automatically, or via prompting:
150 my (@to,$no_to,@initial_to,@cc,$no_cc,@initial_cc,@bcclist,$no_bcc,@xh,
151 $initial_reply_to,$initial_subject,@files,
152 $author,$sender,$smtp_authpass,$annotate,$use_xmailer,$compose,$time);
157 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
159 my $repo = eval { Git->repository() };
160 my @repo = $repo ? ($repo) : ();
162 $ENV{"GIT_SEND_EMAIL_NOTTY"}
163 ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
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 my $compose_filename;
176 # Handle interactive edition of files.
181 if (!defined($editor)) {
182 $editor = Git::command_oneline('var', 'GIT_EDITOR');
184 if (defined($multiedit) && !$multiedit) {
186 system('sh', '-c', $editor.' "$@"', $editor, $_);
187 if (($? & 127) || ($? >> 8)) {
188 die("the editor exited uncleanly, aborting everything");
192 system('sh', '-c', $editor.' "$@"', $editor, @_);
193 if (($? & 127) || ($? >> 8)) {
194 die("the editor exited uncleanly, aborting everything");
199 # Variables with corresponding config settings
200 my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc);
201 my ($cover_cc, $cover_to);
202 my ($to_cmd, $cc_cmd);
203 my ($smtp_server, $smtp_server_port, @smtp_server_options);
204 my ($smtp_authuser, $smtp_encryption, $smtp_ssl_cert_path);
205 my ($identity, $aliasfiletype, @alias_files, $smtp_domain);
206 my ($validate, $confirm);
208 my ($auto_8bit_encoding);
209 my ($compose_encoding);
211 my ($debug_net_smtp) = 0; # Net::SMTP, see send_message()
213 my %config_bool_settings = (
214 "thread" => [\$thread, 1],
215 "chainreplyto" => [\$chain_reply_to, 0],
216 "suppressfrom" => [\$suppress_from, undef],
217 "signedoffbycc" => [\$signed_off_by_cc, undef],
218 "cccover" => [\$cover_cc, undef],
219 "tocover" => [\$cover_to, undef],
220 "signedoffcc" => [\$signed_off_by_cc, undef], # Deprecated
221 "validate" => [\$validate, 1],
222 "multiedit" => [\$multiedit, undef],
223 "annotate" => [\$annotate, undef],
224 "xmailer" => [\$use_xmailer, 1]
227 my %config_settings = (
228 "smtpserver" => \$smtp_server,
229 "smtpserverport" => \$smtp_server_port,
230 "smtpserveroption" => \@smtp_server_options,
231 "smtpuser" => \$smtp_authuser,
232 "smtppass" => \$smtp_authpass,
233 "smtpsslcertpath" => \$smtp_ssl_cert_path,
234 "smtpdomain" => \$smtp_domain,
235 "to" => \@initial_to,
237 "cc" => \@initial_cc,
239 "aliasfiletype" => \$aliasfiletype,
241 "suppresscc" => \@suppress_cc,
242 "envelopesender" => \$envelope_sender,
243 "confirm" => \$confirm,
245 "assume8bitencoding" => \$auto_8bit_encoding,
246 "composeencoding" => \$compose_encoding,
249 my %config_path_settings = (
250 "aliasesfile" => \@alias_files,
253 # Handle Uncouth Termination
257 print color("reset"), "\n";
259 # SMTP password masked
262 # tmp files from --compose
263 if (defined $compose_filename) {
264 if (-e $compose_filename) {
265 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
267 if (-e ($compose_filename . ".final")) {
268 print "'$compose_filename.final' contains the composed email.\n"
275 $SIG{TERM} = \&signal_handler;
276 $SIG{INT} = \&signal_handler;
278 # Begin by accumulating all the variables (defined above), that we will end up
279 # needing, first, from the command line:
282 my $rc = GetOptions("h" => \$help,
283 "sender|from=s" => \$sender,
284 "in-reply-to=s" => \$initial_reply_to,
285 "subject=s" => \$initial_subject,
286 "to=s" => \@initial_to,
287 "to-cmd=s" => \$to_cmd,
289 "cc=s" => \@initial_cc,
291 "bcc=s" => \@bcclist,
292 "no-bcc" => \$no_bcc,
293 "chain-reply-to!" => \$chain_reply_to,
294 "smtp-server=s" => \$smtp_server,
295 "smtp-server-option=s" => \@smtp_server_options,
296 "smtp-server-port=s" => \$smtp_server_port,
297 "smtp-user=s" => \$smtp_authuser,
298 "smtp-pass:s" => \$smtp_authpass,
299 "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
300 "smtp-encryption=s" => \$smtp_encryption,
301 "smtp-ssl-cert-path=s" => \$smtp_ssl_cert_path,
302 "smtp-debug:i" => \$debug_net_smtp,
303 "smtp-domain:s" => \$smtp_domain,
304 "identity=s" => \$identity,
305 "annotate!" => \$annotate,
306 "compose" => \$compose,
308 "cc-cmd=s" => \$cc_cmd,
309 "suppress-from!" => \$suppress_from,
310 "suppress-cc=s" => \@suppress_cc,
311 "signed-off-cc|signed-off-by-cc!" => \$signed_off_by_cc,
312 "cc-cover|cc-cover!" => \$cover_cc,
313 "to-cover|to-cover!" => \$cover_to,
314 "confirm=s" => \$confirm,
315 "dry-run" => \$dry_run,
316 "envelope-sender=s" => \$envelope_sender,
317 "thread!" => \$thread,
318 "validate!" => \$validate,
319 "format-patch!" => \$format_patch,
320 "8bit-encoding=s" => \$auto_8bit_encoding,
321 "compose-encoding=s" => \$compose_encoding,
323 "xmailer!" => \$use_xmailer,
331 die "Cannot run git format-patch from outside a repository\n"
332 if $format_patch and not $repo;
334 # Now, let's fill any that aren't set in with defaults:
339 foreach my $setting (keys %config_bool_settings) {
340 my $target = $config_bool_settings{$setting}->[0];
341 $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
344 foreach my $setting (keys %config_path_settings) {
345 my $target = $config_path_settings{$setting};
346 if (ref($target) eq "ARRAY") {
348 my @values = Git::config_path(@repo, "$prefix.$setting");
349 @$target = @values if (@values && defined $values[0]);
353 $$target = Git::config_path(@repo, "$prefix.$setting") unless (defined $$target);
357 foreach my $setting (keys %config_settings) {
358 my $target = $config_settings{$setting};
359 next if $setting eq "to" and defined $no_to;
360 next if $setting eq "cc" and defined $no_cc;
361 next if $setting eq "bcc" and defined $no_bcc;
362 if (ref($target) eq "ARRAY") {
364 my @values = Git::config(@repo, "$prefix.$setting");
365 @$target = @values if (@values && defined $values[0]);
369 $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
373 if (!defined $smtp_encryption) {
374 my $enc = Git::config(@repo, "$prefix.smtpencryption");
376 $smtp_encryption = $enc;
377 } elsif (Git::config_bool(@repo, "$prefix.smtpssl")) {
378 $smtp_encryption = 'ssl';
383 # read configuration from [sendemail "$identity"], fall back on [sendemail]
384 $identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
385 read_config("sendemail.$identity") if (defined $identity);
386 read_config("sendemail");
388 # fall back on builtin bool defaults
389 foreach my $setting (values %config_bool_settings) {
390 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
393 # 'default' encryption is none -- this only prevents a warning
394 $smtp_encryption = '' unless (defined $smtp_encryption);
396 # Set CC suppressions
399 foreach my $entry (@suppress_cc) {
400 die "Unknown --suppress-cc field: '$entry'\n"
401 unless $entry =~ /^(?:all|cccmd|cc|author|self|sob|body|bodycc)$/;
402 $suppress_cc{$entry} = 1;
406 if ($suppress_cc{'all'}) {
407 foreach my $entry (qw (cccmd cc author self sob body bodycc)) {
408 $suppress_cc{$entry} = 1;
410 delete $suppress_cc{'all'};
413 # If explicit old-style ones are specified, they trump --suppress-cc.
414 $suppress_cc{'self'} = $suppress_from if defined $suppress_from;
415 $suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
417 if ($suppress_cc{'body'}) {
418 foreach my $entry (qw (sob bodycc)) {
419 $suppress_cc{$entry} = 1;
421 delete $suppress_cc{'body'};
424 # Set confirm's default value
425 my $confirm_unconfigured = !defined $confirm;
426 if ($confirm_unconfigured) {
427 $confirm = scalar %suppress_cc ? 'compose' : 'auto';
429 die "Unknown --confirm setting: '$confirm'\n"
430 unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
432 # Debugging, print out the suppressions.
434 print "suppressions:\n";
435 foreach my $entry (keys %suppress_cc) {
436 printf " %-5s -> $suppress_cc{$entry}\n", $entry;
440 my ($repoauthor, $repocommitter);
441 ($repoauthor) = Git::ident_person(@repo, 'author');
442 ($repocommitter) = Git::ident_person(@repo, 'committer');
444 # Verify the user input
446 foreach my $entry (@initial_to) {
447 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
450 foreach my $entry (@initial_cc) {
451 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
454 foreach my $entry (@bcclist) {
455 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
458 sub parse_address_line {
459 if ($have_mail_address) {
460 return map { $_->format } Mail::Address->parse($_[0]);
462 return split_addrs($_[0]);
467 return quotewords('\s*,\s*', 1, @_);
472 # multiline formats can be supported in the future
473 mutt => sub { my $fh = shift; while (<$fh>) {
474 if (/^\s*alias\s+(?:-group\s+\S+\s+)*(\S+)\s+(.*)$/) {
475 my ($alias, $addr) = ($1, $2);
476 $addr =~ s/#.*$//; # mutt allows # comments
477 # commas delimit multiple addresses
478 $aliases{$alias} = [ split_addrs($addr) ];
480 mailrc => sub { my $fh = shift; while (<$fh>) {
481 if (/^alias\s+(\S+)\s+(.*)$/) {
482 # spaces delimit multiple addresses
483 $aliases{$1} = [ quotewords('\s+', 0, $2) ];
485 pine => sub { my $fh = shift; my $f='\t[^\t]*';
486 for (my $x = ''; defined($x); $x = $_) {
488 $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
489 $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
490 $aliases{$1} = [ split_addrs($2) ];
492 elm => sub { my $fh = shift;
494 if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
495 my ($alias, $addr) = ($1, $2);
496 $aliases{$alias} = [ split_addrs($addr) ];
500 gnus => sub { my $fh = shift; while (<$fh>) {
501 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
502 $aliases{$1} = [ $2 ];
506 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
507 foreach my $file (@alias_files) {
508 open my $fh, '<', $file or die "opening $file: $!\n";
509 $parse_alias{$aliasfiletype}->($fh);
514 ($sender) = expand_aliases($sender) if defined $sender;
516 # is_format_patch_arg($f) returns 0 if $f names a patch, or 1 if
517 # $f is a revision list specification to be passed to format-patch.
518 sub is_format_patch_arg {
522 $repo->command('rev-parse', '--verify', '--quiet', $f);
523 if (defined($format_patch)) {
524 return $format_patch;
527 File '$f' exists but it could also be the range of commits
528 to produce patches for. Please disambiguate by...
530 * Saying "./$f" if you mean a file; or
531 * Giving --format-patch option if you mean a range.
533 } catch Git::Error::Command with {
534 # Not a valid revision. Treat it as a filename.
539 # Now that all the defaults are set, process the rest of the command line
540 # arguments and collect up the files that need to be processed.
542 while (defined(my $f = shift @ARGV)) {
544 push @rev_list_opts, "--", @ARGV;
546 } elsif (-d $f and !is_format_patch_arg($f)) {
548 or die "Failed to opendir $f: $!";
550 push @files, grep { -f $_ } map { catfile($f, $_) }
553 } elsif ((-f $f or -p $f) and !is_format_patch_arg($f)) {
556 push @rev_list_opts, $f;
560 if (@rev_list_opts) {
561 die "Cannot run git format-patch from outside a repository\n"
563 push @files, $repo->command('format-patch', '-o', tempdir(CLEANUP => 1), @rev_list_opts);
567 foreach my $f (@files) {
569 my $error = validate_patch($f);
570 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
577 print $_,"\n" for (@files);
580 print STDERR "\nNo patch files specified!\n\n";
584 sub get_patch_subject {
586 open (my $fh, '<', $fn);
587 while (my $line = <$fh>) {
588 next unless ($line =~ /^Subject: (.*)$/);
593 die "No subject line in $fn ?";
597 # Note that this does not need to be secure, but we will make a small
598 # effort to have it be unique
599 $compose_filename = ($repo ?
600 tempfile(".gitsendemail.msg.XXXXXX", DIR => $repo->repo_path()) :
601 tempfile(".gitsendemail.msg.XXXXXX", DIR => "."))[1];
602 open my $c, ">", $compose_filename
603 or die "Failed to open for writing $compose_filename: $!";
606 my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
607 my $tpl_subject = $initial_subject || '';
608 my $tpl_reply_to = $initial_reply_to || '';
611 From $tpl_sender # This line is ignored.
612 GIT: Lines beginning in "GIT:" will be removed.
613 GIT: Consider including an overall diffstat or table of contents
614 GIT: for the patch you are writing.
616 GIT: Clear the body content if you don't wish to send a summary.
618 Subject: $tpl_subject
619 In-Reply-To: $tpl_reply_to
623 print $c get_patch_subject($f);
628 do_edit($compose_filename, @files);
630 do_edit($compose_filename);
633 open my $c2, ">", $compose_filename . ".final"
634 or die "Failed to open $compose_filename.final : " . $!;
636 open $c, "<", $compose_filename
637 or die "Failed to open $compose_filename : " . $!;
639 my $need_8bit_cte = file_has_nonascii($compose_filename);
641 my $summary_empty = 1;
642 if (!defined $compose_encoding) {
643 $compose_encoding = "UTF-8";
648 $summary_empty = 0 unless (/^\n$/);
651 if ($need_8bit_cte) {
652 print $c2 "MIME-Version: 1.0\n",
653 "Content-Type: text/plain; ",
654 "charset=$compose_encoding\n",
655 "Content-Transfer-Encoding: 8bit\n";
657 } elsif (/^MIME-Version:/i) {
659 } elsif (/^Subject:\s*(.+)\s*$/i) {
660 $initial_subject = $1;
661 my $subject = $initial_subject;
663 quote_subject($subject, $compose_encoding) .
665 } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
666 $initial_reply_to = $1;
668 } elsif (/^From:\s*(.+)\s*$/i) {
671 } elsif (/^(?:To|Cc|Bcc):/i) {
672 print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
680 if ($summary_empty) {
681 print "Summary email is empty, skipping it\n";
684 } elsif ($annotate) {
689 my ($prompt, %arg) = @_;
690 my $valid_re = $arg{valid_re};
691 my $default = $arg{default};
692 my $confirm_only = $arg{confirm_only};
695 return defined $default ? $default : undef
696 unless defined $term->IN and defined fileno($term->IN) and
697 defined $term->OUT and defined fileno($term->OUT);
699 $resp = $term->readline($prompt);
700 if (!defined $resp) { # EOF
702 return defined $default ? $default : undef;
704 if ($resp eq '' and defined $default) {
707 if (!defined $valid_re or $resp =~ /$valid_re/) {
711 my $yesno = $term->readline("Are you sure you want to use <$resp> [y/N]? ");
712 if (defined $yesno && $yesno =~ /y/i) {
722 sub file_declares_8bit_cte {
724 open (my $fh, '<', $fn);
725 while (my $line = <$fh>) {
726 last if ($line =~ /^$/);
727 return 1 if ($line =~ /^Content-Transfer-Encoding: .*8bit.*$/);
733 foreach my $f (@files) {
734 next unless (body_or_subject_has_nonascii($f)
735 && !file_declares_8bit_cte($f));
736 $broken_encoding{$f} = 1;
739 if (!defined $auto_8bit_encoding && scalar %broken_encoding) {
740 print "The following files are 8bit, but do not declare " .
741 "a Content-Transfer-Encoding.\n";
742 foreach my $f (sort keys %broken_encoding) {
745 $auto_8bit_encoding = ask("Which 8bit encoding should I declare [UTF-8]? ",
751 if (get_patch_subject($f) =~ /\Q*** SUBJECT HERE ***\E/) {
752 die "Refusing to send because the patch\n\t$f\n"
753 . "has the template subject '*** SUBJECT HERE ***'. "
754 . "Pass --force if you really want to send.\n";
759 if (!defined $sender) {
760 $sender = $repoauthor || $repocommitter || '';
763 # $sender could be an already sanitized address
764 # (e.g. sendemail.from could be manually sanitized by user).
765 # But it's a no-op to run sanitize_address on an already sanitized address.
766 $sender = sanitize_address($sender);
769 if (!@initial_to && !defined $to_cmd) {
770 my $to = ask("Who should the emails be sent to (if any)? ",
772 valid_re => qr/\@.*\./, confirm_only => 1);
773 push @initial_to, parse_address_line($to) if defined $to; # sanitized/validated later
778 return map { expand_one_alias($_) } @_;
781 my %EXPANDED_ALIASES;
782 sub expand_one_alias {
784 if ($EXPANDED_ALIASES{$alias}) {
785 die "fatal: alias '$alias' expands to itself\n";
787 local $EXPANDED_ALIASES{$alias} = 1;
788 return $aliases{$alias} ? expand_aliases(@{$aliases{$alias}}) : $alias;
791 @initial_to = expand_aliases(@initial_to);
792 @initial_to = validate_address_list(sanitize_address_list(@initial_to));
793 @initial_cc = expand_aliases(@initial_cc);
794 @initial_cc = validate_address_list(sanitize_address_list(@initial_cc));
795 @bcclist = expand_aliases(@bcclist);
796 @bcclist = validate_address_list(sanitize_address_list(@bcclist));
798 if ($thread && !defined $initial_reply_to && $prompting) {
799 $initial_reply_to = ask(
800 "Message-ID to be used as In-Reply-To for the first email (if any)? ",
802 valid_re => qr/\@.*\./, confirm_only => 1);
804 if (defined $initial_reply_to) {
805 $initial_reply_to =~ s/^\s*<?//;
806 $initial_reply_to =~ s/>?\s*$//;
807 $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
810 if (!defined $smtp_server) {
811 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
817 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
820 if ($compose && $compose > 0) {
821 @files = ($compose_filename . ".final", @files);
824 # Variables we set as part of the loop over files
825 our ($message_id, %mail, $subject, $reply_to, $references, $message,
826 $needs_confirm, $message_num, $ask_default);
828 sub extract_valid_address {
830 my $local_part_regexp = qr/[^<>"\s@]+/;
831 my $domain_regexp = qr/[^.<>"\s@]+(?:\.[^.<>"\s@]+)+/;
833 # check for a local address:
834 return $address if ($address =~ /^($local_part_regexp)$/);
836 $address =~ s/^\s*<(.*)>\s*$/$1/;
837 if ($have_email_valid) {
838 return scalar Email::Valid->address($address);
841 # less robust/correct than the monster regexp in Email::Valid,
842 # but still does a 99% job, and one less dependency
843 return $1 if $address =~ /($local_part_regexp\@$domain_regexp)/;
847 sub extract_valid_address_or_die {
849 $address = extract_valid_address($address);
850 die "error: unable to extract a valid address from: $address\n"
855 sub validate_address {
857 while (!extract_valid_address($address)) {
858 print STDERR "error: unable to extract a valid address from: $address\n";
859 $_ = ask("What to do with this address? ([q]uit|[d]rop|[e]dit): ",
860 valid_re => qr/^(?:quit|q|drop|d|edit|e)/i,
865 cleanup_compose_files();
868 $address = ask("Who should the email be sent to (if any)? ",
870 valid_re => qr/\@.*\./, confirm_only => 1);
875 sub validate_address_list {
876 return (grep { defined $_ }
877 map { validate_address($_) } @_);
880 # Usually don't need to change anything below here.
882 # we make a "fake" message id by taking the current number
883 # of seconds since the beginning of Unix time and tacking on
884 # a random number to the end, in case we are called quicker than
885 # 1 second since the last time we were called.
887 # We'll setup a template for the message id, using the "from" address:
889 my ($message_id_stamp, $message_id_serial);
890 sub make_message_id {
892 if (!defined $message_id_stamp) {
893 $message_id_stamp = sprintf("%s-%s", time, $$);
894 $message_id_serial = 0;
896 $message_id_serial++;
897 $uniq = "$message_id_stamp-$message_id_serial";
900 for ($sender, $repocommitter, $repoauthor) {
901 $du_part = extract_valid_address(sanitize_address($_));
902 last if (defined $du_part and $du_part ne '');
904 if (not defined $du_part or $du_part eq '') {
905 require Sys::Hostname;
906 $du_part = 'user@' . Sys::Hostname::hostname();
908 my $message_id_template = "<%s-git-send-email-%s>";
909 $message_id = sprintf($message_id_template, $uniq, $du_part);
910 #print "new message id = $message_id\n"; # Was useful for debugging
915 $time = time - scalar $#files;
917 sub unquote_rfc2047 {
920 s{=\?([^?]+)\?q\?(.*?)\?=}{
924 $e =~ s/=([0-9A-F]{2})/chr(hex($1))/eg;
927 return wantarray ? ($_, $encoding) : $_;
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 {
940 my $token = qr/[^][()<>@,;:"\/?.= \000-\037\177-\377]+/;
941 my $encoded_text = qr/[!->@-~]+/;
943 $s =~ m/^(?:"[[:ascii:]]*"|=\?$token\?$token\?$encoded_text\?=)$/o;
946 sub subject_needs_rfc2047_quoting {
949 return ($s =~ /[^[:ascii:]]/) || ($s =~ /=\?/);
953 local $subject = shift;
954 my $encoding = shift || 'UTF-8';
956 if (subject_needs_rfc2047_quoting($subject)) {
957 return quote_rfc2047($subject, $encoding);
962 # use the simplest quoting being able to handle the recipient
963 sub sanitize_address {
964 my ($recipient) = @_;
966 # remove garbage after email address
967 $recipient =~ s/(.*>).*$/$1/;
969 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
971 if (not $recipient_name) {
975 # if recipient_name is already quoted, do nothing
976 if (is_rfc2047_quoted($recipient_name)) {
980 # rfc2047 is needed if a non-ascii char is included
981 if ($recipient_name =~ /[^[:ascii:]]/) {
982 $recipient_name =~ s/^"(.*)"$/$1/;
983 $recipient_name = quote_rfc2047($recipient_name);
986 # double quotes are needed if specials or CTLs are included
987 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
988 $recipient_name =~ s/(["\\\r])/\\$1/g;
989 $recipient_name = qq["$recipient_name"];
992 return "$recipient_name $recipient_addr";
996 sub sanitize_address_list {
997 return (map { sanitize_address($_) } @_);
1000 # Returns the local Fully Qualified Domain Name (FQDN) if available.
1002 # Tightly configured MTAa require that a caller sends a real DNS
1003 # domain name that corresponds the IP address in the HELO/EHLO
1004 # handshake. This is used to verify the connection and prevent
1005 # spammers from trying to hide their identity. If the DNS and IP don't
1006 # match, the receiveing MTA may deny the connection.
1008 # Here is a deny example of Net::SMTP with the default "localhost.localdomain"
1010 # Net::SMTP=GLOB(0x267ec28)>>> EHLO localhost.localdomain
1011 # Net::SMTP=GLOB(0x267ec28)<<< 550 EHLO argument does not match calling host
1013 # This maildomain*() code is based on ideas in Perl library Test::Reporter
1014 # /usr/share/perl5/Test/Reporter/Mail/Util.pm ==> sub _maildomain ()
1018 return defined $domain && !($^O eq 'darwin' && $domain =~ /\.local$/) && $domain =~ /\./;
1021 sub maildomain_net {
1024 if (eval { require Net::Domain; 1 }) {
1025 my $domain = Net::Domain::domainname();
1026 $maildomain = $domain if valid_fqdn($domain);
1032 sub maildomain_mta {
1035 if (eval { require Net::SMTP; 1 }) {
1036 for my $host (qw(mailhost localhost)) {
1037 my $smtp = Net::SMTP->new($host);
1038 if (defined $smtp) {
1039 my $domain = $smtp->domain;
1042 $maildomain = $domain if valid_fqdn($domain);
1044 last if $maildomain;
1053 return maildomain_net() || maildomain_mta() || 'localhost.localdomain';
1056 sub smtp_host_string {
1057 if (defined $smtp_server_port) {
1058 return "$smtp_server:$smtp_server_port";
1060 return $smtp_server;
1064 # Returns 1 if authentication succeeded or was not necessary
1065 # (smtp_user was not specified), and 0 otherwise.
1067 sub smtp_auth_maybe {
1068 if (!defined $smtp_authuser || $auth) {
1072 # Workaround AUTH PLAIN/LOGIN interaction defect
1073 # with Authen::SASL::Cyrus
1075 require Authen::SASL;
1076 Authen::SASL->import(qw(Perl));
1079 # TODO: Authentication may fail not because credentials were
1080 # invalid but due to other reasons, in which we should not
1081 # reject credentials.
1082 $auth = Git::credential({
1083 'protocol' => 'smtp',
1084 'host' => smtp_host_string(),
1085 'username' => $smtp_authuser,
1086 # if there's no password, "git credential fill" will
1087 # give us one, otherwise it'll just pass this one.
1088 'password' => $smtp_authpass
1091 return !!$smtp->auth($cred->{'username'}, $cred->{'password'});
1097 sub ssl_verify_params {
1099 require IO::Socket::SSL;
1100 IO::Socket::SSL->import(qw/SSL_VERIFY_PEER SSL_VERIFY_NONE/);
1103 print STDERR "Not using SSL_VERIFY_PEER due to out-of-date IO::Socket::SSL.\n";
1107 if (!defined $smtp_ssl_cert_path) {
1108 # use the OpenSSL defaults
1109 return (SSL_verify_mode => SSL_VERIFY_PEER());
1112 if ($smtp_ssl_cert_path eq "") {
1113 return (SSL_verify_mode => SSL_VERIFY_NONE());
1114 } elsif (-d $smtp_ssl_cert_path) {
1115 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1116 SSL_ca_path => $smtp_ssl_cert_path);
1117 } elsif (-f $smtp_ssl_cert_path) {
1118 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1119 SSL_ca_file => $smtp_ssl_cert_path);
1121 print STDERR "Not using SSL_VERIFY_PEER because the CA path does not exist.\n";
1122 return (SSL_verify_mode => SSL_VERIFY_NONE());
1126 sub file_name_is_absolute {
1129 # msys does not grok DOS drive-prefixes
1130 if ($^O eq 'msys') {
1131 return ($path =~ m#^/# || $path =~ m#^[a-zA-Z]\:#)
1134 require File::Spec::Functions;
1135 return File::Spec::Functions::file_name_is_absolute($path);
1138 # Returns 1 if the message was sent, and 0 otherwise.
1139 # In actuality, the whole program dies when there
1140 # is an error sending a message.
1143 my @recipients = unique_email_list(@to);
1144 @cc = (grep { my $cc = extract_valid_address_or_die($_);
1145 not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
1148 my $to = join (",\n\t", @recipients);
1149 @recipients = unique_email_list(@recipients,@cc,@bcclist);
1150 @recipients = (map { extract_valid_address_or_die($_) } @recipients);
1151 my $date = format_2822_time($time++);
1152 my $gitversion = '@@GIT_VERSION@@';
1153 if ($gitversion =~ m/..GIT_VERSION../) {
1154 $gitversion = Git::version();
1157 my $cc = join(",\n\t", unique_email_list(@cc));
1160 $ccline = "\nCc: $cc";
1162 make_message_id() unless defined($message_id);
1164 my $header = "From: $sender
1168 Message-Id: $message_id
1171 $header .= "X-Mailer: git-send-email $gitversion\n";
1175 $header .= "In-Reply-To: $reply_to\n";
1176 $header .= "References: $references\n";
1179 $header .= join("\n", @xh) . "\n";
1182 my @sendmail_parameters = ('-i', @recipients);
1183 my $raw_from = $sender;
1184 if (defined $envelope_sender && $envelope_sender ne "auto") {
1185 $raw_from = $envelope_sender;
1187 $raw_from = extract_valid_address($raw_from);
1188 unshift (@sendmail_parameters,
1189 '-f', $raw_from) if(defined $envelope_sender);
1191 if ($needs_confirm && !$dry_run) {
1192 print "\n$header\n";
1193 if ($needs_confirm eq "inform") {
1194 $confirm_unconfigured = 0; # squelch this message for the rest of this run
1195 $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
1196 print " The Cc list above has been expanded by additional\n";
1197 print " addresses found in the patch commit message. By default\n";
1198 print " send-email prompts before sending whenever this occurs.\n";
1199 print " This behavior is controlled by the sendemail.confirm\n";
1200 print " configuration setting.\n";
1202 print " For additional information, run 'git send-email --help'.\n";
1203 print " To retain the current behavior, but squelch this message,\n";
1204 print " run 'git config --global sendemail.confirm auto'.\n\n";
1206 $_ = ask("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
1207 valid_re => qr/^(?:yes|y|no|n|quit|q|all|a)/i,
1208 default => $ask_default);
1209 die "Send this email reply required" unless defined $_;
1213 cleanup_compose_files();
1220 unshift (@sendmail_parameters, @smtp_server_options);
1223 # We don't want to send the email.
1224 } elsif (file_name_is_absolute($smtp_server)) {
1225 my $pid = open my $sm, '|-';
1226 defined $pid or die $!;
1228 exec($smtp_server, @sendmail_parameters) or die $!;
1230 print $sm "$header\n$message";
1231 close $sm or die $!;
1234 if (!defined $smtp_server) {
1235 die "The required SMTP server is not properly defined."
1238 if ($smtp_encryption eq 'ssl') {
1239 $smtp_server_port ||= 465; # ssmtp
1240 require Net::SMTP::SSL;
1241 $smtp_domain ||= maildomain();
1242 require IO::Socket::SSL;
1243 # Net::SMTP::SSL->new() does not forward any SSL options
1244 IO::Socket::SSL::set_client_defaults(
1245 ssl_verify_params());
1246 $smtp ||= Net::SMTP::SSL->new($smtp_server,
1247 Hello => $smtp_domain,
1248 Port => $smtp_server_port,
1249 Debug => $debug_net_smtp);
1253 $smtp_domain ||= maildomain();
1254 $smtp_server_port ||= 25;
1255 $smtp ||= Net::SMTP->new($smtp_server,
1256 Hello => $smtp_domain,
1257 Debug => $debug_net_smtp,
1258 Port => $smtp_server_port);
1259 if ($smtp_encryption eq 'tls' && $smtp) {
1260 require Net::SMTP::SSL;
1261 $smtp->command('STARTTLS');
1263 if ($smtp->code == 220) {
1264 $smtp = Net::SMTP::SSL->start_SSL($smtp,
1265 ssl_verify_params())
1266 or die "STARTTLS failed! ".IO::Socket::SSL::errstr();
1267 $smtp_encryption = '';
1268 # Send EHLO again to receive fresh
1269 # supported commands
1270 $smtp->hello($smtp_domain);
1272 die "Server does not support STARTTLS! ".$smtp->message;
1278 die "Unable to initialize SMTP properly. Check config and use --smtp-debug. ",
1279 "VALUES: server=$smtp_server ",
1280 "encryption=$smtp_encryption ",
1281 "hello=$smtp_domain",
1282 defined $smtp_server_port ? " port=$smtp_server_port" : "";
1285 smtp_auth_maybe or die $smtp->message;
1287 $smtp->mail( $raw_from ) or die $smtp->message;
1288 $smtp->to( @recipients ) or die $smtp->message;
1289 $smtp->data or die $smtp->message;
1290 $smtp->datasend("$header\n$message") or die $smtp->message;
1291 $smtp->dataend() or die $smtp->message;
1292 $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
1295 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
1297 print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
1298 if (!file_name_is_absolute($smtp_server)) {
1299 print "Server: $smtp_server\n";
1300 print "MAIL FROM:<$raw_from>\n";
1301 foreach my $entry (@recipients) {
1302 print "RCPT TO:<$entry>\n";
1305 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
1307 print $header, "\n";
1309 print "Result: ", $smtp->code, ' ',
1310 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
1312 print "Result: OK\n";
1319 $reply_to = $initial_reply_to;
1320 $references = $initial_reply_to || '';
1321 $subject = $initial_subject;
1324 foreach my $t (@files) {
1325 open my $fh, "<", $t or die "can't open file $t";
1328 my $sauthor = undef;
1329 my $author_encoding;
1330 my $has_content_type;
1335 my $input_format = undef;
1339 # First unfold multiline header fields
1342 if (/^\s+\S/ and @header) {
1343 chomp($header[$#header]);
1345 $header[$#header] .= $_;
1350 # Now parse the header
1353 $input_format = 'mbox';
1357 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1358 $input_format = 'mbox';
1361 if (defined $input_format && $input_format eq 'mbox') {
1362 if (/^Subject:\s+(.*)$/i) {
1365 elsif (/^From:\s+(.*)$/i) {
1366 ($author, $author_encoding) = unquote_rfc2047($1);
1367 $sauthor = sanitize_address($author);
1368 next if $suppress_cc{'author'};
1369 next if $suppress_cc{'self'} and $sauthor eq $sender;
1370 printf("(mbox) Adding cc: %s from line '%s'\n",
1371 $1, $_) unless $quiet;
1374 elsif (/^To:\s+(.*)$/i) {
1375 foreach my $addr (parse_address_line($1)) {
1376 printf("(mbox) Adding to: %s from line '%s'\n",
1377 $addr, $_) unless $quiet;
1381 elsif (/^Cc:\s+(.*)$/i) {
1382 foreach my $addr (parse_address_line($1)) {
1383 my $qaddr = unquote_rfc2047($addr);
1384 my $saddr = sanitize_address($qaddr);
1385 if ($saddr eq $sender) {
1386 next if ($suppress_cc{'self'});
1388 next if ($suppress_cc{'cc'});
1390 printf("(mbox) Adding cc: %s from line '%s'\n",
1391 $addr, $_) unless $quiet;
1395 elsif (/^Content-type:/i) {
1396 $has_content_type = 1;
1397 if (/charset="?([^ "]+)/) {
1398 $body_encoding = $1;
1402 elsif (/^Message-Id: (.*)/i) {
1405 elsif (!/^Date:\s/i && /^[-A-Za-z]+:\s+\S/) {
1410 # In the traditional
1411 # "send lots of email" format,
1414 # So let's support that, too.
1415 $input_format = 'lots';
1416 if (@cc == 0 && !$suppress_cc{'cc'}) {
1417 printf("(non-mbox) Adding cc: %s from line '%s'\n",
1418 $_, $_) unless $quiet;
1420 } elsif (!defined $subject) {
1425 # Now parse the message body
1428 if (/^(Signed-off-by|Cc): (.*)$/i) {
1430 my ($what, $c) = ($1, $2);
1432 my $sc = sanitize_address($c);
1433 if ($sc eq $sender) {
1434 next if ($suppress_cc{'self'});
1436 next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1437 next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1440 printf("(body) Adding cc: %s from line '%s'\n",
1441 $c, $_) unless $quiet;
1446 push @to, recipients_cmd("to-cmd", "to", $to_cmd, $t)
1448 push @cc, recipients_cmd("cc-cmd", "cc", $cc_cmd, $t)
1449 if defined $cc_cmd && !$suppress_cc{'cccmd'};
1451 if ($broken_encoding{$t} && !$has_content_type) {
1452 $has_content_type = 1;
1453 push @xh, "MIME-Version: 1.0",
1454 "Content-Type: text/plain; charset=$auto_8bit_encoding",
1455 "Content-Transfer-Encoding: 8bit";
1456 $body_encoding = $auto_8bit_encoding;
1459 if ($broken_encoding{$t} && !is_rfc2047_quoted($subject)) {
1460 $subject = quote_subject($subject, $auto_8bit_encoding);
1463 if (defined $sauthor and $sauthor ne $sender) {
1464 $message = "From: $author\n\n$message";
1465 if (defined $author_encoding) {
1466 if ($has_content_type) {
1467 if ($body_encoding eq $author_encoding) {
1468 # ok, we already have the right encoding
1471 # uh oh, we should re-encode
1475 $has_content_type = 1;
1477 'MIME-Version: 1.0',
1478 "Content-Type: text/plain; charset=$author_encoding",
1479 'Content-Transfer-Encoding: 8bit';
1485 $confirm eq "always" or
1486 ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1487 ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1488 $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1490 @to = validate_address_list(sanitize_address_list(@to));
1491 @cc = validate_address_list(sanitize_address_list(@cc));
1493 @to = (@initial_to, @to);
1494 @cc = (@initial_cc, @cc);
1496 if ($message_num == 1) {
1497 if (defined $cover_cc and $cover_cc) {
1500 if (defined $cover_to and $cover_to) {
1505 my $message_was_sent = send_message();
1507 # set up for the next message
1508 if ($thread && $message_was_sent &&
1509 ($chain_reply_to || !defined $reply_to || length($reply_to) == 0 ||
1510 $message_num == 1)) {
1511 $reply_to = $message_id;
1512 if (length $references > 0) {
1513 $references .= "\n $message_id";
1515 $references = "$message_id";
1518 $message_id = undef;
1521 # Execute a command (e.g. $to_cmd) to get a list of email addresses
1522 # and return a results array
1523 sub recipients_cmd {
1524 my ($prefix, $what, $cmd, $file) = @_;
1527 open my $fh, "-|", "$cmd \Q$file\E"
1528 or die "($prefix) Could not execute '$cmd'";
1529 while (my $address = <$fh>) {
1530 $address =~ s/^\s*//g;
1531 $address =~ s/\s*$//g;
1532 $address = sanitize_address($address);
1533 next if ($address eq $sender and $suppress_cc{'self'});
1534 push @addresses, $address;
1535 printf("($prefix) Adding %s: %s from: '%s'\n",
1536 $what, $address, $cmd) unless $quiet;
1539 or die "($prefix) failed to close pipe to '$cmd'";
1543 cleanup_compose_files();
1545 sub cleanup_compose_files {
1546 unlink($compose_filename, $compose_filename . ".final") if $compose;
1549 $smtp->quit if $smtp;
1551 sub unique_email_list {
1555 foreach my $entry (@_) {
1556 my $clean = extract_valid_address_or_die($entry);
1557 $seen{$clean} ||= 0;
1558 next if $seen{$clean}++;
1559 push @emails, $entry;
1564 sub validate_patch {
1566 open(my $fh, '<', $fn)
1567 or die "unable to open $fn: $!\n";
1568 while (my $line = <$fh>) {
1569 if (length($line) > 998) {
1570 return "$.: patch contains a line longer than 998 characters";
1576 sub file_has_nonascii {
1578 open(my $fh, '<', $fn)
1579 or die "unable to open $fn: $!\n";
1580 while (my $line = <$fh>) {
1581 return 1 if $line =~ /[^[:ascii:]]/;
1586 sub body_or_subject_has_nonascii {
1588 open(my $fh, '<', $fn)
1589 or die "unable to open $fn: $!\n";
1590 while (my $line = <$fh>) {
1591 last if $line =~ /^$/;
1592 return 1 if $line =~ /^Subject.*[^[:ascii:]]/;
1594 while (my $line = <$fh>) {
1595 return 1 if $line =~ /[^[:ascii:]]/;