Upgrade to 4.0.10.
[usit-rt.git] / lib / RT / Action / RecordCorrespondence.pm
CommitLineData
84fb5b46
MKG
1# BEGIN BPS TAGGED BLOCK {{{
2#
3# COPYRIGHT:
4#
403d7b0b 5# This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
84fb5b46
MKG
6# <sales@bestpractical.com>
7#
8# (Except where explicitly superseded by other copyright notices)
9#
10#
11# LICENSE:
12#
13# This work is made available to you under the terms of Version 2 of
14# the GNU General Public License. A copy of that license should have
15# been provided with this software, but in any event can be snarfed
16# from www.gnu.org.
17#
18# This work is distributed in the hope that it will be useful, but
19# WITHOUT ANY WARRANTY; without even the implied warranty of
20# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21# General Public License for more details.
22#
23# You should have received a copy of the GNU General Public License
24# along with this program; if not, write to the Free Software
25# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26# 02110-1301 or visit their web page on the internet at
27# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28#
29#
30# CONTRIBUTION SUBMISSION POLICY:
31#
32# (The following paragraph is not intended to limit the rights granted
33# to you to modify and distribute this software under the terms of
34# the GNU General Public License and is only of importance to you if
35# you choose to contribute your changes and enhancements to the
36# community by submitting them to Best Practical Solutions, LLC.)
37#
38# By intentionally submitting any modifications, corrections or
39# derivatives to this work, or any other work intended for use with
40# Request Tracker, to Best Practical Solutions, LLC, you confirm that
41# you are the copyright holder for those contributions and you grant
42# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43# royalty-free, perpetual, license to use, copy, create derivative
44# works based on those contributions, and sublicense and distribute
45# those contributions and any derivatives thereof.
46#
47# END BPS TAGGED BLOCK }}}
48
49package RT::Action::RecordCorrespondence;
50use base 'RT::Action';
51use strict;
403d7b0b 52use warnings;
84fb5b46
MKG
53
54=head1 NAME
55
56RT::Action::RecordCorrespondence - An Action which can be used from an
57external tool, or in any situation where a ticket transaction has not
58been started, to make a comment on the ticket.
59
60=head1 SYNOPSIS
61
62my $action_obj = RT::Action::RecordCorrespondence->new(
63 'TicketObj' => $ticket_obj,
64 'TemplateObj' => $template_obj,
65 );
66my $result = $action_obj->Prepare();
67$action_obj->Commit() if $result;
68
69=head1 METHODS
70
71=head2 Prepare
72
73Check for the existence of a Transaction. If a Transaction already
74exists, and is of type "Comment" or "Correspond", abort because that
75will give us a loop.
76
77=cut
78
79
80sub Prepare {
81 my $self = shift;
82 if (defined $self->{'TransactionObj'} &&
83 $self->{'TransactionObj'}->Type =~ /^(Comment|Correspond)$/) {
84 return undef;
85 }
86 return 1;
87}
88
89=head2 Commit
90
91Create a Transaction by calling the ticket's Correspond method on our
92parsed Template, which may have an RT-Send-Cc or RT-Send-Bcc header.
93The Transaction will be of type Correspond. This Transaction can then
94be used by the scrips that actually send the email.
95
96=cut
97
98sub Commit {
99 my $self = shift;
100 $self->CreateTransaction();
101}
102
103sub CreateTransaction {
104 my $self = shift;
105
106 my ($result, $msg) = $self->{'TemplateObj'}->Parse(
107 TicketObj => $self->{'TicketObj'});
108 return undef unless $result;
109
110 my ($trans, $desc, $transaction) = $self->{'TicketObj'}->Correspond(
111 MIMEObj => $self->TemplateObj->MIMEObj);
112 $self->{'TransactionObj'} = $transaction;
113}
114
115
116RT::Base->_ImportOverlays();
117
1181;