# Web http://www.lx-office.org
#
#=====================================================================
-# SQL-Ledger Accounting
-# Copyright (C) 2001
-#
-# Author: Dieter Simader
-# Email: dsimader@sql-ledger.org
-# Web: http://www.sql-ledger.org
-#
-# Contributors:
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1335, USA.
#======================================================================
package Mailer;
+use Email::Address;
+use Email::MIME::Creator;
+use File::MimeInfo::Magic;
+use File::Slurp;
+use List::UtilsBy qw(bundle_by);
+
use SL::Common;
+use SL::DB::EmailJournal;
+use SL::DB::EmailJournalAttachment;
+use SL::DB::Employee;
+use SL::Template;
-sub new {
- $main::lxdebug->enter_sub();
+use strict;
- my ($type) = @_;
- my $self = {};
+my $num_sent = 0;
- $main::lxdebug->leave_sub();
+my %mail_delivery_modules = (
+ sendmail => 'SL::Mailer::Sendmail',
+ smtp => 'SL::Mailer::SMTP',
+);
+
+sub new {
+ my ($type, %params) = @_;
+ my $self = { %params };
bless $self, $type;
}
-sub mime_quote_text {
- $main::lxdebug->enter_sub();
-
- my ($self, $text, $chars_left) = @_;
+sub _create_driver {
+ my ($self) = @_;
- my $q_start = "=?$self->{charset}?Q?";
- my $l_start = length($q_start);
+ my %params = (
+ mailer => $self,
+ form => $::form,
+ myconfig => \%::myconfig,
+ );
- my $new_text = "$q_start";
- $chars_left -= $l_start;
+ my $module = $mail_delivery_modules{ $::lx_office_conf{mail_delivery}->{method} };
+ eval "require $module" or return undef;
- for (my $i = 0; $i < length($text); $i++) {
- my $char = ord(substr($text, $i, 1));
-
- if (($char < 32) || ($char > 127) ||
- ($char == ord('?')) || ($char == ord('_'))) {
- if ($chars_left < 5) {
- $new_text .= "?=\n $q_start";
- $chars_left = 75 - $l_start;
- }
+ return $module->new(%params);
+}
- $new_text .= sprintf("=%02X", $char);
- $chars_left -= 3;
+sub _cleanup_addresses {
+ my ($self) = @_;
- } else {
- $char = ord('_') if ($char == ord(' '));
- if ($chars_left < 5) {
- $new_text .= "?=\n $q_start";
- $chars_left = 75 - $l_start;
- }
+ foreach my $item (qw(to cc bcc)) {
+ next unless $self->{$item};
- $new_text .= chr($char);
- $chars_left--;
- }
+ $self->{$item} =~ s/\</</g;
+ $self->{$item} =~ s/\$<\$/</g;
+ $self->{$item} =~ s/\>/>/g;
+ $self->{$item} =~ s/\$>\$/>/g;
}
+}
- $new_text .= "?=";
+sub _create_message_id {
+ my ($self) = @_;
- $main::lxdebug->leave_sub();
+ $num_sent += 1;
+ my $domain = $self->{from};
+ $domain =~ s/.*\@//;
+ $domain =~ s/>.*//;
- return $new_text;
+ return "kivitendo-$self->{version}-" . time() . "-${$}-${num_sent}\@$domain";
}
-sub send {
- $main::lxdebug->enter_sub();
+sub _create_address_headers {
+ my ($self) = @_;
- my ($self, $out) = @_;
+ # $self->{addresses} collects the recipients for use in e.g. the
+ # SMTP 'RCPT TO:' envelope command. $self->{headers} collects the
+ # headers that make up the actual email. 'BCC' should not be
+ # included there for certain transportation methods (SMTP).
- my $boundary = time;
- $boundary = "LxOffice-$self->{version}-$boundary";
- my $domain = $self->{from};
- $domain =~ s/(.*?\@|>)//g;
- my $msgid = "$boundary\@$domain";
+ $self->{addresses} = {};
- $self->{charset} = Common::DEFAULT_CHARSET unless $self->{charset};
+ foreach my $item (qw(from to cc bcc)) {
+ $self->{addresses}->{$item} = [];
+ next if !$self->{$item};
- if ($out) {
- if (!open(OUT, $out)) {
- $main::lxdebug->leave_sub();
- return "$out : $!";
- }
- } else {
- if (!open(OUT, ">-")) {
- $main::lxdebug->leave_sub();
- return "STDOUT : $!";
+ my @header_addresses;
+
+ foreach my $addr_obj (Email::Address->parse($self->{$item})) {
+ push @{ $self->{addresses}->{$item} }, $addr_obj->address;
+ next if $self->{driver}->keep_from_header($item);
+
+ my $phrase = $addr_obj->phrase();
+ if ($phrase) {
+ $phrase =~ s/^\"//;
+ $phrase =~ s/\"$//;
+ $addr_obj->phrase($phrase);
+ }
+
+ push @header_addresses, $addr_obj->format;
}
+
+ push @{ $self->{headers} }, ( ucfirst($item) => join(', ', @header_addresses) ) if @header_addresses;
}
+}
- $self->{contenttype} = "text/plain" unless $self->{contenttype};
+sub _create_attachment_part {
+ my ($self, $attachment) = @_;
- my ($cc, $bcc);
- $cc = "Cc: $self->{cc}\n" if $self->{cc};
- $bcc = "Bcc: $self->{bcc}\n" if $self->{bcc};
+ my %attributes = (
+ disposition => 'attachment',
+ encoding => 'base64',
+ );
- foreach my $item (qw(to cc bcc)) {
- $self->{$item} =~ s/\</</g;
- $self->{$item} =~ s/\$<\$/</g;
- $self->{$item} =~ s/\>/>/g;
- $self->{$item} =~ s/\$>\$/>/g;
- }
+ my $attachment_content;
+ my $file_id = 0;
+ my $email_journal = $::instance_conf->get_email_journal;
- my $subject = $self->mime_quote_text($self->{subject}, 60);
+ $::lxdebug->message(LXDebug->DEBUG2(), "mail5 att=" . $attachment . " email_journal=" . $email_journal . " id=" . $attachment->{id});
- print OUT qq|From: $self->{from}
-To: $self->{to}
-${cc}${bcc}Subject: $subject
-Message-ID: <$msgid>
-X-Mailer: Lx-Office $self->{version}
-MIME-Version: 1.0
-|;
+ if (ref($attachment) eq "HASH") {
+ $attributes{filename} = $attachment->{name};
+ $file_id = $attachment->{id} || '0';
+ $attributes{content_type} = $attachment->{type} || 'application/pdf';
+ $attachment_content = $attachment->{content};
+ $attachment_content = eval { read_file($attachment->{path}) } if !$attachment_content;
- if ($self->{attachments}) {
- print OUT qq|Content-Type: multipart/mixed; boundary="$boundary"
+ } else {
+ $attributes{filename} = $attachment;
+ $attributes{filename} =~ s:.*\Q$self->{fileid}\E:: if $self->{fileid};
+ $attributes{filename} =~ s:.*/::g;
+
+ my $application = ($attachment =~ /(^\w+$)|\.(html|text|txt|sql)$/) ? 'text' : 'application';
+ $attributes{content_type} = File::MimeInfo::Magic::magic($attachment);
+ $attributes{content_type} ||= "${application}/$self->{format}" if $self->{format};
+ $attributes{content_type} ||= 'application/octet-stream';
+ $attachment_content = eval { read_file($attachment) };
+ }
-|;
- if ($self->{message}) {
- print OUT qq|--${boundary}
-Content-Type: $self->{contenttype}; charset="$self->{charset}"
+ return undef if $email_journal > 1 && !defined $attachment_content;
-$self->{message}
+ $attachment_content ||= ' ';
+ $attributes{charset} = $self->{charset} if $self->{charset} && ($attributes{content_type} =~ m{^text/});
-|;
- }
+ $::lxdebug->message(LXDebug->DEBUG2(), "mail6 mtype=" . $attributes{content_type} . " filename=" . $attributes{filename});
- foreach my $attachment (@{ $self->{attachments} }) {
+ my $ent;
+ if ( $attributes{content_type} eq 'message/rfc822' ) {
+ $ent = Email::MIME->new($attachment_content);
+ $ent->header_str_set('Content-disposition' => 'attachment; filename='.$attributes{filename});
+ } else {
+ $ent = Email::MIME->create(
+ attributes => \%attributes,
+ body => $attachment_content,
+ );
+ }
- my $filename;
+ push @{ $self->{mail_attachments}} , SL::DB::EmailJournalAttachment->new(
+ name => $attributes{filename},
+ mime_type => $attributes{content_type},
+ content => ( $email_journal > 1 ? $attachment_content : ' '),
+ file_id => $file_id,
+ );
- if (ref($attachment) eq "HASH") {
- $filename = $attachment->{"name"};
- $attachment = $attachment->{"filename"};
- } else {
- $filename = $attachment;
- # strip path
- $filename =~ s/(.*\/|$self->{fileid})//g;
- }
+ return $ent;
+}
- my $application =
- ($attachment =~ /(^\w+$)|\.(html|text|txt|sql)$/)
- ? "text"
- : "application";
+sub _create_message {
+ my ($self) = @_;
- open(IN, $attachment);
- if ($?) {
- close(OUT);
- $main::lxdebug->leave_sub();
- return "$attachment : $!";
- }
+ my @parts;
- print OUT qq|--${boundary}
-Content-Type: $application/$self->{format}; name="$filename"; charset="$self->{charset}"
-Content-Transfer-Encoding: BASE64
-Content-Disposition: attachment; filename="$filename"\n\n|;
+ push @{ $self->{headers} }, (Type => "multipart/mixed");
- my $msg = "";
- while (<IN>) {
- ;
- $msg .= $_;
- }
- print OUT &encode_base64($msg);
+ if ($self->{message}) {
+ push @parts, Email::MIME->create(
+ attributes => {
+ content_type => $self->{contenttype},
+ charset => $self->{charset},
+ encoding => 'quoted-printable',
+ },
+ body_str => $self->{message},
+ );
- close(IN);
+ push @{ $self->{headers} }, (
+ 'Content-Type' => qq|$self->{contenttype}; charset="$self->{charset}"|,
+ );
+ }
- }
- print OUT qq|--${boundary}--\n|;
+ push @parts, grep { $_ } map { $self->_create_attachment_part($_) } @{ $self->{attachments} || [] };
- } else {
- print OUT qq|Content-Type: $self->{contenttype}; charset="$self->{charset}"
+ return Email::MIME->create(
+ header_str => $self->{headers},
+ parts => \@parts,
+ );
+}
+
+sub send {
+ my ($self) = @_;
+
+ # Create driver for delivery method (sendmail/SMTP)
+ $self->{driver} = eval { $self->_create_driver };
+ if (!$self->{driver}) {
+ my $error = $@;
+ $self->_store_in_journal('failed', 'driver could not be created; check your configuration & log files');
+ $::lxdebug->message(LXDebug::WARN(), "Mailer error during 'send': $error");
-$self->{message}
-|;
+ return $error;
}
- close(OUT);
+ # Set defaults & headers
+ $self->{charset} = 'UTF-8';
+ $self->{contenttype} ||= "text/plain";
+ $self->{headers} = [
+ Subject => $self->{subject},
+ 'Message-ID' => '<' . $self->_create_message_id . '>',
+ 'X-Mailer' => "kivitendo $self->{version}",
+ ];
+ $self->{mail_attachments} = [];
+ $self->{content_by_name} = $::instance_conf->get_email_journal == 1 && $::instance_conf->get_doc_files;
- $main::lxdebug->leave_sub();
+ my $error;
+ my $ok = eval {
+ # Clean up To/Cc/Bcc address fields
+ $self->_cleanup_addresses;
+ $self->_create_address_headers;
- return "";
-}
+ my $email = $self->_create_message;
-sub encode_base64 ($;$) {
- $main::lxdebug->enter_sub();
+ #$::lxdebug->message(0, "message: " . $email->as_string);
+ # return "boom";
- # this code is from the MIME-Base64-2.12 package
- # Copyright 1995-1999,2001 Gisle Aas <gisle@ActiveState.com>
+ $::lxdebug->message(LXDebug->DEBUG2(), "mail1 from=".$self->{from}." to=".$self->{to});
+ my $from_obj = (Email::Address->parse($self->{from}))[0];
- my $res = "";
- my $eol = $_[1];
- $eol = "\n" unless defined $eol;
- pos($_[0]) = 0; # ensure start at the beginning
+ $self->{driver}->start_mail(from => $from_obj->address, to => [ $self->_all_recipients ]);
+ $self->{driver}->print($email->as_string);
+ $self->{driver}->send;
- $res = join '', map(pack('u', $_) =~ /^.(\S*)/, ($_[0] =~ /(.{1,45})/gs));
+ 1;
+ };
- $res =~ tr|` -_|AA-Za-z0-9+/|; # `# help emacs
- # fix padding at the end
- my $padding = (3 - length($_[0]) % 3) % 3;
- $res =~ s/.{$padding}$/'=' x $padding/e if $padding;
+ $error = $@ if !$ok;
- # break encoded string into lines of no more than 60 characters each
- if (length $eol) {
- $res =~ s/(.{1,60})/$1$eol/g;
- }
+ $self->{journalentry} = $self->_store_in_journal;
+
+ return $ok ? '' : ($error || "undefined error");
+}
- $main::lxdebug->leave_sub();
+sub _all_recipients {
+ my ($self) = @_;
+ $self->{addresses} ||= {};
+ return map { @{ $self->{addresses}->{$_} || [] } } qw(to cc bcc);
+}
- return $res;
+sub _store_in_journal {
+ my ($self, $status, $extended_status) = @_;
+
+ my $journal_enable = $::instance_conf->get_email_journal;
+
+ return if $journal_enable == 0;
+
+ $status //= $self->{driver}->status if $self->{driver};
+ $status //= 'failed';
+ $extended_status //= $self->{driver}->extended_status if $self->{driver};
+ $extended_status //= 'unknown error';
+
+ my $headers = join "\r\n", (bundle_by { join(': ', @_) } 2, @{ $self->{headers} || [] });
+
+ my $jentry = SL::DB::EmailJournal->new(
+ sender => SL::DB::Manager::Employee->current,
+ from => $self->{from} // '',
+ recipients => join(', ', $self->_all_recipients),
+ subject => $self->{subject} // '',
+ headers => $headers,
+ body => $self->{message} // '',
+ sent_on => DateTime->now_local,
+ attachments => \@{ $self->{mail_attachments} },
+ status => $status,
+ extended_status => $extended_status,
+ )->save;
+ return $jentry->id;
}
1;
-
projects / kivitendo-erp.git / blobdiff