From 6ed109914cfd6e0fb5e9add0bbce7d4ac3ab3e64 Mon Sep 17 00:00:00 2001 From: Jonathan Hall Date: Mon, 15 Sep 2014 12:51:08 -0500 Subject: [PATCH] POD updates, corrections, and clarifications. --- docs/hooks.pod | 20 ++++++++++---------- lib/Qpsmtpd/Address.pm | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/hooks.pod b/docs/hooks.pod index 3c7b6f6..36ec59c 100644 --- a/docs/hooks.pod +++ b/docs/hooks.pod @@ -712,20 +712,20 @@ Allowed return codes are plugin didn't find the requested value -=item OK +=item OK, @values requested values as C<@list>, example: - return (OK, @{$config{$value}}) - if exists $config{$value}; + return (OK, @{$config{$key}}) + if exists $config{$key}; return (DECLINED); =back Arguments: - my ($self,$transaction,$value) = @_; - # $value: the requested config item(s) + my ($self,$transaction,$key) = @_; + # $key: the requested config item(s) B C<$transaction> may be C, depending when / where this hook is called. It's probably best not to try acessing it. @@ -744,20 +744,20 @@ Allowed return codes are plugin didn't find the requested value -=item OK +=item OK, @values requested values as C<@list>, example: - return (OK, @{$config{$value}}) - if exists $config{$value}; + return (OK, @{$config{$key}}) + if exists $config{$key}; return (DECLINED); =back Arguments: - my ($self,$transaction,$user,$value) = @_; - # $value: the requested config item(s) + my ($self,$transaction,$user,$key) = @_; + # $key: the requested config item(s) Example plugin is F from the qpsmtpd distribution. diff --git a/lib/Qpsmtpd/Address.pm b/lib/Qpsmtpd/Address.pm index 5e25813..50aa6e2 100644 --- a/lib/Qpsmtpd/Address.pm +++ b/lib/Qpsmtpd/Address.pm @@ -341,7 +341,7 @@ sub notes { =head2 config($value) Looks up a configuration directive based on this recipient, using any plugins that utilize -hook_rcpt_config +hook_user_config =cut