Documentation/stash: remove mention of git reset --hard
[git.git] / git-send-email.perl
blobda81be40cb7f9af1a960be2c22f8e75c9d16822e
1 #!/usr/bin/perl
3 # Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com>
4 # Copyright 2005 Ryan Anderson <ryan@michonline.com>
6 # GPL v2 (See COPYING)
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.
19 use 5.008;
20 use strict;
21 use warnings;
22 use POSIX qw/strftime/;
23 use Term::ReadLine;
24 use Getopt::Long;
25 use Text::ParseWords;
26 use Term::ANSIColor;
27 use File::Temp qw/ tempdir tempfile /;
28 use File::Spec::Functions qw(catfile);
29 use Error qw(:try);
30 use Git;
32 Getopt::Long::Configure qw/ pass_through /;
34 package FakeTerm;
35 sub new {
36 my ($class, $reason) = @_;
37 return bless \$reason, shift;
39 sub readline {
40 my $self = shift;
41 die "Cannot use readline on FakeTerm: $$self";
43 package main;
46 sub usage {
47 print <<EOT;
48 git send-email [options] <file | directory | rev-list options >
49 git send-email --dump-aliases
51 Composing:
52 --from <str> * Email From:
53 --[no-]to <str> * Email To:
54 --[no-]cc <str> * Email Cc:
55 --[no-]bcc <str> * Email Bcc:
56 --subject <str> * Email "Subject:"
57 --in-reply-to <str> * Email "In-Reply-To:"
58 --[no-]xmailer * Add "X-Mailer:" header (default).
59 --[no-]annotate * Review each patch that will be sent in an editor.
60 --compose * Open an editor for introduction.
61 --compose-encoding <str> * Encoding to assume for introduction.
62 --8bit-encoding <str> * Encoding to assume 8bit mails if undeclared
63 --transfer-encoding <str> * Transfer encoding to use (quoted-printable, 8bit, base64)
65 Sending:
66 --envelope-sender <str> * Email envelope sender.
67 --smtp-server <str:int> * Outgoing SMTP server to use. The port
68 is optional. Default 'localhost'.
69 --smtp-server-option <str> * Outgoing SMTP server option to use.
70 --smtp-server-port <int> * Outgoing SMTP server port.
71 --smtp-user <str> * Username for SMTP-AUTH.
72 --smtp-pass <str> * Password for SMTP-AUTH; not necessary.
73 --smtp-encryption <str> * tls or ssl; anything else disables.
74 --smtp-ssl * Deprecated. Use '--smtp-encryption ssl'.
75 --smtp-ssl-cert-path <str> * Path to ca-certificates (either directory or file).
76 Pass an empty string to disable certificate
77 verification.
78 --smtp-domain <str> * The domain name sent to HELO/EHLO handshake
79 --smtp-auth <str> * Space-separated list of allowed AUTH mechanisms.
80 This setting forces to use one of the listed mechanisms.
81 --smtp-debug <0|1> * Disable, enable Net::SMTP debug.
83 Automating:
84 --identity <str> * Use the sendemail.<id> options.
85 --to-cmd <str> * Email To: via `<str> \$patch_path`
86 --cc-cmd <str> * Email Cc: via `<str> \$patch_path`
87 --suppress-cc <str> * author, self, sob, cc, cccmd, body, bodycc, all.
88 --[no-]cc-cover * Email Cc: addresses in the cover letter.
89 --[no-]to-cover * Email To: addresses in the cover letter.
90 --[no-]signed-off-by-cc * Send to Signed-off-by: addresses. Default on.
91 --[no-]suppress-from * Send to self. Default off.
92 --[no-]chain-reply-to * Chain In-Reply-To: fields. Default off.
93 --[no-]thread * Use In-Reply-To: field. Default on.
95 Administering:
96 --confirm <str> * Confirm recipients before sending;
97 auto, cc, compose, always, or never.
98 --quiet * Output one line of info per email.
99 --dry-run * Don't actually send the emails.
100 --[no-]validate * Perform patch sanity checks. Default on.
101 --[no-]format-patch * understand any non optional arguments as
102 `git format-patch` ones.
103 --force * Send even if safety checks would prevent it.
105 Information:
106 --dump-aliases * Dump configured aliases and exit.
109 exit(1);
112 # most mail servers generate the Date: header, but not all...
113 sub format_2822_time {
114 my ($time) = @_;
115 my @localtm = localtime($time);
116 my @gmttm = gmtime($time);
117 my $localmin = $localtm[1] + $localtm[2] * 60;
118 my $gmtmin = $gmttm[1] + $gmttm[2] * 60;
119 if ($localtm[0] != $gmttm[0]) {
120 die "local zone differs from GMT by a non-minute interval\n";
122 if ((($gmttm[6] + 1) % 7) == $localtm[6]) {
123 $localmin += 1440;
124 } elsif ((($gmttm[6] - 1) % 7) == $localtm[6]) {
125 $localmin -= 1440;
126 } elsif ($gmttm[6] != $localtm[6]) {
127 die "local time offset greater than or equal to 24 hours\n";
129 my $offset = $localmin - $gmtmin;
130 my $offhour = $offset / 60;
131 my $offmin = abs($offset % 60);
132 if (abs($offhour) >= 24) {
133 die ("local time offset greater than or equal to 24 hours\n");
136 return sprintf("%s, %2d %s %d %02d:%02d:%02d %s%02d%02d",
137 qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]],
138 $localtm[3],
139 qw(Jan Feb Mar Apr May Jun
140 Jul Aug Sep Oct Nov Dec)[$localtm[4]],
141 $localtm[5]+1900,
142 $localtm[2],
143 $localtm[1],
144 $localtm[0],
145 ($offset >= 0) ? '+' : '-',
146 abs($offhour),
147 $offmin,
151 my $have_email_valid = eval { require Email::Valid; 1 };
152 my $have_mail_address = eval { require Mail::Address; 1 };
153 my $smtp;
154 my $auth;
156 # Regexes for RFC 2047 productions.
157 my $re_token = qr/[^][()<>@,;:\\"\/?.= \000-\037\177-\377]+/;
158 my $re_encoded_text = qr/[^? \000-\037\177-\377]+/;
159 my $re_encoded_word = qr/=\?($re_token)\?($re_token)\?($re_encoded_text)\?=/;
161 # Variables we fill in automatically, or via prompting:
162 my (@to,$no_to,@initial_to,@cc,$no_cc,@initial_cc,@bcclist,$no_bcc,@xh,
163 $initial_reply_to,$initial_subject,@files,
164 $author,$sender,$smtp_authpass,$annotate,$use_xmailer,$compose,$time);
166 my $envelope_sender;
168 # Example reply to:
169 #$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>';
171 my $repo = eval { Git->repository() };
172 my @repo = $repo ? ($repo) : ();
173 my $term = eval {
174 $ENV{"GIT_SEND_EMAIL_NOTTY"}
175 ? new Term::ReadLine 'git-send-email', \*STDIN, \*STDOUT
176 : new Term::ReadLine 'git-send-email';
178 if ($@) {
179 $term = new FakeTerm "$@: going non-interactive";
182 # Behavior modification variables
183 my ($quiet, $dry_run) = (0, 0);
184 my $format_patch;
185 my $compose_filename;
186 my $force = 0;
187 my $dump_aliases = 0;
189 # Handle interactive edition of files.
190 my $multiedit;
191 my $editor;
193 sub do_edit {
194 if (!defined($editor)) {
195 $editor = Git::command_oneline('var', 'GIT_EDITOR');
197 if (defined($multiedit) && !$multiedit) {
198 map {
199 system('sh', '-c', $editor.' "$@"', $editor, $_);
200 if (($? & 127) || ($? >> 8)) {
201 die("the editor exited uncleanly, aborting everything");
203 } @_;
204 } else {
205 system('sh', '-c', $editor.' "$@"', $editor, @_);
206 if (($? & 127) || ($? >> 8)) {
207 die("the editor exited uncleanly, aborting everything");
212 # Variables with corresponding config settings
213 my ($thread, $chain_reply_to, $suppress_from, $signed_off_by_cc);
214 my ($cover_cc, $cover_to);
215 my ($to_cmd, $cc_cmd);
216 my ($smtp_server, $smtp_server_port, @smtp_server_options);
217 my ($smtp_authuser, $smtp_encryption, $smtp_ssl_cert_path);
218 my ($identity, $aliasfiletype, @alias_files, $smtp_domain, $smtp_auth);
219 my ($validate, $confirm);
220 my (@suppress_cc);
221 my ($auto_8bit_encoding);
222 my ($compose_encoding);
223 my ($target_xfer_encoding);
225 my ($debug_net_smtp) = 0; # Net::SMTP, see send_message()
227 my %config_bool_settings = (
228 "thread" => [\$thread, 1],
229 "chainreplyto" => [\$chain_reply_to, 0],
230 "suppressfrom" => [\$suppress_from, undef],
231 "signedoffbycc" => [\$signed_off_by_cc, undef],
232 "cccover" => [\$cover_cc, undef],
233 "tocover" => [\$cover_to, undef],
234 "signedoffcc" => [\$signed_off_by_cc, undef], # Deprecated
235 "validate" => [\$validate, 1],
236 "multiedit" => [\$multiedit, undef],
237 "annotate" => [\$annotate, undef],
238 "xmailer" => [\$use_xmailer, 1]
241 my %config_settings = (
242 "smtpserver" => \$smtp_server,
243 "smtpserverport" => \$smtp_server_port,
244 "smtpserveroption" => \@smtp_server_options,
245 "smtpuser" => \$smtp_authuser,
246 "smtppass" => \$smtp_authpass,
247 "smtpdomain" => \$smtp_domain,
248 "smtpauth" => \$smtp_auth,
249 "to" => \@initial_to,
250 "tocmd" => \$to_cmd,
251 "cc" => \@initial_cc,
252 "cccmd" => \$cc_cmd,
253 "aliasfiletype" => \$aliasfiletype,
254 "bcc" => \@bcclist,
255 "suppresscc" => \@suppress_cc,
256 "envelopesender" => \$envelope_sender,
257 "confirm" => \$confirm,
258 "from" => \$sender,
259 "assume8bitencoding" => \$auto_8bit_encoding,
260 "composeencoding" => \$compose_encoding,
261 "transferencoding" => \$target_xfer_encoding,
264 my %config_path_settings = (
265 "aliasesfile" => \@alias_files,
266 "smtpsslcertpath" => \$smtp_ssl_cert_path,
269 # Handle Uncouth Termination
270 sub signal_handler {
272 # Make text normal
273 print color("reset"), "\n";
275 # SMTP password masked
276 system "stty echo";
278 # tmp files from --compose
279 if (defined $compose_filename) {
280 if (-e $compose_filename) {
281 print "'$compose_filename' contains an intermediate version of the email you were composing.\n";
283 if (-e ($compose_filename . ".final")) {
284 print "'$compose_filename.final' contains the composed email.\n"
288 exit;
291 $SIG{TERM} = \&signal_handler;
292 $SIG{INT} = \&signal_handler;
294 # Begin by accumulating all the variables (defined above), that we will end up
295 # needing, first, from the command line:
297 my $help;
298 my $rc = GetOptions("h" => \$help,
299 "dump-aliases" => \$dump_aliases);
300 usage() unless $rc;
301 die "--dump-aliases incompatible with other options\n"
302 if !$help and $dump_aliases and @ARGV;
303 $rc = GetOptions(
304 "sender|from=s" => \$sender,
305 "in-reply-to=s" => \$initial_reply_to,
306 "subject=s" => \$initial_subject,
307 "to=s" => \@initial_to,
308 "to-cmd=s" => \$to_cmd,
309 "no-to" => \$no_to,
310 "cc=s" => \@initial_cc,
311 "no-cc" => \$no_cc,
312 "bcc=s" => \@bcclist,
313 "no-bcc" => \$no_bcc,
314 "chain-reply-to!" => \$chain_reply_to,
315 "no-chain-reply-to" => sub {$chain_reply_to = 0},
316 "smtp-server=s" => \$smtp_server,
317 "smtp-server-option=s" => \@smtp_server_options,
318 "smtp-server-port=s" => \$smtp_server_port,
319 "smtp-user=s" => \$smtp_authuser,
320 "smtp-pass:s" => \$smtp_authpass,
321 "smtp-ssl" => sub { $smtp_encryption = 'ssl' },
322 "smtp-encryption=s" => \$smtp_encryption,
323 "smtp-ssl-cert-path=s" => \$smtp_ssl_cert_path,
324 "smtp-debug:i" => \$debug_net_smtp,
325 "smtp-domain:s" => \$smtp_domain,
326 "smtp-auth=s" => \$smtp_auth,
327 "identity=s" => \$identity,
328 "annotate!" => \$annotate,
329 "no-annotate" => sub {$annotate = 0},
330 "compose" => \$compose,
331 "quiet" => \$quiet,
332 "cc-cmd=s" => \$cc_cmd,
333 "suppress-from!" => \$suppress_from,
334 "no-suppress-from" => sub {$suppress_from = 0},
335 "suppress-cc=s" => \@suppress_cc,
336 "signed-off-cc|signed-off-by-cc!" => \$signed_off_by_cc,
337 "no-signed-off-cc|no-signed-off-by-cc" => sub {$signed_off_by_cc = 0},
338 "cc-cover|cc-cover!" => \$cover_cc,
339 "no-cc-cover" => sub {$cover_cc = 0},
340 "to-cover|to-cover!" => \$cover_to,
341 "no-to-cover" => sub {$cover_to = 0},
342 "confirm=s" => \$confirm,
343 "dry-run" => \$dry_run,
344 "envelope-sender=s" => \$envelope_sender,
345 "thread!" => \$thread,
346 "no-thread" => sub {$thread = 0},
347 "validate!" => \$validate,
348 "no-validate" => sub {$validate = 0},
349 "transfer-encoding=s" => \$target_xfer_encoding,
350 "format-patch!" => \$format_patch,
351 "no-format-patch" => sub {$format_patch = 0},
352 "8bit-encoding=s" => \$auto_8bit_encoding,
353 "compose-encoding=s" => \$compose_encoding,
354 "force" => \$force,
355 "xmailer!" => \$use_xmailer,
356 "no-xmailer" => sub {$use_xmailer = 0},
359 usage() if $help;
360 unless ($rc) {
361 usage();
364 die "Cannot run git format-patch from outside a repository\n"
365 if $format_patch and not $repo;
367 # Now, let's fill any that aren't set in with defaults:
369 sub read_config {
370 my ($prefix) = @_;
372 foreach my $setting (keys %config_bool_settings) {
373 my $target = $config_bool_settings{$setting}->[0];
374 $$target = Git::config_bool(@repo, "$prefix.$setting") unless (defined $$target);
377 foreach my $setting (keys %config_path_settings) {
378 my $target = $config_path_settings{$setting};
379 if (ref($target) eq "ARRAY") {
380 unless (@$target) {
381 my @values = Git::config_path(@repo, "$prefix.$setting");
382 @$target = @values if (@values && defined $values[0]);
385 else {
386 $$target = Git::config_path(@repo, "$prefix.$setting") unless (defined $$target);
390 foreach my $setting (keys %config_settings) {
391 my $target = $config_settings{$setting};
392 next if $setting eq "to" and defined $no_to;
393 next if $setting eq "cc" and defined $no_cc;
394 next if $setting eq "bcc" and defined $no_bcc;
395 if (ref($target) eq "ARRAY") {
396 unless (@$target) {
397 my @values = Git::config(@repo, "$prefix.$setting");
398 @$target = @values if (@values && defined $values[0]);
401 else {
402 $$target = Git::config(@repo, "$prefix.$setting") unless (defined $$target);
406 if (!defined $smtp_encryption) {
407 my $enc = Git::config(@repo, "$prefix.smtpencryption");
408 if (defined $enc) {
409 $smtp_encryption = $enc;
410 } elsif (Git::config_bool(@repo, "$prefix.smtpssl")) {
411 $smtp_encryption = 'ssl';
416 # read configuration from [sendemail "$identity"], fall back on [sendemail]
417 $identity = Git::config(@repo, "sendemail.identity") unless (defined $identity);
418 read_config("sendemail.$identity") if (defined $identity);
419 read_config("sendemail");
421 # fall back on builtin bool defaults
422 foreach my $setting (values %config_bool_settings) {
423 ${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
426 # 'default' encryption is none -- this only prevents a warning
427 $smtp_encryption = '' unless (defined $smtp_encryption);
429 # Set CC suppressions
430 my(%suppress_cc);
431 if (@suppress_cc) {
432 foreach my $entry (@suppress_cc) {
433 die "Unknown --suppress-cc field: '$entry'\n"
434 unless $entry =~ /^(?:all|cccmd|cc|author|self|sob|body|bodycc)$/;
435 $suppress_cc{$entry} = 1;
439 if ($suppress_cc{'all'}) {
440 foreach my $entry (qw (cccmd cc author self sob body bodycc)) {
441 $suppress_cc{$entry} = 1;
443 delete $suppress_cc{'all'};
446 # If explicit old-style ones are specified, they trump --suppress-cc.
447 $suppress_cc{'self'} = $suppress_from if defined $suppress_from;
448 $suppress_cc{'sob'} = !$signed_off_by_cc if defined $signed_off_by_cc;
450 if ($suppress_cc{'body'}) {
451 foreach my $entry (qw (sob bodycc)) {
452 $suppress_cc{$entry} = 1;
454 delete $suppress_cc{'body'};
457 # Set confirm's default value
458 my $confirm_unconfigured = !defined $confirm;
459 if ($confirm_unconfigured) {
460 $confirm = scalar %suppress_cc ? 'compose' : 'auto';
462 die "Unknown --confirm setting: '$confirm'\n"
463 unless $confirm =~ /^(?:auto|cc|compose|always|never)/;
465 # Debugging, print out the suppressions.
466 if (0) {
467 print "suppressions:\n";
468 foreach my $entry (keys %suppress_cc) {
469 printf " %-5s -> $suppress_cc{$entry}\n", $entry;
473 my ($repoauthor, $repocommitter);
474 ($repoauthor) = Git::ident_person(@repo, 'author');
475 ($repocommitter) = Git::ident_person(@repo, 'committer');
477 sub parse_address_line {
478 if ($have_mail_address) {
479 return map { $_->format } Mail::Address->parse($_[0]);
480 } else {
481 return Git::parse_mailboxes($_[0]);
485 sub split_addrs {
486 return quotewords('\s*,\s*', 1, @_);
489 my %aliases;
491 sub parse_sendmail_alias {
492 local $_ = shift;
493 if (/"/) {
494 print STDERR "warning: sendmail alias with quotes is not supported: $_\n";
495 } elsif (/:include:/) {
496 print STDERR "warning: `:include:` not supported: $_\n";
497 } elsif (/[\/|]/) {
498 print STDERR "warning: `/file` or `|pipe` redirection not supported: $_\n";
499 } elsif (/^(\S+?)\s*:\s*(.+)$/) {
500 my ($alias, $addr) = ($1, $2);
501 $aliases{$alias} = [ split_addrs($addr) ];
502 } else {
503 print STDERR "warning: sendmail line is not recognized: $_\n";
507 sub parse_sendmail_aliases {
508 my $fh = shift;
509 my $s = '';
510 while (<$fh>) {
511 chomp;
512 next if /^\s*$/ || /^\s*#/;
513 $s .= $_, next if $s =~ s/\\$// || s/^\s+//;
514 parse_sendmail_alias($s) if $s;
515 $s = $_;
517 $s =~ s/\\$//; # silently tolerate stray '\' on last line
518 parse_sendmail_alias($s) if $s;
521 my %parse_alias = (
522 # multiline formats can be supported in the future
523 mutt => sub { my $fh = shift; while (<$fh>) {
524 if (/^\s*alias\s+(?:-group\s+\S+\s+)*(\S+)\s+(.*)$/) {
525 my ($alias, $addr) = ($1, $2);
526 $addr =~ s/#.*$//; # mutt allows # comments
527 # commas delimit multiple addresses
528 my @addr = split_addrs($addr);
530 # quotes may be escaped in the file,
531 # unescape them so we do not double-escape them later.
532 s/\\"/"/g foreach @addr;
533 $aliases{$alias} = \@addr
534 }}},
535 mailrc => sub { my $fh = shift; while (<$fh>) {
536 if (/^alias\s+(\S+)\s+(.*?)\s*$/) {
537 # spaces delimit multiple addresses
538 $aliases{$1} = [ quotewords('\s+', 0, $2) ];
539 }}},
540 pine => sub { my $fh = shift; my $f='\t[^\t]*';
541 for (my $x = ''; defined($x); $x = $_) {
542 chomp $x;
543 $x .= $1 while(defined($_ = <$fh>) && /^ +(.*)$/);
544 $x =~ /^(\S+)$f\t\(?([^\t]+?)\)?(:?$f){0,2}$/ or next;
545 $aliases{$1} = [ split_addrs($2) ];
547 elm => sub { my $fh = shift;
548 while (<$fh>) {
549 if (/^(\S+)\s+=\s+[^=]+=\s(\S+)/) {
550 my ($alias, $addr) = ($1, $2);
551 $aliases{$alias} = [ split_addrs($addr) ];
553 } },
554 sendmail => \&parse_sendmail_aliases,
555 gnus => sub { my $fh = shift; while (<$fh>) {
556 if (/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) {
557 $aliases{$1} = [ $2 ];
561 if (@alias_files and $aliasfiletype and defined $parse_alias{$aliasfiletype}) {
562 foreach my $file (@alias_files) {
563 open my $fh, '<', $file or die "opening $file: $!\n";
564 $parse_alias{$aliasfiletype}->($fh);
565 close $fh;
569 if ($dump_aliases) {
570 print "$_\n" for (sort keys %aliases);
571 exit(0);
574 # is_format_patch_arg($f) returns 0 if $f names a patch, or 1 if
575 # $f is a revision list specification to be passed to format-patch.
576 sub is_format_patch_arg {
577 return unless $repo;
578 my $f = shift;
579 try {
580 $repo->command('rev-parse', '--verify', '--quiet', $f);
581 if (defined($format_patch)) {
582 return $format_patch;
584 die(<<EOF);
585 File '$f' exists but it could also be the range of commits
586 to produce patches for. Please disambiguate by...
588 * Saying "./$f" if you mean a file; or
589 * Giving --format-patch option if you mean a range.
591 } catch Git::Error::Command with {
592 # Not a valid revision. Treat it as a filename.
593 return 0;
597 # Now that all the defaults are set, process the rest of the command line
598 # arguments and collect up the files that need to be processed.
599 my @rev_list_opts;
600 while (defined(my $f = shift @ARGV)) {
601 if ($f eq "--") {
602 push @rev_list_opts, "--", @ARGV;
603 @ARGV = ();
604 } elsif (-d $f and !is_format_patch_arg($f)) {
605 opendir my $dh, $f
606 or die "Failed to opendir $f: $!";
608 push @files, grep { -f $_ } map { catfile($f, $_) }
609 sort readdir $dh;
610 closedir $dh;
611 } elsif ((-f $f or -p $f) and !is_format_patch_arg($f)) {
612 push @files, $f;
613 } else {
614 push @rev_list_opts, $f;
618 if (@rev_list_opts) {
619 die "Cannot run git format-patch from outside a repository\n"
620 unless $repo;
621 push @files, $repo->command('format-patch', '-o', tempdir(CLEANUP => 1), @rev_list_opts);
624 @files = handle_backup_files(@files);
626 if ($validate) {
627 foreach my $f (@files) {
628 unless (-p $f) {
629 my $error = validate_patch($f);
630 $error and die "fatal: $f: $error\nwarning: no patches were sent\n";
635 if (@files) {
636 unless ($quiet) {
637 print $_,"\n" for (@files);
639 } else {
640 print STDERR "\nNo patch files specified!\n\n";
641 usage();
644 sub get_patch_subject {
645 my $fn = shift;
646 open (my $fh, '<', $fn);
647 while (my $line = <$fh>) {
648 next unless ($line =~ /^Subject: (.*)$/);
649 close $fh;
650 return "GIT: $1\n";
652 close $fh;
653 die "No subject line in $fn ?";
656 if ($compose) {
657 # Note that this does not need to be secure, but we will make a small
658 # effort to have it be unique
659 $compose_filename = ($repo ?
660 tempfile(".gitsendemail.msg.XXXXXX", DIR => $repo->repo_path()) :
661 tempfile(".gitsendemail.msg.XXXXXX", DIR => "."))[1];
662 open my $c, ">", $compose_filename
663 or die "Failed to open for writing $compose_filename: $!";
666 my $tpl_sender = $sender || $repoauthor || $repocommitter || '';
667 my $tpl_subject = $initial_subject || '';
668 my $tpl_reply_to = $initial_reply_to || '';
670 print $c <<EOT;
671 From $tpl_sender # This line is ignored.
672 GIT: Lines beginning in "GIT:" will be removed.
673 GIT: Consider including an overall diffstat or table of contents
674 GIT: for the patch you are writing.
675 GIT:
676 GIT: Clear the body content if you don't wish to send a summary.
677 From: $tpl_sender
678 Subject: $tpl_subject
679 In-Reply-To: $tpl_reply_to
682 for my $f (@files) {
683 print $c get_patch_subject($f);
685 close $c;
687 if ($annotate) {
688 do_edit($compose_filename, @files);
689 } else {
690 do_edit($compose_filename);
693 open my $c2, ">", $compose_filename . ".final"
694 or die "Failed to open $compose_filename.final : " . $!;
696 open $c, "<", $compose_filename
697 or die "Failed to open $compose_filename : " . $!;
699 my $need_8bit_cte = file_has_nonascii($compose_filename);
700 my $in_body = 0;
701 my $summary_empty = 1;
702 if (!defined $compose_encoding) {
703 $compose_encoding = "UTF-8";
705 while(<$c>) {
706 next if m/^GIT:/;
707 if ($in_body) {
708 $summary_empty = 0 unless (/^\n$/);
709 } elsif (/^\n$/) {
710 $in_body = 1;
711 if ($need_8bit_cte) {
712 print $c2 "MIME-Version: 1.0\n",
713 "Content-Type: text/plain; ",
714 "charset=$compose_encoding\n",
715 "Content-Transfer-Encoding: 8bit\n";
717 } elsif (/^MIME-Version:/i) {
718 $need_8bit_cte = 0;
719 } elsif (/^Subject:\s*(.+)\s*$/i) {
720 $initial_subject = $1;
721 my $subject = $initial_subject;
722 $_ = "Subject: " .
723 quote_subject($subject, $compose_encoding) .
724 "\n";
725 } elsif (/^In-Reply-To:\s*(.+)\s*$/i) {
726 $initial_reply_to = $1;
727 next;
728 } elsif (/^From:\s*(.+)\s*$/i) {
729 $sender = $1;
730 next;
731 } elsif (/^(?:To|Cc|Bcc):/i) {
732 print "To/Cc/Bcc fields are not interpreted yet, they have been ignored\n";
733 next;
735 print $c2 $_;
737 close $c;
738 close $c2;
740 if ($summary_empty) {
741 print "Summary email is empty, skipping it\n";
742 $compose = -1;
744 } elsif ($annotate) {
745 do_edit(@files);
748 sub ask {
749 my ($prompt, %arg) = @_;
750 my $valid_re = $arg{valid_re};
751 my $default = $arg{default};
752 my $confirm_only = $arg{confirm_only};
753 my $resp;
754 my $i = 0;
755 return defined $default ? $default : undef
756 unless defined $term->IN and defined fileno($term->IN) and
757 defined $term->OUT and defined fileno($term->OUT);
758 while ($i++ < 10) {
759 $resp = $term->readline($prompt);
760 if (!defined $resp) { # EOF
761 print "\n";
762 return defined $default ? $default : undef;
764 if ($resp eq '' and defined $default) {
765 return $default;
767 if (!defined $valid_re or $resp =~ /$valid_re/) {
768 return $resp;
770 if ($confirm_only) {
771 my $yesno = $term->readline("Are you sure you want to use <$resp> [y/N]? ");
772 if (defined $yesno && $yesno =~ /y/i) {
773 return $resp;
777 return;
780 my %broken_encoding;
782 sub file_declares_8bit_cte {
783 my $fn = shift;
784 open (my $fh, '<', $fn);
785 while (my $line = <$fh>) {
786 last if ($line =~ /^$/);
787 return 1 if ($line =~ /^Content-Transfer-Encoding: .*8bit.*$/);
789 close $fh;
790 return 0;
793 foreach my $f (@files) {
794 next unless (body_or_subject_has_nonascii($f)
795 && !file_declares_8bit_cte($f));
796 $broken_encoding{$f} = 1;
799 if (!defined $auto_8bit_encoding && scalar %broken_encoding) {
800 print "The following files are 8bit, but do not declare " .
801 "a Content-Transfer-Encoding.\n";
802 foreach my $f (sort keys %broken_encoding) {
803 print " $f\n";
805 $auto_8bit_encoding = ask("Which 8bit encoding should I declare [UTF-8]? ",
806 valid_re => qr/.{4}/, confirm_only => 1,
807 default => "UTF-8");
810 if (!$force) {
811 for my $f (@files) {
812 if (get_patch_subject($f) =~ /\Q*** SUBJECT HERE ***\E/) {
813 die "Refusing to send because the patch\n\t$f\n"
814 . "has the template subject '*** SUBJECT HERE ***'. "
815 . "Pass --force if you really want to send.\n";
820 if (defined $sender) {
821 $sender =~ s/^\s+|\s+$//g;
822 ($sender) = expand_aliases($sender);
823 } else {
824 $sender = $repoauthor || $repocommitter || '';
827 # $sender could be an already sanitized address
828 # (e.g. sendemail.from could be manually sanitized by user).
829 # But it's a no-op to run sanitize_address on an already sanitized address.
830 $sender = sanitize_address($sender);
832 my $to_whom = "To whom should the emails be sent (if anyone)?";
833 my $prompting = 0;
834 if (!@initial_to && !defined $to_cmd) {
835 my $to = ask("$to_whom ",
836 default => "",
837 valid_re => qr/\@.*\./, confirm_only => 1);
838 push @initial_to, parse_address_line($to) if defined $to; # sanitized/validated later
839 $prompting++;
842 sub expand_aliases {
843 return map { expand_one_alias($_) } @_;
846 my %EXPANDED_ALIASES;
847 sub expand_one_alias {
848 my $alias = shift;
849 if ($EXPANDED_ALIASES{$alias}) {
850 die "fatal: alias '$alias' expands to itself\n";
852 local $EXPANDED_ALIASES{$alias} = 1;
853 return $aliases{$alias} ? expand_aliases(@{$aliases{$alias}}) : $alias;
856 @initial_to = process_address_list(@initial_to);
857 @initial_cc = process_address_list(@initial_cc);
858 @bcclist = process_address_list(@bcclist);
860 if ($thread && !defined $initial_reply_to && $prompting) {
861 $initial_reply_to = ask(
862 "Message-ID to be used as In-Reply-To for the first email (if any)? ",
863 default => "",
864 valid_re => qr/\@.*\./, confirm_only => 1);
866 if (defined $initial_reply_to) {
867 $initial_reply_to =~ s/^\s*<?//;
868 $initial_reply_to =~ s/>?\s*$//;
869 $initial_reply_to = "<$initial_reply_to>" if $initial_reply_to ne '';
872 if (!defined $smtp_server) {
873 foreach (qw( /usr/sbin/sendmail /usr/lib/sendmail )) {
874 if (-x $_) {
875 $smtp_server = $_;
876 last;
879 $smtp_server ||= 'localhost'; # could be 127.0.0.1, too... *shrug*
882 if ($compose && $compose > 0) {
883 @files = ($compose_filename . ".final", @files);
886 # Variables we set as part of the loop over files
887 our ($message_id, %mail, $subject, $reply_to, $references, $message,
888 $needs_confirm, $message_num, $ask_default);
890 sub extract_valid_address {
891 my $address = shift;
892 my $local_part_regexp = qr/[^<>"\s@]+/;
893 my $domain_regexp = qr/[^.<>"\s@]+(?:\.[^.<>"\s@]+)+/;
895 # check for a local address:
896 return $address if ($address =~ /^($local_part_regexp)$/);
898 $address =~ s/^\s*<(.*)>\s*$/$1/;
899 if ($have_email_valid) {
900 return scalar Email::Valid->address($address);
903 # less robust/correct than the monster regexp in Email::Valid,
904 # but still does a 99% job, and one less dependency
905 return $1 if $address =~ /($local_part_regexp\@$domain_regexp)/;
906 return;
909 sub extract_valid_address_or_die {
910 my $address = shift;
911 $address = extract_valid_address($address);
912 die "error: unable to extract a valid address from: $address\n"
913 if !$address;
914 return $address;
917 sub validate_address {
918 my $address = shift;
919 while (!extract_valid_address($address)) {
920 print STDERR "error: unable to extract a valid address from: $address\n";
921 $_ = ask("What to do with this address? ([q]uit|[d]rop|[e]dit): ",
922 valid_re => qr/^(?:quit|q|drop|d|edit|e)/i,
923 default => 'q');
924 if (/^d/i) {
925 return undef;
926 } elsif (/^q/i) {
927 cleanup_compose_files();
928 exit(0);
930 $address = ask("$to_whom ",
931 default => "",
932 valid_re => qr/\@.*\./, confirm_only => 1);
934 return $address;
937 sub validate_address_list {
938 return (grep { defined $_ }
939 map { validate_address($_) } @_);
942 # Usually don't need to change anything below here.
944 # we make a "fake" message id by taking the current number
945 # of seconds since the beginning of Unix time and tacking on
946 # a random number to the end, in case we are called quicker than
947 # 1 second since the last time we were called.
949 # We'll setup a template for the message id, using the "from" address:
951 my ($message_id_stamp, $message_id_serial);
952 sub make_message_id {
953 my $uniq;
954 if (!defined $message_id_stamp) {
955 $message_id_stamp = strftime("%Y%m%d%H%M%S.$$", gmtime(time));
956 $message_id_serial = 0;
958 $message_id_serial++;
959 $uniq = "$message_id_stamp-$message_id_serial";
961 my $du_part;
962 for ($sender, $repocommitter, $repoauthor) {
963 $du_part = extract_valid_address(sanitize_address($_));
964 last if (defined $du_part and $du_part ne '');
966 if (not defined $du_part or $du_part eq '') {
967 require Sys::Hostname;
968 $du_part = 'user@' . Sys::Hostname::hostname();
970 my $message_id_template = "<%s-%s>";
971 $message_id = sprintf($message_id_template, $uniq, $du_part);
972 #print "new message id = $message_id\n"; # Was useful for debugging
977 $time = time - scalar $#files;
979 sub unquote_rfc2047 {
980 local ($_) = @_;
981 my $charset;
982 my $sep = qr/[ \t]+/;
983 s{$re_encoded_word(?:$sep$re_encoded_word)*}{
984 my @words = split $sep, $&;
985 foreach (@words) {
986 m/$re_encoded_word/;
987 $charset = $1;
988 my $encoding = $2;
989 my $text = $3;
990 if ($encoding eq 'q' || $encoding eq 'Q') {
991 $_ = $text;
992 s/_/ /g;
993 s/=([0-9A-F]{2})/chr(hex($1))/egi;
994 } else {
995 # other encodings not supported yet
998 join '', @words;
999 }eg;
1000 return wantarray ? ($_, $charset) : $_;
1003 sub quote_rfc2047 {
1004 local $_ = shift;
1005 my $encoding = shift || 'UTF-8';
1006 s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X", ord($1))/eg;
1007 s/(.*)/=\?$encoding\?q\?$1\?=/;
1008 return $_;
1011 sub is_rfc2047_quoted {
1012 my $s = shift;
1013 length($s) <= 75 &&
1014 $s =~ m/^(?:"[[:ascii:]]*"|$re_encoded_word)$/o;
1017 sub subject_needs_rfc2047_quoting {
1018 my $s = shift;
1020 return ($s =~ /[^[:ascii:]]/) || ($s =~ /=\?/);
1023 sub quote_subject {
1024 local $subject = shift;
1025 my $encoding = shift || 'UTF-8';
1027 if (subject_needs_rfc2047_quoting($subject)) {
1028 return quote_rfc2047($subject, $encoding);
1030 return $subject;
1033 # use the simplest quoting being able to handle the recipient
1034 sub sanitize_address {
1035 my ($recipient) = @_;
1037 # remove garbage after email address
1038 $recipient =~ s/(.*>).*$/$1/;
1040 my ($recipient_name, $recipient_addr) = ($recipient =~ /^(.*?)\s*(<.*)/);
1042 if (not $recipient_name) {
1043 return $recipient;
1046 # if recipient_name is already quoted, do nothing
1047 if (is_rfc2047_quoted($recipient_name)) {
1048 return $recipient;
1051 # remove non-escaped quotes
1052 $recipient_name =~ s/(^|[^\\])"/$1/g;
1054 # rfc2047 is needed if a non-ascii char is included
1055 if ($recipient_name =~ /[^[:ascii:]]/) {
1056 $recipient_name = quote_rfc2047($recipient_name);
1059 # double quotes are needed if specials or CTLs are included
1060 elsif ($recipient_name =~ /[][()<>@,;:\\".\000-\037\177]/) {
1061 $recipient_name =~ s/([\\\r])/\\$1/g;
1062 $recipient_name = qq["$recipient_name"];
1065 return "$recipient_name $recipient_addr";
1069 sub sanitize_address_list {
1070 return (map { sanitize_address($_) } @_);
1073 sub process_address_list {
1074 my @addr_list = map { parse_address_line($_) } @_;
1075 @addr_list = expand_aliases(@addr_list);
1076 @addr_list = sanitize_address_list(@addr_list);
1077 @addr_list = validate_address_list(@addr_list);
1078 return @addr_list;
1081 # Returns the local Fully Qualified Domain Name (FQDN) if available.
1083 # Tightly configured MTAa require that a caller sends a real DNS
1084 # domain name that corresponds the IP address in the HELO/EHLO
1085 # handshake. This is used to verify the connection and prevent
1086 # spammers from trying to hide their identity. If the DNS and IP don't
1087 # match, the receiveing MTA may deny the connection.
1089 # Here is a deny example of Net::SMTP with the default "localhost.localdomain"
1091 # Net::SMTP=GLOB(0x267ec28)>>> EHLO localhost.localdomain
1092 # Net::SMTP=GLOB(0x267ec28)<<< 550 EHLO argument does not match calling host
1094 # This maildomain*() code is based on ideas in Perl library Test::Reporter
1095 # /usr/share/perl5/Test/Reporter/Mail/Util.pm ==> sub _maildomain ()
1097 sub valid_fqdn {
1098 my $domain = shift;
1099 return defined $domain && !($^O eq 'darwin' && $domain =~ /\.local$/) && $domain =~ /\./;
1102 sub maildomain_net {
1103 my $maildomain;
1105 if (eval { require Net::Domain; 1 }) {
1106 my $domain = Net::Domain::domainname();
1107 $maildomain = $domain if valid_fqdn($domain);
1110 return $maildomain;
1113 sub maildomain_mta {
1114 my $maildomain;
1116 if (eval { require Net::SMTP; 1 }) {
1117 for my $host (qw(mailhost localhost)) {
1118 my $smtp = Net::SMTP->new($host);
1119 if (defined $smtp) {
1120 my $domain = $smtp->domain;
1121 $smtp->quit;
1123 $maildomain = $domain if valid_fqdn($domain);
1125 last if $maildomain;
1130 return $maildomain;
1133 sub maildomain {
1134 return maildomain_net() || maildomain_mta() || 'localhost.localdomain';
1137 sub smtp_host_string {
1138 if (defined $smtp_server_port) {
1139 return "$smtp_server:$smtp_server_port";
1140 } else {
1141 return $smtp_server;
1145 # Returns 1 if authentication succeeded or was not necessary
1146 # (smtp_user was not specified), and 0 otherwise.
1148 sub smtp_auth_maybe {
1149 if (!defined $smtp_authuser || $auth) {
1150 return 1;
1153 # Workaround AUTH PLAIN/LOGIN interaction defect
1154 # with Authen::SASL::Cyrus
1155 eval {
1156 require Authen::SASL;
1157 Authen::SASL->import(qw(Perl));
1160 # Check mechanism naming as defined in:
1161 # https://tools.ietf.org/html/rfc4422#page-8
1162 if ($smtp_auth && $smtp_auth !~ /^(\b[A-Z0-9-_]{1,20}\s*)*$/) {
1163 die "invalid smtp auth: '${smtp_auth}'";
1166 # TODO: Authentication may fail not because credentials were
1167 # invalid but due to other reasons, in which we should not
1168 # reject credentials.
1169 $auth = Git::credential({
1170 'protocol' => 'smtp',
1171 'host' => smtp_host_string(),
1172 'username' => $smtp_authuser,
1173 # if there's no password, "git credential fill" will
1174 # give us one, otherwise it'll just pass this one.
1175 'password' => $smtp_authpass
1176 }, sub {
1177 my $cred = shift;
1179 if ($smtp_auth) {
1180 my $sasl = Authen::SASL->new(
1181 mechanism => $smtp_auth,
1182 callback => {
1183 user => $cred->{'username'},
1184 pass => $cred->{'password'},
1185 authname => $cred->{'username'},
1189 return !!$smtp->auth($sasl);
1192 return !!$smtp->auth($cred->{'username'}, $cred->{'password'});
1195 return $auth;
1198 sub ssl_verify_params {
1199 eval {
1200 require IO::Socket::SSL;
1201 IO::Socket::SSL->import(qw/SSL_VERIFY_PEER SSL_VERIFY_NONE/);
1203 if ($@) {
1204 print STDERR "Not using SSL_VERIFY_PEER due to out-of-date IO::Socket::SSL.\n";
1205 return;
1208 if (!defined $smtp_ssl_cert_path) {
1209 # use the OpenSSL defaults
1210 return (SSL_verify_mode => SSL_VERIFY_PEER());
1213 if ($smtp_ssl_cert_path eq "") {
1214 return (SSL_verify_mode => SSL_VERIFY_NONE());
1215 } elsif (-d $smtp_ssl_cert_path) {
1216 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1217 SSL_ca_path => $smtp_ssl_cert_path);
1218 } elsif (-f $smtp_ssl_cert_path) {
1219 return (SSL_verify_mode => SSL_VERIFY_PEER(),
1220 SSL_ca_file => $smtp_ssl_cert_path);
1221 } else {
1222 die "CA path \"$smtp_ssl_cert_path\" does not exist";
1226 sub file_name_is_absolute {
1227 my ($path) = @_;
1229 # msys does not grok DOS drive-prefixes
1230 if ($^O eq 'msys') {
1231 return ($path =~ m#^/# || $path =~ m#^[a-zA-Z]\:#)
1234 require File::Spec::Functions;
1235 return File::Spec::Functions::file_name_is_absolute($path);
1238 # Returns 1 if the message was sent, and 0 otherwise.
1239 # In actuality, the whole program dies when there
1240 # is an error sending a message.
1242 sub send_message {
1243 my @recipients = unique_email_list(@to);
1244 @cc = (grep { my $cc = extract_valid_address_or_die($_);
1245 not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients
1247 @cc);
1248 my $to = join (",\n\t", @recipients);
1249 @recipients = unique_email_list(@recipients,@cc,@bcclist);
1250 @recipients = (map { extract_valid_address_or_die($_) } @recipients);
1251 my $date = format_2822_time($time++);
1252 my $gitversion = '@@GIT_VERSION@@';
1253 if ($gitversion =~ m/..GIT_VERSION../) {
1254 $gitversion = Git::version();
1257 my $cc = join(",\n\t", unique_email_list(@cc));
1258 my $ccline = "";
1259 if ($cc ne '') {
1260 $ccline = "\nCc: $cc";
1262 make_message_id() unless defined($message_id);
1264 my $header = "From: $sender
1265 To: $to${ccline}
1266 Subject: $subject
1267 Date: $date
1268 Message-Id: $message_id
1270 if ($use_xmailer) {
1271 $header .= "X-Mailer: git-send-email $gitversion\n";
1273 if ($reply_to) {
1275 $header .= "In-Reply-To: $reply_to\n";
1276 $header .= "References: $references\n";
1278 if (@xh) {
1279 $header .= join("\n", @xh) . "\n";
1282 my @sendmail_parameters = ('-i', @recipients);
1283 my $raw_from = $sender;
1284 if (defined $envelope_sender && $envelope_sender ne "auto") {
1285 $raw_from = $envelope_sender;
1287 $raw_from = extract_valid_address($raw_from);
1288 unshift (@sendmail_parameters,
1289 '-f', $raw_from) if(defined $envelope_sender);
1291 if ($needs_confirm && !$dry_run) {
1292 print "\n$header\n";
1293 if ($needs_confirm eq "inform") {
1294 $confirm_unconfigured = 0; # squelch this message for the rest of this run
1295 $ask_default = "y"; # assume yes on EOF since user hasn't explicitly asked for confirmation
1296 print " The Cc list above has been expanded by additional\n";
1297 print " addresses found in the patch commit message. By default\n";
1298 print " send-email prompts before sending whenever this occurs.\n";
1299 print " This behavior is controlled by the sendemail.confirm\n";
1300 print " configuration setting.\n";
1301 print "\n";
1302 print " For additional information, run 'git send-email --help'.\n";
1303 print " To retain the current behavior, but squelch this message,\n";
1304 print " run 'git config --global sendemail.confirm auto'.\n\n";
1306 $_ = ask("Send this email? ([y]es|[n]o|[q]uit|[a]ll): ",
1307 valid_re => qr/^(?:yes|y|no|n|quit|q|all|a)/i,
1308 default => $ask_default);
1309 die "Send this email reply required" unless defined $_;
1310 if (/^n/i) {
1311 return 0;
1312 } elsif (/^q/i) {
1313 cleanup_compose_files();
1314 exit(0);
1315 } elsif (/^a/i) {
1316 $confirm = 'never';
1320 unshift (@sendmail_parameters, @smtp_server_options);
1322 if ($dry_run) {
1323 # We don't want to send the email.
1324 } elsif (file_name_is_absolute($smtp_server)) {
1325 my $pid = open my $sm, '|-';
1326 defined $pid or die $!;
1327 if (!$pid) {
1328 exec($smtp_server, @sendmail_parameters) or die $!;
1330 print $sm "$header\n$message";
1331 close $sm or die $!;
1332 } else {
1334 if (!defined $smtp_server) {
1335 die "The required SMTP server is not properly defined."
1338 if ($smtp_encryption eq 'ssl') {
1339 $smtp_server_port ||= 465; # ssmtp
1340 require Net::SMTP::SSL;
1341 $smtp_domain ||= maildomain();
1342 require IO::Socket::SSL;
1344 # Suppress "variable accessed once" warning.
1346 no warnings 'once';
1347 $IO::Socket::SSL::DEBUG = 1;
1350 # Net::SMTP::SSL->new() does not forward any SSL options
1351 IO::Socket::SSL::set_client_defaults(
1352 ssl_verify_params());
1353 $smtp ||= Net::SMTP::SSL->new($smtp_server,
1354 Hello => $smtp_domain,
1355 Port => $smtp_server_port,
1356 Debug => $debug_net_smtp);
1358 else {
1359 require Net::SMTP;
1360 $smtp_domain ||= maildomain();
1361 $smtp_server_port ||= 25;
1362 $smtp ||= Net::SMTP->new($smtp_server,
1363 Hello => $smtp_domain,
1364 Debug => $debug_net_smtp,
1365 Port => $smtp_server_port);
1366 if ($smtp_encryption eq 'tls' && $smtp) {
1367 require Net::SMTP::SSL;
1368 $smtp->command('STARTTLS');
1369 $smtp->response();
1370 if ($smtp->code == 220) {
1371 $smtp = Net::SMTP::SSL->start_SSL($smtp,
1372 ssl_verify_params())
1373 or die "STARTTLS failed! ".IO::Socket::SSL::errstr();
1374 $smtp_encryption = '';
1375 # Send EHLO again to receive fresh
1376 # supported commands
1377 $smtp->hello($smtp_domain);
1378 } else {
1379 die "Server does not support STARTTLS! ".$smtp->message;
1384 if (!$smtp) {
1385 die "Unable to initialize SMTP properly. Check config and use --smtp-debug. ",
1386 "VALUES: server=$smtp_server ",
1387 "encryption=$smtp_encryption ",
1388 "hello=$smtp_domain",
1389 defined $smtp_server_port ? " port=$smtp_server_port" : "";
1392 smtp_auth_maybe or die $smtp->message;
1394 $smtp->mail( $raw_from ) or die $smtp->message;
1395 $smtp->to( @recipients ) or die $smtp->message;
1396 $smtp->data or die $smtp->message;
1397 $smtp->datasend("$header\n") or die $smtp->message;
1398 my @lines = split /^/, $message;
1399 foreach my $line (@lines) {
1400 $smtp->datasend("$line") or die $smtp->message;
1402 $smtp->dataend() or die $smtp->message;
1403 $smtp->code =~ /250|200/ or die "Failed to send $subject\n".$smtp->message;
1405 if ($quiet) {
1406 printf (($dry_run ? "Dry-" : "")."Sent %s\n", $subject);
1407 } else {
1408 print (($dry_run ? "Dry-" : "")."OK. Log says:\n");
1409 if (!file_name_is_absolute($smtp_server)) {
1410 print "Server: $smtp_server\n";
1411 print "MAIL FROM:<$raw_from>\n";
1412 foreach my $entry (@recipients) {
1413 print "RCPT TO:<$entry>\n";
1415 } else {
1416 print "Sendmail: $smtp_server ".join(' ',@sendmail_parameters)."\n";
1418 print $header, "\n";
1419 if ($smtp) {
1420 print "Result: ", $smtp->code, ' ',
1421 ($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
1422 } else {
1423 print "Result: OK\n";
1427 return 1;
1430 $reply_to = $initial_reply_to;
1431 $references = $initial_reply_to || '';
1432 $subject = $initial_subject;
1433 $message_num = 0;
1435 foreach my $t (@files) {
1436 open my $fh, "<", $t or die "can't open file $t";
1438 my $author = undef;
1439 my $sauthor = undef;
1440 my $author_encoding;
1441 my $has_content_type;
1442 my $body_encoding;
1443 my $xfer_encoding;
1444 my $has_mime_version;
1445 @to = ();
1446 @cc = ();
1447 @xh = ();
1448 my $input_format = undef;
1449 my @header = ();
1450 $message = "";
1451 $message_num++;
1452 # First unfold multiline header fields
1453 while(<$fh>) {
1454 last if /^\s*$/;
1455 if (/^\s+\S/ and @header) {
1456 chomp($header[$#header]);
1457 s/^\s+/ /;
1458 $header[$#header] .= $_;
1459 } else {
1460 push(@header, $_);
1463 # Now parse the header
1464 foreach(@header) {
1465 if (/^From /) {
1466 $input_format = 'mbox';
1467 next;
1469 chomp;
1470 if (!defined $input_format && /^[-A-Za-z]+:\s/) {
1471 $input_format = 'mbox';
1474 if (defined $input_format && $input_format eq 'mbox') {
1475 if (/^Subject:\s+(.*)$/i) {
1476 $subject = $1;
1478 elsif (/^From:\s+(.*)$/i) {
1479 ($author, $author_encoding) = unquote_rfc2047($1);
1480 $sauthor = sanitize_address($author);
1481 next if $suppress_cc{'author'};
1482 next if $suppress_cc{'self'} and $sauthor eq $sender;
1483 printf("(mbox) Adding cc: %s from line '%s'\n",
1484 $1, $_) unless $quiet;
1485 push @cc, $1;
1487 elsif (/^To:\s+(.*)$/i) {
1488 foreach my $addr (parse_address_line($1)) {
1489 printf("(mbox) Adding to: %s from line '%s'\n",
1490 $addr, $_) unless $quiet;
1491 push @to, $addr;
1494 elsif (/^Cc:\s+(.*)$/i) {
1495 foreach my $addr (parse_address_line($1)) {
1496 my $qaddr = unquote_rfc2047($addr);
1497 my $saddr = sanitize_address($qaddr);
1498 if ($saddr eq $sender) {
1499 next if ($suppress_cc{'self'});
1500 } else {
1501 next if ($suppress_cc{'cc'});
1503 printf("(mbox) Adding cc: %s from line '%s'\n",
1504 $addr, $_) unless $quiet;
1505 push @cc, $addr;
1508 elsif (/^Content-type:/i) {
1509 $has_content_type = 1;
1510 if (/charset="?([^ "]+)/) {
1511 $body_encoding = $1;
1513 push @xh, $_;
1515 elsif (/^MIME-Version/i) {
1516 $has_mime_version = 1;
1517 push @xh, $_;
1519 elsif (/^Message-Id: (.*)/i) {
1520 $message_id = $1;
1522 elsif (/^Content-Transfer-Encoding: (.*)/i) {
1523 $xfer_encoding = $1 if not defined $xfer_encoding;
1525 elsif (!/^Date:\s/i && /^[-A-Za-z]+:\s+\S/) {
1526 push @xh, $_;
1529 } else {
1530 # In the traditional
1531 # "send lots of email" format,
1532 # line 1 = cc
1533 # line 2 = subject
1534 # So let's support that, too.
1535 $input_format = 'lots';
1536 if (@cc == 0 && !$suppress_cc{'cc'}) {
1537 printf("(non-mbox) Adding cc: %s from line '%s'\n",
1538 $_, $_) unless $quiet;
1539 push @cc, $_;
1540 } elsif (!defined $subject) {
1541 $subject = $_;
1545 # Now parse the message body
1546 while(<$fh>) {
1547 $message .= $_;
1548 if (/^(Signed-off-by|Cc): (.*)$/i) {
1549 chomp;
1550 my ($what, $c) = ($1, $2);
1551 chomp $c;
1552 my $sc = sanitize_address($c);
1553 if ($sc eq $sender) {
1554 next if ($suppress_cc{'self'});
1555 } else {
1556 next if $suppress_cc{'sob'} and $what =~ /Signed-off-by/i;
1557 next if $suppress_cc{'bodycc'} and $what =~ /Cc/i;
1559 push @cc, $c;
1560 printf("(body) Adding cc: %s from line '%s'\n",
1561 $c, $_) unless $quiet;
1564 close $fh;
1566 push @to, recipients_cmd("to-cmd", "to", $to_cmd, $t)
1567 if defined $to_cmd;
1568 push @cc, recipients_cmd("cc-cmd", "cc", $cc_cmd, $t)
1569 if defined $cc_cmd && !$suppress_cc{'cccmd'};
1571 if ($broken_encoding{$t} && !$has_content_type) {
1572 $xfer_encoding = '8bit' if not defined $xfer_encoding;
1573 $has_content_type = 1;
1574 push @xh, "Content-Type: text/plain; charset=$auto_8bit_encoding";
1575 $body_encoding = $auto_8bit_encoding;
1578 if ($broken_encoding{$t} && !is_rfc2047_quoted($subject)) {
1579 $subject = quote_subject($subject, $auto_8bit_encoding);
1582 if (defined $sauthor and $sauthor ne $sender) {
1583 $message = "From: $author\n\n$message";
1584 if (defined $author_encoding) {
1585 if ($has_content_type) {
1586 if ($body_encoding eq $author_encoding) {
1587 # ok, we already have the right encoding
1589 else {
1590 # uh oh, we should re-encode
1593 else {
1594 $xfer_encoding = '8bit' if not defined $xfer_encoding;
1595 $has_content_type = 1;
1596 push @xh,
1597 "Content-Type: text/plain; charset=$author_encoding";
1601 if (defined $target_xfer_encoding) {
1602 $xfer_encoding = '8bit' if not defined $xfer_encoding;
1603 $message = apply_transfer_encoding(
1604 $message, $xfer_encoding, $target_xfer_encoding);
1605 $xfer_encoding = $target_xfer_encoding;
1607 if (defined $xfer_encoding) {
1608 push @xh, "Content-Transfer-Encoding: $xfer_encoding";
1610 if (defined $xfer_encoding or $has_content_type) {
1611 unshift @xh, 'MIME-Version: 1.0' unless $has_mime_version;
1614 $needs_confirm = (
1615 $confirm eq "always" or
1616 ($confirm =~ /^(?:auto|cc)$/ && @cc) or
1617 ($confirm =~ /^(?:auto|compose)$/ && $compose && $message_num == 1));
1618 $needs_confirm = "inform" if ($needs_confirm && $confirm_unconfigured && @cc);
1620 @to = process_address_list(@to);
1621 @cc = process_address_list(@cc);
1623 @to = (@initial_to, @to);
1624 @cc = (@initial_cc, @cc);
1626 if ($message_num == 1) {
1627 if (defined $cover_cc and $cover_cc) {
1628 @initial_cc = @cc;
1630 if (defined $cover_to and $cover_to) {
1631 @initial_to = @to;
1635 my $message_was_sent = send_message();
1637 # set up for the next message
1638 if ($thread && $message_was_sent &&
1639 ($chain_reply_to || !defined $reply_to || length($reply_to) == 0 ||
1640 $message_num == 1)) {
1641 $reply_to = $message_id;
1642 if (length $references > 0) {
1643 $references .= "\n $message_id";
1644 } else {
1645 $references = "$message_id";
1648 $message_id = undef;
1651 # Execute a command (e.g. $to_cmd) to get a list of email addresses
1652 # and return a results array
1653 sub recipients_cmd {
1654 my ($prefix, $what, $cmd, $file) = @_;
1656 my @addresses = ();
1657 open my $fh, "-|", "$cmd \Q$file\E"
1658 or die "($prefix) Could not execute '$cmd'";
1659 while (my $address = <$fh>) {
1660 $address =~ s/^\s*//g;
1661 $address =~ s/\s*$//g;
1662 $address = sanitize_address($address);
1663 next if ($address eq $sender and $suppress_cc{'self'});
1664 push @addresses, $address;
1665 printf("($prefix) Adding %s: %s from: '%s'\n",
1666 $what, $address, $cmd) unless $quiet;
1668 close $fh
1669 or die "($prefix) failed to close pipe to '$cmd'";
1670 return @addresses;
1673 cleanup_compose_files();
1675 sub cleanup_compose_files {
1676 unlink($compose_filename, $compose_filename . ".final") if $compose;
1679 $smtp->quit if $smtp;
1681 sub apply_transfer_encoding {
1682 my $message = shift;
1683 my $from = shift;
1684 my $to = shift;
1686 return $message if ($from eq $to and $from ne '7bit');
1688 require MIME::QuotedPrint;
1689 require MIME::Base64;
1691 $message = MIME::QuotedPrint::decode($message)
1692 if ($from eq 'quoted-printable');
1693 $message = MIME::Base64::decode($message)
1694 if ($from eq 'base64');
1696 die "cannot send message as 7bit"
1697 if ($to eq '7bit' and $message =~ /[^[:ascii:]]/);
1698 return $message
1699 if ($to eq '7bit' or $to eq '8bit');
1700 return MIME::QuotedPrint::encode($message, "\n", 0)
1701 if ($to eq 'quoted-printable');
1702 return MIME::Base64::encode($message, "\n")
1703 if ($to eq 'base64');
1704 die "invalid transfer encoding";
1707 sub unique_email_list {
1708 my %seen;
1709 my @emails;
1711 foreach my $entry (@_) {
1712 my $clean = extract_valid_address_or_die($entry);
1713 $seen{$clean} ||= 0;
1714 next if $seen{$clean}++;
1715 push @emails, $entry;
1717 return @emails;
1720 sub validate_patch {
1721 my $fn = shift;
1722 open(my $fh, '<', $fn)
1723 or die "unable to open $fn: $!\n";
1724 while (my $line = <$fh>) {
1725 if (length($line) > 998) {
1726 return "$.: patch contains a line longer than 998 characters";
1729 return;
1732 sub handle_backup {
1733 my ($last, $lastlen, $file, $known_suffix) = @_;
1734 my ($suffix, $skip);
1736 $skip = 0;
1737 if (defined $last &&
1738 ($lastlen < length($file)) &&
1739 (substr($file, 0, $lastlen) eq $last) &&
1740 ($suffix = substr($file, $lastlen)) !~ /^[a-z0-9]/i) {
1741 if (defined $known_suffix && $suffix eq $known_suffix) {
1742 print "Skipping $file with backup suffix '$known_suffix'.\n";
1743 $skip = 1;
1744 } else {
1745 my $answer = ask("Do you really want to send $file? (y|N): ",
1746 valid_re => qr/^(?:y|n)/i,
1747 default => 'n');
1748 $skip = ($answer ne 'y');
1749 if ($skip) {
1750 $known_suffix = $suffix;
1754 return ($skip, $known_suffix);
1757 sub handle_backup_files {
1758 my @file = @_;
1759 my ($last, $lastlen, $known_suffix, $skip, @result);
1760 for my $file (@file) {
1761 ($skip, $known_suffix) = handle_backup($last, $lastlen,
1762 $file, $known_suffix);
1763 push @result, $file unless $skip;
1764 $last = $file;
1765 $lastlen = length($file);
1767 return @result;
1770 sub file_has_nonascii {
1771 my $fn = shift;
1772 open(my $fh, '<', $fn)
1773 or die "unable to open $fn: $!\n";
1774 while (my $line = <$fh>) {
1775 return 1 if $line =~ /[^[:ascii:]]/;
1777 return 0;
1780 sub body_or_subject_has_nonascii {
1781 my $fn = shift;
1782 open(my $fh, '<', $fn)
1783 or die "unable to open $fn: $!\n";
1784 while (my $line = <$fh>) {
1785 last if $line =~ /^$/;
1786 return 1 if $line =~ /^Subject.*[^[:ascii:]]/;
1788 while (my $line = <$fh>) {
1789 return 1 if $line =~ /[^[:ascii:]]/;
1791 return 0;