WWW::Postini::Constants - Exportable constants for use with WWW::Postini

WWW-Postini documentation Contained in the WWW-Postini distribution.

Index

Code Index:

NAME

Top

WWW::Postini::Constants - Exportable constants for use with WWW::Postini

SYNOPSIS

Top

  use WWW::Postini::Constants ':all';

DESCRIPTION

Top

The WWW::Postini::Constants module contains a collection of constants intended for use with WWW::Postini. This single module approach is taken for the sake of consistency.

CONSTANTS

Top

Message searching

These constants are intended for use with the show parameter of the list_messages() method in WWW::Postini.

SHOW_ALL

Show all messages

SHOW_QUARANTINED

Show only quarantined messages

SHOW_DELIVERED

Show messages which have already been delivered

SHOW_DELETED

Show deleted messages

Message sorting

These constants are intended for use with the sort parameter of the list_messages() method in WWW::Postini.

SORT_NONE

Do not sort messages

SORT_RECIPIENT

Sort by recipient

SORT_SENDER

Sort by sender

SORT_SUBJECT

Sort by subject

SORT_FILTER

Sort by filter

Message recipient

These constants are intended for use with the recipient parameter of the list_messages() method in WWW::Postini.

RECIPIENT_USER

Set recipient to the original user

RECIPIENT_ADMIN

Set recipient to the administrator

EXPORTS

Top

By default, nothing is exported from this module. Constants may be imported individually or via the provided export groups below.

:all

Exports all constants

:show

Exports all SHOW_ constants

:sort

Exports all SORT_ constants

:recipient

Exports all RECIPIENT_ constants

SEE ALSO

Top

WWW::Postini

AUTHOR

Top

Peter Guzis, <pguzis@cpan.org>

COPYRIGHT AND LICENSE

Top

Copyright (C) 2005 by Peter Guzis

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.

Postini, the Postini logo, Postini Perimeter Manager and preEMPT are trademarks, registered trademarks or service marks of Postini, Inc. All other trademarks are the property of their respective owners.

WWW-Postini documentation Contained in the WWW-Postini distribution. 
package WWW::Postini::Constants;

use strict;
use warnings;

use Exporter;

use vars qw( @ISA @EXPORT_OK %EXPORT_TAGS $VERSION );

use constant SHOW_ALL          => 0;
use constant SHOW_QUARANTINED  => 1;
use constant SHOW_DELIVERED    => 2;
use constant SHOW_DELETED      => 3;

use constant SORT_NONE         => 0;
use constant SORT_RECIPIENT    => 1;
use constant SORT_SENDER       => 3;
use constant SORT_SUBJECT      => 4;
use constant SORT_FILTER       => 5;

use constant RECIPIENT_USER    => 0;
use constant RECIPIENT_ADMIN   => 1;

$VERSION = '0.01';

@ISA = qw( Exporter );

@EXPORT_OK = qw(
	SHOW_ALL
	SHOW_QUARANTINED
	SHOW_DELIVERED
	SHOW_DELETED
	
	SORT_NONE
	SORT_RECIPIENT
	SORT_SENDER
	SORT_SUBJECT
	SORT_FILTER
	
	RECIPIENT_USER
	RECIPIENT_ADMIN
);

%EXPORT_TAGS = (
	'all'  => [qw(
		SHOW_ALL
		SHOW_QUARANTINED
		SHOW_DELIVERED
		SHOW_DELETED
		SORT_NONE
		SORT_RECIPIENT
		SORT_SENDER
		SORT_SUBJECT
		SORT_FILTER
		RECIPIENT_USER
		RECIPIENT_ADMIN
	)],
	'show' => [qw(
		SHOW_ALL
		SHOW_QUARANTINED
		SHOW_DELIVERED
		SHOW_DELETED
	)],
	'sort' => [qw(
		SORT_NONE
		SORT_RECIPIENT
		SORT_SUBJECT
		SORT_FILTER
	)],
	'recipient' => [qw(
		RECIPIENT_USER
		RECIPIENT_ADMIN
	)]
);

1;

__END__