Documentation

OSSMail
in package

Configuration file: Config\Modules\OSSMail.

Table of Contents

$address_book_type  : mixed
Contact functionality is disabled
$addressbook_pagesize  : mixed
Address book page size.
$auto_create_user  : mixed
Auto create user.
$date_format  : mixed
Set date format
$date_long  : mixed
Set the long date format
$db_prefix  : mixed
Set default prefix
$default_charset  : mixed
Use this charset as fallback for message decoding
$default_host  : mixed
Default host.
$default_port  : mixed
Port used to connect to IMAP.
$des_key  : mixed
This key is used for encrypting purposes, like storing of imap password in the session. For the default cipher_method a required key length is 24 characters.
$draft_autosave  : mixed
Set autosave time
$enable_authres_status_column  : mixed
Enable authres status column
$enable_spellcheck  : mixed
Enable spell check
$enable_variables_in_signature  : mixed
Enable variables in signature
$htmleditor  : mixed
Html editor
$identities_level  : mixed
Identities level.
$imap_cache  : mixed
Imap cache, Values: 'db', 'apc' and 'memcache' or 'memcached'
$imap_conn_options  : mixed
Connection options imap.
$imap_open_add_connection_type  : mixed
Add connection type
$imap_params  : mixed
Enable this for imapConnect and MS Exchange bug "Kerberos error: Credentials cache file ... not found "DISABLE_AUTHENTICATOR" => "GSSAPI"
$ip_check  : mixed
Ip check.
$junk_mbox  : mixed
Store spam messages in this mailbox
$language  : mixed
Set default language
$list_cols  : mixed
List cols
$mail_pagesize  : mixed
Mail page size.
$mdn_requests  : mixed
Mdn requests
$message_show_email  : mixed
Enables display of email address with name instead of a name (and address in title)
$messages_cache  : mixed
Enables messages cache. Only 'db' cache is supported.
$messages_cache_threshold  : mixed
Maximum cached message size in kilobytes.
$mime_param_folding  : mixed
Mime param folding
$plugins  : mixed
List of plugins
$prefer_html  : mixed
Turn on/off prefer html
$preview_pane  : mixed
Turn on/off preview pane
$product_name  : mixed
Name your service. This is displayed on the login screen and in the window title
$reply_mode  : mixed
Set reply mode
$sendmail_delay  : mixed
Send mail delay
$session_lifetime  : mixed
Session lifetime in minutes
$show_images  : mixed
Display remote resources (inline images, styles). Value: 0 - Never, always ask, 1 - Ask if sender is not in address book, 2 - Always allow
$show_statuses  : mixed
Show statuses
$skin  : mixed
Set the skin
$skin_logo  : mixed
Skin logo
$smtp_conn_options  : mixed
Connection options smtp.
$smtp_helo_host  : mixed
The value to give when sending
$smtp_pass  : mixed
SMTP password (if required) if you use %p as the password Roundcube will use the current user's password for login
$smtp_port  : mixed
Default smtp port
$smtp_server  : mixed
Name of SMTP server
$smtp_timeout  : mixed
Smtp time out
$smtp_user  : mixed
Login to SMTP server
$time_format  : mixed
Set time format
$time_formats  : mixed
give this choice of time formats to the user to select from
$useragent  : mixed
Add this user-agent to message headers when sending
$username_domain  : mixed
User name domain
$validate_cert  : mixed
Validate cert
db_dsnw()  : mixed
Database connection string (DSN) for read+write operations
debug_level()  : mixed
Debug level. sum of: 1 = log; 4 = show, 8 = trace
devel_mode()  : mixed
Debugging information about php memory consumption
imap_debug()  : mixed
Imap conversation debug
ldap_debug()  : mixed
Ldap conversation debug
log_dir()  : mixed
Log dir
log_logins()  : mixed
Logins successful/failed
per_user_logging()  : mixed
Per user logging
root_directory()  : mixed
Root directory
session_debug()  : mixed
Session authentication debug
smtp_debug()  : mixed
Smtp conversation debug
smtp_log()  : mixed
Log sent messages to cache/logs/sendmail
sql_debug()  : mixed
Sql queries debug
temp_dir()  : mixed
Temp dir

Properties

$address_book_type

Contact functionality is disabled

public static mixed $address_book_type = ''

$addressbook_pagesize

Address book page size.

public static mixed $addressbook_pagesize = 50

$auto_create_user

Auto create user.

public static mixed $auto_create_user = true

$date_format

Set date format

public static mixed $date_format = 'Y-m-d'

$date_long

Set the long date format

public static mixed $date_long = 'Y-m-d H:i'

$db_prefix

Set default prefix

public static mixed $db_prefix = 'roundcube_'

$default_charset

Use this charset as fallback for message decoding

public static mixed $default_charset = 'UTF-8'

$default_host

Default host.

public static mixed $default_host = ['ssl://imap.gmail.com' => 'ssl://imap.gmail.com']

$default_port

Port used to connect to IMAP.

public static mixed $default_port = 993

$des_key

This key is used for encrypting purposes, like storing of imap password in the session. For the default cipher_method a required key length is 24 characters.

public static mixed $des_key = 'dAHdvKU26pg5dqwtRjqDx9f1'

$draft_autosave

Set autosave time

public static mixed $draft_autosave = 300

$enable_authres_status_column

Enable authres status column

public static mixed $enable_authres_status_column = true

$enable_spellcheck

Enable spell check

public static mixed $enable_spellcheck = true

$enable_variables_in_signature

Enable variables in signature

public static mixed $enable_variables_in_signature = false

