view release on metacpan or  search on metacpan

Mercury/UserManager.pm  view on Meta::CPAN

Your userprofile() method can support more; which you can
then make use of in a custom Display class, for example.
You can also opt to make your userprofile() method read-write,
and then make use of it elsewhere in your application.
The only requirements of Apache::App::Mercury is it should
return valid values for the above params for the currently
logged-in user.

=cut
sub userprofile($) {}

=item * get_userinfo(@users)

Get user profile information on users that exist in the application
(but not necessarily logged in at the moment).  Input is a list of
valid user names in your application.  Output should be an array of
hashrefs, one for each of @users, (minimally) of the following structure:

  { user  => 'userid',
    fname => 'First name of user',
    mname => 'Middle name or initial of user', #optional
    lname => 'Last name of user',
    e_mail => 'email@forward.to.addr' }

=cut
sub get_userinfo(@) {}

=item * mailboxes($user, [@update_boxes])

Get a list of $user's custom-defined mailboxes, or if called in
set context sets the given user's custom-defined mailboxes to
those specified in @update_boxes.  If called in set context,
return 1 for success, undef on failure.

=cut
sub mailboxes($@) {}

=item * mail_trans_filter([$trans_box])

Get name of mailbox to send transaction-related msgs to for current user.
In set context (if $trans_box is given), sets mailbox to filter
transaction-related msgs to.  Returns 1 for success, undef on failure.

Expects the calling object to know what user is logged in,
and the mail_trans_filter() method to have access to that information.

Mercury/UserManager.pm  view on Meta::CPAN

Return value is one of "message", "notify", or "none".

  "message" => "send the entire message",
  "notify"  => "send a notification",
  "none"    => "do not send anything"

Expects the calling object to know what user is logged in,
and the auto_forward() method to have access to that information.

=cut
sub auto_forward($) {}


1;
__END__

=head1 AUTHOR

Adi Fairbank <adi@adiraj.org>

=head1 COPYRIGHT