Documentation

IMP_Imap_Config
in package
implements Serializable

The configuration for a IMP backend.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2013-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

Interfaces

Serializable

Constants

PASSWORDS_KEY  = 'imap_config_pass'

Properties

$acl  : bool
$admin  : array<string|int, mixed>
$atc_structure  : bool
$autocreate_special  : array<string|int, mixed>
$cache  : mixed
$cache_lifetime  : string
$cache_params  : array<string|int, mixed>
$capability_ignore  : array<string|int, mixed>
$comparator  : string
$debug  : string
$debug_raw  : bool
$hordeauth  : mixed
$hostspec  : string
$id  : array<string|int, mixed>
$import_limit  : int
$innocent_params  : array<string|int, mixed>
$lang  : array<string|int, mixed>
$maildomain  : string
$name  : string
$namespace  : array<string|int, mixed>
$port  : int
$preferred  : array<string|int, mixed>
$preferred  : mixed
$protocol  : string
$quota  : array<string|int, mixed>
$secure  : mixed
$smtp  : array<string|int, mixed>
$sort_force  : bool
$spam  : array<string|int, mixed>
$spam_params  : array<string|int, mixed>
$special_mboxes  : array<string|int, mixed>
$thread  : string
$timeout  : string
$user_special_mboxes  : array<string|int, mixed>
$_aoptions  : array<string|int, mixed>
Array options.
$_boptions_false  : array<string|int, mixed>
Boolean options defaulting to false.
$_boptions_true  : array<string|int, mixed>
Boolean options defaulting to true.
$_config  : array<string|int, mixed>
Config data.
$_moptions  : array<string|int, mixed>
Mixed options.
$_passwords  : array<string|int, mixed>
Passwords.
$_poptions  : array<string|int, mixed>
Password storage options (must be an array option).
$_soptions  : array<string|int, mixed>
String options.

Methods

__construct()  : mixed
Constructor.
__get()  : mixed
__isset()  : mixed
__serialize()  : array<string|int, mixed>
__set()  : mixed
__unserialize()  : void
__unset()  : mixed
serialize()  : mixed
unserialize()  : mixed

Constants

PASSWORDS_KEY

public mixed PASSWORDS_KEY = 'imap_config_pass'

Properties

$acl

public bool $acl

Enable ACLs?

$admin

public array<string|int, mixed> $admin

Admin configuration.

$atc_structure

public bool $atc_structure

Use body structure data to determine attachment flag status?

$autocreate_special

public array<string|int, mixed> $autocreate_special

Autocreate the special mailboxes?

$cache

public mixed $cache

The cache configuration from backends.php.

$cache_lifetime

public string $cache_lifetime

Cache lifetime.

$cache_params read-only

public array<string|int, mixed> $cache_params

The cache configuration.

$capability_ignore

public array<string|int, mixed> $capability_ignore

The list of capabilities to ignore.

$comparator

public string $comparator

The non-default comparator to use.

$debug

public string $debug

The debug handler.

$debug_raw

public bool $debug_raw

Do raw debugging?

$hordeauth

public mixed $hordeauth

Type of horde authentication to use.

$hostspec

public string $hostspec

Hostspec of the backend.

$id

public array<string|int, mixed> $id

List of ID information to send via the ID command.

$import_limit read-only

public int $import_limit

The maximum number of messages allowed to be imported.

$innocent_params read-only

public array<string|int, mixed> $innocent_params

Innocent reporting parameters.

$lang

public array<string|int, mixed> $lang

The list of langauges used to display messages on the IMAP server.

$maildomain

public string $maildomain

The maildomain to use for outgoing mail.

$name

public string $name

Label for the backend.

$namespace

public array<string|int, mixed> $namespace

Namespace overrides.

$port

public int $port

Port number of the backend.

$preferred read-only

public array<string|int, mixed> $preferred

The preferred servers list.

$preferred write-only

public mixed $preferred

The preferred server(s).

$protocol

public string $protocol

Either 'imap' or 'pop'.

$quota

public array<string|int, mixed> $quota

Quota paramters.

$secure

public mixed $secure

The security layer to use.

$smtp

public array<string|int, mixed> $smtp

SMTP configuration.

$sort_force

public bool $sort_force

Force sorting on the web server?

$spam

public array<string|int, mixed> $spam

Spam configuration.

$spam_params read-only

public array<string|int, mixed> $spam_params

Spam reporting parameters.

$special_mboxes

public array<string|int, mixed> $special_mboxes

List of special mailboxes overrides.

$thread

public string $thread

The preferred thread sort algorithm.

$timeout

public string $timeout

The connection timeout (in seconds).

$user_special_mboxes read-only

public array<string|int, mixed> $user_special_mboxes

List of user special mailboxes.

$_aoptions

Array options.

private array<string|int, mixed> $_aoptions = array('admin', 'cache_params', 'capability_ignore', 'id', 'lang', 'namespace', 'preferred', 'quota', 'smtp', 'spam', 'special_mboxes')

$_boptions_false

Boolean options defaulting to false.

private array<string|int, mixed> $_boptions_false = array('autocreate_special', 'debug_raw', 'sort_force')

$_boptions_true

Boolean options defaulting to true.

private array<string|int, mixed> $_boptions_true = array('acl', 'atc_structure')

$_config

Config data.

private array<string|int, mixed> $_config = array()

$_moptions

Mixed options.

private array<string|int, mixed> $_moptions = array('cache', 'hordeauth', 'secure')

$_passwords

Passwords.

private array<string|int, mixed> $_passwords = array()

$_poptions

Password storage options (must be an array option).

private array<string|int, mixed> $_poptions = array('admin', 'quota')

$_soptions

String options.

private array<string|int, mixed> $_soptions = array('cache_lifetime', 'comparator', 'debug', 'hostspec', 'import_limit', 'maildomain', 'name', 'port', 'protocol', 'thread', 'timeout')

Methods

__construct()

Constructor.

public __construct(array<string|int, mixed> $c) : mixed
Parameters
$c : array<string|int, mixed>

Config array (from backends.php).

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed

__isset()

public __isset(mixed $name) : mixed
Parameters
$name : mixed

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed

__unserialize()

public __unserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

__unset()

public __unset(mixed $name) : mixed
Parameters
$name : mixed

serialize()

public serialize() : mixed

unserialize()

public unserialize(mixed $data) : mixed
Parameters
$data : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results