StudipMail Class Reference

Collaboration diagram for StudipMail:

Public Member Functions
	__construct ($data=null)
	setSenderEmail ($mail)
	getSenderEmail ()
	setSenderName ($name)
	getSenderName ()
	setReplyToEmail ($mail)
	getReplyToEmail ()
	setReplyToName ($name)
	getReplyToName ()
	setSubject ($subject)
	getSubject ()
	addRecipient ($mail, $name='', $type='To')
	removeRecipient ($mail)
	getRecipients ()
	isRecipient ($mail)
	addFileAttachment ($file_name, $name='', $type='automatic/name', $disposition='attachment')
	addDataAttachment ($data, $name, $type='automatic/name', $disposition='attachment')
	addStudipAttachment (FileRef $file_ref)
	removeAttachment ($name)
	getAttachments ()
	isAttachment ($name)
	setBodyText ($body)
	getBodyText ()
	setBodyHtml ($body)
	getBodyHtml ()
	send (email_message_class $transporter=null)
	toArray ()
	setData ($data)

Static Public Member Functions
static	setDefaultTransporter (email_message_class $transporter)
static	getDefaultTransporter ()
static	sendMessage ($recipient, $subject, $text, $html=null)
static	sendAbuseMessage ($subject, $text)

Static Protected Member Functions
static	quoteString ($string)

Detailed Description

StudipMail.class.php

class for constructing and sending emails in Stud.IP

Author

André Noack <noack@data-quest>, Suchi & Berg GmbH info@.nosp@m.data.nosp@m.-ques.nosp@m.t.de

Version

1 @license GPL2 or any later version

Copyright

2009 authors

Constructor & Destructor Documentation

__construct()

__construct

(

$data = null

)

sets some default values for sender and reply to from configuration settings. The return path is always set to MAIL_ABUSE

Here is the call graph for this function:

Member Function Documentation

addDataAttachment()

addDataAttachment	(		$data,
			$name,
			$type = 'automatic/name',
			$disposition = 'attachment'
	)

Parameters

$data
$name
$type
$disposition

Returns

StudipMail provides fluent interface

addFileAttachment()

addFileAttachment	(		$file_name,
			$name = '',
			$type = 'automatic/name',
			$disposition = 'attachment'
	)

Parameters

$file_name
$name
$type
$disposition

Returns

StudipMail provides fluent interface

Here is the caller graph for this function:

addRecipient()

addRecipient	(		$mail,
			$name = '',
			$type = 'To'
	)

Parameters

$mail
$name
$type

Returns

StudipMail provides fluent interface

addStudipAttachment()

addStudipAttachment

(

FileRef

$file_ref

)

Parameters

FileRef

$file_ref

The FileRef object of a file that shall be added to a mail

Returns

StudipMail provides fluent interface

Here is the call graph for this function:

getAttachments()

getAttachments

(

)

Returns

array

Here is the caller graph for this function:

getBodyHtml()

getBodyHtml

(

)

Returns

unknown_type

Here is the caller graph for this function:

getBodyText()

getBodyText

(

)

Returns

unknown_type

Here is the caller graph for this function:

getDefaultTransporter()

static getDefaultTransporter ( )

static

gets the default transporter used in StudipMail::send()

Returns

email_message_class

Here is the caller graph for this function:

getRecipients()

getRecipients

(

)

Returns

array

Here is the caller graph for this function:

getReplyToEmail()

getReplyToEmail

(

)

Returns

unknown_type

Here is the caller graph for this function:

getReplyToName()

getReplyToName

(

)

Returns

unknown_type

Here is the caller graph for this function:

getSenderEmail()

getSenderEmail

(

)

Returns

string

Here is the caller graph for this function:

getSenderName()

getSenderName

(

)

Returns

unknown_type

Here is the caller graph for this function:

getSubject()

getSubject

(

)

Returns

unknown_type

Here is the caller graph for this function:

isAttachment()

isAttachment

(

$name

)

Parameters

$name

Returns

unknown_type

isRecipient()

isRecipient

(

$mail

)

Parameters

$mail

Returns

unknown_type

quoteString()

static quoteString (   $string )

staticprotected

quotes the given string if it contains any characters reserved for special interpretation in RFC 2822.

Here is the caller graph for this function:

removeAttachment()

removeAttachment

(

$name

)

Parameters

$name

Returns

StudipMail provides fluent interface

removeRecipient()

removeRecipient

(

$mail

)

Parameters

$mail

Returns

StudipMail provides fluent interface

send()

send

(

email_message_class

$transporter = null

)

send the mail using the given transporter object, or the set default transporter

Parameters

email_message_class

$transporter

Returns

bool

Here is the call graph for this function:

sendAbuseMessage()

static sendAbuseMessage (   $subject,   $text  )

static

convenience method for sending a qick, text based email message to the configured abuse adress

Parameters

string	$subject
string	$text

Returns

bool

Here is the caller graph for this function:

sendMessage()

static sendMessage (   $recipient,   $subject,   $text,   $html = null  )

static

convenience method for sending a qick, text based email message

Parameters

string	$recipient
string	$subject
string	$text	Plain text version of the message (required).
string	$html	HTML version of the message (optional).

Returns

bool

Here is the caller graph for this function:

setBodyHtml()

setBodyHtml

(

$body

)

Parameters

$body

Returns

StudipMail provides fluent interface

setBodyText()

setBodyText

(

$body

)

Parameters

$body

Returns

StudipMail provides fluent interface

setData()

setData

(

$data

)

Here is the caller graph for this function:

setDefaultTransporter()

static setDefaultTransporter ( email_message_class  $transporter )

static

Sets the default transporter used in StudipMail::send()

Parameters

email_message_class

$transporter

Returns

void

Here is the caller graph for this function:

setReplyToEmail()

setReplyToEmail

(

$mail

)

Parameters

$mail

Returns

StudipMail provides fluent interface

Here is the caller graph for this function:

setReplyToName()

setReplyToName

(

$name

)

Parameters

$name

Returns

StudipMail provides fluent interface

setSenderEmail()

setSenderEmail

(

$mail

)

Parameters

string

$mail

Returns

StudipMail provides fluent interface

Here is the caller graph for this function:

setSenderName()

setSenderName

(

$name

)

Parameters

string

$name

Returns

StudipMail provides fluent interface

Here is the caller graph for this function:

setSubject()

setSubject

(

$subject

)

Parameters

$subject

Returns

StudipMail provides fluent interface

toArray()

toArray

(

)

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• lib/classes/StudipMail.class.php