include/SugarPHPMailer.php
inherited
Classes
\SugarPHPMailer
Sugar mailer
- Parent(s)
- \PHPMailer
- Api
Constants
STOP_MESSAGE
= 0- Inherited_from
- \PHPMailer::STOP_MESSAGE
STOP_CONTINUE
= 1- Inherited_from
- \PHPMailer::STOP_CONTINUE
STOP_CRITICAL
= 2- Inherited_from
- \PHPMailer::STOP_CRITICAL
Properties
string
$AltBody= ''''
Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.
Inherited from: \PHPMailer::$$AltBody''Details- Type
- string
- Inherited_from
- \PHPMailer::$$AltBody
string
$Body= ''''
Sets the Body of the message. This can be either an HTML or text body.
Inherited from: \PHPMailer::$$Bodystring
$CharSet= ''utf-8''
'utf-8'Details- Type
- string
- Inherited_from
- \PHPMailer::$$CharSet
string
$ConfirmReadingTo= ''''
Sets the email address that a reading confirmation will be sent.
Inherited from: \PHPMailer::$$ConfirmReadingTo''Details- Type
- string
- Inherited_from
- \PHPMailer::$$ConfirmReadingTo
string
$ContentType= ''text/plain''
'text/plain'Details- Type
- string
- Inherited_from
- \PHPMailer::$$ContentType
$CustomHeader= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$CustomHeader
string
$DKIM_domain= ''''
Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com'
Inherited from: \PHPMailer::$$DKIM_domain''Details- Type
- string
- Inherited_from
- \PHPMailer::$$DKIM_domain
string
$DKIM_identity= ''''
Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com'
Inherited from: \PHPMailer::$$DKIM_identity''Details- Type
- string
- Inherited_from
- \PHPMailer::$$DKIM_identity
string
$DKIM_passphrase= ''''
''Details- Type
- string
- Inherited_from
- \PHPMailer::$$DKIM_passphrase
string
$DKIM_private= ''''
Used with DKIM DNS Resource Record optional, in format of email address 'you@yourdomain.com'
Inherited from: \PHPMailer::$$DKIM_private''Details- Type
- string
- Inherited_from
- \PHPMailer::$$DKIM_private
string
$DKIM_selector= ''phpmailer''
'phpmailer'Details- Type
- string
- Inherited_from
- \PHPMailer::$$DKIM_selector
string
$Encoding= ''8bit''
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Inherited from: \PHPMailer::$$Encoding'8bit'Details- Type
- string
- Inherited_from
- \PHPMailer::$$Encoding
string
$From= ''root@localhost''
'root@localhost'Details- Type
- string
- Inherited_from
- \PHPMailer::$$From
string
$FromName= ''Root User''
'Root User'Details- Type
- string
- Inherited_from
- \PHPMailer::$$FromName
string
$Helo= ''''
Sets the SMTP HELO of the message (Default is $Hostname).
Inherited from: \PHPMailer::$$Helo''Details- Type
- string
- Inherited_from
- \PHPMailer::$$Helo
string
$Host= ''localhost''
Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com").
Inherited from: \PHPMailer::$$HostHosts will be tried in order.
'localhost'Details- Type
- string
- Inherited_from
- \PHPMailer::$$Host
string
$Hostname= ''''
Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.
Inherited from: \PHPMailer::$$Hostname''Details- Type
- string
- Inherited_from
- \PHPMailer::$$Hostname
string
$MIMEBody= ''''
''Details- Type
- string
- Access
- protected
- Inherited_from
- \PHPMailer::$$MIMEBody
string
$MIMEHeader= ''''
''Details- Type
- string
- Access
- protected
- Inherited_from
- \PHPMailer::$$MIMEHeader
string
$MessageID= ''''
Sets the message ID to be used in the Message-Id header.
Inherited from: \PHPMailer::$$MessageIDIf empty, a unique id will be generated.
''Details- Type
- string
- Inherited_from
- \PHPMailer::$$MessageID
string
$PluginDir= ''''
Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.
Inherited from: \PHPMailer::$$PluginDir''Details- Type
- string
- Inherited_from
- \PHPMailer::$$PluginDir
$ReplyTo= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$ReplyTo
bool
$SMTPAuth= 'false'
Sets SMTP authentication. Utilizes the Username and Password variables.
Inherited from: \PHPMailer::$$SMTPAuthfalseDetails- Type
- bool
- Inherited_from
- \PHPMailer::$$SMTPAuth
bool
$SMTPKeepAlive= 'false'
Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().
Inherited from: \PHPMailer::$$SMTPKeepAlivefalseDetails- Type
- bool
- Inherited_from
- \PHPMailer::$$SMTPKeepAlive
string
$SMTPSecure= ''''
Options are "", "ssl" or "tls"
''Details- Type
- string
- Inherited_from
- \PHPMailer::$$SMTPSecure
string
$Sender= ''''
Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
Inherited from: \PHPMailer::$$Sender''Details- Type
- string
- Inherited_from
- \PHPMailer::$$Sender
string
$Sendmail= ''/usr/sbin/sendmail''
'/usr/sbin/sendmail'Details- Type
- string
- Inherited_from
- \PHPMailer::$$Sendmail
string
$SentMIMEMessage= ''''
Stores the complete sent MIME message (Body and Headers)
Inherited from: \PHPMailer::$$SentMIMEMessage''Details- Type
- string
- Access
- protected
- Inherited_from
- \PHPMailer::$$SentMIMEMessage
bool
$SingleTo= 'false'
Provides the ability to have the TO field process individual emails, instead of sending to entire TO addresses
Inherited from: \PHPMailer::$$SingleTofalseDetails- Type
- bool
- Inherited_from
- \PHPMailer::$$SingleTo
bool
$SingleToArray= 'array()'
If SingleTo is true, this provides the array to hold the email addresses
Inherited from: \PHPMailer::$$SingleToArrayarray()Details- Type
- bool
- Inherited_from
- \PHPMailer::$$SingleToArray
int
$Timeout= '10'
This function will not work with the win32 version.
10Details- Type
- int
- Inherited_from
- \PHPMailer::$$Timeout
string
$Version= ''5.2.1''
'5.2.1'Details- Type
- string
- Inherited_from
- \PHPMailer::$$Version
int
$WordWrap= '0'
Sets word wrapping on the body of the message to a given number of characters.
Inherited from: \PHPMailer::$$WordWrap0Details- Type
- int
- Inherited_from
- \PHPMailer::$$WordWrap
string
$action_function= ''''
Callback Action function name the function that handles the result of the send email action. Parameters: bool $result result of the send action string $to email address of the recipient string $cc cc email addresses string $bcc bcc email addresses string $subject the subject string $body the email body
Inherited from: \PHPMailer::$$action_function''Details- Type
- string
- Inherited_from
- \PHPMailer::$$action_function
$all_recipients= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$all_recipients
$attachment= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$attachment
$bcc= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$bcc
$boundary= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$boundary
$cc= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$cc
$disclosureEnabled= ''
- Type
- n/a
$disclosureText= ''
- Type
- n/a
$error_count= '0'
0Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$error_count
$exceptions= 'false'
falseDetails- Type
- n/a
- Inherited_from
- \PHPMailer::$$exceptions
$isHostEmpty= 'false'
falseDetails- Type
- n/a
$language= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$language
$message_type= ''''
''Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$message_type
$oe= ''
- Type
- n/a
$opensslOpened= 'true'
trueDetails- Type
- n/a
$preppedForOutbound= 'false'
falseDetails- Type
- n/a
$protocol= '"tcp://"'
"tcp://"Details- Type
- n/a
$sign_cert_file= ''''
''Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$sign_cert_file
$sign_key_file= ''''
''Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$sign_key_file
$sign_key_pass= ''''
''Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$sign_key_pass
$smtp= 'NULL'
NULLDetails- Type
- n/a
- Inherited_from
- \PHPMailer::$$smtp
$to= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \PHPMailer::$$to
Methods
AddAddress(
string $address, string $name
=
''
)
:
boolean| Name | Type | Description |
|---|---|---|
| $address | string | |
| $name | string |
| Type | Description |
|---|---|
| boolean | true on success, false if address already used |
AddAnAddress(
string $kind, string $address, string $name
=
''
)
:
booleanAdds an address to one of the recipient arrays Addresses that have been added already return false, but do not throw exceptions
Inherited from: \PHPMailer::AddAnAddress()| Name | Type | Description |
|---|---|---|
| $kind | string | One of 'to', 'cc', 'bcc', 'ReplyTo' |
| $address | string | The email address to send to |
| $name | string |
| Type | Description |
|---|---|
| boolean | true on success, false if address already used or invalid in some way |
- Access
- protected
AddAttachment(
string $path, string $name
=
'', string $encoding
=
'base64', string $type
=
'application/octet-stream'
)
:
boolAdds an attachment from a path on the filesystem.
Inherited from: \PHPMailer::AddAttachment()Returns false if the file could not be found or accessed.
| Name | Type | Description |
|---|---|---|
| $path | string | Path to the attachment. |
| $name | string | Overrides the attachment name. |
| $encoding | string | File encoding (see $Encoding). |
| $type | string | File extension (MIME) type. |
| Type | Description |
|---|---|
| bool |
AddBCC(
string $address, string $name
=
''
)
:
boolean
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
| Name | Type | Description |
|---|---|---|
| $address | string | |
| $name | string |
| Type | Description |
|---|---|
| boolean | true on success, false if address already used |
AddCC(
string $address, string $name
=
''
)
:
boolean
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
| Name | Type | Description |
|---|---|---|
| $address | string | |
| $name | string |
| Type | Description |
|---|---|
| boolean | true on success, false if address already used |
AddCustomHeader(
$custom_header
)
:
void
| Name | Type | Description |
|---|---|---|
| $custom_header |
- Access
- public
AddEmbeddedImage(
string $path, string $cid, string $name
=
'', string $encoding
=
'base64', string $type
=
'application/octet-stream'
)
:
boolAdds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif".
Inherited from: \PHPMailer::AddEmbeddedImage()| Name | Type | Description |
|---|---|---|
| $path | string | Path to the attachment. |
| $cid | string | Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form. |
| $name | string | Overrides the attachment name. |
| $encoding | string | File encoding (see $Encoding). |
| $type | string | File extension (MIME) type. |
| Type | Description |
|---|---|
| bool |
AddReplyTo(
string $address, string $name
=
''
)
:
boolean
| Name | Type | Description |
|---|---|---|
| $address | string | |
| $name | string |
| Type | Description |
|---|---|
| boolean |
AddStringAttachment(
string $string, string $filename, string $encoding
=
'base64', string $type
=
'application/octet-stream'
)
:
voidAdds a string or binary attachment (non-filesystem) to the list.
Inherited from: \PHPMailer::AddStringAttachment()This method can be used to attach ascii or binary data, such as a BLOB record from a database.
| Name | Type | Description |
|---|---|---|
| $string | string | String attachment data. |
| $filename | string | Name of the attachment. |
| $encoding | string | File encoding (see $Encoding). |
| $type | string | File extension (MIME) type. |
AddStringEmbeddedImage(
$string, $cid, $filename
=
'', $encoding
=
'base64', $type
=
'application/octet-stream'
)
:
void| Name | Type | Description |
|---|---|---|
| $string | ||
| $cid | ||
| $filename | ||
| $encoding | ||
| $type |
AddrAppend(
$type, $addr
)
:
string
| Name | Type | Description |
|---|---|---|
| $type | ||
| $addr |
| Type | Description |
|---|---|
| string |
- Access
- public
AddrFormat(
$addr
)
:
string
| Name | Type | Description |
|---|---|---|
| $addr |
| Type | Description |
|---|---|
| string |
- Access
- public
AttachAll(
)
:
stringAttaches all fs, string, and binary attachments to the message.
Returns an empty string on failure.
| Type | Description |
|---|---|
| string |
- Access
- private
Base64EncodeWrapMB(
string $str
)
:
stringCorrectly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
Inherited from: \PHPMailer::Base64EncodeWrapMB()Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php
| Name | Type | Description |
|---|---|---|
| $str | string | multi-byte text to wrap encode |
| Type | Description |
|---|---|
| string |
- Access
- public
ClearAddresses(
)
:
voidClears all recipients assigned in the TO array. Returns void.
Inherited from: \PHPMailer::ClearAddresses()ClearAllRecipients(
)
:
voidClears all recipients assigned in the TO, CC and BCC array. Returns void.
Inherited from: \PHPMailer::ClearAllRecipients()ClearAttachments(
)
:
voidClears all previously set filesystem, string, and binary attachments. Returns void.
Inherited from: \PHPMailer::ClearAttachments()ClearBCCs(
)
:
voidClears all recipients assigned in the BCC array. Returns void.
Inherited from: \PHPMailer::ClearBCCs()ClearCCs(
)
:
voidClears all recipients assigned in the CC array. Returns void.
Inherited from: \PHPMailer::ClearCCs()ClearCustomHeaders(
)
:
void
ClearReplyTos(
)
:
voidClears all recipients assigned in the ReplyTo array. Returns void.
Inherited from: \PHPMailer::ClearReplyTos()CreateBody(
)
:
stringAssembles the message body. Returns an empty string on failure.
Inherited from: \PHPMailer::CreateBody()| Type | Description |
|---|---|
| string | The assembled message body |
- Access
- public
CreateHeader(
)
:
string
| Type | Description |
|---|---|
| string | The assembled header |
- Access
- public
DKIM_Add(
string $headers_line, string $subject, string $body
)
:
void
| Name | Type | Description |
|---|---|---|
| $headers_line | string | Header lines |
| $subject | string | Subject |
| $body | string | Body |
- Access
- public
DKIM_BodyC(
string $body
)
:
void
| Name | Type | Description |
|---|---|---|
| $body | string | Message Body |
- Access
- public
DKIM_HeaderC(
string $s
)
:
void
| Name | Type | Description |
|---|---|---|
| $s | string | Header |
- Access
- public
DKIM_QP(
$txt
)
:
voidSet the private key file and password to sign the message.
Inherited from: \PHPMailer::DKIM_QP()| Name | Type | Description |
|---|---|---|
| $txt |
- Access
- public
DKIM_Sign(
string $s
)
:
void
| Name | Type | Description |
|---|---|---|
| $s | string | Header |
- Access
- public
EncodeFile(
string $path, string $encoding
=
'base64'
)
:
string
Returns an empty string on failure.
| Name | Type | Description |
|---|---|---|
| $path | string | The full path to the file |
| $encoding | string | The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' |
| Type | Description |
|---|---|
| string |
- Access
- protected
- See
- \EncodeFile()
EncodeHeader(
$str, $position
=
'text'
)
:
stringEncode a header string to best (shortest) of Q, B, quoted or none.
Inherited from: \PHPMailer::EncodeHeader()| Name | Type | Description |
|---|---|---|
| $str | ||
| $position |
| Type | Description |
|---|---|
| string |
- Access
- public
EncodeQ(
string $str, string $position
=
'text'
)
:
string
| Name | Type | Description |
|---|---|---|
| $str | string | the text to encode |
| $position | string | Where the text is going to be used, see the RFC for what that means |
| Type | Description |
|---|---|
| string |
- Access
- public
- Link
- http://tools.ietf.org/html/rfc2047
EncodeQP(
string $string, integer $line_max
=
76, boolean $space_conv
=
false
)
:
stringEncode string to RFC2045 (6.7) quoted-printable format Uses a PHP5 stream filter to do the encoding about 64x faster than the old version Also results in same content as you started with after decoding
Inherited from: \PHPMailer::EncodeQP()| Name | Type | Description |
|---|---|---|
| $string | string | the text to encode |
| $line_max | integer | Number of chars allowed on a line before wrapping |
| $space_conv | boolean | Dummy param for compatibility with existing EncodeQP function |
| Type | Description |
|---|---|
| string |
- Access
- public
- Author
- Marcus Bointon
- See
- \EncodeQPphp()
EncodeQPphp(
$input
=
'', integer $line_max
=
76, $space_conv
=
false
)
:
string
Only uses standard PHP, slow, but will always work
| Name | Type | Description |
|---|---|---|
| $input | ||
| $line_max | integer | Number of chars allowed on a line before wrapping |
| $space_conv |
| Type | Description |
|---|---|
| string |
- Access
- public
EncodeString(
string $str, string $encoding
=
'base64'
)
:
string
Returns an empty string on failure.
| Name | Type | Description |
|---|---|---|
| $str | string | The text to encode |
| $encoding | string | The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' |
| Type | Description |
|---|---|
| string |
- Access
- public
EndBoundary(
$boundary
)
:
string
| Name | Type | Description |
|---|---|---|
| $boundary |
| Type | Description |
|---|---|
| string |
- Access
- protected
FixEOL(
$str
)
:
string
| Name | Type | Description |
|---|---|---|
| $str |
| Type | Description |
|---|---|
| string |
- Access
- public
GetAttachments(
)
:
array
| Type | Description |
|---|---|
| array |
GetBoundary(
$boundary, $charSet, $contentType, $encoding
)
:
string
| Name | Type | Description |
|---|---|---|
| $boundary | ||
| $charSet | ||
| $contentType | ||
| $encoding |
| Type | Description |
|---|---|
| string |
- Access
- protected
GetMailMIME(
)
:
string
| Type | Description |
|---|---|
| string |
- Access
- public
GetSentMIMEMessage(
)
:
stringReturns the MIME message (headers and body). Only really valid post PreSend().
Inherited from: \PHPMailer::GetSentMIMEMessage()| Type | Description |
|---|---|
| string |
- Access
- public
GetTranslations(
)
:
array
| Type | Description |
|---|---|
| array |
HasMultiBytes(
string $str
)
:
boolChecks if a string contains multibyte characters.
Inherited from: \PHPMailer::HasMultiBytes()| Name | Type | Description |
|---|---|---|
| $str | string | multi-byte text to wrap encode |
| Type | Description |
|---|---|
| bool |
- Access
- public
HeaderLine(
$name, $value
)
:
string
| Name | Type | Description |
|---|---|---|
| $name | ||
| $value |
| Type | Description |
|---|---|
| string |
- Access
- public
InlineImageExists(
)
:
boolReturns true if an inline attachment is present.
Inherited from: \PHPMailer::InlineImageExists()| Type | Description |
|---|---|
| bool |
- Access
- public
IsError(
)
:
bool
| Type | Description |
|---|---|
| bool |
- Access
- public
IsHTML(
bool $ishtml
=
true
)
:
void
| Name | Type | Description |
|---|---|---|
| $ishtml | bool |
IsMail(
)
:
voidSets Mailer to send message using PHP mail() function.
Inherited from: \PHPMailer::IsMail()IsQmail(
)
:
void
IsSMTP(
)
:
void
IsSendmail(
)
:
voidSets Mailer to send message using the $Sendmail program.
Inherited from: \PHPMailer::IsSendmail()Lang(
$key
)
:
string
| Name | Type | Description |
|---|---|---|
| $key |
| Type | Description |
|---|---|
| string |
- Access
- protected
MailSend(
string $header, string $body
)
:
bool
| Name | Type | Description |
|---|---|---|
| $header | string | The message headers |
| $body | string | The message body |
| Type | Description |
|---|---|
| bool |
- Access
- protected
MsgHTML(
$message, $basedir
=
''
)
:
\$messageEvaluates the message and returns modifications for inline images and backgrounds
Inherited from: \PHPMailer::MsgHTML()| Name | Type | Description |
|---|---|---|
| $message | ||
| $basedir |
| Type | Description |
|---|---|
| \$message |
- Access
- public
PreSend(
)
:
voidRFCDate(
)
:
string
| Type | Description |
|---|---|
| string |
- Access
- public
- Static
SecureHeader(
string $str
)
:
string
| Name | Type | Description |
|---|---|---|
| $str | string | String |
| Type | Description |
|---|---|
| string |
- Access
- public
Send(
)
:
boolCreates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.
Inherited from: \PHPMailer::Send()| Type | Description |
|---|---|
| bool |
SendmailSend(
string $header, string $body
)
:
bool
| Name | Type | Description |
|---|---|---|
| $header | string | The message headers |
| $body | string | The message body |
| Type | Description |
|---|---|
| bool |
- Access
- protected
ServerHostname(
)
:
stringReturns the server hostname or 'localhost.localdomain' if unknown.
Inherited from: \PHPMailer::ServerHostname()| Type | Description |
|---|---|
| string |
- Access
- protected
SetError(
$msg
)
:
voidoverloads class.phpmailer's SetError() method so that we can log errors in sugarcrm.log
| Name | Type | Description |
|---|---|---|
| $msg |
SetFrom(
string $address, string $name
=
'', $auto
=
1
)
:
boolean
| Name | Type | Description |
|---|---|---|
| $address | string | |
| $name | string | |
| $auto |
| Type | Description |
|---|---|
| boolean |
SetLanguage(
string $langcode
=
'en', string $lang_path
=
'language/'
)
:
void
Returns false if it cannot load the language file. The default language is English.
| Name | Type | Description |
|---|---|---|
| $langcode | string | ISO 639-1 2-character language code (e.g. Portuguese: "br") |
| $lang_path | string | Path to the language file directory |
- Access
- public
SetMessageType(
)
:
void
- Access
- protected
SetWordWrap(
)
:
void
- Access
- public
Sign(
$cert_filename, string $key_filename, string $key_pass
)
:
voidSet the private key file and password to sign the message.
Inherited from: \PHPMailer::Sign()| Name | Type | Description |
|---|---|---|
| $cert_filename | ||
| $key_filename | string | Parameter File Name |
| $key_pass | string | Password for private key |
- Access
- public
SmtpClose(
)
:
void
SmtpConnect(
)
:
boolInitiates a connection to an SMTP server.
Returns false if the operation failed.
| Type | Description |
|---|---|
| bool |
SmtpSend(
string $header, string $body
)
:
boolSends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Inherited from: \PHPMailer::SmtpSend()| Name | Type | Description |
|---|---|---|
| $header | string | The message headers |
| $body | string | The message body |
| Type | Description |
|---|---|
| bool |
- Access
- protected
- Uses
- \SMTP
SugarPHPMailer(
)
:
voidSole constructor
TextLine(
$value
)
:
string
| Name | Type | Description |
|---|---|---|
| $value |
| Type | Description |
|---|---|
| string |
- Access
- public
UTF8CharBoundary(
string $encodedText, int $maxLength
)
:
intFinds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
Inherited from: \PHPMailer::UTF8CharBoundary()Original written by Colin Brown.
| Name | Type | Description |
|---|---|---|
| $encodedText | string | utf-8 QP text |
| $maxLength | int | find last character boundary prior to this length |
| Type | Description |
|---|---|
| int |
- Access
- public
ValidateAddress(
string $address
)
:
booleanCheck that a string looks roughly like an email address should Static so it can be used without instantiation Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator Conforms approximately to RFC2822
Inherited from: \PHPMailer::ValidateAddress()| Name | Type | Description |
|---|---|---|
| $address | string | The email address to check |
| Type | Description |
|---|---|
| boolean |
- Access
- public
- Link
- Original pattern found here
- Static
WrapText(
string $message, integer $length, boolean $qp_mode
=
false
)
:
stringWraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
Inherited from: \PHPMailer::WrapText()Original written by philippe.
| Name | Type | Description |
|---|---|---|
| $message | string | The message to wrap |
| $length | integer | The line length to wrap to |
| $qp_mode | boolean | Whether to run in Quoted-Printable mode |
| Type | Description |
|---|---|
| string |
- Access
- public
__construct(
boolean $exceptions
=
false
)
:
void
| Name | Type | Description |
|---|---|---|
| $exceptions | boolean | Should we throw external exceptions? |
_mime_types(
string $ext
=
''
)
:
stringGets the MIME type of the embedded or inline image
Inherited from: \PHPMailer::_mime_types()| Name | Type | Description |
|---|---|---|
| $ext | string | File extension |
| Type | Description |
|---|---|
| string | MIME type of ext |
- Access
- public
- Static
doCallback(
$isSent, $to, $cc, $bcc, $subject, $body
)
:
void| Name | Type | Description |
|---|---|---|
| $isSent | ||
| $to | ||
| $cc | ||
| $bcc | ||
| $subject | ||
| $body |
handleAttachments(
\notes $notes
)
:
void| Name | Type | Description |
|---|---|---|
| $notes | \notes | array of note beans |
prepForOutbound(
)
:
voidhandles Charset translation for all visual parts of the email.
replaceImageByRegex(
string $regex, string $local_prefix, bool $object
=
false
)
:
voidReplace images with locations specified by regex with cid: images and attach needed files
| Name | Type | Description |
|---|---|---|
| $regex | string | Regular expression |
| $local_prefix | string | Prefix where local files are stored |
| $object | bool | Use attachment object |
set(
string $name, mixed $value
=
''
)
:
void
Usage Example: $page->set('X-Priority', '3');
| Name | Type | Description |
|---|---|---|
| $name | string | Parameter Name |
| $value | mixed | Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset |
- Access
- public
setMailer(
)
:
voidPrefills outbound details
setMailerForSystem(
)
:
voidPrefills mailer for system