Stud.IP  5.4
Public Member Functions | Static Public Member Functions | Static Protected Member Functions
StudipMail Class Reference

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)
 
 addRelatedAttachment (string $file_name, string $name, string $type, string $content_id)
 
 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 getAbuseEmail ()
 
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-quest>, Suchi & Berg GmbH info@.nosp@m.data.nosp@m.-ques.nosp@m.t.de
Version
1 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.

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

◆ addRecipient()

addRecipient (   $mail,
  $name = '',
  $type = 'To' 
)
Parameters
$mail
$name
$type
Returns
StudipMail provides fluent interface

◆ addRelatedAttachment()

addRelatedAttachment ( string  $file_name,
string  $name,
string  $type,
string  $content_id 
)

◆ addStudipAttachment()

addStudipAttachment ( FileRef  $file_ref)
Parameters
FileRef$file_refThe FileRef object of a file that shall be added to a mail
Returns
StudipMail provides fluent interface

◆ getAbuseEmail()

static getAbuseEmail ( )
static

Gets the configured abuse mail contact

Returns
string

◆ getAttachments()

getAttachments ( )
Returns
array

◆ getBodyHtml()

getBodyHtml ( )
Returns
unknown_type

◆ getBodyText()

getBodyText ( )
Returns
unknown_type

◆ getDefaultTransporter()

static getDefaultTransporter ( )
static

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

Returns
email_message_class

◆ getRecipients()

getRecipients ( )
Returns
array

◆ getReplyToEmail()

getReplyToEmail ( )
Returns
unknown_type

◆ getReplyToName()

getReplyToName ( )
Returns
unknown_type

◆ getSenderEmail()

getSenderEmail ( )
Returns
string

◆ getSenderName()

getSenderName ( )
Returns
unknown_type

◆ getSubject()

getSubject ( )
Returns
unknown_type

◆ 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.

◆ 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

◆ 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

◆ 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$textPlain text version of the message (required).
string$htmlHTML version of the message (optional).
Returns
bool

◆ setBodyHtml()

setBodyHtml (   $body)
Parameters
$body
Returns
StudipMail provides fluent interface

◆ setBodyText()

setBodyText (   $body)
Parameters
$body
Returns
StudipMail provides fluent interface

◆ setData()

setData (   $data)

◆ setDefaultTransporter()

static setDefaultTransporter ( email_message_class  $transporter)
static

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

Parameters
email_message_class$transporter
Returns
void

◆ setReplyToEmail()

setReplyToEmail (   $mail)
Parameters
$mail
Returns
StudipMail provides fluent interface

◆ setReplyToName()

setReplyToName (   $name)
Parameters
$name
Returns
StudipMail provides fluent interface

◆ setSenderEmail()

setSenderEmail (   $mail)
Parameters
string$mail
Returns
StudipMail provides fluent interface

◆ setSenderName()

setSenderName (   $name)
Parameters
string$name
Returns
StudipMail provides fluent interface

◆ setSubject()

setSubject (   $subject)
Parameters
$subject
Returns
StudipMail provides fluent interface

◆ toArray()

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