StudipMail Class Reference

Collaboration diagram for StudipMail:

Public Member Functions
	__construct ()
	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 ($dokument_id)
	removeAttachment ($name)
	getAttachments ()
	isAttachment ($name)
	setBodyText ($body)
	getBodyText ()
	setBodyHtml ($body)
	getBodyHtml ()
	send (email_message_class $transporter=null)

Static Public Member Functions
static	setDefaultTransporter (email_message_class $transporter)
static	getDefaultTransporter ()
static	sendMessage ($recipient, $subject, $text)
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-quest>, Suchi & Berg GmbH info@.nosp@m.data.nosp@m.-ques.nosp@m.t.de

Version

1

Constructor & Destructor Documentation

__construct

(

)

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	(		$data,
			$name,
			$type = 'automatic/name',
			$disposition = 'attachment'
	)

Parameters

$data
$name
$type
$disposition

Returns

StudipMail provides fluent interface

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	(		$mail,
			$name = '',
			$type = 'To'
	)

Parameters

$mail
$name
$type

Returns

StudipMail provides fluent interface

addStudipAttachment

(

$dokument_id

)

Parameters

$dokument_id

Returns

StudipMail provides fluent interface

Here is the call graph for this function:

getAttachments

(

)

Returns

array

Here is the caller graph for this function:

getBodyHtml

(

)

Returns

unknown_type

Here is the caller graph for this function:

getBodyText

(

)

Returns

unknown_type

Here is the caller graph for this function:

static getDefaultTransporter ( )

static

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

Returns

email_message_class

Here is the caller graph for this function:

getRecipients

(

)

Returns

array

Here is the caller graph for this function:

getReplyToEmail

(

)

Returns

unknown_type

Here is the caller graph for this function:

getReplyToName

(

)

Returns

unknown_type

Here is the caller graph for this function:

getSenderEmail

(

)

Returns

string

Here is the caller graph for this function:

getSenderName

(

)

Returns

unknown_type

Here is the caller graph for this function:

getSubject

(

)

Returns

unknown_type

Here is the caller graph for this function:

isAttachment

(

$name

)

Parameters

$name

Returns

unknown_type

isRecipient

(

$mail

)

Parameters

$mail

Returns

unknown_type

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

(

$name

)

Parameters

$name

Returns

StudipMail provides fluent interface

removeRecipient

(

$mail

)

Parameters

$mail

Returns

StudipMail provides fluent interface

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:

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:

static sendMessage (   $recipient,   $subject,   $text  )

static

convenience method for sending a qick, text based email message

Parameters

string	$recipient
string	$subject
string	$text

Returns

bool

Here is the caller graph for this function:

setBodyHtml

(

$body

)

Parameters

$body

Returns

StudipMail provides fluent interface

setBodyText

(

$body

)

Parameters

$body

Returns

StudipMail provides fluent interface

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

(

$mail

)

Parameters

$mail

Returns

StudipMail provides fluent interface

Here is the caller graph for this function:

setReplyToName

(

$name

)

Parameters

$name

Returns

StudipMail provides fluent interface

setSenderEmail

(

$mail

)

Parameters

string

$mail

Returns

StudipMail provides fluent interface

Here is the caller graph for this function:

setSenderName

(

$name

)

Parameters

string

$name

Returns

StudipMail provides fluent interface

Here is the caller graph for this function:

setSubject

(

$subject

)

Parameters

$subject

Returns

StudipMail provides fluent interface

---

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

• lib/classes/StudipMail.class.php