Joostina CMS / CMF v2.* API
  • Docs
  • Package
  • Class
  • Tree
  • Todo
Overview

Packages

  • Components
    • Acls
      • Models
        • Admin
        • Site
    • BlogCategory
      • Models
        • Admin
        • Site
    • Blogs
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • Coder
      • Controllers
        • Admin
      • Models
        • Admin
    • Comments
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • CommentsCounter
      • Models
        • Admin
        • Site
    • Mainpage
      • Controllers
        • Site
    • News
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • Pages
      • Controllers
        • Admin
        • Site
      • Models
        • Site
    • Search
      • Controllers
        • Site
    • Site
      • Controllers
        • Admin
        • Site
    • Sitemap
      • Controllers
        • Admin
        • Site
      • Models
        • Admin
        • Site
    • Test
      • Controllers
        • Site
    • Torrents
      • Controllers
        • Site
    • Users
      • Controllers
        • Admin
        • Site
      • Models
        • Admin
        • Site
  • Compression
  • Core
    • Libraries
      • Arhive
      • Array
      • Attached
      • Autoadmin
      • Autoloader
      • Benchmark
      • Breadcrumbs
      • Cache
      • Config
      • Cookie
      • Csrf
      • Database
        • Drivers
          • Interfaces
      • Datetime
      • Debug
      • Editor
      • Events
      • File
      • Filter
      • Flashmessage
      • Folder
      • Hit
      • Html
      • Image
      • Inflector
      • Inputfilter
      • Libraries
      • Mail
      • Module
      • Nestedset
      • Pager
      • Pages
      • Params
      • Randomizer
      • Request
      • RobotLoader
      • Route
      • Security
      • Session
      • Static
      • String
      • Text
      • Trash
      • Validate
  • Email
  • Extra
    • Libraries
      • Basket
  • Joostina
    • Controller
    • Core
    • Document
  • JSMin
  • Libraries
    • Extra
      • Basket
        • Models
          • Site
  • None
  • Plugins
    • Autoadmin
    • Editor
    • Sitemap
  • SimpleMail
  • Vendors
    • Libraries
      • Email

Classes

  • SimpleMail

Class SimpleMail

Used to send basic or complex emails

License: GNU/GPL
Author: Cyril Nicodème
Version: 0.1
Since: 09/07/2008
Located at: app/vendors/simplemail/simplemail/Email/SimpleMail.php

Methods summary

public
# __construct( Array $aProperties = null )

Constructor. Set the Date and optionnaly some properties

Constructor. Set the Date and optionnaly some properties

Parameters

$aProperties
Array
(Optionnal) : The properties to set more quickly
public Void
# __set( String $sKey, Mixed $mValue )

Magic Method setter. Set the properties easily

Magic Method setter. Set the properties easily

Parameters

$sKey
String
: The name of the property
$mValue
Mixed
: The value to set

Returns

Void
public Mixed
# __get( String $sKey )

Magic Method getter. Retrieve the property nicely

Magic Method getter. Retrieve the property nicely

Parameters

$sKey
String
: The name of the property to retrieve

Returns

Mixed
public Void
# addAttachment( String $sFilePath, String $sType = 'Application/Octet-Stream', String $sFileName = null, iCompression $oCompress = null, $sCid = null )

Add an attachment to the email (will be found on Multipart/mixed)

Add an attachment to the email (will be found on Multipart/mixed)

Parameters

$sFilePath
String
: The path of the file to send
$sType
String
(Optionnal, default set to 'Application/Octet-Stream') : The content Type
$sFileName
String
(Optionnal) : The filename to display for the recipient
$oCompress
iCompression
(Optionnal) : An instance of iCompress Class for compress the file
$sCid

Returns

Void
public Void
# addBody( String $sBody, String $sType = 'text/plain', String $sCharset = null )

Add a text to the email

Add a text to the email

Parameters

$sBody
String
: The text to add
$sType
String
(Optionnal, default to 'text/plain') : The content type
$sCharset
String
(Optionnal, default to 'Utf-8') : The Charset

Returns

Void
public Void
# send( )

Send an Email after checking the kind of structure (Normal, Multipart/Alternative, Multipart/Mixed, etc)

Send an Email after checking the kind of structure (Normal, Multipart/Alternative, Multipart/Mixed, etc)

Returns

Void
public String
# inlineAttachment( Array $aMatches )

Modify the src="" element to be joined with the mail as an inline statement

Modify the src="" element to be joined with the mail as an inline statement

Parameters

$aMatches
Array

Returns

String
Joostina CMS / CMF v2.* API API documentation generated by ApiGen 2.6.1 – Template adapted by @olvlv and Joostina Team