.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Dist::Zilla::Plugin::EmailNotify 3pm" .TH Dist::Zilla::Plugin::EmailNotify 3pm "2016-01-22" "perl v5.22.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Dist::Zilla::Plugin::EmailNotify \- send an email on dist release .SH "VERSION" .IX Header "VERSION" version 0.004 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This plugin allows one to send an email when releasing. .SH "FIELDS" .IX Header "FIELDS" .SS "from" .IX Subsection "from" Who is sending the email? .PP .Vb 2 \& [EmailNotify] \& from = xsawyerx@cpan.org .Ve .SS "recipient" .IX Subsection "recipient" Multiple single recipients. These will compose the 'to' field. .PP .Vb 3 \& [EmailNotify] \& recipient = jack@myemail.com \& recipient = jill@myemail.com .Ve .SS "to" .IX Subsection "to" Direct recipients string. This should be comma separated. .PP .Vb 2 \& [EmailNotify] \& to = jack@myemail.com, jill@myemail.com .Ve .SS "cc" .IX Subsection "cc" Any \s-1CC\s0 you may want. This should be comma separated. .PP .Vb 2 \& [EmailNotify] \& cc = myboss@myemail.com, jacksboss@myemail.com .Ve .SS "bcc" .IX Subsection "bcc" Any \s-1BCC\s0 you may want. This should be comma separated. .PP .Vb 2 \& [EmailNotify] \& bcc = topgun@myemail.com .Ve .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "to(Str)" .IX Subsection "to(Str)" The 'to' email field. .SS "recipient(ArrayRef[Str])" .IX Subsection "recipient(ArrayRef[Str])" This array reference of strings will be used to compose the 'to' email field. .PP It is used in case you want to comfortably write down the recipients instead of one long string. This is not provided for other fields. .SS "from(Str)" .IX Subsection "from(Str)" The 'from' email field. .SS "cc(Str)" .IX Subsection "cc(Str)" The 'cc' email field. .SS "bcc(Str)" .IX Subsection "bcc(Str)" The 'bcc' email field. .SH "METHODS/SUBROUTINES" .IX Header "METHODS/SUBROUTINES" .SS "after_release" .IX Subsection "after_release" Method to actually send the email right after the 'release' process. Takes all the arguments, creates a body message text using last change log entry and sends the email using Email::Stuff. .SS "_build_to" .IX Subsection "_build_to" Builder to take all the recipient attribute values and create a single string. .SS "mvp_multivalue_args" .IX Subsection "mvp_multivalue_args" Internal, Config::MVP related. Creates a multivalue argument. .SH "AUTHOR" .IX Header "AUTHOR" Sawyer X .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2016 by Sawyer X. .PP This is free software, licensed under: .PP .Vb 1 \& The MIT (X11) License .Ve