[Swift_Message] element index

Package indexes

All elements
a b c d e f g h i l m n p q r s t u w _
_
top
__construct
Constructor
__construct
Constructor
__construct
Ctor.
__construct
Constructor
__construct
Constructor
__construct
Constructor
a
top
$attributes
Attributes appended to headers
addChild
Nest a child mime part in this document
addressChunk
Break a string apart at every occurence of <add@ress> and return an array This method does NOT remove any characters like a preg_split() would do.
attach
Attach a mime part or an attachment of some sort
SAFE_LENGTH
Constant for safe line length in almost all places
Attachment.php
Attachment.php in Attachment.php
b
top
$boundary
The boundary used to separate mime parts
base64Encode
Return the base64 encoded version of the string
base64EncodeFile
Return the base64 encoded version of a file
build
Compile the list of headers which have been set and return an ascii string The return value should always be 7-bit ascii and will have been cleaned for header injection If this looks complicated it's probably because it is!! Keeping everything compliant is not easy.
build
Compile the entire MIME document into a string The returned string may be used in other documents if needed.
buildAttributes
Build the list of attributes for appending to the given header This is RFC 2231 & 2047 compliant.
buildData
Get the data in the format suitable for sending
c
top
$cache
An instance of Swift_Cache
$cached
Cached, pre-built headers
$charset
The charset used in the headers
$children
Nested mime parts
$cid
The content-id in the headers (used in <img src=...> values)
d
top
$data
The body of the documented (unencoded)
detach
Remove a nested MIME part
e
top
$emailContainingHeaders
Headers which may contain email addresses, and therefore should take notice when encoding
$encoding
The encoding format used for the body of the document
encode7Bit
Encode a string as 7bit ascii
encode7BitFile
Return a 7bit string from a file
encode7BitPrintable
Strip out any characters which are not in the ASCII 7bit printable range
encode8Bit
Return the 8bit encoded form of a string (unchanged there-abouts)
encode8BitFile
Return a 8bit string from a file
LEVEL_ALTERNATIVE
Constant for MIME sections which must appear in the multipart/alternative section.
LEVEL_MIXED
Constant for MIME sections which must appear in the multipart/mixed section.
LEVEL_RELATED
Constant for MIME sections which must appear in the multipart/related section.
LEVEL_TOP
Constant for MIME sections which must appear in the multipart/mixed section.
EmbeddedFile.php
EmbeddedFile.php in EmbeddedFile.php
Encoder.php
Encoder.php in Encoder.php
VERY_SAFE_LENGTH
Constant for really safe line length
f
top
$fileId
A numeric counter, incremented by 1 when a filename is made.
$forceEncoding
If QP or Base64 encoding should be forced
fixContentType
Sets the correct content type header by looking at what types of data we have set
fixLE
Fixes line endings to be whatever is specified by the user
forceEncoding
Turn on or off forced header encoding
g
top
generateBoundary
Compute a unique boundary
generateFileName
Get a unique filename (just a sequence)
generateId
Create a RFC 2822 compliant message id, optionally based upon $idstring.
get
Get the value at a given header
getAttribute
Get the value for a given attribute on a given header
getBcc
Return the list of recipients in the Bcc: header
getBody
Alias for getData()
getBody
Alias for getData()
getCc
Swift_Message::getCc() in Message.php
Return the list of recipients in the Cc: header
getCharset
Get the charset used in the document
getCharset
Get the charset used in the document
getCharset
Get the current charset used
getChild
Get a child document, identified by $id
getContentId
Get the content-id of this file
getContentType
Get the content type which has been set
getData
Return the string which makes up the body of this MIME document
getDate
Get the date as it looks in the headers
getDescription
Return the description in the headers
getDisposition
Get the disposition used in the attachment (usually inline or attachment)
getEncoded
Get the header in it's compliant, encoded form
getEncoding
Get the encoding format used in this document
getEncoding
Get the encoding format used in this document
getFileName
Get the filename of this attachment
getFrom
Get the address used in the From: header
getHcf
getId
Swift_Message::getId() in Message.php
Get the generated message ID for this message, including the <> quotes.
getLanguage
Get the language used in the headers to $lang (e.g. en-us, en-gb, sv etc)
getLE
Get the line ending sequence
getLE
Get the line ending sequence
getLevel
Get the level in the MIME hierarchy at which this section should appear.
getLevel
Get the level at which this mime part would appear in a document
getLevel
Get the level in the MIME hierarchy at which this section should appear.
getLevel
Get the level in the MIME hierarchy at which this section should appear.
getLevel
Get the level in the MIME hierarchy at which this section should appear.
getList
Just fetch the array containing the headers
getMimeWarning
Get the MIME warning which is displayed to old clients
getPriority
Get the current message priority
getReference
Get a reference to an object (for complex reasons).
getReplyTo
Return the list of recipients in the Reply-To: header
getReturnPath
Return the address used in the Return-Path: header
getSubject
Get the current subject used in the headers
getTo
Swift_Message::getTo() in Message.php
Return the list of recipients in the To: header
h
top
$headers
The header part of this MIME document
$headers
A collection of headers
CHEAP_ADDRESS_RE
A regular expression which matches valid e-mail addresses (including some unlikely ones)
has
Check if a header has been set or not
hasAttribute
Check if a header has a given attribute applied to it
hasChild
Check if a child exists identified by $id
header7BitEncode
Keeps lines longer than 76 characters trimmed down to size
Headers.php
Headers.php in Headers.php
i
top
$instance
A singleton of this class
instance
Retreive an instance of the encoder as a singleton.
is7BitAscii
If the characters fall exclusively in the 7bit ascii range, return true
is7BitPrintable
This function checks for 7bit *printable* characters
isFlowed
Check if the message format is set as flowed
isHeaderSafe
Check that a string does not contain any evil characters for headers.
isUTF8
Detect if a string contains multi-byte non-ascii chars that fall in the UTF-8 ranges
MISC
Constant for miscellaneous mime type
Image.php
Image.php in Image.php
l
top
$language
The language used in the headers (doesn't really matter much)
$LE
The line ending characters needed
$LE
The line ending used in the headers
$libVersion
The version of the library (Swift) if known.
$lowerHeaders
A container of references to the headers
listAttributes
Get a list of all the attributes in the given header.
listChildren
List the IDs of all children in this document
PLAIN
Constant for plain-text emails
m
top
$mimeWarning
The MIME warning for client not supporting multipart content
moveBranchIn
Move a branch of the tree, containing all it's MIME parts onto another branch
moveBranchOut
Move a branch further toward the top of the tree
Mime.php
Mime.php in Mime.php
MimeException.php
MimeException.php in MimeException.php
Message.php
Message.php in Message.php
n
top
numChildren
Get the total number of children present in this document
p
top
postAttachFixStructure
Analyzes the mixing of MIME types in a mulitpart message an re-arranges if needed
postDetachFixStructure
Analyzes the mixing of MIME types in a mulitpart message an re-arranges if needed
preBuild
Pre-compilation logic
preBuild
Execute any logic needed prior to building
preBuild
Execute needed logic prior to compilation
preBuild
Execute needed logic prior to building
Part.php
Part.php in Part.php
q
top
QPEncode
Return the quoted printable version of the input string
QPEncodeFile
Return a file as a quoted printable encoded string
quoteChunk
Break a string apart at every occurence of <xxxyyy> and return an array This method does NOT remove any characters like a preg_split() would do.
r
top
$references
A container for references to other objects.
PRIORITY_HIGH
Constant from a high priority message (pretty meaningless)
PRIORITY_LOW
Constant for a low priority message
PRIORITY_NORMAL
Constant for a normal priority message
rawBase64Encode
Return the base64 encoded version of a string with no breaks
rawQPEncode
Return the QP encoded version of a string with no breaks
remove
Remove a header from the list
removeAttribute
Remove an attribute from a header
removeChild
Remove a part from the document
requestReadReceipt
Request that the client send back a read-receipt (don't rely on this!)
rfc2047Encode
Encode a string for RFC 2047 compatability (url-encode)
s
top
set
Add a header or change an existing header value
setAttribute
Set an attribute in a major header
setBcc
Set the list of recipients in the Bcc: header
setBody
Alias for setData()
setBody
Alias for setData()
setCc
Swift_Message::setCc() in Message.php
Set the list of recipients in the Cc: header
setCharset
Set the charset of the document
setCharset
Set the charset of the document
setCharset
Set the charset used in the headers
setContentId
Set the Content-Id to use
setContentType
Set the content type of this MIME document
setData
Overrides setData() in MIME so that a filename can be set
setData
Specify the string which makes up the body of this message HINT: You can always nest another MIME document here if you call it's build() method.
setData
Set data for the image
setDate
Set the date in the headers in RFC 2822 format
setDescription
Set the Content-Description header
setDisposition
Set the disposition of the attachment (usually inline or attachment)
setEncoding
Set the encoding format to be used on the body of the document
setEncoding
Specify the encoding to use for the headers if characters outside the 7-bit-printable ascii range are found This encoding will never be used if only 7-bit-printable characters are found in the headers.
setFileName
Set the name (and description) used to identify the file
setFlowed
Set the "format" attribute to flowed
setFlowed
Set the "format" attribute to flowed
setFrom
Set the address in the From: header
setHeaders
Replace the current headers with new ones
setId
Swift_Message::setId() in Message.php
Set the message id literally.
setLanguage
Set the language used in the headers to $lang (e.g. en-us, en-gb, sv etc)
setLE
Set the line ending character to use
setLE
Set the line ending character to use
setLineWrap
Set the size at which lines wrap around (includes the CRLF)
setMimeWarning
Set the MIME warning message which is displayed to old clients
setPriority
Set the message prioirty in the mail client (don't rely on this)
setReference
Sets a reference so when nodes are nested, operations can be redirected.
setReplyTo
Set the list of recipients in the Reply-To: header
setReturnPath
Set the address in the Return-Path: header
setSubject
Set the subject in the headers
setTo
Swift_Message::setTo() in Message.php
Set the list of recipients in the To: header
Swift_Message
Swift_Message in Message.php
Swift Message class
Swift_Message_Attachment
Swift_Message_Attachment in Attachment.php
Attachment component for Swift Mailer
Swift_Message_EmbeddedFile
Swift_Message_EmbeddedFile in EmbeddedFile.php
Embedded File component for Swift Mailer
Swift_Message_Encoder
Swift_Message_Encoder in Encoder.php
Encodes strings in a variety of formats and detects some encoding formats
Swift_Message_Headers
Swift_Message_Headers in Headers.php
Contains and constructs the headers for a MIME document
Swift_Message_Image
Swift_Message_Image in Image.php
Embedded Image component for Swift Mailer
Swift_Message_Mime
Swift_Message_Mime in Mime.php
Mime is the underbelly for Messages, Attachments, Parts, Embedded Images, Forwarded Mail, etc
Swift_Message_MimeException
Swift_Message_MimeException in MimeException.php
Swift MIME Exception
Swift_Message_Part
Swift_Message_Part in Part.php
MIME Part body component for Swift Mailer
t
top
HTML
Constant for HTML emails
u
top
$usedBoundaries
A list of used MIME boundaries after they're generated.
uncacheAll
Reset the entire cache state from this branch of the tree and traversing down through the children
uncacheAll
Reset the cache state in these headers
w
top
$wrap
Maximum line length
wantsReadReceipt
Check if a read receipt has been requested for this message
a b c d e f g h i l m n p q r s t u w _