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_Sender
  • Jyxo_Mail_Sender_Result
  • Jyxo_Mail_Sender_Smtp

Exceptions

  • Jyxo_Mail_Sender_CreateException
  • Jyxo_Mail_Sender_Exception
  • Jyxo_Mail_Sender_RecipientUnknownException
  • Jyxo_Mail_Sender_SmtpException
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class Jyxo_Mail_Sender

Class for sending emails. Based on PhpMailer class (C) Copyright 2001-2003 Brent R. Matzelle

Category: Jyxo
Package: Jyxo_Mail
Subpackage: Sender
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/Sender.php
Methods summary
public string
# getCharset( )

Returns charset.

Returns charset.

Returns

string
public Jyxo_Mail_Sender
# setCharset( string $charset )

Sets charset.

Sets charset.

Parameters

$charset
string
Final charset

Returns

Jyxo_Mail_Sender
public string
# getHostname( )

Returns hostname.

Returns hostname.

Returns

string
public Jyxo_Mail_Sender
# setHostname( string $hostname )

Sets hostname.

Sets hostname.

Parameters

$hostname
string
Hostname

Returns

Jyxo_Mail_Sender
public string
# getXmailer( )

Returns X-Mailer header value.

Returns X-Mailer header value.

Returns

string
public Jyxo_Mail_Sender
# setXmailer( string $xmailer )

Sets X-Mailer header value.

Sets X-Mailer header value.

Parameters

$xmailer
string
X-Mailer header value

Returns

Jyxo_Mail_Sender
public string
# getEncoding( )

Returns encoding.

Returns encoding.

Returns

string
public Jyxo_Mail_Sender
# setEncoding( string $encoding )

Sets encoding.

Sets encoding.

Parameters

$encoding
string
Encoding

Returns

Jyxo_Mail_Sender

Throws

InvalidArgumentException
If an incompatible encoding was provided
public Jyxo_Mail_Email
# getEmail( )

Returns the email to be sent.

Returns the email to be sent.

Returns

Jyxo_Mail_Email
public Jyxo_Mail_Sender
# setEmail( Jyxo_Mail_Email $email )

Sets the email to be sent.

Sets the email to be sent.

Parameters

$email
Jyxo_Mail_Email
Email instance

Returns

Jyxo_Mail_Sender
public Jyxo_Mail_Sender
# setSmtp( string $host, integer $port = 25, string $helo = '', string $user = '', string $password = '', integer $timeout = 5 )

Sets SMTP parameters.

Sets SMTP parameters.

Parameters

$host
string
Hostname
$port
integer
Port
$helo
string
HELO value
$user
string
Username
$password
string
Password
$timeout
integer
Connection timeout

Returns

Jyxo_Mail_Sender
public Jyxo_Mail_Sender_Result
# send( string $mode )

Sends an email using the given mode.

Sends an email using the given mode.

Parameters

$mode
string
Sending mode

Returns

Jyxo_Mail_Sender_Result

Throws

InvalidArgumentException
If an unknown mode was requested
Jyxo_Mail_Sender_Exception
On error
Jyxo_Mail_Sender_CreateException
If a required setting is missing
Constants summary
string MODE_MAIL 'mail'
#

Send using the internal mail() function.

Send using the internal mail() function.

string MODE_SMTP 'smtp'
#

Send using a SMTP server.

Send using a SMTP server.

string MODE_NONE 'none'
#

No sending. Useful if we actually don't want to send the message but just generate it.

No sending. Useful if we actually don't want to send the message but just generate it.

integer LINE_LENGTH 74
#

Maximum line length.

Maximum line length.

string LINE_END "\n"
#

Line ending.

Line ending.

string TYPE_SIMPLE 'simple'
#

Simple mail type.

Simple mail type.

string TYPE_ALTERNATIVE 'alternative'
#

Email with a HTML and plaintext part.

Email with a HTML and plaintext part.

string TYPE_ALTERNATIVE_ATTACHMENTS 'alternative_attachments'
#

Email with a HTML and plaintext part and attachments.

Email with a HTML and plaintext part and attachments.

string TYPE_ATTACHMENTS 'attachments'
#

Email with attachments.

Email with attachments.

Jyxo PHP Library API documentation generated by ApiGen 2.3.0