Description
Swift_Mime_SimpleMimeEntity
|
--Swift_Mime_MimePart
|
--Swift_Mime_SimpleMessage
Located in File: /vendors/swiftMailer/classes/Swift/Mime/SimpleMessage.php
The default email message class.
Classes extended from Swift_Mime_SimpleMessage:
- Swift_Message
- The Message class for building emails.
Method Detail
Summary:
void
addBcc
(
string $address, [
string $name =
null])
void
addCc
(
string $address, [
string $name =
null])
void
addFrom
(
string $address, [
string $name =
null])
void
addReplyTo
(
string $address, [
string $name =
null])
void
addTo
(
string $address, [
string $name =
null])
void
setBcc
(
array $addresses, [
string $name =
null])
void
setCc
(
array $addresses, [
string $name =
null])
void
setFrom
(
string $addresses, [
string $name =
null])
void
setReplyTo
(
string $addresses, [
string $name =
null])
void
setSender
(
$address, [
string $name =
null],
string $sender)
void
setTo
(
array $addresses, [
string $name =
null])
Method addBcc (line 372)
void addBcc(
string
$address, [string
$name = null])
Add a Bcc: address to this message.
If $name is passed this name will be associated with the address.
Parameters
- string $address:
- string $name: optional
Info
Method addCc (line 324)
void addCc(
string
$address, [string
$name = null])
Add a Cc: address to this message.
If $name is passed this name will be associated with the address.
Parameters
- string $address:
- string $name: optional
Info
Method addFrom (line 174)
void addFrom(
string
$address, [string
$name = null])
Add a From: address to this message.
If $name is passed this name will be associated with the address.
Parameters
- string $address:
- string $name: optional
Info
Method addReplyTo (line 224)
void addReplyTo(
string
$address, [string
$name = null])
Add a Reply-To: address to this message.
If $name is passed this name will be associated with the address.
Parameters
- string $address:
- string $name: optional
Info
Method addTo (line 274)
void addTo(
string
$address, [string
$name = null])
Add a To: address to this message.
If $name is passed this name will be associated with the address.
Parameters
- string $address:
- string $name: optional
Info
Method attach (line 485)
Attach a Swift_Mime_MimeEntity such as an Attachment or MimePart.
Parameters
Info
Method detach (line 495)
Remove an already attached entity.
Parameters
Info
Method embed (line 515)
This method should be used when embedding images or other data in a message.
Parameters
Info
Method getBcc (line 407)
array getBcc(
)
Implementation of:
- Swift_Mime_Message::getBcc()
- Get the Bcc addresses for this message.
Get the Bcc addresses of this message.
Info
Method getCc (line 359)
array getCc(
)
Implementation of:
- Swift_Mime_Message::getCc()
- Get the Cc addresses for this message.
Get the Cc address of this message.
Info
Method getDate (line 110)
int getDate(
)
Implementation of:
- Swift_Mime_Message::getDate()
- Get the origination date of the message as a UNIX timestamp.
Get the date at which this message was created.
Info
Method getFrom (line 211)
string getFrom(
)
Implementation of:
- Swift_Mime_Message::getFrom()
- Get the From address(es) of this message.
Get the from address of this message.
Info
Method getPriority (line 450)
int getPriority(
)
Get the priority of this message.
The returned value is an integer where 1 is the highest priority and 5 is the lowest.
Info
Method getReadReceiptTo (line 476)
string getReadReceiptTo(
)
Get the addresses to which a read-receipt will be sent.
Info
Method getReplyTo (line 261)
string getReplyTo(
)
Implementation of:
- Swift_Mime_Message::getReplyTo()
- Get the Reply-To addresses for this message.
Get the reply-to address of this message.
Info
Method getReturnPath (line 132)
string getReturnPath(
)
Implementation of:
- Swift_Mime_Message::getReturnPath()
- Get the return-path (bounce-detect) address.
Get the return-path (bounce address) of this message.
Info
Method getSender (line 161)
string getSender(
)
Implementation of:
- Swift_Mime_Message::getSender()
- Get the sender address for this message.
Get the sender of this message.
Info
Method getSubject (line 88)
string getSubject(
)
Implementation of:
- Swift_Mime_Message::getSubject()
- Get the subject of the message.
Get the subject of this message.
Info
Method getTo (line 311)
array getTo(
)
Implementation of:
- Swift_Mime_Message::getTo()
- Get the To addresses for this message.
Get the To addresses of this message.
Info
Method setBcc (line 388)
void setBcc(
array
$addresses, [string
$name = null])
Implementation of:
- Swift_Mime_Message::setBcc()
- Set the Bcc address(es).
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.
Parameters
- array $addresses:
- string $name: optional
Info
Method setCc (line 340)
void setCc(
array
$addresses, [string
$name = null])
Implementation of:
- Swift_Mime_Message::setCc()
- Set the Cc address(es).
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.
Parameters
- array $addresses:
- string $name: optional
Info
Method setDate (line 97)
void setDate(
int
$date)
Implementation of:
- Swift_Mime_Message::setDate()
- Set the origination date of the message as a UNIX timestamp.
Set the date at which this message was created.
Parameters
Info
Method setFrom (line 192)
void setFrom(
string
$addresses, [string
$name = null])
Implementation of:
- Swift_Mime_Message::setFrom()
- Set the From address of this message.
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.
Parameters
- string $addresses:
- string $name: optional
Info
Method setPriority (line 417)
void setPriority(
int
$priority)
Set the priority of this message.
The value is an integer where 1 is the highest priority and 5 is the lowest.
Parameters
Info
Method setReadReceiptTo (line 462)
void setReadReceiptTo(
array
$addresses)
Ask for a delivery receipt from the recipient to be sent to $addresses
Parameters
Info
Method setReplyTo (line 242)
void setReplyTo(
string
$addresses, [string
$name = null])
Implementation of:
- Swift_Mime_Message::setReplyTo()
- Set the Reply-To address(es).
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.
Parameters
- string $addresses:
- string $name: optional
Info
Method setReturnPath (line 119)
void setReturnPath(
string
$address)
Implementation of:
- Swift_Mime_Message::setReturnPath()
- Set the return-path (bounce-detect) address.
Set the return-path (the bounce address) of this message.
Parameters
Info
Method setSender (line 143)
void setSender(
$address, [string
$name = null], string
$sender)
Implementation of:
- Swift_Mime_Message::setSender()
- Set the sender of this message.
Set the sender of this message.
This does not override the From field, but it has a higher significance.
Parameters
- string $sender:
- string $name: optional
- $address:
Info
Method setSubject (line 75)
void setSubject(
string
$subject)
Implementation of:
- Swift_Mime_Message::setSubject()
- Set the subject of the message.
Set the subject of this message.
Parameters
Info
Method setTo (line 292)
void setTo(
array
$addresses, [string
$name = null])
Implementation of:
- Swift_Mime_Message::setTo()
- Set the To address(es).
Set the to addresses of this message.
If multiple recipients will receive the message and array should be used.
If $name is passed and the first parameter is a string, this name will be associated with the address.
Parameters
- array $addresses:
- string $name: optional
Info