Overview

Packages

  • Jyxo_Beholder
  • Jyxo_Charset
  • Jyxo_Color
  • Jyxo_Css
  • Jyxo_ErrorHandling
  • Jyxo_FirePhp
  • Jyxo_Gettext
    • Parser
  • Jyxo_Html
  • Jyxo_Input
    • Chain
    • Filter
    • Validator
  • Jyxo_Mail
    • Email
    • Parser
    • Sender
  • Jyxo_Rpc
    • Json
    • Xml
  • Jyxo_Shell
  • Jyxo_SpamFilter
  • Jyxo_Spl
  • Jyxo_String
  • Jyxo_Svn
  • Jyxo_Time
  • Jyxo_Timer
  • Jyxo_Webdav
  • Jyxo_XmlReader
  • PHP

Classes

  • Jyxo_Mail_Email
  • Jyxo_Mail_Email_Address
  • Jyxo_Mail_Email_Attachment
  • Jyxo_Mail_Email_Attachment_File
  • Jyxo_Mail_Email_Attachment_InlineFile
  • Jyxo_Mail_Email_Attachment_InlineString
  • Jyxo_Mail_Email_Attachment_String
  • Jyxo_Mail_Email_Body
  • Jyxo_Mail_Email_Header
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class Jyxo_Mail_Email

Email contents container.

Jyxo_Spl_Object implements Jyxo_Spl_ArrayCopy
Extended by Jyxo_Mail_Email
Category: Jyxo
Package: Jyxo_Mail
Subpackage: Email
Copyright: Copyright (c) 2005-2011 Jyxo, s.r.o.
License: https://github.com/jyxo/php/blob/master/license.txt
Author: Jaroslav HanslĂ­k
Located at Mail/Email.php
Methods summary
public string
# getSubject( )

Returns subject.

Returns subject.

Returns

string
public Jyxo_Mail_Email
# setSubject( string $subject )

Sets subject.

Sets subject.

Parameters

$subject
string
Subject

Returns

Jyxo_Mail_Email
public Jyxo_Mail_Email_Address
# getFrom( )

Returns sender address.

Returns sender address.

Returns

Jyxo_Mail_Email_Address
public Jyxo_Mail_Email
# setFrom( Jyxo_Mail_Email_Address $from )

Sets sender address.

Sets sender address.

Parameters

$from
Jyxo_Mail_Email_Address
Message sender

Returns

Jyxo_Mail_Email
public array
# getTo( )

Returns list of message recipients.

Returns list of message recipients.

Returns

array
public Jyxo_Mail_Email
# addTo( Jyxo_Mail_Email_Address $to )

Adds a recipient.

Adds a recipient.

Parameters

$to
Jyxo_Mail_Email_Address
New recipient

Returns

Jyxo_Mail_Email
public array
# getCc( )

Returns list of carbon copy recipients.

Returns list of carbon copy recipients.

Returns

array
public Jyxo_Mail_Email
# addCc( Jyxo_Mail_Email_Address $cc )

Adds a carbon copy recipient.

Adds a carbon copy recipient.

Parameters

$cc
Jyxo_Mail_Email_Address
New recipient

Returns

Jyxo_Mail_Email
public array
# getBcc( )

Returns list of blind carbon copy recipients.

Returns list of blind carbon copy recipients.

Returns

array
public Jyxo_Mail_Email
# addBcc( Jyxo_Mail_Email_Address $bcc )

Adds a blind carbon copy recipient.

Adds a blind carbon copy recipient.

Parameters

$bcc
Jyxo_Mail_Email_Address
New recipient

Returns

Jyxo_Mail_Email
public array
# getReplyTo( )

Returns the 'ReplyTo' address.

Returns the 'ReplyTo' address.

Returns

array
public Jyxo_Mail_Email
# addReplyTo( Jyxo_Mail_Email_Address $replyTo )

Adds a 'ReplyTo' address.

Adds a 'ReplyTo' address.

Parameters

$replyTo
Jyxo_Mail_Email_Address

Returns

Jyxo_Mail_Email
public array
# getConfirmReadingTo( )

Returns a reading confirmation address.

Returns a reading confirmation address.

Returns

array
public Jyxo_Mail_Email
# setConfirmReadingTo( Jyxo_Mail_Email_Address $confirmReadingTo )

Sets a reading confirmation address.

Sets a reading confirmation address.

Parameters

$confirmReadingTo
Jyxo_Mail_Email_Address
Confirmation recipient

Returns

Jyxo_Mail_Email
public Jyxo_Mail_Email
# setInReplyTo( string $inReplyTo, array $references = array() )

Sets Id of the message this is a response to.

Sets Id of the message this is a response to.

Parameters

$inReplyTo
string
Message Id
$references
array
Previous mail references

Returns

Jyxo_Mail_Email
public string
# getInReplyTo( )

Returns Id of the message this is a response to.

Returns Id of the message this is a response to.

Returns

string
public array
# getReferences( )

Returns references to previous messages in the thread.

Returns references to previous messages in the thread.

Returns

array
public integer
# getPriority( )

Returns message priority.

Returns message priority.

Returns

integer
public Jyxo_Mail_Email
# setPriority( integer $priority )

Sets message priority.

Sets message priority.

Parameters

$priority
integer
Priority

Returns

Jyxo_Mail_Email

Throws

InvalidArgumentException
If an unknown priority was provided
public array
# getHeaders( )

Returns custom headers.

Returns custom headers.

Returns

array
public Jyxo_Mail_Email
# addHeader( Jyxo_Mail_Email_Header $header )

Adds a custom header.

Adds a custom header.

Parameters

$header
Jyxo_Mail_Email_Header
Header

Returns

Jyxo_Mail_Email
public Jyxo_Mail_Email_Body
# getBody( )

Returns message body.

Returns message body.

Returns

Jyxo_Mail_Email_Body
public Jyxo_Mail_Email
# setBody( Jyxo_Mail_Email_Body $body )

Sets message body.

Sets message body.

Parameters

$body
Jyxo_Mail_Email_Body
Body

Returns

Jyxo_Mail_Email
public array
# getAttachments( )

Returns attachments.

Returns attachments.

Returns

array
public Jyxo_Mail_Email
# addAttachment( Jyxo_Mail_Email_Attachment $attachment )

Adds an attachment.

Adds an attachment.

Parameters

$attachment
Jyxo_Mail_Email_Attachment
Attachment

Returns

Jyxo_Mail_Email
public boolean
# hasInlineAttachments( )

Checks if the message contains any attachments.

Checks if the message contains any attachments.

Returns

boolean
Methods inherited from Jyxo_Spl_Object
__get(), __isset(), __set(), getClass(), toArray()
Constants summary
integer PRIORITY_HIGHEST 1
#

Highest priority.

Highest priority.

integer PRIORITY_HIGH 2
#

High priority.

High priority.

integer PRIORITY_NORMAL 3
#

Normal priority.

Normal priority.

integer PRIORITY_LOW 4
#

Low priority.

Low priority.

integer PRIORITY_LOWEST 5
#

Lowest priority.

Lowest priority.

Jyxo PHP Library API documentation generated by ApiGen 2.3.0