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.
26 use File
::Temp qw
/ tempdir tempfile /;
30 Getopt
::Long
::Configure qw
/ pass_through /;
34 my ($class, $reason) = @_;
35 return bless \
$reason, shift;
39 die "Cannot use readline on FakeTerm: $$self";
46 git send-email [options] <file | directory | rev-list options >
49 --from <str> * Email From:
50 --[no-]to <str> * Email To:
51 --[no-]cc <str> * Email Cc:
52 --[no-]bcc <str> * Email Bcc:
53 --subject <str> * Email "Subject:"
54 --in-reply-to <str> * Email "In-Reply-To:"
55 --annotate * Review each patch that will be sent in an editor.
56 --compose * Open an editor for introduction.
57 --8bit-encoding <str> * Encoding to assume 8bit mails if undeclared
60 --envelope-sender <str> * Email envelope sender.
61 --smtp-server <str:int> * Outgoing SMTP server to use. The port
62 is optional. Default 'localhost'.
63 --smtp-server-port <int> * Outgoing SMTP server port.
64 --smtp-user <str> * Username for SMTP-AUTH.
65 --smtp-pass <str> * Password for SMTP-AUTH; not necessary.
66 --smtp-encryption <str> * tls or ssl; anything else disables.
67 --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
68 --smtp-domain <str> * The domain name sent to HELO/EHLO handshake
69 --smtp-debug <0|1> * Disable, enable Net::SMTP debug.
72 --identity <str> * Use the sendemail.<id> options.
73 --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
74 --suppress-cc <str> * author, self, sob, cc, cccmd, body, bodycc, all.
75 --[no-]signed-off-by-cc * Send to Signed-off-by: addresses. Default on.
76 --[no-]suppress-from * Send to self. Default off.
77 --[no-]chain-reply-to * Chain In-Reply-To: fields. Default off.
78 --[no-]thread * Use In-Reply-To: field. Default on.
81 --confirm <str> * Confirm recipients before sending;
82 auto, cc, compose, always, or never.
83 --quiet * Output one line of info per email.
84 --dry-run * Don't actually send the emails.
85 --[no-]validate * Perform patch sanity checks. Default on.
86 --[no-]format-patch * understand any non optional arguments as
87 `git format-patch` ones.
93 # most mail servers generate the Date: header, but not all...
94 sub format_2822_time
{
96 my @localtm = localtime($time);
97 my @gmttm = gmtime($time);
98 my $localmin = $localtm[1] + $localtm[2] * 60;
99 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
100 if ($localtm[0] != $gmttm[0]) {
101 die "local zone differs from GMT by a non-minute interval\n";
103 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
105 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
107 } elsif ($gmttm[6] != $localtm[6]) {
108 die "local time offset greater than or equal to 24 hours\n";
110 my $offset = $localmin - $gmtmin;
111 my $offhour = $offset / 60;
112 my $offmin = abs($offset % 60);
113 if (abs($offhour) >= 24) {
114 die ("local time offset greater than or equal to 24 hours\n");
117 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
118 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
120 qw(Jan Feb Mar Apr May Jun
121 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
126 ($offset >= 0) ?
'+' : '-',
132 my $have_email_valid = eval { require Email
::Valid
; 1 };
133 my $have_mail_address = eval { require Mail
::Address
; 1 };
137 sub unique_email_list
(@
);
138 sub cleanup_compose_files
();
140 # Variables we fill in automatically, or via prompting:
141 my (@to,$no_to,@cc,$no_cc,@initial_cc,@bcclist,$no_bcc,@xh,
142 $initial_reply_to,$initial_subject,@files,
143 $author,$sender,$smtp_authpass,$annotate,$compose,$time);
148 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
150 my $repo = eval { Git
->repository() };
151 my @repo = $repo ?
($repo) : ();
153 $ENV{"GIT_SEND_EMAIL_NOTTY"}
154 ? new Term
::ReadLine
'git-send-email', \
*STDIN
, \
*STDOUT
155 : new Term
::ReadLine
'git-send-email';
158 $term = new FakeTerm
"$@: going non-interactive";
161 # Behavior modification variables
162 my ($quiet, $dry_run) = (0, 0);
164 my $compose_filename;
166 # Handle interactive edition of files.
171 if (!defined($editor)) {
172 $editor = Git
::command_oneline
('var', 'GIT_EDITOR');
174 if (defined($multiedit) && !$multiedit) {
176 system('sh', '-c', $editor.' "$@"', $editor, $_);
177 if (($?
& 127) || ($?
>> 8)) {
178 die("the editor exited uncleanly, aborting everything");
182 system('sh', '-c', $editor.' "$@"', $editor, @_);
183 if (($?
& 127) || ($?
>> 8)) {
184 die("the editor exited uncleanly, aborting everything");
189 # Variables with corresponding config settings
190 my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc, $cc_cmd);
191 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_encryption);
192 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts, $smtp_domain);
193 my ($validate, $confirm);
195 my ($auto_8bit_encoding);
197 my ($debug_net_smtp) = 0; # Net::SMTP, see send_message()
199 my $not_set_by_user = "true but not set by the user";
201 my %config_bool_settings = (
202 "thread" => [\
$thread, 1],
203 "chainreplyto" => [\
$chain_reply_to, $not_set_by_user],
204 "suppressfrom" => [\
$suppress_from, undef],
205 "signedoffbycc" => [\
$signed_off_by_cc, undef],
206 "signedoffcc" => [\
$signed_off_by_cc, undef], # Deprecated
207 "validate" => [\
$validate, 1],
210 my %config_settings = (
211 "smtpserver" => \
$smtp_server,
212 "smtpserverport" => \
$smtp_server_port,
213 "smtpuser" => \
$smtp_authuser,
214 "smtppass" => \
$smtp_authpass,
215 "smtpdomain" => \
$smtp_domain,
217 "cc" => \
@initial_cc,
219 "aliasfiletype" => \
$aliasfiletype,
221 "aliasesfile" => \
@alias_files,
222 "suppresscc" => \
@suppress_cc,
223 "envelopesender" => \
$envelope_sender,
224 "multiedit" => \
$multiedit,
225 "confirm" => \
$confirm,
227 "assume8bitencoding" => \
$auto_8bit_encoding,
230 # Help users prepare for 1.7.0
232 if (defined $chain_reply_to &&
233 $chain_reply_to eq $not_set_by_user) {
235 "In git 1.7.0, the default has changed to --no-chain-reply-to\n" .
236 "Set sendemail.chainreplyto configuration variable to true if\n" .
237 "you want to keep --chain-reply-to as your default.\n";
240 return $chain_reply_to;
243 # Handle Uncouth Termination
247 print color
("reset"), "\n";
249 # SMTP password masked
252 # tmp files from --compose
253 if (defined $compose_filename) {
254 if (-e
$compose_filename) {
255 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
257 if (-e
($compose_filename . ".final")) {
258 print "'$compose_filename.final' contains the composed email.\n"
265 $SIG{TERM
} = \
&signal_handler
;
266 $SIG{INT
} = \
&signal_handler
;
268 # Begin by accumulating all the variables (defined above), that we will end up
269 # needing, first, from the command line:
271 my $rc = GetOptions
("sender|from=s" => \
$sender,
272 "in-reply-to=s" => \
$initial_reply_to,
273 "subject=s" => \
$initial_subject,
276 "cc=s" => \
@initial_cc,
278 "bcc=s" => \
@bcclist,
279 "no-bcc" => \
$no_bcc,
280 "chain-reply-to!" => \
$chain_reply_to,
281 "smtp-server=s" => \
$smtp_server,
282 "smtp-server-port=s" => \
$smtp_server_port,
283 "smtp-user=s" => \
$smtp_authuser,
284 "smtp-pass:s" => \
$smtp_authpass,
285 "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
286 "smtp-encryption=s" => \
$smtp_encryption,
287 "smtp-debug:i" => \
$debug_net_smtp,
288 "smtp-domain:s" => \
$smtp_domain,
289 "identity=s" => \
$identity,
290 "annotate" => \
$annotate,
291 "compose" => \
$compose,
293 "cc-cmd=s" => \
$cc_cmd,
294 "suppress-from!" => \
$suppress_from,
295 "suppress-cc=s" => \
@suppress_cc,
296 "signed-off-cc|signed-off-by-cc!" => \
$signed_off_by_cc,
297 "confirm=s" => \
$confirm,
298 "dry-run" => \
$dry_run,
299 "envelope-sender=s" => \
$envelope_sender,
300 "thread!" => \
$thread,
301 "validate!" => \
$validate,
302 "format-patch!" => \
$format_patch,
303 "8bit-encoding=s" => \
$auto_8bit_encoding,
310 die "Cannot run git format-patch from outside a repository\n"
311 if $format_patch and not $repo;
313 # Now, let's fill any that aren't set in with defaults:
318 foreach my $setting (keys %config_bool_settings) {
319 my $target = $config_bool_settings{$setting}->[0];
320 $$target = Git
::config_bool
(@repo, "$prefix.$setting") unless (defined $$target);
323 foreach my $setting (keys %config_settings) {
324 my $target = $config_settings{$setting};
325 next if $setting eq "to" and defined $no_to;
326 next if $setting eq "cc" and defined $no_cc;
327 next if $setting eq "bcc" and defined $no_bcc;
328 if (ref($target) eq "ARRAY") {
330 my @values = Git
::config
(@repo, "$prefix.$setting");
331 @
$target = @values if (@values && defined $values[0]);
335 $$target = Git
::config
(@repo, "$prefix.$setting") unless (defined $$target);
339 if (!defined $smtp_encryption) {
340 my $enc = Git
::config
(@repo, "$prefix.smtpencryption");
342 $smtp_encryption = $enc;
343 } elsif (Git
::config_bool
(@repo, "$prefix.smtpssl")) {
344 $smtp_encryption = 'ssl';
349 # read configuration from [sendemail "$identity"], fall back on [sendemail]
350 $identity = Git
::config
(@repo, "sendemail.identity") unless (defined $identity);
351 read_config
("sendemail.$identity") if (defined $identity);
352 read_config
("sendemail");
354 # fall back on builtin bool defaults
355 foreach my $setting (values %config_bool_settings) {
356 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
359 # 'default' encryption is none -- this only prevents a warning
360 $smtp_encryption = '' unless (defined $smtp_encryption);
362 # Set CC suppressions
365 foreach my $entry (@suppress_cc) {
366 die "Unknown --suppress-cc field: '$entry'\n"
367 unless $entry =~ /^(all|cccmd|cc|author|self|sob|body|bodycc)$/;
368 $suppress_cc{$entry} = 1;
372 if ($suppress_cc{'all'}) {
373 foreach my $entry (qw
(cccmd cc author self sob body bodycc
)) {
374 $suppress_cc{$entry} = 1;
376 delete $suppress_cc{'all'};
379 # If explicit old-style ones are specified, they trump --suppress-cc.
380 $suppress_cc{'self'} = $suppress_from if defined $suppress_from;
381 $suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
383 if ($suppress_cc{'body'}) {
384 foreach my $entry (qw
(sob bodycc
)) {
385 $suppress_cc{$entry} = 1;
387 delete $suppress_cc{'body'};
390 # Set confirm's default value
391 my $confirm_unconfigured = !defined $confirm;
392 if ($confirm_unconfigured) {
393 $confirm = scalar %suppress_cc ?
'compose' : 'auto';
395 die "Unknown --confirm setting: '$confirm'\n"
396 unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
398 # Debugging, print out the suppressions.
400 print "suppressions:\n";
401 foreach my $entry (keys %suppress_cc) {
402 printf " %-5s -> $suppress_cc{$entry}\n", $entry;
406 my ($repoauthor, $repocommitter);
407 ($repoauthor) = Git
::ident_person
(@repo, 'author');
408 ($repocommitter) = Git
::ident_person
(@repo, 'committer');
410 # Verify the user input
412 foreach my $entry (@to) {
413 die "Comma in --to entry: $entry'\n" unless $entry !~ m/,/;
416 foreach my $entry (@initial_cc) {
417 die "Comma in --cc entry: $entry'\n" unless $entry !~ m/,/;
420 foreach my $entry (@bcclist) {
421 die "Comma in --bcclist entry: $entry'\n" unless $entry !~ m/,/;
424 sub parse_address_line
{
425 if ($have_mail_address) {
426 return map { $_->format } Mail
::Address
->parse($_[0]);
428 return split_addrs
($_[0]);
433 return quotewords
('\s*,\s*', 1, @_);
438 # multiline formats can be supported in the future
439 mutt
=> sub { my $fh = shift; while (<$fh>) {
440 if (/^\s*alias\s+(?:-group\s+\S+\s+)*(\S+)\s+(.*)$/) {
441 my ($alias, $addr) = ($1, $2);
442 $addr =~ s/#.*$//; # mutt allows # comments
443 # commas delimit multiple addresses
444 $aliases{$alias} = [ split_addrs
($addr) ];
446 mailrc
=> sub { my $fh = shift; while (<$fh>) {
447 if (/^alias\s+(\S+)\s+(.*)$/) {
448 # spaces delimit multiple addresses
449 $aliases{$1} = [ quotewords
('\s+', 0, $2) ];
451 pine
=> sub { my $fh = shift; my $f='\t[^\t]*';
452 for (my $x = ''; defined($x); $x = $_) {
454 $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
455 $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
456 $aliases{$1} = [ split_addrs
($2) ];
458 elm
=> sub { my $fh = shift;
460 if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
461 my ($alias, $addr) = ($1, $2);
462 $aliases{$alias} = [ split_addrs
($addr) ];
466 gnus
=> sub { my $fh = shift; while (<$fh>) {
467 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
468 $aliases{$1} = [ $2 ];
472 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
473 foreach my $file (@alias_files) {
474 open my $fh, '<', $file or die "opening $file: $!\n";
475 $parse_alias{$aliasfiletype}->($fh);
480 ($sender) = expand_aliases
($sender) if defined $sender;
482 # returns 1 if the conflict must be solved using it as a format-patch argument
483 sub check_file_rev_conflict
($) {
487 $repo->command('rev-parse', '--verify', '--quiet', $f);
488 if (defined($format_patch)) {
489 return $format_patch;
492 File '$f' exists but it could also be the range of commits
493 to produce patches for. Please disambiguate by...
495 * Saying "./$f" if you mean a file; or
496 * Giving --format-patch option if you mean a range.
498 } catch Git
::Error
::Command with
{
503 # Now that all the defaults are set, process the rest of the command line
504 # arguments and collect up the files that need to be processed.
506 while (defined(my $f = shift @ARGV)) {
508 push @rev_list_opts, "--", @ARGV;
510 } elsif (-d
$f and !check_file_rev_conflict
($f)) {
512 or die "Failed to opendir $f: $!";
514 push @files, grep { -f
$_ } map { +$f . "/" . $_ }
517 } elsif ((-f
$f or -p
$f) and !check_file_rev_conflict
($f)) {
520 push @rev_list_opts, $f;
524 if (@rev_list_opts) {
525 die "Cannot run git format-patch from outside a repository\n"
527 push @files, $repo->command('format-patch', '-o', tempdir
(CLEANUP
=> 1), @rev_list_opts);
531 foreach my $f (@files) {
533 my $error = validate_patch
($f);
534 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
541 print $_,"\n" for (@files);
544 print STDERR
"\nNo patch files specified!\n\n";
548 sub get_patch_subject
($) {
550 open (my $fh, '<', $fn);
551 while (my $line = <$fh>) {
552 next unless ($line =~ /^Subject: (.*)$/);
557 die "No subject line in $fn ?";
561 # Note that this does not need to be secure, but we will make a small
562 # effort to have it be unique
563 $compose_filename = ($repo ?
564 tempfile
(".gitsendemail.msg.XXXXXX", DIR
=> $repo->repo_path()) :
565 tempfile
(".gitsendemail.msg.XXXXXX", DIR
=> "."))[1];
566 open(C
,">",$compose_filename)
567 or die "Failed to open for writing $compose_filename: $!";
570 my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
571 my $tpl_subject = $initial_subject || '';
572 my $tpl_reply_to = $initial_reply_to || '';
575 From $tpl_sender # This line is ignored.
576 GIT: Lines beginning in "GIT:" will be removed.
577 GIT: Consider including an overall diffstat or table of contents
578 GIT: for the patch you are writing.
580 GIT: Clear the body content if you don't wish to send a summary.
582 Subject: $tpl_subject
583 In-Reply-To: $tpl_reply_to
587 print C get_patch_subject
($f);
592 do_edit
($compose_filename, @files);
594 do_edit
($compose_filename);
597 open(C2
,">",$compose_filename . ".final")
598 or die "Failed to open $compose_filename.final : " . $!;
600 open(C
,"<",$compose_filename)
601 or die "Failed to open $compose_filename : " . $!;
603 my $need_8bit_cte = file_has_nonascii
($compose_filename);
605 my $summary_empty = 1;
609 $summary_empty = 0 unless (/^\n$/);
612 if ($need_8bit_cte) {
613 print C2
"MIME-Version: 1.0\n",
614 "Content-Type: text/plain; ",
616 "Content-Transfer-Encoding: 8bit\n";
618 } elsif (/^MIME-Version:/i) {
620 } elsif (/^Subject:\s*(.+)\s*$/i) {
621 $initial_subject = $1;
622 my $subject = $initial_subject;
624 ($subject =~ /[^[:ascii:]]/ ?
625 quote_rfc2047
($subject) :
628 } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
629 $initial_reply_to = $1;
631 } elsif (/^From:\s*(.+)\s*$/i) {
634 } elsif (/^(?:To|Cc|Bcc):/i) {
635 print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
643 if ($summary_empty) {
644 print "Summary email is empty, skipping it\n";
647 } elsif ($annotate) {
652 my ($prompt, %arg) = @_;
653 my $valid_re = $arg{valid_re
};
654 my $default = $arg{default};
657 return defined $default ?
$default : undef
658 unless defined $term->IN and defined fileno($term->IN) and
659 defined $term->OUT and defined fileno($term->OUT);
661 $resp = $term->readline($prompt);
662 if (!defined $resp) { # EOF
664 return defined $default ?
$default : undef;
666 if ($resp eq '' and defined $default) {
669 if (!defined $valid_re or $resp =~ /$valid_re/) {
678 sub file_declares_8bit_cte
($) {
680 open (my $fh, '<', $fn);
681 while (my $line = <$fh>) {
682 last if ($line =~ /^$/);
683 return 1 if ($line =~ /^Content-Transfer-Encoding: .*8bit.*$/);
689 foreach my $f (@files) {
690 next unless (body_or_subject_has_nonascii
($f)
691 && !file_declares_8bit_cte
($f));
692 $broken_encoding{$f} = 1;
695 if (!defined $auto_8bit_encoding && scalar %broken_encoding) {
696 print "The following files are 8bit, but do not declare " .
697 "a Content-Transfer-Encoding.\n";
698 foreach my $f (sort keys %broken_encoding) {
701 $auto_8bit_encoding = ask
("Which 8bit encoding should I declare [UTF-8]? ",
706 if (!defined $sender) {
707 $sender = $repoauthor || $repocommitter || '';
708 $sender = ask
("Who should the emails appear to be from? [$sender] ",
710 print "Emails will be sent from: ", $sender, "\n";
715 my $to = ask
("Who should the emails be sent to? ");
716 push @to, parse_address_line
($to) if defined $to; # sanitized/validated later
721 return map { expand_one_alias
($_) } @_;
724 my %EXPANDED_ALIASES;
725 sub expand_one_alias
{
727 if ($EXPANDED_ALIASES{$alias}) {
728 die "fatal: alias '$alias' expands to itself\n";
730 local $EXPANDED_ALIASES{$alias} = 1;
731 return $aliases{$alias} ? expand_aliases
(@
{$aliases{$alias}}) : $alias;
734 @to = expand_aliases
(@to);
735 @to = (map { sanitize_address
($_) } @to);
736 @initial_cc = expand_aliases
(@initial_cc);
737 @bcclist = expand_aliases
(@bcclist);
739 if ($thread && !defined $initial_reply_to && $prompting) {
740 $initial_reply_to = ask
(
741 "Message-ID to be used as In-Reply-To for the first email? ");
743 if (defined $initial_reply_to) {
744 $initial_reply_to =~ s/^\s*<?//;
745 $initial_reply_to =~ s/>?\s*$//;
746 $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
749 if (!defined $smtp_server) {
750 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
756 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
759 if ($compose && $compose > 0) {
760 @files = ($compose_filename . ".final", @files);
763 # Variables we set as part of the loop over files
764 our ($message_id, %mail, $subject, $reply_to, $references, $message,
765 $needs_confirm, $message_num, $ask_default);
767 sub extract_valid_address
{
769 my $local_part_regexp = '[^<>"\s@]+';
770 my $domain_regexp = '[^.<>"\s@]+(?:\.[^.<>"\s@]+)+';
772 # check for a local address:
773 return $address if ($address =~ /^($local_part_regexp)$/);
775 $address =~ s/^\s*<(.*)>\s*$/$1/;
776 if ($have_email_valid) {
777 return scalar Email
::Valid
->address($address);
779 # less robust/correct than the monster regexp in Email::Valid,
780 # but still does a 99% job, and one less dependency
781 $address =~ /($local_part_regexp\@$domain_regexp)/;
786 # Usually don't need to change anything below here.
788 # we make a "fake" message id by taking the current number
789 # of seconds since the beginning of Unix time and tacking on
790 # a random number to the end, in case we are called quicker than
791 # 1 second since the last time we were called.
793 # We'll setup a template for the message id, using the "from" address:
795 my ($message_id_stamp, $message_id_serial);
796 sub make_message_id
{
798 if (!defined $message_id_stamp) {
799 $message_id_stamp = sprintf("%s-%s", time, $$);
800 $message_id_serial = 0;
802 $message_id_serial++;
803 $uniq = "$message_id_stamp-$message_id_serial";
806 for ($sender, $repocommitter, $repoauthor) {
807 $du_part = extract_valid_address
(sanitize_address
($_));
808 last if (defined $du_part and $du_part ne '');
810 if (not defined $du_part or $du_part eq '') {
811 use Sys
::Hostname
qw();
812 $du_part = 'user@' . Sys
::Hostname
::hostname
();
814 my $message_id_template = "<%s-git-send-email-%s>";
815 $message_id = sprintf($message_id_template, $uniq, $du_part);
816 #print "new message id = $message_id\n"; # Was useful for debugging
821 $time = time - scalar $#files;
823 sub unquote_rfc2047
{
826 if (s/=\?([^?]+)\?q\?(.*)\?=/$2/g) {
829 s/=([0-9A-F]{2})/chr(hex($1))/eg;
831 return wantarray ?
($_, $encoding) : $_;
836 my $encoding = shift || 'UTF-8';
837 s/([^-a-zA-Z0-9!*+\/])/sprintf
("=%02X", ord($1))/eg
;
838 s/(.*)/=\?$encoding\?q\?$1\?=/;
842 sub is_rfc2047_quoted
{
844 my $token = '[^][()<>@,;:"\/?.= \000-\037\177-\377]+';
845 my $encoded_text = '[!->@-~]+';
847 $s =~ m/^(?:"[[:ascii:]]*"|=\?$token\?$token\?$encoded_text\?=)$/o;
850 # use the simplest quoting being able to handle the recipient
851 sub sanitize_address
{
852 my ($recipient) = @_;
853 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
855 if (not $recipient_name) {
859 # if recipient_name is already quoted, do nothing
860 if (is_rfc2047_quoted
($recipient_name)) {
864 # rfc2047 is needed if a non-ascii char is included
865 if ($recipient_name =~ /[^[:ascii:]]/) {
866 $recipient_name =~ s/^"(.*)"$/$1/;
867 $recipient_name = quote_rfc2047
($recipient_name);
870 # double quotes are needed if specials or CTLs are included
871 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
872 $recipient_name =~ s/(["\\\r])/\\$1/g;
873 $recipient_name = "\"$recipient_name\"";
876 return "$recipient_name $recipient_addr";
880 # Returns the local Fully Qualified Domain Name (FQDN) if available.
882 # Tightly configured MTAa require that a caller sends a real DNS
883 # domain name that corresponds the IP address in the HELO/EHLO
884 # handshake. This is used to verify the connection and prevent
885 # spammers from trying to hide their identity. If the DNS and IP don't
886 # match, the receiveing MTA may deny the connection.
888 # Here is a deny example of Net::SMTP with the default "localhost.localdomain"
890 # Net::SMTP=GLOB(0x267ec28)>>> EHLO localhost.localdomain
891 # Net::SMTP=GLOB(0x267ec28)<<< 550 EHLO argument does not match calling host
893 # This maildomain*() code is based on ideas in Perl library Test::Reporter
894 # /usr/share/perl5/Test/Reporter/Mail/Util.pm ==> sub _maildomain ()
898 return defined $domain && !($^O
eq 'darwin' && $domain =~ /\.local$/) && $domain =~ /\./;
904 if (eval { require Net
::Domain
; 1 }) {
905 my $domain = Net
::Domain
::domainname
();
906 $maildomain = $domain if valid_fqdn
($domain);
915 if (eval { require Net
::SMTP
; 1 }) {
916 for my $host (qw(mailhost localhost)) {
917 my $smtp = Net
::SMTP
->new($host);
919 my $domain = $smtp->domain;
922 $maildomain = $domain if valid_fqdn
($domain);
933 return maildomain_net
() || maildomain_mta
() || 'localhost.localdomain';
936 # Returns 1 if the message was sent, and 0 otherwise.
937 # In actuality, the whole program dies when there
938 # is an error sending a message.
941 my @recipients = unique_email_list
(@to);
942 @cc = (grep { my $cc = extract_valid_address
($_);
943 not grep { $cc eq $_ } @recipients
945 map { sanitize_address
($_) }
947 my $to = join (",\n\t", @recipients);
948 @recipients = unique_email_list
(@recipients,@cc,@bcclist);
949 @recipients = (map { extract_valid_address
($_) } @recipients);
950 my $date = format_2822_time
($time++);
951 my $gitversion = '@@GIT_VERSION@@';
952 if ($gitversion =~ m/..GIT_VERSION../) {
953 $gitversion = Git
::version
();
956 my $cc = join(",\n\t", unique_email_list
(@cc));
959 $ccline = "\nCc: $cc";
961 my $sanitized_sender = sanitize_address
($sender);
962 make_message_id
() unless defined($message_id);
964 my $header = "From: $sanitized_sender
968 Message-Id: $message_id
969 X-Mailer: git-send-email $gitversion
973 $header .= "In-Reply-To: $reply_to\n";
974 $header .= "References: $references\n";
977 $header .= join("\n", @xh) . "\n";
980 my @sendmail_parameters = ('-i', @recipients);
981 my $raw_from = $sanitized_sender;
982 if (defined $envelope_sender && $envelope_sender ne "auto") {
983 $raw_from = $envelope_sender;
985 $raw_from = extract_valid_address
($raw_from);
986 unshift (@sendmail_parameters,
987 '-f', $raw_from) if(defined $envelope_sender);
989 if ($needs_confirm && !$dry_run) {
991 if ($needs_confirm eq "inform") {
992 $confirm_unconfigured = 0; # squelch this message for the rest of this run
993 $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
994 print " The Cc list above has been expanded by additional\n";
995 print " addresses found in the patch commit message. By default\n";
996 print " send-email prompts before sending whenever this occurs.\n";
997 print " This behavior is controlled by the sendemail.confirm\n";
998 print " configuration setting.\n";
1000 print " For additional information, run 'git send-email --help'.\n";
1001 print " To retain the current behavior, but squelch this message,\n";
1002 print " run 'git config --global sendemail.confirm auto'.\n\n";
1004 $_ = ask
("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
1005 valid_re
=> qr/^(?:yes|y|no|n|quit|q|all|a)/i,
1006 default => $ask_default);
1007 die "Send this email reply required" unless defined $_;
1011 cleanup_compose_files
();
1019 # We don't want to send the email.
1020 } elsif ($smtp_server =~ m
#^/# || $smtp_server =~ m#[a-zA-Z]\:#) {
1021 my $pid = open my $sm, '|-';
1022 defined $pid or die $!;
1024 exec($smtp_server, @sendmail_parameters) or die $!;
1026 print $sm "$header\n$message";
1027 close $sm or die $?
;
1030 if (!defined $smtp_server) {
1031 die "The required SMTP server is not properly defined."
1034 if ($smtp_encryption eq 'ssl') {
1035 $smtp_server_port ||= 465; # ssmtp
1036 require Net
::SMTP
::SSL
;
1037 $smtp_domain ||= maildomain
();
1038 $smtp ||= Net
::SMTP
::SSL
->new($smtp_server,
1039 Hello
=> $smtp_domain,
1040 Port
=> $smtp_server_port);
1044 $smtp_domain ||= maildomain
();
1045 $smtp ||= Net
::SMTP
->new((defined $smtp_server_port)
1046 ?
"$smtp_server:$smtp_server_port"
1048 Hello
=> $smtp_domain,
1049 Debug
=> $debug_net_smtp);
1050 if ($smtp_encryption eq 'tls' && $smtp) {
1051 require Net
::SMTP
::SSL
;
1052 $smtp->command('STARTTLS');
1054 if ($smtp->code == 220) {
1055 $smtp = Net
::SMTP
::SSL
->start_SSL($smtp)
1056 or die "STARTTLS failed! ".$smtp->message;
1057 $smtp_encryption = '';
1058 # Send EHLO again to receive fresh
1059 # supported commands
1062 die "Server does not support STARTTLS! ".$smtp->message;
1068 die "Unable to initialize SMTP properly. Check config and use --smtp-debug. ",
1069 "VALUES: server=$smtp_server ",
1070 "encryption=$smtp_encryption ",
1071 "hello=$smtp_domain",
1072 defined $smtp_server_port ?
"port=$smtp_server_port" : "";
1075 if (defined $smtp_authuser) {
1077 if (!defined $smtp_authpass) {
1079 system "stty -echo";
1085 } while (!defined $_);
1087 chomp($smtp_authpass = $_);
1092 $auth ||= $smtp->auth( $smtp_authuser, $smtp_authpass ) or die $smtp->message;
1095 $smtp->mail( $raw_from ) or die $smtp->message;
1096 $smtp->to( @recipients ) or die $smtp->message;
1097 $smtp->data or die $smtp->message;
1098 $smtp->datasend("$header\n$message") or die $smtp->message;
1099 $smtp->dataend() or die $smtp->message;
1100 $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
1103 printf (($dry_run ?
"Dry-" : "")."Sent %s\n", $subject);
1105 print (($dry_run ?
"Dry-" : "")."OK. Log says:\n");
1106 if ($smtp_server !~ m
#^/# && $smtp_server !~ m#[a-zA-Z]:#) {
1107 print "Server: $smtp_server\n";
1108 print "MAIL FROM:<$raw_from>\n";
1109 foreach my $entry (@recipients) {
1110 print "RCPT TO:<$entry>\n";
1113 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
1115 print $header, "\n";
1117 print "Result: ", $smtp->code, ' ',
1118 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
1120 print "Result: OK\n";
1127 $reply_to = $initial_reply_to;
1128 $references = $initial_reply_to || '';
1129 $subject = $initial_subject;
1132 foreach my $t (@files) {
1133 open(F
,"<",$t) or die "can't open file $t";
1136 my $author_encoding;
1137 my $has_content_type;
1141 my $input_format = undef;
1145 # First unfold multiline header fields
1148 if (/^\s+\S/ and @header) {
1149 chomp($header[$#header]);
1151 $header[$#header] .= $_;
1156 # Now parse the header
1159 $input_format = 'mbox';
1163 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1164 $input_format = 'mbox';
1167 if (defined $input_format && $input_format eq 'mbox') {
1168 if (/^Subject:\s+(.*)$/) {
1171 elsif (/^From:\s+(.*)$/) {
1172 ($author, $author_encoding) = unquote_rfc2047
($1);
1173 next if $suppress_cc{'author'};
1174 next if $suppress_cc{'self'} and $author eq $sender;
1175 printf("(mbox) Adding cc: %s from line '%s'\n",
1176 $1, $_) unless $quiet;
1179 elsif (/^Cc:\s+(.*)$/) {
1180 foreach my $addr (parse_address_line
($1)) {
1181 if (unquote_rfc2047
($addr) eq $sender) {
1182 next if ($suppress_cc{'self'});
1184 next if ($suppress_cc{'cc'});
1186 printf("(mbox) Adding cc: %s from line '%s'\n",
1187 $addr, $_) unless $quiet;
1191 elsif (/^Content-type:/i) {
1192 $has_content_type = 1;
1193 if (/charset="?([^ "]+)/) {
1194 $body_encoding = $1;
1198 elsif (/^Message-Id: (.*)/i) {
1201 elsif (!/^Date:\s/ && /^[-A-Za-z]+:\s+\S/) {
1206 # In the traditional
1207 # "send lots of email" format,
1210 # So let's support that, too.
1211 $input_format = 'lots';
1212 if (@cc == 0 && !$suppress_cc{'cc'}) {
1213 printf("(non-mbox) Adding cc: %s from line '%s'\n",
1214 $_, $_) unless $quiet;
1216 } elsif (!defined $subject) {
1221 # Now parse the message body
1224 if (/^(Signed-off-by|Cc): (.*)$/i) {
1226 my ($what, $c) = ($1, $2);
1228 if ($c eq $sender) {
1229 next if ($suppress_cc{'self'});
1231 next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1232 next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1235 printf("(body) Adding cc: %s from line '%s'\n",
1236 $c, $_) unless $quiet;
1241 if (defined $cc_cmd && !$suppress_cc{'cccmd'}) {
1242 open(F
, "$cc_cmd \Q$t\E |")
1243 or die "(cc-cmd) Could not execute '$cc_cmd'";
1248 next if ($c eq $sender and $suppress_from);
1250 printf("(cc-cmd) Adding cc: %s from: '%s'\n",
1251 $c, $cc_cmd) unless $quiet;
1254 or die "(cc-cmd) failed to close pipe to '$cc_cmd'";
1257 if ($broken_encoding{$t} && !$has_content_type) {
1258 $has_content_type = 1;
1259 push @xh, "MIME-Version: 1.0",
1260 "Content-Type: text/plain; charset=$auto_8bit_encoding",
1261 "Content-Transfer-Encoding: 8bit";
1262 $body_encoding = $auto_8bit_encoding;
1265 if ($broken_encoding{$t} && !is_rfc2047_quoted
($subject)) {
1266 $subject = quote_rfc2047
($subject, $auto_8bit_encoding);
1269 if (defined $author and $author ne $sender) {
1270 $message = "From: $author\n\n$message";
1271 if (defined $author_encoding) {
1272 if ($has_content_type) {
1273 if ($body_encoding eq $author_encoding) {
1274 # ok, we already have the right encoding
1277 # uh oh, we should re-encode
1281 $has_content_type = 1;
1283 'MIME-Version: 1.0',
1284 "Content-Type: text/plain; charset=$author_encoding",
1285 'Content-Transfer-Encoding: 8bit';
1291 $confirm eq "always" or
1292 ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1293 ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1294 $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1296 @cc = (@initial_cc, @cc);
1298 my $message_was_sent = send_message
();
1300 # set up for the next message
1301 if ($thread && $message_was_sent &&
1302 (chain_reply_to
() || !defined $reply_to || length($reply_to) == 0)) {
1303 $reply_to = $message_id;
1304 if (length $references > 0) {
1305 $references .= "\n $message_id";
1307 $references = "$message_id";
1310 $message_id = undef;
1313 cleanup_compose_files
();
1315 sub cleanup_compose_files
() {
1316 unlink($compose_filename, $compose_filename . ".final") if $compose;
1319 $smtp->quit if $smtp;
1321 sub unique_email_list
(@
) {
1325 foreach my $entry (@_) {
1326 if (my $clean = extract_valid_address
($entry)) {
1327 $seen{$clean} ||= 0;
1328 next if $seen{$clean}++;
1329 push @emails, $entry;
1331 print STDERR
"W: unable to extract a valid address",
1338 sub validate_patch
{
1340 open(my $fh, '<', $fn)
1341 or die "unable to open $fn: $!\n";
1342 while (my $line = <$fh>) {
1343 if (length($line) > 998) {
1344 return "$.: patch contains a line longer than 998 characters";
1350 sub file_has_nonascii
{
1352 open(my $fh, '<', $fn)
1353 or die "unable to open $fn: $!\n";
1354 while (my $line = <$fh>) {
1355 return 1 if $line =~ /[^[:ascii:]]/;
1360 sub body_or_subject_has_nonascii
{
1362 open(my $fh, '<', $fn)
1363 or die "unable to open $fn: $!\n";
1364 while (my $line = <$fh>) {
1365 last if $line =~ /^$/;
1366 return 1 if $line =~ /^Subject.*[^[:ascii:]]/;
1368 while (my $line = <$fh>) {
1369 return 1 if $line =~ /[^[:ascii:]]/;