[Bps-public-commit] RT-Extension-CommandByMail branch, 4.4/updates-for-44, updated. 1.00-11-gc90edf5

Jim Brandt jbrandt at bestpractical.com
Wed Apr 6 14:06:49 EDT 2016


The branch, 4.4/updates-for-44 has been updated
       via  c90edf56e720379e2c1f77615578eb5b0036a625 (commit)
       via  65a81d25ed3aafa463e3688a9d2b93f342423e7a (commit)
       via  68a7fda36185a0319719b22a428e0b915e075602 (commit)
      from  cf5bb67b8c6f8660ad1e7d2184219950b834d615 (commit)

Summary of changes:
 Changes                           |  2 ++
 META.yml                          |  2 +-
 README                            | 47 +++++++++++++++++---------------
 lib/RT/Extension/CommandByMail.pm | 56 +++++++++++++++++++++------------------
 4 files changed, 59 insertions(+), 48 deletions(-)

- Log -----------------------------------------------------------------
commit 68a7fda36185a0319719b22a428e0b915e075602
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Wed Apr 6 13:58:01 2016 -0400

    Clarify header parsing features
    
    The previous documentation implied that the extension looked
    equally at headers and the email body for possible commands
    to process. However, the extent of header parsing is scoped to
    defining a specific header and then toggling whether you want the
    email body to also be parsed or not when using that header. This
    commit clarifies the functionality.

diff --git a/README b/README
index 1450297..177138a 100644
--- a/README
+++ b/README
@@ -56,8 +56,30 @@ INSTALLATION
 
     Restart your webserver
 
+CONFIGURATION
+    In addition to adding the configuration above to activate the extension
+    in RT, the following options are available.
+
+  $CommandByMailGroup
+    You may set a $CommandByMailGroup to a particular group ID in
+    RT_SiteConfig. If set, only members of this group may perform commands
+    by mail.
+
+  $CommandByMailHeader
+    You may set this configuration value to the name of a header to examine
+    as well. For example:
+
+        Set($CommandByMailHeader, "X-RT-Command");
+
+  $CommandByMailOnlyHeaders
+    If set, the body will not be examined, only the header defined by the
+    previous configuration option.
+
+CAVEATS
+    This extension is incompatible with UnsafeEmailCommands RT option.
+
 DESCRIPTION
-    This extension allows you to manage tickets via email interface. You may
+    This extension allows you to manage ticket metadata via email. You may
     put commands into the beginning of an email, and the extension will
     apply them. The list of commands is detailed below.
 
@@ -66,8 +88,9 @@ DESCRIPTION
     also currently expects and parses text, not HTML.
 
   FORMAT
-    This extension parses the body and headers of incoming messages for list
-    commands. Format of commands is:
+    This extension parses the body, and optionally a header, in incoming
+    messages for commands to update ticket metadata. The format of commands
+    is:
 
         Command: value
         Command: value
@@ -174,24 +197,6 @@ SECURITY
     This extension has no extended auth system; so all security issues that
     apply to the RT in general also apply to the extension.
 
-CONFIGURATION
-  $CommandByMailGroup
-    You may set a $CommandByMailGroup to a particular group ID in
-    RT_SiteConfig. If set, only members of this group may perform commands
-    by mail.
-
-  $CommandByMailHeader
-    You may set this configuration value to the name of a header to examine
-    as well. For example:
-
-        Set($CommandByMailHeader, "X-RT-Command");
-
-  $CommandByMailOnlyHeaders
-    If set, the body will not be examined, only the headers.
-
-CAVEATS
-    This extension is incompatible with UnsafeEmailCommands RT option.
-
 METHODS
   ProcessCommands
     This method provides the main email processing functionality. It
diff --git a/lib/RT/Extension/CommandByMail.pm b/lib/RT/Extension/CommandByMail.pm
index e29a34f..b5b9360 100644
--- a/lib/RT/Extension/CommandByMail.pm
+++ b/lib/RT/Extension/CommandByMail.pm
@@ -83,9 +83,35 @@ For RT 4.4.0, apply the included patch:
 
 =back
 
