[ Index ]

MailPress 544

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    

title

Body

[close]

/mp-includes/Swiftmailer/classes/Swift/Mime/ -> SimpleMessage.php (summary)

(no description)

File Size: 649 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Swift_Mime_SimpleMessage:: (38 methods):
  __construct()
  getNestingLevel()
  setSubject()
  getSubject()
  setDate()
  getDate()
  setReturnPath()
  getReturnPath()
  setSender()
  getSender()
  addFrom()
  setFrom()
  getFrom()
  addReplyTo()
  setReplyTo()
  getReplyTo()
  addTo()
  setTo()
  getTo()
  addCc()
  setCc()
  getCc()
  addBcc()
  setBcc()
  getBcc()
  setPriority()
  getPriority()
  setReadReceiptTo()
  getReadReceiptTo()
  attach()
  detach()
  embed()
  toString()
  __toString()
  toByteStream()
  _getIdField()
  _becomeMimePart()
  _getTopNestingLevel()


Class: Swift_Mime_SimpleMessage  - X-Ref

The default email message class.

__construct(Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, $charset = null)   X-Ref
Create a new SimpleMessage with $headers, $encoder and $cache.

param: Swift_Mime_HeaderSet      $headers
param: Swift_Mime_ContentEncoder $encoder
param: Swift_KeyCache            $cache
param: Swift_Mime_Grammar        $grammar
param: string                    $charset

getNestingLevel()   X-Ref
Always returns {@link LEVEL_TOP} for a message instance.

return: int

setSubject($subject)   X-Ref
Set the subject of this message.

param: string $subject
return: Swift_Mime_SimpleMessage

getSubject()   X-Ref
Get the subject of this message.

return: string

setDate($date)   X-Ref
Set the date at which this message was created.

param: int $date
return: Swift_Mime_SimpleMessage

getDate()   X-Ref
Get the date at which this message was created.

return: int

setReturnPath($address)   X-Ref
Set the return-path (the bounce address) of this message.

param: string $address
return: Swift_Mime_SimpleMessage

getReturnPath()   X-Ref
Get the return-path (bounce address) of this message.

return: string

setSender($address, $name = null)   X-Ref
Set the sender of this message.

This does not override the From field, but it has a higher significance.

param: string $address
param: string $name    optional
return: Swift_Mime_SimpleMessage

getSender()   X-Ref
Get the sender of this message.

return: string

addFrom($address, $name = null)   X-Ref
Add a From: address to this message.

If $name is passed this name will be associated with the address.

param: string $address
param: string $name    optional
return: Swift_Mime_SimpleMessage

setFrom($addresses, $name = null)   X-Ref
Set the from address of this message.

You may pass an array of addresses if this message is from multiple people.

If $name is passed and the first parameter is a string, this name will be
associated with the address.

param: string|array $addresses
param: string       $name      optional
return: Swift_Mime_SimpleMessage

getFrom()   X-Ref
Get the from address of this message.

return: mixed

addReplyTo($address, $name = null)   X-Ref
Add a Reply-To: address to this message.

If $name is passed this name will be associated with the address.

param: string $address
param: string $name    optional
return: Swift_Mime_SimpleMessage

setReplyTo($addresses, $name = null)   X-Ref
Set the reply-to address of this message.

You may pass an array of addresses if replies will go to multiple people.

If $name is passed and the first parameter is a string, this name will be
associated with the address.

param: string $addresses
param: string $name      optional
return: Swift_Mime_SimpleMessage

getReplyTo()   X-Ref
Get the reply-to address of this message.

return: string

addTo($address, $name = null)   X-Ref
Add a To: address to this message.

If $name is passed this name will be associated with the address.

param: string $address
param: string $name    optional
return: Swift_Mime_SimpleMessage

setTo($addresses, $name = null)   X-Ref
Set the to addresses of this message.

If multiple recipients will receive the message an array should be used.
Example: array('receiver@domain.org', 'other@domain.org' => 'A name')

If $name is passed and the first parameter is a string, this name will be
associated with the address.

param: mixed  $addresses
param: string $name      optional
return: Swift_Mime_SimpleMessage

getTo()   X-Ref
Get the To addresses of this message.

return: array

addCc($address, $name = null)   X-Ref
Add a Cc: address to this message.

If $name is passed this name will be associated with the address.

param: string $address
param: string $name    optional
return: Swift_Mime_SimpleMessage

setCc($addresses, $name = null)   X-Ref
Set the Cc addresses of this message.

If $name is passed and the first parameter is a string, this name will be
associated with the address.

param: mixed  $addresses
param: string $name      optional
return: Swift_Mime_SimpleMessage

getCc()   X-Ref
Get the Cc address of this message.

return: array

addBcc($address, $name = null)   X-Ref
Add a Bcc: address to this message.

If $name is passed this name will be associated with the address.

param: string $address
param: string $name    optional
return: Swift_Mime_SimpleMessage

setBcc($addresses, $name = null)   X-Ref
Set the Bcc addresses of this message.

If $name is passed and the first parameter is a string, this name will be
associated with the address.

param: mixed  $addresses
param: string $name      optional
return: Swift_Mime_SimpleMessage

getBcc()   X-Ref
Get the Bcc addresses of this message.

return: array

setPriority($priority)   X-Ref
Set the priority of this message.

The value is an integer where 1 is the highest priority and 5 is the lowest.

param: int $priority
return: Swift_Mime_SimpleMessage

getPriority()   X-Ref
Get the priority of this message.

The returned value is an integer where 1 is the highest priority and 5
is the lowest.

return: int

setReadReceiptTo($addresses)   X-Ref
Ask for a delivery receipt from the recipient to be sent to $addresses.

param: array $addresses
return: Swift_Mime_SimpleMessage

getReadReceiptTo()   X-Ref
Get the addresses to which a read-receipt will be sent.

return: string

attach(Swift_Mime_MimeEntity $entity)   X-Ref
Attach a {@link Swift_Mime_MimeEntity} such as an Attachment or MimePart.

param: Swift_Mime_MimeEntity $entity
return: Swift_Mime_SimpleMessage

detach(Swift_Mime_MimeEntity $entity)   X-Ref
Remove an already attached entity.

param: Swift_Mime_MimeEntity $entity
return: Swift_Mime_SimpleMessage

embed(Swift_Mime_MimeEntity $entity)   X-Ref
Attach a {@link Swift_Mime_MimeEntity} and return it's CID source.
This method should be used when embedding images or other data in a message.

param: Swift_Mime_MimeEntity $entity
return: string

toString()   X-Ref
Get this message as a complete string.

return: string

__toString()   X-Ref
Returns a string representation of this object.

return: string

toByteStream(Swift_InputByteStream $is)   X-Ref
Write this message to a {@link Swift_InputByteStream}.

param: Swift_InputByteStream $is

_getIdField()   X-Ref
No description

_becomeMimePart()   X-Ref
No description

_getTopNestingLevel()   X-Ref
No description



Generated: Thu Apr 28 18:38:52 2016 Cross-referenced by PHPXref 0.7.1