Email_Module

+------------------------------------------------------------+ | apnscp | +------------------------------------------------------------+ | Copyright (c) Apis Networks | +------------------------------------------------------------+ | Licensed under Artistic License 2.0 | +------------------------------------------------------------+ | Author: Matt Saladna (msaladna@apisnetworks.com) | +------------------------------------------------------------+
extends Module\Skeleton\Standard implements Module\Skeleton\Contracts\Proxied , Opcenter\Contracts\Hookable
Methods Summary
public
# __construct( )
{{{ void __construct(void)

ignore


Overrides

public
public
# get_provider( )
Get DNS provider
public
public
# list_mailboxes( $filter = NULL, $address = NULL, $domain = NULL )
Retrieve mailbox delivery maps from system
public
# enable_address( $account , $domain = NULL )
public
# enabled( string $which = NULL )
Verify service is enabled
public
# rename_mailbox( $olduser , $olddomain , $newuser , $newdomain , $newmailbox , $newtype = NULL )

Deprecated


public
# modify_mailbox( string $olduser , string $olddomain , string $newuser = '', string $newdomain = '', string $newdestination = '', string $newtype = NULL )
Rename a mailbox IMPORTANT: a mailbox may not be remapped into a catchall here
public
# address_exists( $user , $domain )
public
# mailbox_type( $user , $domain )
public
# save_mailboxes( )
Save all mailboxes to a serialized file

see

restore_mailboxes()
public
# remove_alias( string $user , string $domain )
Remove an e-mail alias
public
# delete_mailbox( $user , $domain , $type = '' )
public
# get_mailbox( $user , $domain )
public
# remove_maildir( $mailbox )
public
# restore_mailboxes( $file = 'email_addr' )
Restore a saved copy of mailboxes
public
# remove_mailbox( $user , $domain )
public
# transport_exists( string $domain )
Domain is designated to receive e-mail on hosting server
public
# get_spool_size( $username )
public
# get_spool_size_backend( string $path )
Get mail folder size
public
# set_vacation_options( array $options )
Set vacation options
public
# get_vacation_options( )
Get vacation options
public
# get_vacation_message( $user = NULL )
public
# add_vacation( $response , null $user = NULL, array $flags = NULL )
Wrapper to set_vacation

Deprecated


public
# enable_vacation( null|string $user = NULL, array $flags = NULL )
Enable vacation auto-responder
public
# vacation_exists( $user = NULL )
public
# change_vacation_message( string $response , string|null $user = NULL, array $flags = array ( ) )
Change existing vacation message
public
# remove_vacation( string $user = NULL )
Disable vacation status
public
# clone_domain_mailboxes( $source , $destination )
public
# remove_virtual_transport( string $domain , bool $keepdns = NULL )
Deauthorize server from handling mail for domain
public
# add_virtual_transport( $domain , $subdomain = '' )
public
# add_mailbox( $user , $domain , $uid , $mailbox = '' )
public
# add_alias( $user , $domain , $destination )
public
# disable_address( $account , $domain = NULL )
public
# set_webmail_location( $app , $subdomain )
public
public
public
public
public
# _reload( $why = NULL )
public
# create_maildir( $mailbox )
public
# create_maildir_backend( $user , $mailbox )
Create
public
# get_records( string $domain )
Get DNS records
public
public
public
# _edit_user( string $userold , string $usernew , array $oldpwd )
public
public
# user_enabled( $user , $svc = NULL )
public
# permit_user( $user , $svc = NULL )
public
# deny_user( $user , $svc = NULL )
public
public
# _verify_conf( Opcenter\Service\ConfigurationContext $ctx )
public
Methods inherited from Module\Skeleton\Standard
__construct(), set_user_parameters(), clean_user_parameters(), set_session_id(), _invoke(), __debugInfo(), getExportedFunctions(), _reset(), get_service_names(), get_services(), get_new_services(), get_active_services(), get_config(), get_service_value(), set_config_journal(), set_config(), query(), _resetModule()
Constants Summary
public array DEPENDENCY_MAP
# array ( 0 => 'siteinfo', 1 => 'ipinfo', 2 => 'ipinfo6', 3 => 'users', 4 => 'aliases', 5 => 'dns', )
public string MAILDIR_HOME
# 'Mail'
public string MAILBOX_SPECIAL
# 's'
public string MAILBOX_FORWARD
# 'a'
public string MAILBOX_USER
# 'v'
public string MAILBOX_DISABLED
# 'd'
public string MAILBOX_ENABLED
# 'e'
public string MAILBOX_SINGLE
# '1'
public string VACATION_PREFKEY
# 'mail.vacapref'
public string POSTFIX_CMD
# '/usr/sbin/postfix'
public string DOVECOT_SSL_CONFIG_DIR
# '/etc/dovecot/conf.d/ssl'
Constants inherited from Module\Skeleton\Standard
DEPENDENCY_MAP
Properties inherited from Module\Skeleton\Standard
$exportedFunctions, $username, $password, $domain, $user_id, $group_id, $permission_level, $session_id, $site, $site_id, $pgsql, $mysql