| 1 | package App::Framework::Feature::Mail ; | ||||||||||||||||||||||||||||||||||||||||||
| 2 | |||||||||||||||||||||||||||||||||||||||||||
| 3 | =head1 NAME | ||||||||||||||||||||||||||||||||||||||||||
| 4 | |||||||||||||||||||||||||||||||||||||||||||
| 5 | App::Framework::Feature::Mail - Send mail | ||||||||||||||||||||||||||||||||||||||||||
| 6 | |||||||||||||||||||||||||||||||||||||||||||
| 7 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||||||||||||||||
| 8 | |||||||||||||||||||||||||||||||||||||||||||
| 9 | use App::Framework '+Mail' ; | ||||||||||||||||||||||||||||||||||||||||||
| 10 | |||||||||||||||||||||||||||||||||||||||||||
| 11 | |||||||||||||||||||||||||||||||||||||||||||
| 12 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||||||||||||||||
| 13 | |||||||||||||||||||||||||||||||||||||||||||
| 14 | Provides a simplified mail interface, and application error auto-mailing. | ||||||||||||||||||||||||||||||||||||||||||
| 15 | |||||||||||||||||||||||||||||||||||||||||||
| 16 | When used as a mail interface, this feature is accessed in the same manner as any other (e.g. see L<App::Framework::Feature::Args>). | ||||||||||||||||||||||||||||||||||||||||||
| 17 | |||||||||||||||||||||||||||||||||||||||||||
| 18 | The accessor function (L</mail>) returns the mail object if no parameters are specified; otherwise it will send a mail: | ||||||||||||||||||||||||||||||||||||||||||
| 19 | |||||||||||||||||||||||||||||||||||||||||||
| 20 | $app->Mail("This is a test", | ||||||||||||||||||||||||||||||||||||||||||
| 21 | 'from' => 'someone@domain.co.uk', | ||||||||||||||||||||||||||||||||||||||||||
| 22 | 'to' => 'afriend@domain.com', | ||||||||||||||||||||||||||||||||||||||||||
| 23 | 'subject' => 'a test', | ||||||||||||||||||||||||||||||||||||||||||
| 24 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 25 | |||||||||||||||||||||||||||||||||||||||||||
| 26 | Default settings may be set at the start of an application so that only specific parameters need to be added: | ||||||||||||||||||||||||||||||||||||||||||
| 27 | |||||||||||||||||||||||||||||||||||||||||||
| 28 | $app->Mail()->set( | ||||||||||||||||||||||||||||||||||||||||||
| 29 | 'from' => 'someone@domain.co.uk', | ||||||||||||||||||||||||||||||||||||||||||
| 30 | 'error_to' => 'someone@domain.co.uk', | ||||||||||||||||||||||||||||||||||||||||||
| 31 | 'err_level' => 'warning', | ||||||||||||||||||||||||||||||||||||||||||
| 32 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 33 | |||||||||||||||||||||||||||||||||||||||||||
| 34 | ## send a mail to 'afriend@domain.com' | ||||||||||||||||||||||||||||||||||||||||||
| 35 | $app->Mail("This is a test", | ||||||||||||||||||||||||||||||||||||||||||
| 36 | 'to' => 'afriend@domain.com', | ||||||||||||||||||||||||||||||||||||||||||
| 37 | 'subject' => 'a test', | ||||||||||||||||||||||||||||||||||||||||||
| 38 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 39 | |||||||||||||||||||||||||||||||||||||||||||
| 40 | ... | ||||||||||||||||||||||||||||||||||||||||||
| 41 | |||||||||||||||||||||||||||||||||||||||||||
| 42 | ## send another - still goers to 'afriend@domain.com' | ||||||||||||||||||||||||||||||||||||||||||
| 43 | $app->Mail("This is another test", | ||||||||||||||||||||||||||||||||||||||||||
| 44 | 'subject' => 'another test', | ||||||||||||||||||||||||||||||||||||||||||
| 45 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 46 | |||||||||||||||||||||||||||||||||||||||||||
| 47 | An additional capability is that this feature can automatically send emails of any errors. To do this you first of all | ||||||||||||||||||||||||||||||||||||||||||
| 48 | need to specify the 'error_to' recipient, and then set the 'err_level'. The 'err_level' setting specifies the type of | ||||||||||||||||||||||||||||||||||||||||||
| 49 | error that will generate an email. For example, setting 'err_level' to "warning" means all warnings AND errors will result | ||||||||||||||||||||||||||||||||||||||||||
| 50 | in emails; but notes will not (see L<App::Framework::Base::Object::ErrorHandle> for types). | ||||||||||||||||||||||||||||||||||||||||||
| 51 | |||||||||||||||||||||||||||||||||||||||||||
| 52 | This feature also automatically adds mail-related command line options to allow a user to specify the field settings for themselves | ||||||||||||||||||||||||||||||||||||||||||
| 53 | (or an application may over ride with their own defaults). | ||||||||||||||||||||||||||||||||||||||||||
| 54 | |||||||||||||||||||||||||||||||||||||||||||
| 55 | Note that the 'to' and 'error_to' fields may be a comma seperated list of mail recipients. | ||||||||||||||||||||||||||||||||||||||||||
| 56 | |||||||||||||||||||||||||||||||||||||||||||
| 57 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 58 | |||||||||||||||||||||||||||||||||||||||||||
| 59 | 2 | ▶ | use strict ; | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||
| 60 | 2 | ▶ | use Carp ; | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||
| 61 | |||||||||||||||||||||||||||||||||||||||||||
| 62 | 2 | our $VERSION = "1.002" ; | |||||||||||||||||||||||||||||||||||||||||
| 63 | |||||||||||||||||||||||||||||||||||||||||||
| 64 | |||||||||||||||||||||||||||||||||||||||||||
| 65 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 66 | # USES | ||||||||||||||||||||||||||||||||||||||||||
| 67 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 68 | 2 | ▶ | use App::Framework::Feature ; | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||
| 69 | |||||||||||||||||||||||||||||||||||||||||||
| 70 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 71 | # OBJECT HIERARCHY | ||||||||||||||||||||||||||||||||||||||||||
| 72 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 73 | 2 | our @ISA = qw(App::Framework::Feature) ; | |||||||||||||||||||||||||||||||||||||||||
| 74 | |||||||||||||||||||||||||||||||||||||||||||
| 75 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 76 | # GLOBALS | ||||||||||||||||||||||||||||||||||||||||||
| 77 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 78 | |||||||||||||||||||||||||||||||||||||||||||
| 79 | =head2 ADDITIONAL COMMAND LINE OPTIONS | ||||||||||||||||||||||||||||||||||||||||||
| 80 | |||||||||||||||||||||||||||||||||||||||||||
| 81 | This extension adds the following additional command line options to any application: | ||||||||||||||||||||||||||||||||||||||||||
| 82 | |||||||||||||||||||||||||||||||||||||||||||
| 83 | =over 4 | ||||||||||||||||||||||||||||||||||||||||||
| 84 | |||||||||||||||||||||||||||||||||||||||||||
| 85 | =item B<-mail-from> - Mail sender (required) | ||||||||||||||||||||||||||||||||||||||||||
| 86 | |||||||||||||||||||||||||||||||||||||||||||
| 87 | Email sender | ||||||||||||||||||||||||||||||||||||||||||
| 88 | |||||||||||||||||||||||||||||||||||||||||||
| 89 | =item B<-mail-to> - Mail recipient(s) (required) | ||||||||||||||||||||||||||||||||||||||||||
| 90 | |||||||||||||||||||||||||||||||||||||||||||
| 91 | Email recipient. Where there are multiple recipients, they should be set as a comma seperated list of email addresses | ||||||||||||||||||||||||||||||||||||||||||
| 92 | |||||||||||||||||||||||||||||||||||||||||||
| 93 | =item B<-mail-error-to> - Error mail recipient(s) | ||||||||||||||||||||||||||||||||||||||||||
| 94 | |||||||||||||||||||||||||||||||||||||||||||
| 95 | Email recipient for errors. If set, program errors are sent to this email. | ||||||||||||||||||||||||||||||||||||||||||
| 96 | |||||||||||||||||||||||||||||||||||||||||||
| 97 | =item B<-mail-err-level> - Error level for mails | ||||||||||||||||||||||||||||||||||||||||||
| 98 | |||||||||||||||||||||||||||||||||||||||||||
| 99 | Set the minium error level that triggers an email. Level can be: note, warning, error | ||||||||||||||||||||||||||||||||||||||||||
| 100 | |||||||||||||||||||||||||||||||||||||||||||
| 101 | =item B<-mail-subject> - Mail subject | ||||||||||||||||||||||||||||||||||||||||||
| 102 | |||||||||||||||||||||||||||||||||||||||||||
| 103 | Optional mail subject line | ||||||||||||||||||||||||||||||||||||||||||
| 104 | |||||||||||||||||||||||||||||||||||||||||||
| 105 | =item B<-mail-host> - Mail host | ||||||||||||||||||||||||||||||||||||||||||
| 106 | |||||||||||||||||||||||||||||||||||||||||||
| 107 | Mailing host. If not specified uses 'localhost' | ||||||||||||||||||||||||||||||||||||||||||
| 108 | |||||||||||||||||||||||||||||||||||||||||||
| 109 | =back | ||||||||||||||||||||||||||||||||||||||||||
| 110 | |||||||||||||||||||||||||||||||||||||||||||
| 111 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 112 | |||||||||||||||||||||||||||||||||||||||||||
| 113 | # Set of script-related default options | ||||||||||||||||||||||||||||||||||||||||||
| 114 | 2 | my @OPTIONS = ( | |||||||||||||||||||||||||||||||||||||||||
| 115 | ['mail-from=s', 'Mail sender', 'Email sender', ], | ||||||||||||||||||||||||||||||||||||||||||
| 116 | ['mail-to=s', 'Mail recipient', 'Email recipient(s). Where there are multiple recipients, they should be set as a comma seperated list of email addresses', ], | ||||||||||||||||||||||||||||||||||||||||||
| 117 | ['mail-error-to=s', 'Error mail recipient', 'Email recipient(s) for errors. If set, program errors are sent to this email.'], | ||||||||||||||||||||||||||||||||||||||||||
| 118 | ['mail-err-level=s', 'Error level for mails', 'Set the minium error level that triggers an email (must have error-to set). Level can be: note, warning, error', 'error'], | ||||||||||||||||||||||||||||||||||||||||||
| 119 | ['mail-subject=s', 'Mail subject', 'Optional mail subject line'], | ||||||||||||||||||||||||||||||||||||||||||
| 120 | ['mail-host=s', 'Mail host', 'Mailing host.', 'localhost'], | ||||||||||||||||||||||||||||||||||||||||||
| 121 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 122 | |||||||||||||||||||||||||||||||||||||||||||
| 123 | |||||||||||||||||||||||||||||||||||||||||||
| 124 | |||||||||||||||||||||||||||||||||||||||||||
| 125 | =head2 FIELDS | ||||||||||||||||||||||||||||||||||||||||||
| 126 | |||||||||||||||||||||||||||||||||||||||||||
| 127 | The following fields should be defined either in the call to 'new()', as part of a 'set()' call, or called by their accessor method | ||||||||||||||||||||||||||||||||||||||||||
| 128 | (which is the same name as the field): | ||||||||||||||||||||||||||||||||||||||||||
| 129 | |||||||||||||||||||||||||||||||||||||||||||
| 130 | |||||||||||||||||||||||||||||||||||||||||||
| 131 | =over 4 | ||||||||||||||||||||||||||||||||||||||||||
| 132 | |||||||||||||||||||||||||||||||||||||||||||
| 133 | |||||||||||||||||||||||||||||||||||||||||||
| 134 | =item B<from> - Mail sender (required) | ||||||||||||||||||||||||||||||||||||||||||
| 135 | |||||||||||||||||||||||||||||||||||||||||||
| 136 | Email sender | ||||||||||||||||||||||||||||||||||||||||||
| 137 | |||||||||||||||||||||||||||||||||||||||||||
| 138 | =item B<to> - Mail recipient(s) (required) | ||||||||||||||||||||||||||||||||||||||||||
| 139 | |||||||||||||||||||||||||||||||||||||||||||
| 140 | Email recipient. Where there are multiple recipients, they should be set as a comma seperated list of email addresses | ||||||||||||||||||||||||||||||||||||||||||
| 141 | |||||||||||||||||||||||||||||||||||||||||||
| 142 | =item B<error_to> - Error mail recipient(s) | ||||||||||||||||||||||||||||||||||||||||||
| 143 | |||||||||||||||||||||||||||||||||||||||||||
| 144 | Email recipient for errors. If set, program errors are sent to this email. | ||||||||||||||||||||||||||||||||||||||||||
| 145 | |||||||||||||||||||||||||||||||||||||||||||
| 146 | =item B<err_level> - Error level for mails | ||||||||||||||||||||||||||||||||||||||||||
| 147 | |||||||||||||||||||||||||||||||||||||||||||
| 148 | Set the minium error level that triggers an email. Level can be: note, warning, error | ||||||||||||||||||||||||||||||||||||||||||
| 149 | |||||||||||||||||||||||||||||||||||||||||||
| 150 | =item B<subject> - Mail subject | ||||||||||||||||||||||||||||||||||||||||||
| 151 | |||||||||||||||||||||||||||||||||||||||||||
| 152 | Optional mail subject line | ||||||||||||||||||||||||||||||||||||||||||
| 153 | |||||||||||||||||||||||||||||||||||||||||||
| 154 | =item B<host> - Mail host | ||||||||||||||||||||||||||||||||||||||||||
| 155 | |||||||||||||||||||||||||||||||||||||||||||
| 156 | Mailing host. If not specified uses 'localhost' | ||||||||||||||||||||||||||||||||||||||||||
| 157 | |||||||||||||||||||||||||||||||||||||||||||
| 158 | |||||||||||||||||||||||||||||||||||||||||||
| 159 | =back | ||||||||||||||||||||||||||||||||||||||||||
| 160 | |||||||||||||||||||||||||||||||||||||||||||
| 161 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 162 | |||||||||||||||||||||||||||||||||||||||||||
| 163 | 2 | my %FIELDS = ( | |||||||||||||||||||||||||||||||||||||||||
| 164 | 'from' => '', | ||||||||||||||||||||||||||||||||||||||||||
| 165 | 'to' => '', | ||||||||||||||||||||||||||||||||||||||||||
| 166 | 'error_to' => '', | ||||||||||||||||||||||||||||||||||||||||||
| 167 | 'err_level' => 'error', | ||||||||||||||||||||||||||||||||||||||||||
| 168 | 'subject' => '', | ||||||||||||||||||||||||||||||||||||||||||
| 169 | 'host' => 'localhost', | ||||||||||||||||||||||||||||||||||||||||||
| 170 | |||||||||||||||||||||||||||||||||||||||||||
| 171 | ## Private | ||||||||||||||||||||||||||||||||||||||||||
| 172 | '_caught_error' => 0, | ||||||||||||||||||||||||||||||||||||||||||
| 173 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 174 | |||||||||||||||||||||||||||||||||||||||||||
| 175 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 176 | |||||||||||||||||||||||||||||||||||||||||||
| 177 | =head2 CONSTRUCTOR | ||||||||||||||||||||||||||||||||||||||||||
| 178 | |||||||||||||||||||||||||||||||||||||||||||
| 179 | =over 4 | ||||||||||||||||||||||||||||||||||||||||||
| 180 | |||||||||||||||||||||||||||||||||||||||||||
| 181 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 182 | |||||||||||||||||||||||||||||||||||||||||||
| 183 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 184 | |||||||||||||||||||||||||||||||||||||||||||
| 185 | |||||||||||||||||||||||||||||||||||||||||||
| 186 | =item B< new([%args]) > | ||||||||||||||||||||||||||||||||||||||||||
| 187 | |||||||||||||||||||||||||||||||||||||||||||
| 188 | Create a new Mail. | ||||||||||||||||||||||||||||||||||||||||||
| 189 | |||||||||||||||||||||||||||||||||||||||||||
| 190 | The %args are specified as they would be in the B<set> method (see L</Fields>). | ||||||||||||||||||||||||||||||||||||||||||
| 191 | |||||||||||||||||||||||||||||||||||||||||||
| 192 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 193 | |||||||||||||||||||||||||||||||||||||||||||
| 194 | sub new | ||||||||||||||||||||||||||||||||||||||||||
| 195 | 2 | ▶ | { | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
new: called CC=3 SCAR=11.3
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||
| 196 | 2 | my ($obj, %args) = @_ ; | |||||||||||||||||||||||||||||||||||||||||
| 197 | |||||||||||||||||||||||||||||||||||||||||||
| 198 | 2 | ▶ | my $class = ref($obj) || $obj ; | ||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
ref $obj || $obj
MC/DC0%0/2
ref $obj || $obj
ref $obj
$obj
Truth table33%1/3
A || B
A= ref $objB= $obj
| |||||||||||||||||||||||||||||||||||||||||||
| 199 | |||||||||||||||||||||||||||||||||||||||||||
| 200 | # Create object | ||||||||||||||||||||||||||||||||||||||||||
| 201 | 2 | my $this = $class->SUPER::new(%args, | |||||||||||||||||||||||||||||||||||||||||
| 202 | 'requires' => [qw/Net::SMTP/], | ||||||||||||||||||||||||||||||||||||||||||
| 203 | 'registered' => [qw/application_entry catch_error_entry/], | ||||||||||||||||||||||||||||||||||||||||||
| 204 | 'feature_options' => \@OPTIONS, | ||||||||||||||||||||||||||||||||||||||||||
| 205 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 206 | |||||||||||||||||||||||||||||||||||||||||||
| 207 | |||||||||||||||||||||||||||||||||||||||||||
| 208 | ## If associated with an app, set options | ||||||||||||||||||||||||||||||||||||||||||
| 209 | 2 | my $app = $this->app ; | |||||||||||||||||||||||||||||||||||||||||
| 210 | 2 | ▶ | if ($app) | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 211 | { | ||||||||||||||||||||||||||||||||||||||||||
| 212 | ## Set options | ||||||||||||||||||||||||||||||||||||||||||
| 213 | 2 | $app->feature('Options')->append_options(\@OPTIONS) ; | |||||||||||||||||||||||||||||||||||||||||
| 214 | |||||||||||||||||||||||||||||||||||||||||||
| 215 | ## Update option defaults | ||||||||||||||||||||||||||||||||||||||||||
| 216 | 2 | $app->feature('Options')->defaults_from_obj($this, [keys %FIELDS]) ; | |||||||||||||||||||||||||||||||||||||||||
| 217 | } | ||||||||||||||||||||||||||||||||||||||||||
| 218 | |||||||||||||||||||||||||||||||||||||||||||
| 219 | |||||||||||||||||||||||||||||||||||||||||||
| 220 | 2 | return($this) ; | |||||||||||||||||||||||||||||||||||||||||
| 221 | } | ||||||||||||||||||||||||||||||||||||||||||
| 222 | |||||||||||||||||||||||||||||||||||||||||||
| 223 | |||||||||||||||||||||||||||||||||||||||||||
| 224 | |||||||||||||||||||||||||||||||||||||||||||
| 225 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 226 | |||||||||||||||||||||||||||||||||||||||||||
| 227 | =back | ||||||||||||||||||||||||||||||||||||||||||
| 228 | |||||||||||||||||||||||||||||||||||||||||||
| 229 | =head2 CLASS METHODS | ||||||||||||||||||||||||||||||||||||||||||
| 230 | |||||||||||||||||||||||||||||||||||||||||||
| 231 | =over 4 | ||||||||||||||||||||||||||||||||||||||||||
| 232 | |||||||||||||||||||||||||||||||||||||||||||
| 233 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 234 | |||||||||||||||||||||||||||||||||||||||||||
| 235 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 236 | |||||||||||||||||||||||||||||||||||||||||||
| 237 | |||||||||||||||||||||||||||||||||||||||||||
| 238 | #----------------------------------------------------------------------------- | ||||||||||||||||||||||||||||||||||||||||||
| 239 | |||||||||||||||||||||||||||||||||||||||||||
| 240 | =item B< init_class([%args]) > | ||||||||||||||||||||||||||||||||||||||||||
| 241 | |||||||||||||||||||||||||||||||||||||||||||
| 242 | Initialises the Mail object class variables. | ||||||||||||||||||||||||||||||||||||||||||
| 243 | |||||||||||||||||||||||||||||||||||||||||||
| 244 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 245 | |||||||||||||||||||||||||||||||||||||||||||
| 246 | sub init_class | ||||||||||||||||||||||||||||||||||||||||||
| 247 | 2 | ▶ | { | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
init_class: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||
| 248 | 2 | my $class = shift ; | |||||||||||||||||||||||||||||||||||||||||
| 249 | 2 | my (%args) = @_ ; | |||||||||||||||||||||||||||||||||||||||||
| 250 | |||||||||||||||||||||||||||||||||||||||||||
| 251 | # Add extra fields | ||||||||||||||||||||||||||||||||||||||||||
| 252 | 2 | $class->add_fields(\%FIELDS, \%args) ; | |||||||||||||||||||||||||||||||||||||||||
| 253 | |||||||||||||||||||||||||||||||||||||||||||
| 254 | # init class | ||||||||||||||||||||||||||||||||||||||||||
| 255 | 2 | $class->SUPER::init_class(%args) ; | |||||||||||||||||||||||||||||||||||||||||
| 256 | |||||||||||||||||||||||||||||||||||||||||||
| 257 | } | ||||||||||||||||||||||||||||||||||||||||||
| 258 | |||||||||||||||||||||||||||||||||||||||||||
| 259 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 260 | |||||||||||||||||||||||||||||||||||||||||||
| 261 | =back | ||||||||||||||||||||||||||||||||||||||||||
| 262 | |||||||||||||||||||||||||||||||||||||||||||
| 263 | =head2 OBJECT METHODS | ||||||||||||||||||||||||||||||||||||||||||
| 264 | |||||||||||||||||||||||||||||||||||||||||||
| 265 | =over 4 | ||||||||||||||||||||||||||||||||||||||||||
| 266 | |||||||||||||||||||||||||||||||||||||||||||
| 267 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 268 | |||||||||||||||||||||||||||||||||||||||||||
| 269 | #============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 270 | |||||||||||||||||||||||||||||||||||||||||||
| 271 | |||||||||||||||||||||||||||||||||||||||||||
| 272 | #-------------------------------------------------------------------------------------------- | ||||||||||||||||||||||||||||||||||||||||||
| 273 | |||||||||||||||||||||||||||||||||||||||||||
| 274 | =item B< mail($content [, %args]) > | ||||||||||||||||||||||||||||||||||||||||||
| 275 | |||||||||||||||||||||||||||||||||||||||||||
| 276 | Send some mail stored in $content. $content may either be a string (containing newlines), or an | ||||||||||||||||||||||||||||||||||||||||||
| 277 | ARRAY ref. | ||||||||||||||||||||||||||||||||||||||||||
| 278 | |||||||||||||||||||||||||||||||||||||||||||
| 279 | Optionally %args may be specified (to set 'subject' etc). | ||||||||||||||||||||||||||||||||||||||||||
| 280 | |||||||||||||||||||||||||||||||||||||||||||
| 281 | If no arguments are specified then just returns the mail object. | ||||||||||||||||||||||||||||||||||||||||||
| 282 | |||||||||||||||||||||||||||||||||||||||||||
| 283 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 284 | |||||||||||||||||||||||||||||||||||||||||||
| 285 | sub mail | ||||||||||||||||||||||||||||||||||||||||||
| 286 | 12 | ▶ | { | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
mail: called CC=11 SCAR=46.3
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||
| 287 | 12 | my $this = shift ; | |||||||||||||||||||||||||||||||||||||||||
| 288 | 12 | my ($content, %args) = @_ ; | |||||||||||||||||||||||||||||||||||||||||
| 289 | |||||||||||||||||||||||||||||||||||||||||||
| 290 | 12 | ▶ | return $this unless $content ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 291 | |||||||||||||||||||||||||||||||||||||||||||
| 292 | 0 | $this->_dbg_prt(["mail() : content=\"$content\"\n"]) ; | |||||||||||||||||||||||||||||||||||||||||
| 293 | |||||||||||||||||||||||||||||||||||||||||||
| 294 | 0 | $this->set(%args) ; | |||||||||||||||||||||||||||||||||||||||||
| 295 | |||||||||||||||||||||||||||||||||||||||||||
| 296 | 0 | my $from = $this->from ; | |||||||||||||||||||||||||||||||||||||||||
| 297 | 0 | my $mail_to = $this->to ; | |||||||||||||||||||||||||||||||||||||||||
| 298 | 0 | my $subject = $this->subject ; | |||||||||||||||||||||||||||||||||||||||||
| 299 | 0 | my $host = $this->host ; | |||||||||||||||||||||||||||||||||||||||||
| 300 | |||||||||||||||||||||||||||||||||||||||||||
| 301 | |||||||||||||||||||||||||||||||||||||||||||
| 302 | ## error check | ||||||||||||||||||||||||||||||||||||||||||
| 303 | 0 | ▶ | $this->throw_fatal("Mail: not specified 'from' field") unless $from ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 304 | 0 | ▶ | $this->throw_fatal("Mail: not specified 'to' field") unless $mail_to ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 305 | 0 | ▶ | $this->throw_fatal("Mail: not specified 'host' field") unless $host ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 306 | |||||||||||||||||||||||||||||||||||||||||||
| 307 | 0 | my @content ; | |||||||||||||||||||||||||||||||||||||||||
| 308 | 0 | ▶ | if (ref($content) eq 'ARRAY') | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||
| 309 | { | ||||||||||||||||||||||||||||||||||||||||||
| 310 | 0 | @content = @$content ; | |||||||||||||||||||||||||||||||||||||||||
| 311 | } | ||||||||||||||||||||||||||||||||||||||||||
| 312 | elsif (!ref($content)) | ||||||||||||||||||||||||||||||||||||||||||
| 313 | { | ||||||||||||||||||||||||||||||||||||||||||
| 314 | 0 | @content = split /\n/, $content ; | |||||||||||||||||||||||||||||||||||||||||
| 315 | } | ||||||||||||||||||||||||||||||||||||||||||
| 316 | |||||||||||||||||||||||||||||||||||||||||||
| 317 | ## For each recipient, need to send a separate mail | ||||||||||||||||||||||||||||||||||||||||||
| 318 | 0 | my @to = split /,/, $mail_to ; | |||||||||||||||||||||||||||||||||||||||||
| 319 | 0 | foreach my $to (@to) | |||||||||||||||||||||||||||||||||||||||||
| 320 | { | ||||||||||||||||||||||||||||||||||||||||||
| 321 | 0 | my $smtp = Net::SMTP->new($host); # connect to an SMTP server | |||||||||||||||||||||||||||||||||||||||||
| 322 | 0 | ▶ | $this->throw_fatal("Mail: unable to connect to '$host'") unless $smtp ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 323 | |||||||||||||||||||||||||||||||||||||||||||
| 324 | 0 | $smtp->mail($from); # use the sender's address here | |||||||||||||||||||||||||||||||||||||||||
| 325 | 0 | $smtp->to($to); # recipient's address | |||||||||||||||||||||||||||||||||||||||||
| 326 | 0 | $smtp->data(); # Start the mail | |||||||||||||||||||||||||||||||||||||||||
| 327 | |||||||||||||||||||||||||||||||||||||||||||
| 328 | # Send the header. | ||||||||||||||||||||||||||||||||||||||||||
| 329 | 0 | $smtp->datasend("To: $mail_to\n"); | |||||||||||||||||||||||||||||||||||||||||
| 330 | 0 | $smtp->datasend("From: $from\n"); | |||||||||||||||||||||||||||||||||||||||||
| 331 | 0 | ▶ | $smtp->datasend("Subject: $subject\n") if $subject ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 332 | |||||||||||||||||||||||||||||||||||||||||||
| 333 | # Send the body. | ||||||||||||||||||||||||||||||||||||||||||
| 334 | 0 | $smtp->datasend("$_\n") foreach (@content) ; | |||||||||||||||||||||||||||||||||||||||||
| 335 | |||||||||||||||||||||||||||||||||||||||||||
| 336 | 0 | $smtp->dataend(); # Finish sending the mail | |||||||||||||||||||||||||||||||||||||||||
| 337 | 0 | $smtp->quit; # Close the SMTP connection | |||||||||||||||||||||||||||||||||||||||||
| 338 | } | ||||||||||||||||||||||||||||||||||||||||||
| 339 | } | ||||||||||||||||||||||||||||||||||||||||||
| 340 | |||||||||||||||||||||||||||||||||||||||||||
| 341 | #---------------------------------------------------------------------------- | ||||||||||||||||||||||||||||||||||||||||||
| 342 | |||||||||||||||||||||||||||||||||||||||||||
| 343 | =item B< Mail([%args]) > | ||||||||||||||||||||||||||||||||||||||||||
| 344 | |||||||||||||||||||||||||||||||||||||||||||
| 345 | Alias to L</mail> | ||||||||||||||||||||||||||||||||||||||||||
| 346 | |||||||||||||||||||||||||||||||||||||||||||
| 347 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 348 | |||||||||||||||||||||||||||||||||||||||||||
| 349 | 2 | *Mail = \&mail ; | |||||||||||||||||||||||||||||||||||||||||
| 350 | |||||||||||||||||||||||||||||||||||||||||||
| 351 | |||||||||||||||||||||||||||||||||||||||||||
| 352 | #---------------------------------------------------------------------------- | ||||||||||||||||||||||||||||||||||||||||||
| 353 | |||||||||||||||||||||||||||||||||||||||||||
| 354 | =item B<application_entry()> | ||||||||||||||||||||||||||||||||||||||||||
| 355 | |||||||||||||||||||||||||||||||||||||||||||
| 356 | Called by the application framework at the start of the application. | ||||||||||||||||||||||||||||||||||||||||||
| 357 | |||||||||||||||||||||||||||||||||||||||||||
| 358 | This method checks for the user specifying any of the options described above (see L</ADDITIONAL COMMAND LINE OPTIONS>) and handles | ||||||||||||||||||||||||||||||||||||||||||
| 359 | them if so. | ||||||||||||||||||||||||||||||||||||||||||
| 360 | |||||||||||||||||||||||||||||||||||||||||||
| 361 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 362 | |||||||||||||||||||||||||||||||||||||||||||
| 363 | |||||||||||||||||||||||||||||||||||||||||||
| 364 | sub application_entry | ||||||||||||||||||||||||||||||||||||||||||
| 365 | 1 | ▶ | { | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
application_entry: called CC=3 SCAR=12.3
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||
| 366 | 1 | my $this = shift ; | |||||||||||||||||||||||||||||||||||||||||
| 367 | |||||||||||||||||||||||||||||||||||||||||||
| 368 | 1 | $this->_dbg_prt(["application_entry()\n"], 2) ; | |||||||||||||||||||||||||||||||||||||||||
| 369 | |||||||||||||||||||||||||||||||||||||||||||
| 370 | ## Handle special options | ||||||||||||||||||||||||||||||||||||||||||
| 371 | 1 | my $app = $this->app ; | |||||||||||||||||||||||||||||||||||||||||
| 372 | 1 | my %opts = $app->options() ; | |||||||||||||||||||||||||||||||||||||||||
| 373 | 1 | $this->_dbg_prt(["mail options=",\%opts], 2) ; | |||||||||||||||||||||||||||||||||||||||||
| 374 | |||||||||||||||||||||||||||||||||||||||||||
| 375 | |||||||||||||||||||||||||||||||||||||||||||
| 376 | ## Map from options to object data | ||||||||||||||||||||||||||||||||||||||||||
| 377 | 1 | foreach my $opt_entry_aref (@OPTIONS) | |||||||||||||||||||||||||||||||||||||||||
| 378 | { | ||||||||||||||||||||||||||||||||||||||||||
| 379 | 6 | my $opt = $opt_entry_aref->[0] ; | |||||||||||||||||||||||||||||||||||||||||
| 380 | 6 | ▶ | if ($opts{$opt}) | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 381 | { | ||||||||||||||||||||||||||||||||||||||||||
| 382 | 0 | my $field = $opt ; | |||||||||||||||||||||||||||||||||||||||||
| 383 | 0 | $field =~ s/[-]/_/g ; | |||||||||||||||||||||||||||||||||||||||||
| 384 | 0 | $field =~ s/^mail\-// ; | |||||||||||||||||||||||||||||||||||||||||
| 385 | |||||||||||||||||||||||||||||||||||||||||||
| 386 | 0 | $this->set($field => $opts{$opt}) ; | |||||||||||||||||||||||||||||||||||||||||
| 387 | } | ||||||||||||||||||||||||||||||||||||||||||
| 388 | } | ||||||||||||||||||||||||||||||||||||||||||
| 389 | } | ||||||||||||||||||||||||||||||||||||||||||
| 390 | |||||||||||||||||||||||||||||||||||||||||||
| 391 | |||||||||||||||||||||||||||||||||||||||||||
| 392 | #-------------------------------------------------------------------------------------------- | ||||||||||||||||||||||||||||||||||||||||||
| 393 | |||||||||||||||||||||||||||||||||||||||||||
| 394 | =item B< catch_error_entry($error) > | ||||||||||||||||||||||||||||||||||||||||||
| 395 | |||||||||||||||||||||||||||||||||||||||||||
| 396 | Send some mail stored in $content. $content may either be a string (containing newlines), or an | ||||||||||||||||||||||||||||||||||||||||||
| 397 | ARRAY ref. | ||||||||||||||||||||||||||||||||||||||||||
| 398 | |||||||||||||||||||||||||||||||||||||||||||
| 399 | Optionally %args may be specified (to set 'subject' etc) | ||||||||||||||||||||||||||||||||||||||||||
| 400 | |||||||||||||||||||||||||||||||||||||||||||
| 401 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 402 | |||||||||||||||||||||||||||||||||||||||||||
| 403 | sub catch_error_entry | ||||||||||||||||||||||||||||||||||||||||||
| 404 | 0 | ▶ | { | ||||||||||||||||||||||||||||||||||||||||
|
Subroutine
catch_error_entry: not called CC=12 SCAR=50.5
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||
| 405 | 0 | my $this = shift ; | |||||||||||||||||||||||||||||||||||||||||
| 406 | 0 | my ($error) = @_ ; | |||||||||||||||||||||||||||||||||||||||||
| 407 | |||||||||||||||||||||||||||||||||||||||||||
| 408 | ## skip if already inside an error | ||||||||||||||||||||||||||||||||||||||||||
| 409 | 0 | ▶ | return if $this->_caught_error ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 410 | |||||||||||||||||||||||||||||||||||||||||||
| 411 | 0 | my $from = $this->from ; | |||||||||||||||||||||||||||||||||||||||||
| 412 | 0 | my $error_to = $this->error_to ; | |||||||||||||||||||||||||||||||||||||||||
| 413 | 0 | my $app = $this->app ; | |||||||||||||||||||||||||||||||||||||||||
| 414 | |||||||||||||||||||||||||||||||||||||||||||
| 415 | 0 | $this->_dbg_prt(["catch_error_entry() : from=$from error-to=$error_to app=$app\n"]) ; | |||||||||||||||||||||||||||||||||||||||||
| 416 | 0 | $this->_dbg_prt(["error=", $error], 5) ; | |||||||||||||||||||||||||||||||||||||||||
| 417 | |||||||||||||||||||||||||||||||||||||||||||
| 418 | # skip if required fields not set | ||||||||||||||||||||||||||||||||||||||||||
| 419 | 0 | ▶ | return unless $from && $error_to && $app ; | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/6
$from and $error_to and $app
$from and $error_to
MC/DC0%0/3
$from and $error_to and $app
$from
$error_to
$app
Truth table0%0/4
A and B and C
A= $fromB= $error_toC= $app
| |||||||||||||||||||||||||||||||||||||||||||
| 420 | |||||||||||||||||||||||||||||||||||||||||||
| 421 | 0 | my $appname = $app->name ; | |||||||||||||||||||||||||||||||||||||||||
| 422 | 0 | my $level = $this->err_level ; | |||||||||||||||||||||||||||||||||||||||||
| 423 | |||||||||||||||||||||||||||||||||||||||||||
| 424 | 0 | $this->_dbg_prt(["mail level=$level, app=$appname\n"]) ; | |||||||||||||||||||||||||||||||||||||||||
| 425 | |||||||||||||||||||||||||||||||||||||||||||
| 426 | ## See if we mail it | ||||||||||||||||||||||||||||||||||||||||||
| 427 | 0 | my ($msg, $exitcode, $error_type) ; | |||||||||||||||||||||||||||||||||||||||||
| 428 | |||||||||||||||||||||||||||||||||||||||||||
| 429 | # If it's an error, mail it | ||||||||||||||||||||||||||||||||||||||||||
| 430 | 0 | ▶ | if ($this->is_error($error)) | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 431 | { | ||||||||||||||||||||||||||||||||||||||||||
| 432 | 0 | ($msg, $exitcode) = $this->error_split($error) ; | |||||||||||||||||||||||||||||||||||||||||
| 433 | 0 | $error_type = "fatal error" ; | |||||||||||||||||||||||||||||||||||||||||
| 434 | } | ||||||||||||||||||||||||||||||||||||||||||
| 435 | 0 | ▶ | if ($this->is_warning($error) && (($level eq 'warning') || ($level eq 'note'))) | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/6
$this->is_warning($error) and $level eq "warning" || $level eq "note"
$level eq "warning" or $level eq "note"
MC/DC0%0/3
$this->is_warning($error) and $level eq "warning" || $level eq "note"
$this->is_warning($error)
$level eq "warning"
$level eq "note"
Truth table0%0/4
A and B or C
A= $this->is_warning($error)B= $level eq "warning"C= $level eq "note"
| |||||||||||||||||||||||||||||||||||||||||||
| 436 | { | ||||||||||||||||||||||||||||||||||||||||||
| 437 | 0 | ($msg, $exitcode) = $this->error_split($error) ; | |||||||||||||||||||||||||||||||||||||||||
| 438 | 0 | $error_type = "warning" ; | |||||||||||||||||||||||||||||||||||||||||
| 439 | } | ||||||||||||||||||||||||||||||||||||||||||
| 440 | 0 | ▶ | if ( $this->is_note($error) && ($level eq 'note') ) | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$this->is_note($error) and $level eq "note"
MC/DC0%0/2
$this->is_note($error) and $level eq "note"
$this->is_note($error)
$level eq "note"
Truth table0%0/3
A and B
A= $this->is_note($error)B= $level eq "note"
| |||||||||||||||||||||||||||||||||||||||||||
| 441 | { | ||||||||||||||||||||||||||||||||||||||||||
| 442 | 0 | ($msg, $exitcode) = $this->error_split($error) ; | |||||||||||||||||||||||||||||||||||||||||
| 443 | 0 | $error_type = "note" ; | |||||||||||||||||||||||||||||||||||||||||
| 444 | } | ||||||||||||||||||||||||||||||||||||||||||
| 445 | |||||||||||||||||||||||||||||||||||||||||||
| 446 | 0 | $this->_dbg_prt(["type=$error_type, exit=$exitcode, msg=\"$msg\"\n"]) ; | |||||||||||||||||||||||||||||||||||||||||
| 447 | |||||||||||||||||||||||||||||||||||||||||||
| 448 | 0 | ▶ | if ($msg) | ||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||
| 449 | { | ||||||||||||||||||||||||||||||||||||||||||
| 450 | 0 | $this->_caught_error(1) ; | |||||||||||||||||||||||||||||||||||||||||
| 451 | 0 | my $orig_to = $this->to ; | |||||||||||||||||||||||||||||||||||||||||
| 452 | 0 | $this->mail( | |||||||||||||||||||||||||||||||||||||||||
| 453 | $msg, | ||||||||||||||||||||||||||||||||||||||||||
| 454 | 'to' => $error_to, | ||||||||||||||||||||||||||||||||||||||||||
| 455 | 'subject' => "$appname $error_type", | ||||||||||||||||||||||||||||||||||||||||||
| 456 | ) ; | ||||||||||||||||||||||||||||||||||||||||||
| 457 | 0 | $this->to($orig_to) ; | |||||||||||||||||||||||||||||||||||||||||
| 458 | 0 | $this->_caught_error(0) ; | |||||||||||||||||||||||||||||||||||||||||
| 459 | } | ||||||||||||||||||||||||||||||||||||||||||
| 460 | } | ||||||||||||||||||||||||||||||||||||||||||
| 461 | |||||||||||||||||||||||||||||||||||||||||||
| 462 | # ============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 463 | # PRIVATE METHODS | ||||||||||||||||||||||||||||||||||||||||||
| 464 | # ============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 465 | |||||||||||||||||||||||||||||||||||||||||||
| 466 | |||||||||||||||||||||||||||||||||||||||||||
| 467 | # ============================================================================================ | ||||||||||||||||||||||||||||||||||||||||||
| 468 | # END OF PACKAGE | ||||||||||||||||||||||||||||||||||||||||||
| 469 | |||||||||||||||||||||||||||||||||||||||||||
| 470 | =back | ||||||||||||||||||||||||||||||||||||||||||
| 471 | |||||||||||||||||||||||||||||||||||||||||||
| 472 | =head1 DIAGNOSTICS | ||||||||||||||||||||||||||||||||||||||||||
| 473 | |||||||||||||||||||||||||||||||||||||||||||
| 474 | Setting the debug flag to level 1 prints out (to STDOUT) some debug messages, setting it to level 2 prints out more verbose messages. | ||||||||||||||||||||||||||||||||||||||||||
| 475 | |||||||||||||||||||||||||||||||||||||||||||
| 476 | =head1 AUTHOR | ||||||||||||||||||||||||||||||||||||||||||
| 477 | |||||||||||||||||||||||||||||||||||||||||||
| 478 | Steve Price C<< <sdprice at cpan.org> >> | ||||||||||||||||||||||||||||||||||||||||||
| 479 | |||||||||||||||||||||||||||||||||||||||||||
| 480 | =head1 BUGS | ||||||||||||||||||||||||||||||||||||||||||
| 481 | |||||||||||||||||||||||||||||||||||||||||||
| 482 | None that I know of! | ||||||||||||||||||||||||||||||||||||||||||
| 483 | |||||||||||||||||||||||||||||||||||||||||||
| 484 | =cut | ||||||||||||||||||||||||||||||||||||||||||
| 485 | |||||||||||||||||||||||||||||||||||||||||||
| 486 | 2 | 1; | |||||||||||||||||||||||||||||||||||||||||
| 487 | |||||||||||||||||||||||||||||||||||||||||||
| 488 | __END__ | ||||||||||||||||||||||||||||||||||||||||||