boolean authenticate(
string
$username, string
$password, [string
$authtype = 'LOGIN'], [string
$realm = ''], [string
$workstation = '']
)
|
|
Perform SMTP authentication.
Must be run after hello().
Parameters:
string |
$username: |
The user name |
string |
$password: |
The password |
string |
$authtype: |
The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5) |
string |
$realm: |
The auth realm for NTLM |
string |
$workstation: |
The auth workstation for NTLM |
API Tags:
Return: | True if successfully authenticated. |
See: | SMTP::hello() |
Access: | public |
integer|boolean client_send(
string
$data
)
|
|
Send raw data to the server.
Parameters:
string |
$data: |
The data to send |
API Tags:
Return: | The number of bytes sent to the server or false on error |
Access: | public |
Close the socket and clean up the state of the class.
Don't use this function without first trying to use QUIT.
API Tags:
boolean connect(
string
$host, [integer
$port = null], [integer
$timeout = 30], [array
$options = array()]
)
|
|
Connect to an SMTP server.
Parameters:
string |
$host: |
SMTP server IP or host name |
integer |
$port: |
The port number to connect to |
integer |
$timeout: |
How long to wait for the connection to open |
array |
$options: |
An array of options for stream_context_create() |
API Tags:
Check connection state.
API Tags:
Return: | True if connected. |
Access: | public |
boolean data(
string
$msg_data
)
|
|
Send an SMTP DATA command.
Issues a data command and sends the msg_data to the server, finializing the mail transaction. $msg_data is the message that is to be send with the headers. Each header needs to be on a single line followed by a <CRLF> with the message headers and the message body being separated by and additional <CRLF>. Implements rfc 821: DATA <CRLF>
Parameters:
string |
$msg_data: |
Message data to send |
API Tags:
void edebug(
string
$str, [integer
$level = 0]
)
|
|
Output debugging info via a user-selected method.
Parameters:
string |
$str: |
Debug string to output |
integer |
$level: |
The debug level of this message; see DEBUG_* constants |
API Tags:
Get debug output level.
API Tags:
Get debug output method.
API Tags:
Get the latest error.
API Tags:
Get the last reply from the server.
API Tags:
Get SMTP timeout.
API Tags:
Get VERP address generation mode.
API Tags:
Read the SMTP server's response.
Either before eof or socket timeout occurs on the operation. With SMTP we can tell if we have more lines to read if the 4th character is '-' symbol. If it is a space then we don't need to read anything else.
API Tags:
boolean hello(
[string
$host = '']
)
|
|
Send an SMTP HELO or EHLO command.
Used to identify the sending server to the receiving server. This makes sure that client and server are in a known state. Implements RFC 821: HELO <SP> <domain> <CRLF> and RFC 2821 EHLO.
Parameters:
string |
$host: |
The host name or IP to connect to |
API Tags:
string hmac(
string
$data, string
$key
)
|
|
Calculate an MD5 HMAC hash.
Works like hash_hmac('md5', $data, $key) in case that function is not available
Parameters:
string |
$data: |
The data to hash |
string |
$key: |
The key to hash with |
API Tags:
boolean mail(
string
$from
)
|
|
Send an SMTP MAIL command.
Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more recipient commands may be called followed by a data command. Implements rfc 821: MAIL <SP> FROM:<reverse-path> <CRLF>
Parameters:
string |
$from: |
Source address of this message |
API Tags:
Send an SMTP NOOP command.
Used to keep keep-alives alive, doesn't actually do anything
API Tags:
boolean quit(
[boolean
$close_on_error = true]
)
|
|
Send an SMTP QUIT command.
Closes the socket if there is no error or the $close_on_error argument is true. Implements from rfc 821: QUIT <CRLF>
Parameters:
boolean |
$close_on_error: |
Should the connection close if an error occurs? |
API Tags:
boolean recipient(
string
$toaddr
)
|
|
Send an SMTP RCPT command.
Sets the TO argument to $toaddr. Returns true if the recipient was accepted false if it was rejected. Implements from rfc 821: RCPT <SP> TO:<forward-path> <CRLF>
Parameters:
string |
$toaddr: |
The address the message is being sent to |
API Tags:
Send an SMTP RSET command.
Abort any transaction that is currently in progress. Implements rfc 821: RSET <CRLF>
API Tags:
Return: | True on success. |
Access: | public |
boolean sendAndMail(
string
$from
)
|
|
Send an SMTP SAML command.
Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more recipient commands may be called followed by a data command. This command will send the message to the users terminal if they are logged in and send them an email. Implements rfc 821: SAML <SP> FROM:<reverse-path> <CRLF>
Parameters:
string |
$from: |
The address the message is from |
API Tags:
boolean sendCommand(
string
$command, string
$commandstring, integer|array
$expect
)
|
|
Send a command to an SMTP server and check its return code.
Parameters:
string |
$command: |
The command name - not sent to the server |
string |
$commandstring: |
The actual command to send |
integer|array |
$expect: |
One or more expected integer success codes |
API Tags:
Return: | True on success. |
Access: | protected |
boolean sendHello(
string
$hello, string
$host
)
|
|
Send an SMTP HELO or EHLO command.
Low-level implementation used by hello()
Parameters:
string |
$hello: |
The HELO string |
string |
$host: |
The hostname to say we are |
API Tags:
void setDebugLevel(
[integer
$level = 0]
)
|
|
Set debug output level.
Parameters:
API Tags:
void setDebugOutput(
[string
$method = 'echo']
)
|
|
Set debug output method.
Parameters:
string |
$method: |
The function/method to use for debugging output. |
API Tags:
void setTimeout(
[integer
$timeout = 0]
)
|
|
Set SMTP timeout.
Parameters:
API Tags:
void setVerp(
[boolean
$enabled = false]
)
|
|
Enable or disable VERP address generation.
Parameters:
API Tags:
Initiate a TLS (encrypted) session.
API Tags:
Send an SMTP TURN command.
This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and _may_ be implemented in future Implements from rfc 821: TURN <CRLF>
API Tags:
boolean verify(
string
$name
)
|
|
Send an SMTP VRFY command.
Parameters:
string |
$name: |
The name to verify |
API Tags: