Overview

Packages

  • Mail

Classes

  • Horde_Mail
  • Horde_Mail_Exception
  • Horde_Mail_Rfc822
  • Horde_Mail_Rfc822_Address
  • Horde_Mail_Rfc822_Group
  • Horde_Mail_Rfc822_Object
  • Horde_Mail_Transport
  • Horde_Mail_Transport_Mail
  • Horde_Mail_Transport_Mock
  • Horde_Mail_Transport_Null
  • Horde_Mail_Transport_Sendmail
  • Horde_Mail_Transport_Smtp
  • Horde_Mail_Transport_Smtpmx
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Mail_Transport_Smtp

SMTP implementation.

Horde_Mail_Transport
Extended by Horde_Mail_Transport_Smtp
Package: Mail
Category: Horde
Located at Horde/Mail/Transport/Smtp.php
Methods summary
public
# __construct( array $params = array() )

Constructor.

Constructor.

Parameters

$params
<p>Additional parameters: - auth: (mixed) SMTP authentication. This value may be set to true, false or the name of a specific authentication method. If the value is set to true, the Net_SMTP package will attempt to use the best authentication method advertised by the remote SMTP server. DEFAULT: false. - debug: (boolean) Activate SMTP debug mode? DEFAULT: false - host: (string) The server to connect to. DEFAULT: localhost - localhost: (string) Hostname or domain that will be sent to the remote SMTP server in the HELO / EHLO message. DEFAULT: localhost - password: (string) The password to use for SMTP auth. DEFAULT: NONE - persist: (boolean) Should the SMTP connection persist? DEFAULT: false - pipelining: (boolean) Use SMTP command pipelining. Use SMTP command pipelining (specified in RFC 2920) if the SMTP server supports it. This speeds up delivery over high-latency connections. DEFAULT: false (use default value from Net_SMTP) - port: (integer) The port to connect to. DEFAULT: 25 - timeout: (integer) The SMTP connection timeout. DEFAULT: NONE - username: (string) The username to use for SMTP auth. DEFAULT: NONE</p>
public
# send( mixed $recipients, array $headers, mixed $body )

Send a message.

Send a message.

Parameters

$recipients
<p>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.</p>
$headers
<p>The headers to send with the mail, in an associative array, where the array key is the header name (ie, 'Subject'), and the array value is the header value (ie, 'test'). The header produced from those values would be 'Subject: test'. If the '_raw' key exists, the value of this key will be used as the exact text for sending the message.</p>
$body
<p>The full text of the message body, including any Mime parts, etc. Either a string or a stream resource.</p>

Throws

Horde_Mail_Exception
public Net_SMTP
# getSMTPObject( )

Connect to the SMTP server by instantiating a Net_SMTP object.

Connect to the SMTP server by instantiating a Net_SMTP object.

Returns

Net_SMTP
The SMTP object.

Throws

Horde_Mail_Exception
public
# addServiceExtensionParameter( string $keyword, string $value = null )

Add parameter associated with a SMTP service extension.

Add parameter associated with a SMTP service extension.

Parameters

$keyword
Extension keyword.
$value
Any value the keyword needs.
public boolean
# disconnect( )

Disconnect and destroy the current SMTP connection.

Disconnect and destroy the current SMTP connection.

Returns

boolean
True if the SMTP connection no longer exists.
Methods inherited from Horde_Mail_Transport
parseRecipients(), prepareHeaders()
Constants summary
integer ERROR_CREATE
# 10000
integer ERROR_CONNECT
# 10001
integer ERROR_AUTH
# 10002
integer ERROR_FROM
# 10003
integer ERROR_SENDER
# 10004
integer ERROR_RECIPIENT
# 10005
integer ERROR_DATA
# 10006
Properties summary
public string $greeting

The SMTP greeting.

The SMTP greeting.

# null
public string $queuedAs

The SMTP queued response.

The SMTP queued response.

# null
Properties inherited from Horde_Mail_Transport
$sep
API documentation generated by ApiGen