lib/ezutils/classes/ezmail.php
Classes
File containing the eZMail class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- lib
- Version
- 4.6.0
\eZMail
Package: lib
File containing the eZMail class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Version
- 4.6.0
Constants
REGEXP
= '(((\"[^\"\f\n\r\t\v\b]+\")|([A-Za-z0-9_\!\#\$\%\&\'\*\+\-\~\/\^\`\|\{\}]+(\.[A-Za-z0-9_\!\#\$\%\&\'\*\+\-\~\/\^\`\|\{\}]+)*))@((\[(((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9])))\])|(((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9]))\.((25[0-5])|(2[0-4][0-9])|([0-1]?[0-9]?[0-9])))|((([A-Za-z0-9\-])+\.)+[A-Za-z\-]{2,})))'Properties
$BccElements= ''
Details
- Type
- n/a
$BodyText= ''
Details
- Type
- n/a
$CcElements= ''
Details
- Type
- n/a
$ContentType= ''
Details
- Type
- n/a
$ExtraHeaders= ''
Details
- Type
- n/a
$From= ''
Details
- Type
- n/a
$MIMEVersion= ''
Details
- Type
- n/a
\ezcMail
$Mail= ''
Contains an object of type ezcMail, which is used to store the mail elements like subject, to, from, body etc, instead of using the existing class variables ($Subject, $From, $receiversElements, $BodyText etc).
Details
- Type
- \ezcMail
$MessageID= ''
Details
- Type
- n/a
$ReceiverElements= ''
Details
- Type
- n/a
$ReplyTo= ''
Details
- Type
- n/a
$Subject= ''
Details
- Type
- n/a
$TextCodec= ''
Details
- Type
- n/a
$UserAgent= ''
Details
- Type
- n/a
Methods
addBcc(
$email, $name
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $name |
addCc(
$email, $name
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $name |
addExtraHeader(
$headerName, $headerValue
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $headerName | ||
| $headerValue |
addReceiver(
$email, $name
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $name |
allowedCharsets(
)
:
voidbccElements(
)
:
voidbccReceiverTextList(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
blankNewlines(
$text
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $text |
body(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
ccElements(
)
:
voidccReceiverTextList(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
composeEmailItems(
$items, $join
=
true, $key
=
false, $convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $items | ||
| $join | ||
| $key | ||
| $convert |
composeEmailName(
$item, $key
=
false, $convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $key | ||
| $convert |
contentCharset(
)
:
voidcontentDisposition(
)
:
voidcontentString(
$content
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $content |
contentTransferEncoding(
)
:
voidcontentType(
)
:
voidconvertHeaderText(
$text
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $text |
convertText(
$text, $isHeader
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $text | ||
| $isHeader |
eZMail(
)
:
voidencodeMimeHeader(
$str
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $str |
extraHeaders(
)
:
voidextractEmail(
$text, $email, $name
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $text | ||
| $name |
headerText(
$parameters
=
array()
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $parameters |
headerTextList(
$parameters
=
array()
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $parameters |
headers(
$parameters
=
array()
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $parameters |
isAllowedCharset(
$charset
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $charset |
lineSeparator(
)
:
void
static
messageID(
)
:
voidmimeVersion(
)
:
voidoutputCharset(
)
:
voidreceiverElements(
)
:
voidreceiverEmailText(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
receiverText(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
receiverTextList(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
references(
)
:
voidreplyTo(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
sender(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
senderText(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
setBccElements(
$newBcc
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $newBcc |
setBody(
$newBody
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $newBody |
setCcElements(
$newCc
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $newCc |
setContentType(
$type
=
false, $charset
=
false, $transferEncoding
=
false, $disposition
=
false, $boundary
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $type | ||
| $charset | ||
| $transferEncoding | ||
| $disposition | ||
| $boundary |
setExtraHeader(
$headerName, $headerValue
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $headerName | ||
| $headerValue |
setExtraHeaders(
$headers
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $headers |
setMIMEVersion(
$version
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $version |
setMessageID(
$newMessageID
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $newMessageID |
setReceiver(
$email, $name
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $name |
setReceiverElements(
$toElements
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $toElements |
setReceiverText(
$text
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $text |
setReferences(
$newReference
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $newReference |
setReplyTo(
$email, $name
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $name |
setSender(
$email, $name
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $name |
setSenderText(
$text
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $text |
setSubject(
$newSubject
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $newSubject |
setUserAgent(
$agent
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $agent |
splitList(
$emails
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $emails |
stripEmail(
$address
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $address |
subject(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
usedCharset(
)
:
voiduserAgent(
$convert
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $convert |
validate(
$address
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $address |