+=head1 CONFIGURATION
+
+In addition to adding the configuration above to activate the extension in
+RT, the following options are available.
+
+=head2 C<$CommandByMailGroup>
+
+You may set a C<$CommandByMailGroup> to a particular group ID in RT_SiteConfig.
+If set, only members of this group may perform commands by mail.
+
+=head2 C<$CommandByMailHeader>
+
+You may set this configuration value to the name of a header to examine
+as well.  For example:
+
+    Set($CommandByMailHeader, "X-RT-Command");
+
+=head2 C<$CommandByMailOnlyHeaders>
+
+If set, the body will not be examined, only the header defined by the previous
+configuration option.
+
+=head1 CAVEATS
+
+This extension is incompatible with C<UnsafeEmailCommands> RT option.
+
 =head1 DESCRIPTION
 
-This extension allows you to manage tickets via email interface.  You
+This extension allows you to manage ticket metadata via email.  You
 may put commands into the beginning of an email, and the extension will apply
 them. The list of commands is detailed below.
 
@@ -95,8 +121,8 @@ also currently expects and parses text, not HTML.
 
 =head2 FORMAT
 
-This extension parses the body and headers of incoming messages for
-list commands. Format of commands is:
+This extension parses the body, and optionally a header, in incoming messages
+for commands to update ticket metadata. The format of commands is:
 
     Command: value
     Command: value
@@ -223,28 +249,6 @@ Short forms:
 This extension has no extended auth system; so all security issues that
 apply to the RT in general also apply to the extension.
 
-=head1 CONFIGURATION
-
-=head2 C<$CommandByMailGroup>
-
-You may set a C<$CommandByMailGroup> to a particular group ID in RT_SiteConfig.
-If set, only members of this group may perform commands by mail.
-
-=head2 C<$CommandByMailHeader>
-
-You may set this configuration value to the name of a header to examine
-as well.  For example:
-
-    Set($CommandByMailHeader, "X-RT-Command");
-
-=head2 C<$CommandByMailOnlyHeaders>
-
-If set, the body will not be examined, only the headers.
-
-=head1 CAVEATS
-
-This extension is incompatible with C<UnsafeEmailCommands> RT option.
-
 =head1 METHODS
 
 =head2 ProcessCommands

commit 65a81d25ed3aafa463e3688a9d2b93f342423e7a
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Wed Apr 6 14:05:48 2016 -0400

    Update perl version to 5.10.1, RT's minimum

diff --git a/META.yml b/META.yml
index bd4483a..e45f323 100644
--- a/META.yml
+++ b/META.yml
@@ -24,7 +24,7 @@ no_index:
   package:
     - RT::Extension::CommandByMail::Test
 requires:
-  perl: 5.8.3
+  perl: 5.10.1
 resources:
   license: http://opensource.org/licenses/gpl-license.php
 version: '2.00'
diff --git a/lib/RT/Extension/CommandByMail.pm b/lib/RT/Extension/CommandByMail.pm
index b5b9360..5f02a6f 100644
--- a/lib/RT/Extension/CommandByMail.pm
+++ b/lib/RT/Extension/CommandByMail.pm
@@ -1,4 +1,4 @@
-use 5.008003;
+use 5.10.1;
 package RT::Extension::CommandByMail;
 
 use RT::Interface::Email qw(ParseCcAddressesFromHead);

commit c90edf56e720379e2c1f77615578eb5b0036a625
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Wed Apr 6 14:06:41 2016 -0400

    Update changes

diff --git a/Changes b/Changes
index 88eb993..22468d0 100644
--- a/Changes
+++ b/Changes
@@ -1,5 +1,7 @@
 2.00 2016-03-29
  - Refactor to add support for RT 4.4
+ - Update docs to clarify header handling
+ - Update perl minimum version to 5.10.1
 
 1.00 2014-12-15
  - Packaging and documentation updates

-----------------------------------------------------------------------


More information about the Bps-public-commit mailing list