Overview

Namespaces

  • Jyxo
    • Beholder
      • TestCase
    • Gettext
      • Parser
    • Input
      • Chain
      • Filter
      • Validator
    • Mail
      • Email
        • Attachment
      • Parser
      • Sender
    • Rpc
      • Json
      • Xml
    • Shell
    • Spl
    • Svn
    • Time
    • Webdav
  • PHP

Classes

  • Email
  • Encoding
  • Parser
  • Sender
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated

Class Email

Email contents container.

Jyxo\Spl\Object implements Jyxo\Spl\ArrayCopy
Extended by Jyxo\Mail\Email
Namespace: Jyxo\Mail
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