kivitendo/SL/Mailer.pm @ 86183dc1
| d319704a | Moritz Bunkus | #=====================================================================
|
||
# LX-Office ERP
|
||||
# Copyright (C) 2004
|
||||
# Based on SQL-Ledger Version 2.1.9
|
||||
# Web http://www.lx-office.org
|
||||
#
|
||||
#=====================================================================
|
||||
#
|
||||
# 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
|
||||
# the Free Software Foundation; either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# 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
|
||||
| f7b15d43 | Christian Wittmer | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
||
# MA 02110-1335, USA.
|
||||
| d319704a | Moritz Bunkus | #======================================================================
|
||
package Mailer;
|
||||
| 8f3ecba9 | Moritz Bunkus | use Email::Address;
|
||
| e3b0f613 | Martin Helmling | use Email::MIME::Creator;
|
||
| a40f0c2f | Martin Helmling | use File::MimeInfo::Magic;
|
||
| e8c2a3b8 | Moritz Bunkus | use File::Slurp;
|
||
| 24ab7ec0 | Moritz Bunkus | use List::UtilsBy qw(bundle_by);
|
||
| 8f3ecba9 | Moritz Bunkus | |||
| faef45c2 | Moritz Bunkus | use SL::Common;
|
||
| 24ab7ec0 | Moritz Bunkus | use SL::DB::EmailJournal;
|
||
use SL::DB::EmailJournalAttachment;
|
||||
use SL::DB::Employee;
|
||||
| 920fd369 | Moritz Bunkus | use SL::Template;
|
||
| faef45c2 | Moritz Bunkus | |||
| c510d88b | Sven Schöling | use strict;
|
||
| ba36bef4 | Moritz Bunkus | my $num_sent = 0;
|
||
| adbc100a | Sven Schöling | my %mail_delivery_modules = (
|
||
sendmail => 'SL::Mailer::Sendmail',
|
||||
smtp => 'SL::Mailer::SMTP',
|
||||
);
|
||||
| d319704a | Moritz Bunkus | sub new {
|
||
| 45c9cdd8 | Sven Schöling | my ($type, %params) = @_;
|
||
my $self = { %params };
|
||||
| d319704a | Moritz Bunkus | |||
bless $self, $type;
|
||||
}
|
||||
| 5896d8bf | Moritz Bunkus | sub _create_driver {
|
||
my ($self) = @_;
|
||||
my %params = (
|
||||
mailer => $self,
|
||||
form => $::form,
|
||||
myconfig => \%::myconfig,
|
||||
);
|
||||
| adbc100a | Sven Schöling | my $module = $mail_delivery_modules{ $::lx_office_conf{mail_delivery}->{method} };
|
||
| 16cc4053 | Moritz Bunkus | eval "require $module" or return undef;
|
||
| 7734bb7c | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | return $module->new(%params);
|
||
}
|
||||
| 7734bb7c | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | sub _cleanup_addresses {
|
||
my ($self) = @_;
|
||||
| 7734bb7c | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | foreach my $item (qw(to cc bcc)) {
|
||
next unless $self->{$item};
|
||||
| 7734bb7c | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | $self->{$item} =~ s/\</</g;
|
||
$self->{$item} =~ s/\$<\$/</g;
|
||||
$self->{$item} =~ s/\>/>/g;
|
||||
$self->{$item} =~ s/\$>\$/>/g;
|
||||
| 7734bb7c | Moritz Bunkus | }
|
||
}
|
||||
| 16cc4053 | Moritz Bunkus | sub _create_message_id {
|
||
| 974b5d86 | Moritz Bunkus | my ($self) = @_;
|
||
| 16cc4053 | Moritz Bunkus | $num_sent += 1;
|
||
my $domain = $self->{from};
|
||||
$domain =~ s/.*\@//;
|
||||
$domain =~ s/>.*//;
|
||||
| 920fd369 | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | return "kivitendo-$self->{version}-" . time() . "-${$}-${num_sent}\@$domain";
|
||
}
|
||||
| d319704a | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | sub _create_address_headers {
|
||
my ($self) = @_;
|
||||
| d319704a | Moritz Bunkus | |||
| f8361ca6 | Moritz Bunkus | # $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).
|
||||
| 16cc4053 | Moritz Bunkus | $self->{addresses} = {};
|
||
| d319704a | Moritz Bunkus | |||
| 38c19bfd | Sven Schöling | foreach my $item (qw(from to cc bcc)) {
|
||
| 16cc4053 | Moritz Bunkus | $self->{addresses}->{$item} = [];
|
||
| f8361ca6 | Moritz Bunkus | next if !$self->{$item};
|
||
| 5896d8bf | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | my @header_addresses;
|
||
| 8f3ecba9 | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | foreach my $addr_obj (Email::Address->parse($self->{$item})) {
|
||
push @{ $self->{addresses}->{$item} }, $addr_obj->address;
|
||||
| f8361ca6 | Moritz Bunkus | next if $self->{driver}->keep_from_header($item);
|
||
| 77733865 | Moritz Bunkus | my $phrase = $addr_obj->phrase();
|
||
if ($phrase) {
|
||||
$phrase =~ s/^\"//;
|
||||
$phrase =~ s/\"$//;
|
||||
| 16cc4053 | Moritz Bunkus | $addr_obj->phrase($phrase);
|
||
| 77733865 | Moritz Bunkus | }
|
||
| 8f3ecba9 | Moritz Bunkus | |||
| ae20c836 | Moritz Bunkus | push @header_addresses, $addr_obj->format;
|
||
| 8f3ecba9 | Moritz Bunkus | }
|
||
| 5896d8bf | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | push @{ $self->{headers} }, ( ucfirst($item) => join(', ', @header_addresses) ) if @header_addresses;
|
||
}
|
||||
}
|
||||
| d319704a | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | sub _create_attachment_part {
|
||
my ($self, $attachment) = @_;
|
||||
| d319704a | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | my %attributes = (
|
||
| e3b0f613 | Martin Helmling | disposition => 'attachment',
|
||
encoding => 'base64',
|
||||
| 16cc4053 | Moritz Bunkus | );
|
||
| 3d779763 | Moritz Bunkus | |||
| 8fec2dc1 | Moritz Bunkus | my $attachment_content;
|
||
| 63dc98ee | Moritz Bunkus | my $file_id = 0;
|
||
| a40f0c2f | Martin Helmling | my $email_journal = $::instance_conf->get_email_journal;
|
||
| 8fec2dc1 | Moritz Bunkus | |||
| 63dc98ee | Moritz Bunkus | $::lxdebug->message(LXDebug->DEBUG2(), "mail5 att=" . $attachment . " email_journal=" . $email_journal . " id=" . $attachment->{id});
|
||
| 16cc4053 | Moritz Bunkus | if (ref($attachment) eq "HASH") {
|
||
| e3b0f613 | Martin Helmling | $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;
|
||||
| 3d779763 | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | } else {
|
||
| e3b0f613 | Martin Helmling | $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) };
|
||||
| 16cc4053 | Moritz Bunkus | }
|
||
| d319704a | Moritz Bunkus | |||
| a40f0c2f | Martin Helmling | return undef if $email_journal > 1 && !defined $attachment_content;
|
||
| 48399a5a | Sven Schöling | |||
| 63dc98ee | Moritz Bunkus | $attachment_content ||= ' ';
|
||
| 36857857 | Moritz Bunkus | $attributes{charset} = $self->{charset} if $self->{charset} && ($attributes{content_type} =~ m{^text/});
|
||
| d319704a | Moritz Bunkus | |||
| bdbe2ca0 | Martin Helmling | $::lxdebug->message(LXDebug->DEBUG2(), "mail6 mtype=" . $attributes{content_type} . " filename=" . $attributes{filename});
|
||
| 63dc98ee | Moritz Bunkus | |||
| a40f0c2f | Martin Helmling | my $ent;
|
||
| e3b0f613 | Martin Helmling | if ( $attributes{content_type} eq 'message/rfc822' ) {
|
||
$ent = Email::MIME->new($attachment_content);
|
||||
$ent->header_str_set('Content-disposition' => 'attachment; filename='.$attributes{filename});
|
||||
| a40f0c2f | Martin Helmling | } else {
|
||
| e3b0f613 | Martin Helmling | $ent = Email::MIME->create(
|
||
attributes => \%attributes,
|
||||
body => $attachment_content,
|
||||
);
|
||||
| a40f0c2f | Martin Helmling | }
|
||
| 63dc98ee | Moritz Bunkus | |||
| a40f0c2f | Martin Helmling | push @{ $self->{mail_attachments}} , SL::DB::EmailJournalAttachment->new(
|
||
| e3b0f613 | Martin Helmling | name => $attributes{filename},
|
||
mime_type => $attributes{content_type},
|
||||
| a40f0c2f | Martin Helmling | content => ( $email_journal > 1 ? $attachment_content : ' '),
|
||
file_id => $file_id,
|
||||
| 16cc4053 | Moritz Bunkus | );
|
||
| 63dc98ee | Moritz Bunkus | |||
| a40f0c2f | Martin Helmling | return $ent;
|
||
| 16cc4053 | Moritz Bunkus | }
|
||
| d319704a | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | sub _create_message {
|
||
my ($self) = @_;
|
||||
| d319704a | Moritz Bunkus | |||
| e3b0f613 | Martin Helmling | my @parts;
|
||
| 63dc98ee | Moritz Bunkus | |||
| e3b0f613 | Martin Helmling | push @{ $self->{headers} }, (Type => "multipart/mixed");
|
||
| 63dc98ee | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | if ($self->{message}) {
|
||
| e3b0f613 | Martin Helmling | push @parts, Email::MIME->create(
|
||
attributes => {
|
||||
content_type => $self->{contenttype},
|
||||
charset => $self->{charset},
|
||||
encoding => 'quoted-printable',
|
||||
},
|
||||
body_str => $self->{message},
|
||||
);
|
||||
push @{ $self->{headers} }, (
|
||||
'Content-Type' => qq|$self->{contenttype}; charset="$self->{charset}"|,
|
||||
| 63dc98ee | Moritz Bunkus | );
|
||
| d319704a | Moritz Bunkus | }
|
||
| e3b0f613 | Martin Helmling | push @parts, grep { $_ } map { $self->_create_attachment_part($_) } @{ $self->{attachments} || [] };
|
||
| 63dc98ee | Moritz Bunkus | |||
| e3b0f613 | Martin Helmling | return Email::MIME->create(
|
||
header_str => $self->{headers},
|
||||
parts => \@parts,
|
||||
);
|
||||
| d319704a | Moritz Bunkus | }
|
||
| 16cc4053 | Moritz Bunkus | sub send {
|
||
my ($self) = @_;
|
||||
| d319704a | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | # Create driver for delivery method (sendmail/SMTP)
|
||
$self->{driver} = eval { $self->_create_driver };
|
||||
if (!$self->{driver}) {
|
||||
| 117332fc | Moritz Bunkus | 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");
|
||||
return "send email : $error";
|
||||
| 16cc4053 | Moritz Bunkus | }
|
||
| d319704a | Moritz Bunkus | |||
| 16cc4053 | Moritz Bunkus | # Set defaults & headers
|
||
| dbda14c2 | Moritz Bunkus | $self->{charset} = 'UTF-8';
|
||
| 16cc4053 | Moritz Bunkus | $self->{contenttype} ||= "text/plain";
|
||
$self->{headers} = [
|
||||
| ae20c836 | Moritz Bunkus | Subject => $self->{subject},
|
||
| bdb84974 | Rolf Eike Beer | 'Message-ID' => '<' . $self->_create_message_id . '>',
|
||
| 16cc4053 | Moritz Bunkus | 'X-Mailer' => "kivitendo $self->{version}",
|
||
];
|
||||
| a40f0c2f | Martin Helmling | $self->{mail_attachments} = [];
|
||
$self->{content_by_name} = $::instance_conf->get_email_journal == 1 && $::instance_conf->get_doc_files;
|
||||
| d319704a | Moritz Bunkus | |||
| 24ab7ec0 | Moritz Bunkus | my $error;
|
||
my $ok = eval {
|
||||
# Clean up To/Cc/Bcc address fields
|
||||
$self->_cleanup_addresses;
|
||||
$self->_create_address_headers;
|
||||
| d319704a | Moritz Bunkus | |||
| 24ab7ec0 | Moritz Bunkus | my $email = $self->_create_message;
|
||
| d319704a | Moritz Bunkus | |||
| a40f0c2f | Martin Helmling | #$::lxdebug->message(0, "message: " . $email->as_string);
|
||
| 24ab7ec0 | Moritz Bunkus | # return "boom";
|
||
| d319704a | Moritz Bunkus | |||
| bdbe2ca0 | Martin Helmling | $::lxdebug->message(LXDebug->DEBUG2(), "mail1 from=".$self->{from}." to=".$self->{to});
|
||
| 895ccd7f | Moritz Bunkus | my $from_obj = (Email::Address->parse($self->{from}))[0];
|
||
$self->{driver}->start_mail(from => $from_obj->address, to => [ $self->_all_recipients ]);
|
||||
| 24ab7ec0 | Moritz Bunkus | $self->{driver}->print($email->as_string);
|
||
$self->{driver}->send;
|
||||
| d319704a | Moritz Bunkus | |||
| 24ab7ec0 | Moritz Bunkus | 1;
|
||
};
|
||||
$error = $@ if !$ok;
|
||||
| a40f0c2f | Martin Helmling | $self->{journalentry} = $self->_store_in_journal;
|
||
| 24ab7ec0 | Moritz Bunkus | |||
return $ok ? '' : "send email: $error";
|
||||
}
|
||||
sub _all_recipients {
|
||||
my ($self) = @_;
|
||||
$self->{addresses} ||= {};
|
||||
return map { @{ $self->{addresses}->{$_} || [] } } qw(to cc bcc);
|
||||
}
|
||||
sub _store_in_journal {
|
||||
my ($self, $status, $extended_status) = @_;
|
||||
| 687f2d96 | Martin Helmling | my $journal_enable = $::instance_conf->get_email_journal;
|
||
return if $journal_enable == 0;
|
||||
| 24ab7ec0 | Moritz Bunkus | $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} || [] });
|
||||
| a40f0c2f | Martin Helmling | my $jentry = SL::DB::EmailJournal->new(
|
||
| 24ab7ec0 | Moritz Bunkus | 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,
|
||||
| a40f0c2f | Martin Helmling | attachments => \@{ $self->{mail_attachments} },
|
||
| 24ab7ec0 | Moritz Bunkus | status => $status,
|
||
extended_status => $extended_status,
|
||||
)->save;
|
||||
| a40f0c2f | Martin Helmling | return $jentry->id;
|
||
| d319704a | Moritz Bunkus | }
|
||
1;
|