PHP Class BP_Reply_By_Email_Connect, bp-reply-by-email

Instantiate the class with the static init() method, which will return the the IMAP resource on success. Note: You will need to manually close the connection yourself with {@link imap_close()}.

Since: 1.0-RC3

Show file Open project: r-a-y/bp-reply-by-email Class Usage Examples

Public Methods

Method	Description
__construct ( array $args = [], resource $connection = false ) : resource \| boolean	Constructor.
init ( $args = [], $connection = false ) : resource \| boolean	Static initializer.
is_ssl ( integer $port ) : boolean	Should we enable SSL for the IMAP connection?

Protected Methods

Method	Description
connect ( ) : resource \| boolean	Connect to an IMAP inbox.
get_mailbox ( ) : string	Get the mailbox we want to connect to.
is_reconnection ( ) : boolean	Whether we should attempt a reconnection.

Method Details

__construct() public method

Constructor.

public __construct ( array $args = [], resource $connection = false ) : resource \| boolean
$args	array	{ An array of arguments. @type string $host The server name. (eg. imap.gmail.com) @type int $port The port number used by the server name. @type string $username The username used to login to the server. @type string $password The password used to login to the server. @type bool $validatecert Whether to validate certificates from TLS/ SSL server. Defaults to true. @type string $mailbox The mailbox to open. Defaults to 'INBOX'. @type int $retries How many times to try reconnection on failure. Defaults to 1. @type bool $reconnect Are we attempting a reconnection? Defaults to false. }
$connection	resource	The IMAP resource if attempting a reconnection.
return	resource \| boolean	The IMAP resource on success. Boolean false on failure.

connect() protected method

Connect to an IMAP inbox.

protected connect ( ) : resource \| boolean
return	resource \| boolean	The IMAP resource on success. Boolean false on failure.

get_mailbox() protected method

This, basically, returns the first parameter of {@link imap_open()}, which is also the second parameter of {@link imap_reopen()}.

protected get_mailbox ( ) : string
return	string

init() public static method

Returns IMAP resource on success using the connect() method. For parameters, see constructor.

public static init ( $args = [], $connection = false ) : resource \| boolean
return	resource \| boolean	The IMAP resource on success. Boolean false on failure.

is_reconnection() protected method

Whether we should attempt a reconnection.

protected is_reconnection ( ) : boolean
return	boolean

is_ssl() public static method

Check to see if both the OpenSSL and IMAP modules are loaded. Next, see if the port is explictly 993.

public static is_ssl ( integer $port ) : boolean
$port	integer	The port number used for the IMAP connection.
return	boolean