Docs for page functions.php

Description

mail_fetch/functions.php

Functions for the mail_fetch plugin.

Original code from LexZEUS <[email protected]> and [email protected] (extracted from php manual) Adapted for MailFetch by Philippe Mingo <[email protected]>

version: $Id: functions.php 14845 2020-01-07 08:09:34Z pdontthink $
copyright: 1999-2020 The SquirrelMail Project Team
filesource: Source Code for this file
license: GNU Public License

Includes

include_once (SM_PATH.'config/mail_fetch_config.php') (line 52)

load site config

include_once (SM_PATH.'plugins/mail_fetch/config.php') (line 54)

include_once (SM_PATH.'plugins/mail_fetch/constants.php') (line 21)

pop3 class

include_once (SM_PATH.'plugins/mail_fetch/class.mail_fetch.php') (line 22)

Variables

boolean $mail_fetch_allow_unsubscribed (line 48)

Controls use of unsubscribed folders in plugin

since: 1.5.1 and 1.4.5

Functions

decrypt (line 367)

void decrypt ( $txt)

$txt

encrypt (line 351)

void encrypt ( $txt)

$txt

hex2bin (line 319)

hex2bin - convert a hexadecimal string into binary Exists since PHP 5.4.

void hex2bin ( $data)

$data

mailfetch_optpage_register_block_function (line 265)

Internal function used to register option block

private:
since: 1.5.1

void mailfetch_optpage_register_block_function ()

mail_fetch_check_folder (line 386)

check mail folder

return: true, when folder can be used to store messages.
since: 1.5.1 and 1.4.5

boolean mail_fetch_check_folder (stream $imap_stream, string $imap_folder)

stream $imap_stream: imap connection resource
string $imap_folder: imap folder name

mail_fetch_check_noselect (line 415)

Checks if folder is noselect (can't store messages)

Function does not check if folder subscribed.

return: true, when folder has noselect flag. false in any other case.
since: 1.5.1 and 1.4.5

boolean mail_fetch_check_noselect (stream $imap_stream, string $imap_folder)

stream $imap_stream: imap connection resource
string $imap_folder: imap folder name

mail_fetch_folderact_function (line 282)

Internal function used to update mail_fetch settings when folders are renamed or deleted.

private:
since: 1.5.1

void mail_fetch_folderact_function ( $args)

$args

mail_fetch_link_do (line 34)

Add link to menu at top of content pane

void mail_fetch_link_do ()

mail_fetch_login_function (line 64)

Internal function used to fetch pop3 mails on login

private:
since: 1.5.1

void mail_fetch_login_function ()

mail_fetch_setnew_function (line 254)

Internal function used to detect new logins

void mail_fetch_setnew_function ()

mf_keyED (line 332)

void mf_keyED ( $txt)

$txt

validate_mail_fetch_port_number (line 440)

Validate a requested POP3 port number

Allowable port numbers are configured in config.php (see config_example.php for an example and more rules about how the list of allowable port numbers can be specified)

return: An error string is returned if the port number is not allowable, otherwise an empty string is returned.

string validate_mail_fetch_port_number (int $requested_port)

int $requested_port: The port number given by the user

validate_mail_fetch_server_address (line 471)

Validate a requested POP3 server address

Blocked server addresses are configured in config.php (see config_example.php for more details)

return: An error string is returned if the server address is not allowable, otherwise an empty string is returned.

string validate_mail_fetch_server_address (int $requested_address)

int $requested_address: The server address given by the user

/plugins/mail_fetch/functions.php