Element index for package Mail

Package indexes

[ a ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

[Top]

_

$_body: in file mimePart.php, variable Mail_mimePart::$_body
The body of this part (not encoded)
$_body: in file mimeDecode.php, variable Mail_mimeDecode::$_body
The body part of the input
$_decode_bodies: in file mimeDecode.php, variable Mail_mimeDecode::$_decode_bodies
Flag to determine whether to decode bodies
$_decode_headers: in file mimeDecode.php, variable Mail_mimeDecode::$_decode_headers
Flag to determine whether to decode headers
$_encoded: in file mimePart.php, variable Mail_mimePart::$_encoded
The output of this part after being built
$_encoding: in file mimePart.php, variable Mail_mimePart::$_encoding
The encoding type of this part
$_error: in file mimeDecode.php, variable Mail_mimeDecode::$_error
If an error occurs, this is used to store the message
$_header: in file mimeDecode.php, variable Mail_mimeDecode::$_header
The header part of the input
$_headers: in file mimePart.php, variable Mail_mimePart::$_headers
Headers for this part
$_include_bodies: in file mimeDecode.php, variable Mail_mimeDecode::$_include_bodies
Flag to determine whether to include bodies in the returned object.
$_input: in file mimeDecode.php, variable Mail_mimeDecode::$_input
The raw email to decode
$_params: in file mail.php, variable Mail_mail::$_params
Any arguments to pass to the mail() function.
$_smtp: in file smtp.php, variable Mail_smtp::$_smtp
SMTP connection object.
$_subparts: in file mimePart.php, variable Mail_mimePart::$_subparts
An array of subparts
_boundarySplit: in file mimeDecode.php, method Mail_mimeDecode::_boundarySplit()
This function splits the input based on the given boundary
_decode: in file mimeDecode.php, method Mail_mimeDecode::_decode()
Performs the decoding. Decodes the body string passed to it If it finds certain content-types it will call itself in a recursive fashion
_decodeBody: in file mimeDecode.php, method Mail_mimeDecode::_decodeBody()
Given a body string and an encoding type, this function will decode and return it.
_decodeHeader: in file mimeDecode.php, method Mail_mimeDecode::_decodeHeader()
Given a header, this function will decode it according to RFC2047. Probably not *exactly* conformant, but it does pass all the given examples (in RFC2047).
_error: in file smtp.php, method Mail_smtp::_error()
Build a standardized string describing the current SMTP error.
_getEncodedData: in file mimePart.php, method Mail_mimePart::_getEncodedData()
_getEncodedData()
_getXML: in file mimeDecode.php, method Mail_mimeDecode::_getXML()
Function that does the actual conversion to xml. Does a single mimepart at a time.
_getXML_helper: in file mimeDecode.php, method Mail_mimeDecode::_getXML_helper()
Helper function to _getXML(). Returns xml of a header.
_hasUnclosedBrackets: in file RFC822.php, method Mail_RFC822::_hasUnclosedBrackets()
Checks if a string has an unclosed brackets or not. IMPORTANT: This function handles both angle brackets and square brackets;
_hasUnclosedBracketsSub: in file RFC822.php, method Mail_RFC822::_hasUnclosedBracketsSub()
Sub function that is used only by hasUnclosedBrackets().
_hasUnclosedQuotes: in file RFC822.php, method Mail_RFC822::_hasUnclosedQuotes()
Checks if a string has an unclosed quotes or not.
_isGroup: in file RFC822.php, method Mail_RFC822::_isGroup()
Checks for a group at the start of the string.
_Mail_smtp: in file smtp.php, method Mail_smtp::_Mail_smtp()
Destructor implementation to ensure that we disconnect from any potentially-alive persistent SMTP connections.
_parseHeaders: in file mimeDecode.php, method Mail_mimeDecode::_parseHeaders()
Parse headers given in $input and return as assoc array.
_parseHeaderValue: in file mimeDecode.php, method Mail_mimeDecode::_parseHeaderValue()
Function to parse a header value,
_quotedPrintableDecode: in file mimeDecode.php, method Mail_mimeDecode::_quotedPrintableDecode()
Given a quoted-printable string, this function will decode and return it.
_quotedPrintableEncode: in file mimePart.php, method Mail_mimePart::_quotedPrintableEncode()
quoteadPrintableEncode()
_sanitizeHeaders: in file Mail.php, method Mail::_sanitizeHeaders()
Sanitize an array of mail headers by removing any additional header strings present in a legitimate header's value. The goal of this filter is to prevent mail injection attacks.
_splitAddresses: in file RFC822.php, method Mail_RFC822::_splitAddresses()
Splits an address into separate addresses.
_splitBodyHeader: in file mimeDecode.php, method Mail_mimeDecode::_splitBodyHeader()
Given a string containing a header and body section, this function will split them (at the first blank line) and return them.
_splitCheck: in file RFC822.php, method Mail_RFC822::_splitCheck()
A common function that will check an exploded string.
_validateAddress: in file RFC822.php, method Mail_RFC822::_validateAddress()
Function to begin checking the address.
_validateAddrSpec: in file RFC822.php, method Mail_RFC822::_validateAddrSpec()
Function to validate an addr-spec.
_validateAtom: in file RFC822.php, method Mail_RFC822::_validateAtom()
Function to validate an atom which from rfc822 is: atom = 1*<any CHAR except specials, SPACE and CTLs>
_validateDliteral: in file RFC822.php, method Mail_RFC822::_validateDliteral()
Function to validate a domain literal: domain-literal = "[" *(dtext / quoted-pair) "]"
_validateDomain: in file RFC822.php, method Mail_RFC822::_validateDomain()
Function to validate a domain, though this is not quite what you expect of a strict internet domain.
_validateLocalPart: in file RFC822.php, method Mail_RFC822::_validateLocalPart()
Function to validate the local part of an address: local-part = word *("." word)
_validatePhrase: in file RFC822.php, method Mail_RFC822::_validatePhrase()
Function to validate a phrase.
_validateQuotedString: in file RFC822.php, method Mail_RFC822::_validateQuotedString()
Function to validate quoted string, which is: quoted-string = <"> *(qtext/quoted-pair) <">
_validateRoute: in file RFC822.php, method Mail_RFC822::_validateRoute()
Function to validate a route, which is: route = 1#("@" domain) ":"
_validateRouteAddr: in file RFC822.php, method Mail_RFC822::_validateRouteAddr()
This function validates a route-addr which is: route-addr = "<" [route] addr-spec ">"
_validateSubdomain: in file RFC822.php, method Mail_RFC822::_validateSubdomain()
Function to validate a subdomain: subdomain = domain-ref / domain-literal

[Top]

a

$address: in file RFC822.php, variable Mail_RFC822::$address
The address being parsed by the RFC822 object.
$addresses: in file RFC822.php, variable Mail_RFC822::$addresses
The array of raw addresses built up as we parse.
$auth: in file smtp.php, variable Mail_smtp::$auth
Should SMTP authentication be used?
addSubPart: in file mimePart.php, method Mail_mimePart::addSubPart()
&addSubPart()
approximateCount: in file RFC822.php, method Mail_RFC822::approximateCount()
Returns an approximate count of how many addresses are in the

[Top]

d

$debug: in file smtp.php, variable Mail_smtp::$debug
Turn on Net_SMTP debugging?
$default_domain: in file RFC822.php, variable Mail_RFC822::$default_domain
The default domain to use for unqualified addresses.
decode: in file mimeDecode.php, method Mail_mimeDecode::decode()
Begins the decoding process. If called statically it will create an object and call the decode() method of it.
disconnect: in file smtp.php, method Mail_smtp::disconnect()
Disconnect and destroy the current SMTP connection.

[Top]

e

$error: in file RFC822.php, variable Mail_RFC822::$error
The current error message, if any.
encode: in file mimePart.php, method Mail_mimePart::encode()
encode()

[Top]

f

factory: in file Mail.php, method Mail::factory()
Provides an interface for generating Mail:: objects of various types

[Top]

g

getMimeNumbers: in file mimeDecode.php, method Mail_mimeDecode::getMimeNumbers()
Given the output of the above function, this will return an array of references to the parts, indexed by mime number.
getSendArray: in file mimeDecode.php, method Mail_mimeDecode::getSendArray()
getSendArray() returns the arguments required for Mail::send() used to build the arguments for a mail::send() call
getXML: in file mimeDecode.php, method Mail_mimeDecode::getXML()
Returns a xml copy of the output of Mail_mimeDecode::decode. Pass the output in as the argument. This function can be called statically. Eg:

[Top]

h

$host: in file smtp.php, variable Mail_smtp::$host
The SMTP host to connect to.

[Top]

i

$index: in file RFC822.php, variable Mail_RFC822::$index
An internal counter/pointer.
isValidInetAddress: in file RFC822.php, method Mail_RFC822::isValidInetAddress()
This is a email validating function separate to the rest of the

[Top]

l

$limit: in file RFC822.php, variable Mail_RFC822::$limit
A limit after which processing stops
$localhost: in file smtp.php, variable Mail_smtp::$localhost
Hostname or domain that will be sent to the remote SMTP server in the HELO / EHLO message.

[Top]

m

$mailMimeDecode: in file mimeDecode.php, variable Mail_mimeDecode::$mailMimeDecode
If invoked from a class, $this will be set. This has problematic connotations for calling decode() statically. Hence this variable is used to determine if we are indeed being called statically or via an object.
$mailRFC822: in file RFC822.php, variable Mail_RFC822::$mailRFC822
A variable so that we can tell whether or not we're inside a Mail_RFC822 object.
mail.php: procedural page mail.php
Mail.php: procedural page Mail.php
mimeDecode.php: procedural page mimeDecode.php
mimePart.php: procedural page mimePart.php
Mail: in file Mail.php, class Mail
PEAR's Mail:: interface. Defines the interface for implementing mailers under the PEAR hierarchy, and provides supporting functions useful in multiple mailer backends.
Mail_mail: in file mail.php, class Mail_mail
internal PHP-mail() implementation of the PEAR Mail:: interface.
Mail_mail: in file mail.php, method Mail_mail::Mail_mail()
Constructor.
Mail_mimeDecode: in file mimeDecode.php, method Mail_mimeDecode::Mail_mimeDecode()
Constructor.
Mail_mimeDecode: in file mimeDecode.php, class Mail_mimeDecode
+----------------------------- IMPORTANT ------------------------------+
Mail_mimePart: in file mimePart.php, class Mail_mimePart
Raw mime encoding class
Mail_mimePart: in file mimePart.php, method Mail_mimePart::Mail_mimePart()
Constructor.
Mail_null: in file null.php, class Mail_null
Null implementation of the PEAR Mail:: interface.
Mail_RFC822: in file RFC822.php, class Mail_RFC822
RFC 822 Email address list validation Utility
Mail_RFC822: in file RFC822.php, method Mail_RFC822::Mail_RFC822()
Sets up the object. The address must either be set here or when calling parseAddressList(). One or the other.
Mail_sendmail: in file sendmail.php, method Mail_sendmail::Mail_sendmail()
Constructor.
Mail_sendmail: in file sendmail.php, class Mail_sendmail
Sendmail implementation of the PEAR Mail:: interface.
Mail_smtp: in file smtp.php, method Mail_smtp::Mail_smtp()
Constructor.
Mail_smtp: in file smtp.php, class Mail_smtp
SMTP implementation of the PEAR Mail interface. Requires the Net_SMTP class.

[Top]

n

$nestGroups: in file RFC822.php, variable Mail_RFC822::$nestGroups
Should we return a nested array showing groups, or flatten everything?
$num_groups: in file RFC822.php, variable Mail_RFC822::$num_groups
The number of groups that have been found in the address list.
null.php: procedural page null.php

[Top]

p

$password: in file smtp.php, variable Mail_smtp::$password
The password to use if the SMTP server requires authentication.
$persist: in file smtp.php, variable Mail_smtp::$persist
Indicates whether or not the SMTP connection should persist over multiple calls to the send() method.
$port: in file smtp.php, variable Mail_smtp::$port
The port the SMTP server is on.
parseAddressList: in file RFC822.php, method Mail_RFC822::parseAddressList()
Starts the whole process. The address must either be set here or when creating the object. One or the other.
parseRecipients: in file Mail.php, method Mail::parseRecipients()
Take a set of recipients and parse them, returning an array of bare addresses (forward paths) that can be passed to sendmail or an smtp server with the rcpt to: command.
PEAR_MAIL_SMTP_ERROR_AUTH: in file smtp.php, constant PEAR_MAIL_SMTP_ERROR_AUTH
Error: SMTP authentication failure
PEAR_MAIL_SMTP_ERROR_CONNECT: in file smtp.php, constant PEAR_MAIL_SMTP_ERROR_CONNECT
Error: Failed to connect to SMTP server
PEAR_MAIL_SMTP_ERROR_CREATE: in file smtp.php, constant PEAR_MAIL_SMTP_ERROR_CREATE
Error: Failed to create a Net_SMTP object
PEAR_MAIL_SMTP_ERROR_DATA: in file smtp.php, constant PEAR_MAIL_SMTP_ERROR_DATA
Error: Failed to send data
PEAR_MAIL_SMTP_ERROR_FROM: in file smtp.php, constant PEAR_MAIL_SMTP_ERROR_FROM
Error: No From: address has been provided
PEAR_MAIL_SMTP_ERROR_RECIPIENT: in file smtp.php, constant PEAR_MAIL_SMTP_ERROR_RECIPIENT
Error: Failed to add recipient
PEAR_MAIL_SMTP_ERROR_SENDER: in file smtp.php, constant PEAR_MAIL_SMTP_ERROR_SENDER
Error: Failed to set sender
prepareHeaders: in file Mail.php, method Mail::prepareHeaders()
Take an array of mail headers and return a string containing text usable in sending a message.

[Top]

r

RFC822.php: procedural page RFC822.php

[Top]

s

$sendmail_args: in file sendmail.php, variable Mail_sendmail::$sendmail_args
Any extra command-line parameters to pass to the sendmail or sendmail wrapper binary.
$sendmail_path: in file sendmail.php, variable Mail_sendmail::$sendmail_path
The location of the sendmail or sendmail wrapper binary on the filesystem.
$sep: in file Mail.php, variable Mail::$sep
Line terminator used for separating header lines.
$structure: in file RFC822.php, variable Mail_RFC822::$structure
The final array of parsed address information that we build up.
sendmail.php: procedural page sendmail.php
smtp.php: procedural page smtp.php
send: in file smtp.php, method Mail_smtp::send()
Implements Mail::send() function using SMTP.
send: in file sendmail.php, method Mail_sendmail::send()
Implements Mail::send() function using the sendmail command-line binary.
send: in file Mail.php, method Mail::send()
Implements Mail::send() function using php's built-in mail() command.
send: in file null.php, method Mail_null::send()
Implements Mail_null::send() function. Silently discards all mail.
send: in file mail.php, method Mail_mail::send()
Implements Mail_mail::send() function using php's built-in mail() command.

[Top]

t

$timeout: in file smtp.php, variable Mail_smtp::$timeout
SMTP connection timeout value. NULL indicates no timeout.

[Top]

u

$username: in file smtp.php, variable Mail_smtp::$username
The username to use if the SMTP server requires authentication.
uudecode: in file mimeDecode.php, method Mail_mimeDecode::uudecode()
Checks the input for uuencoded files and returns an array of them. Can be called statically, eg:

[Top]

v

$validate: in file RFC822.php, variable Mail_RFC822::$validate
Whether or not to validate atoms for non-ascii characters.
$verp: in file smtp.php, variable Mail_smtp::$verp
Whether to use VERP or not. If not a boolean, the string value will be used as the VERP separators.
validateMailbox: in file RFC822.php, method Mail_RFC822::validateMailbox()
Function to validate a mailbox, which is: mailbox = addr-spec ; simple address / phrase route-addr ; name and route-addr

Documentation generated on Thu, 24 Jul 2008 05:04:39 +0200 by phpDocumentor 1.4.0a2