Email_Module

E-mail functions (aliases, virtual mailboxes)

extends Module\Skeleton\Standard implements Module\Skeleton\Contracts\Proxied , Opcenter\Contracts\Hookable

Open source code

Methods Summary
`public`	# `__construct( )` {{{ void __construct(void) ignore Overrides `Module\Skeleton\Standard::__construct()`
`public`	# `_proxy( )` Implementation of `Module\Skeleton\Contracts\Proxied::_proxy()`
`public`	# `get_provider( )` Get DNS provider
`public`	# `configured( )` Mail configured for account
`public`	# `providers( )` Get known mail providers
`public`	# `list_aliases( )`
`public`	# `user_mailboxes( string $username = NULL )` List all mailboxes deliverable to user
`public`	# `list_mailboxes( $filter = NULL, $address = NULL, $domain = NULL )` Retrieve mailbox delivery maps from system
`public`	# `enable_address( $account , $domain = NULL )`
`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
`protected`	# `checkForwarding( $destination )` Validate an input type if forwarded
`public`	# `address_exists( $user , $domain )`
`public`	# `mailbox_type( $user , $domain )` Get mailbox type
`public`	# `save_mailboxes( )` Save all mailboxes to a serialized file see `restore_mailboxes()`
`public`	# `dump_mailboxes( )` List all mailboxes for backup/restore purposes
`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`	# `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`	# `set_vacation_options( array $options )` Set vacation options
`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`	# `import_from_domain( string $domain , string $src )` Clone inboxes from domain Wrapper to emulate dns:import-from-domain similarity
`public`	# `clone_domain_mailboxes( $source , $destination )` Clone inboxes from domain
`public`	# `remove_virtual_transport( string $domain , bool $keepdns = NULL )` Deauthorize server from handling mail for domain
`public`	# `get_records( string $domain , string $subdomain = '' )` Get DNS records Deprecated
`public`	# `provisioning_records( string $domain , string $subdomain = '' )` Get DNS records
`public`	# `add_virtual_transport( string $domain , string $subdomain = '' )` Add transport to handle mail
`public`	# `add_mailbox( $user , $domain , $uid , string $mailbox = '' )` Add mailbox for account
`public`	# `add_alias( $user , $domain , $destination )`
`public`	# `disable_address( $account , $domain = NULL )`
`public`	# `get_mail_ip( )` Get mail server IPs
`public`	# `set_webmail_location( $app , $subdomain )`
`public`	# `webmail_apps( )`
`public`	# `get_webmail_location( $app )`
`public`	# `_create( )` Implementation of `Opcenter\Contracts\Hookable::_create()`
`public`	# `_create_user( string $user )` Implementation of `Opcenter\Contracts\Hookable::_create_user()`
`public`	# `_reload( $why = NULL )`
`public`	# `create_maildir_backend( $user , $mailbox )` Create Maildir backend
`public`	# `create_maildir( $mailbox )`
`public`	# `_delete( )` Implementation of `Opcenter\Contracts\Hookable::_delete()`
`public`	# `_edit( )` Implementation of `Opcenter\Contracts\Hookable::_edit()`
`public`	# `_edit_user( string $userold , string $usernew , array $oldpwd )` Implementation of `Opcenter\Contracts\Hookable::_edit_user()`
`public`	# `user_enabled( null $user = NULL, null $svc = NULL )` Mail service is enabled for user
`public`	# `enabled( string $which = NULL )` Verify service is enabled
`public`	# `merge_ssl( string\|array\|null $site = NULL )` Merge issued certificates into haproxy's SNI
`public`	# `list_virtual_transports( )`
`public`	# `_delete_user( string $user )` Implementation of `Opcenter\Contracts\Hookable::_delete_user()`
`public`	# `permit_user( $user , $svc = NULL )`
`public`	# `deny_user( $user , $svc = NULL )`
`public`	# `_verify_conf( Opcenter\Service\ConfigurationContext $ctx )` Implementation of `Opcenter\Contracts\Hookable::_verify_conf()`
`public`	# `_housekeeping( )`
`protected`	# `buildWarningTemplates( )`

Methods inherited from Module\Skeleton\Standard
`__construct()`, `setUserParameters()`, `autoloadModule()`, `__wakeup()`, `_invoke()`, `__debugInfo()`, `getExportedFunctions()`, `_reset()`, `cleanUserParameters()`, `query()`

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`	`MAILBOX_DESTINATION`	# `'destination'`
`public string`	`VACATION_PREFKEY`	# `'mail.vacapref'`
`public string`	`POSTFIX_CMD`	# `'/usr/sbin/postfix'`
`public string`	`SSL_PROXY_DIR`	# `'/etc/haproxy/ssl.d'`

Constants inherited from Module\Skeleton\Standard
`DEPENDENCY_MAP`

Properties Summary
`protected`	`$exportedFunctions`	# array ( 'address_exists' => 3, 'create_maildir_backend' => 18, 'get_spool_size_backend' => 18, 'add_vacation' => 3, 'add_vacation_backend' => 3, 'set_vacation' => 3, 'set_vacation_options' => 3, 'get_vacation_options' => 3, 'vacation_exists' => 3, 'enable_vacation' => 3, 'remove_vacation' => 3, 'get_vacation_message' => 3, 'change_vacation_message' => 3, 'get_webmail_location' => 3, 'webmail_apps' => 3, 'create_maildir' => 3, 'remove_maildir' => 3, 'user_enabled' => 3, 'get_mail_ip' => 3, 'user_mailboxes' => 3, '*' => 2, 'get_provider' => 15, 'providers' => 8, 'merge_ssl' => 8, )

Properties inherited from Module\Skeleton\Standard
`$exportedFunctions`, `$username`, `$password`, `$domain`, `$user_id`, `$group_id`, `$permission_level`, `$session_id`, `$site`, `$site_id`

Email_Module

ignore

Overrides

Implementation of

Deprecated

see

Deprecated

Deprecated

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of