Docs For Class rcube

Description

Class to provide SMTP functionality using PEAR Net_SMTP

Located in /rcube_smtp.php (line 35)

Method Summary

bool connect ([string $host = null], [string $port = null], [string $user = null], [string $pass = null])

void debug_handler ( &$smtp, $message)

void disconnect ()

void get_error ()

void get_response ()

void reset ()

bool send_mail (string $from, mixed $recipients, mixed &$headers, mixed &$body, [array $opts = null])

Methods

connect (line 53)

SMTP Connection and authentication

bool connect ([string $host = null], [string $port = null], [string $user = null], [string $pass = null])

debug_handler (line 339)

This is our own debug handler for the SMTP connection

void debug_handler ( &$smtp, $message)

disconnect (line 326)

Disconnect the global SMTP connection

void disconnect ()

get_error (line 349)

Get error message

void get_error ()

get_response (line 359)

Get server response messages array

void get_response ()

reset (line 315)

Reset the global SMTP connection

void reset ()

send_mail (line 193)

Function for sending mail

bool send_mail (string $from, mixed $recipients, mixed &$headers, mixed &$body, [array $opts = null])

string $from: Sender e-Mail address
mixed $recipients: Either a comma-seperated list of recipients (RFC822 compliant), or an array of recipients, each RFC822 valid. This may contain recipients not specified in the headers, for Bcc:, resending messages, etc.
mixed &$headers: The message headers to send with the mail Either as an associative array or a finally formatted string
mixed &$body: The full text of the message body, including any Mime parts or file handle
array $opts: Delivery options (e.g. DSN request)