$htmleditor

Html editor

public static mixed $htmleditor = 1

$identities_level

Identities level.

public static mixed $identities_level = 0

$imap_cache

Imap cache, Values: 'db', 'apc' and 'memcache' or 'memcached'

public static mixed $imap_cache = 'db'

$imap_conn_options

Connection options imap.

public static mixed $imap_conn_options = ['ssl' => ['verify_peer' => false, 'verify_peer_name' => false]]

$imap_open_add_connection_type

Add connection type

public static mixed $imap_open_add_connection_type = true

$imap_params

Enable this for imapConnect and MS Exchange bug "Kerberos error: Credentials cache file ... not found "DISABLE_AUTHENTICATOR" => "GSSAPI"

public static mixed $imap_params = []

$ip_check

Ip check.

public static mixed $ip_check = false

$junk_mbox

Store spam messages in this mailbox

public static mixed $junk_mbox = ''

$language

Set default language

public static mixed $language = 'en_US'

$list_cols

List cols

public static mixed $list_cols = ['flag', 'status', 'subject', 'fromto', 'date', 'size', 'attachment', 'authres_status', 'threads']

$mail_pagesize

Mail page size.

public static mixed $mail_pagesize = 30

$mdn_requests

Mdn requests

public static mixed $mdn_requests = 0

$message_show_email

Enables display of email address with name instead of a name (and address in title)

public static mixed $message_show_email = true

$messages_cache

Enables messages cache. Only 'db' cache is supported.

public static mixed $messages_cache = 'db'

$messages_cache_threshold

Maximum cached message size in kilobytes.

public static mixed $messages_cache_threshold = 1000

Note: On MySQL this should be less than (max_allowed_packet - 30%)

$mime_param_folding

Mime param folding

public static mixed $mime_param_folding = 0

$plugins

List of plugins

public static mixed $plugins = ['identity_smtp', 'thunderbird_labels', 'zipdownload', 'archive', 'html5_notifier', 'advanced_search', 'contextmenu', 'yetiforce']

$prefer_html

Turn on/off prefer html

public static mixed $prefer_html = true

$preview_pane

Turn on/off preview pane

public static mixed $preview_pane = false

$product_name

Name your service. This is displayed on the login screen and in the window title

public static mixed $product_name = ''

$reply_mode

Set reply mode

public static mixed $reply_mode = 1

$sendmail_delay

Send mail delay

public static mixed $sendmail_delay = 0

$session_lifetime

Session lifetime in minutes

public static mixed $session_lifetime = 30

$show_images

Display remote resources (inline images, styles). Value: 0 - Never, always ask, 1 - Ask if sender is not in address book, 2 - Always allow

public static mixed $show_images = 0

$show_statuses

Show statuses

public static mixed $show_statuses = 127

$skin

Set the skin

public static mixed $skin = 'elastic'

Skin logo

public static mixed $skin_logo = '/images/null.png'

$smtp_conn_options

Connection options smtp.

public static mixed $smtp_conn_options = ['ssl' => ['verify_peer' => false, 'verify_peer_name' => false]]

$smtp_helo_host

The value to give when sending

public static mixed $smtp_helo_host = 'YetiForceCRM'

$smtp_pass

SMTP password (if required) if you use %p as the password Roundcube will use the current user's password for login

public static mixed $smtp_pass = '%p'

$smtp_port

Default smtp port

public static mixed $smtp_port = 465

$smtp_server

Name of SMTP server

public static mixed $smtp_server = 'ssl://smtp.gmail.com'

$smtp_timeout

Smtp time out

public static mixed $smtp_timeout = 10

$smtp_user

Login to SMTP server

public static mixed $smtp_user = '%u'

$time_format

Set time format

public static mixed $time_format = 'H:i'

$time_formats

give this choice of time formats to the user to select from

public static mixed $time_formats = ['G:i', 'H:i', 'g:i a', 'h:i A', 'H:i:s (T P)']

$useragent

Add this user-agent to message headers when sending

public static mixed $useragent = 'YetiForce Webmail'

$username_domain

User name domain

public static mixed $username_domain = 'gmail.com'

$validate_cert

Validate cert

public static mixed $validate_cert = false

Methods

db_dsnw()

Database connection string (DSN) for read+write operations

public static db_dsnw() : mixed
Return values
mixed

debug_level()

Debug level. sum of: 1 = log; 4 = show, 8 = trace

public static debug_level() : mixed
Return values
mixed

devel_mode()

Debugging information about php memory consumption

public static devel_mode() : mixed
Return values
mixed

imap_debug()

Imap conversation debug

public static imap_debug() : mixed
Return values
mixed

ldap_debug()

Ldap conversation debug

public static ldap_debug() : mixed
Return values
mixed

log_dir()

Log dir

public static log_dir() : mixed
Return values
mixed

log_logins()

Logins successful/failed

public static log_logins() : mixed
Return values
mixed

per_user_logging()

Per user logging

public static per_user_logging() : mixed
Return values
mixed

root_directory()

Root directory

public static root_directory() : mixed
Return values
mixed

session_debug()

Session authentication debug

public static session_debug() : mixed
Return values
mixed

smtp_debug()

Smtp conversation debug

public static smtp_debug() : mixed
Return values
mixed

smtp_log()

Log sent messages to cache/logs/sendmail

public static smtp_log() : mixed
Return values
mixed

sql_debug()

Sql queries debug

public static sql_debug() : mixed
Return values
mixed

temp_dir()

Temp dir

public static temp_dir() : mixed
Return values
mixed

        

Search results