Email
[ class tree: Email ] [ index: Email ] [ all elements ]
Packages:
apnscp_esprit
Admin
Aliases
Auth
Backup
Bandwidth
Billing
Common
CRM
Crontab
Demo
DNS
Email
File
Logs
Majordomo
Miscellaneous
Monitor
One-Click
Oneclick
Site
SQL
Statistics
Urchin
User
Version
Web


Files:
email.php

Classes:
Email_Module

Class: Email_Module

Source Location: /email.php

Class Overview

Module_Skeleton
   |
   --Email_Module

Variables

Constants

Methods

Class Details

[line 8]


[ Top ]

Class Variables

$mysql =

[line 9]



Tags:

access:  public

Type:   mixed


[ Top ]

$pgsql =

[line 10]



Tags:

access:  public

Type:   mixed


[ Top ]


Class Methods

method address_exists [line 86]

void address_exists( $mAlias, $mDomain)



Tags:

access:  public


Parameters:

   $mAlias  
   $mDomain  

[ Top ]

method add_alias [line 143]

void add_alias( $mUser, $mDomain, $mDestination)



Tags:

access:  public


Parameters:

   $mUser  
   $mDomain  
   $mDestination  

[ Top ]

method add_mailbox [line 212]

void add_mailbox( $mUser, $mDomain, $mUID, $mCustomBox)



Tags:

access:  public


Parameters:

   $mUser  
   $mDomain  
   $mUID  
   $mCustomBox  

[ Top ]

method add_vacation [line 329]

void add_vacation( $mResponse, [ $mUser = NULL])



Tags:

access:  public


Parameters:

   $mResponse  
   $mUser  

[ Top ]

method add_vacation_backend [line 360]

void add_vacation_backend( $mResponse, $mUser)



Tags:

access:  public


Parameters:

   $mResponse  
   $mUser  

[ Top ]

method add_virtual_transport [line 242]

void add_virtual_transport( $mDomain, [ $mSubdomain = NULL])



Tags:

access:  public


Parameters:

   $mDomain  
   $mSubdomain  

[ Top ]

method change_vacation_message [line 383]

void change_vacation_message( $mResponse, [ $mUser = NULL])



Tags:

access:  public


Parameters:

   $mResponse  
   $mUser  

[ Top ]

method change_vacation_message_backend [line 398]

void change_vacation_message_backend( $mResponse, $mUser)



Tags:

access:  public


Parameters:

   $mResponse  
   $mUser  

[ Top ]

method create_maildir_backend [line 231]

void create_maildir_backend( $mHome, $mMailbox)



Tags:

access:  public


Parameters:

   $mHome  
   $mMailbox  

[ Top ]

method disable_address [line 78]

void disable_address( $mAccount, [ $mDomain = NULL])



Tags:

access:  public


Parameters:

   $mAccount  
   $mDomain  

[ Top ]

method enable_address [line 70]

void enable_address( $mAccount, [ $mDomain = NULL])



Tags:

access:  public


Parameters:

   $mAccount  
   $mDomain  

[ Top ]

method get_mailbox [line 155]

void get_mailbox( $mUser, $mDomain)



Tags:

access:  public


Parameters:

   $mUser  
   $mDomain  

[ Top ]

method get_spool_size [line 300]

int get_spool_size( $mUsername $mUsername)

*

int get_spool_size (string)




Tags:

return:  size of the spool in bytes
privilege:  PRIVILEGE_SITE
access:  public


Parameters:

$mUsername   $mUsername   username of the spool; note well this differs from File_Module::report_quota in that the username is used instead of the uid. This may change in the future. There is a limitation in this process in that it solely scans the main spool file for a user and excludes all other inboxes created from IMAP applications (such as SquirrelMail).

[ Top ]

method get_spool_size_backend [line 308]

void get_spool_size_backend( $mPath)



Tags:

access:  public


Parameters:

   $mPath  

[ Top ]

method get_vacation_message [line 313]

void get_vacation_message( [ $mUser = NULL])



Tags:

access:  public


Parameters:

   $mUser  

[ Top ]

method get_vacation_message_backend [line 323]

void get_vacation_message_backend( $mUser)



Tags:

access:  public


Parameters:

   $mUser  

[ Top ]

method list_aliases [line 66]

void list_aliases( )



Tags:

access:  public


[ Top ]

method list_mailboxes [line 164]

void list_mailboxes( [$mFilter $mFilter = NULL], [$mAddress $mAddress = NULL])



Tags:

access:  public


Parameters:

$mFilter   $mFilter   string optional filter, possible values: forward, local, special, single
$mAddress   $mAddress   string supplementary argument to 'single', restrict address to %expr%

[ Top ]

method list_virtual_transports [line 281]

void list_virtual_transports( )



Tags:

access:  public


[ Top ]

method modify_mailbox [line 94]

void modify_mailbox( $moUser, $moDomain, $mnUser, $mnDomain, $mnMailbox, $mnType)



Tags:

access:  public


Parameters:

   $moUser  
   $moDomain  
   $mnUser  
   $mnDomain  
   $mnMailbox  
   $mnType  

[ Top ]

method remove_alias [line 149]

void remove_alias( $mUser, $mDomain)



Tags:

access:  public


Parameters:

   $mUser  
   $mDomain  

[ Top ]

method remove_mailbox [line 236]

void remove_mailbox( $mUser, $mDomain)



Tags:

access:  public


Parameters:

   $mUser  
   $mDomain  

[ Top ]

method remove_vacation [line 411]

void remove_vacation( [ $mUser = NULL])

bool remove_vacation ([string])



Tags:

access:  public


Parameters:

   $mUser  

[ Top ]

method remove_vacation_backend [line 426]

void remove_vacation_backend( $mUser)



Tags:

access:  public


Parameters:

   $mUser  

[ Top ]

method remove_virtual_transport [line 269]

void remove_virtual_transport( $mDomain)



Tags:

access:  public


Parameters:

   $mDomain  

[ Top ]

method rename_mailbox [line 139]

void rename_mailbox( $moUser, $moDomain, $mnUser, $mnDomain, $mnMailbox, $mnType)



Tags:

deprecated:  
access:  public


Parameters:

   $moUser  
   $moDomain  
   $mnUser  
   $mnDomain  
   $mnMailbox  
   $mnType  

[ Top ]

method vacation_exists [line 342]

void vacation_exists( [ $mUser = NULL])



Tags:

access:  public


Parameters:

   $mUser  

[ Top ]

method vacation_exists_backend [line 356]

void vacation_exists_backend( $mUser)



Tags:

access:  public


Parameters:

   $mUser  

[ Top ]

Class Constants

VACATION_RE =  '^\s*include "\$HOME/\.vacationrc"'

[line 12]


[ Top ]

VACATION_RECIPE =  '/^(?:X-Original-To|Delivered-To): (.+)/
TOADDR=$MATCH1
if (!/^X-Spam-Flag: YES/ && /^(?:To|Cc):.*${TOADDR}/) # Make sure we are not BCC\'d
{
       cc "| mailbot -A \'From: $TOADDR\' -t $HOME/.vacation.msg -d .vacation.db /usr/sbin/sendmail -t -i -f \'\'"
}'

[line 13]


[ Top ]


Documentation generated on Sat, 11 Oct 2008 04:00:36 -0400 by phpDocumentor 1.4.0