phing-tasks-ext
[ class tree: phing-tasks-ext ] [ index: phing-tasks-ext ] [ all elements ]

Class: MailTask

Source Location: /tasks/ext/MailTask.php

Class Overview

ProjectComponent
   |
   --Task
      |
      --MailTask

Send a message by mail()


Author(s):

  • Francois Harvey at SecuriWeb (http://www.securiweb.net)

Version:

  • $Id: MailTask.php 526 2009-08-11 12:11:17Z mrook $

Copyright:

  • � 2001,2002 THYRELL. All rights reserved

Variables

Methods


Inherited Variables

Inherited Methods

Class: Task

Task::getDescription()
Returns the textual description of the task
Task::getLocation()
Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages.
Task::getOwningTarget()
Returns the owning target of this task.
Task::getRegisterSlot()
Returns a name
Task::getRuntimeConfigurableWrapper()
Returns the wrapper object for runtime configuration
Task::getTaskName()
Returns the name of task, used only for log messages
Task::getTaskType()
Returns the name of the task under which it was invoked, usually the XML tagname
Task::init()
Called by the parser to let the task initialize properly.
Task::log()
Provides a project level log event to the task.
Task::main()
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.
Task::maybeConfigure()
Configure this task if it hasn't been done already.
Task::perform()
Perfrom this task
Task::setDescription()
Sets a textual description of the task
Task::setLocation()
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Task::setOwningTarget()
Sets the owning target this task belongs to.
Task::setRuntimeConfigurableWrapper()
Sets the wrapper object this task should use for runtime configurable elements.
Task::setTaskName()
Sets the name of this task for log messages
Task::setTaskType()
Sets the type of the task. Usually this is the name of the XML tag

Class: ProjectComponent

ProjectComponent::getProject()
Returns a reference to current project
ProjectComponent::log()
Logs a message with the given priority.
ProjectComponent::setProject()
References the project to the current component.

Class Details

[line 33]
Send a message by mail()

<mail to="user@example.org" subject="build complete">The build process is a success...</mail>




Tags:

author:  Francois Harvey at SecuriWeb (http://www.securiweb.net)
version:  $Id: MailTask.php 526 2009-08-11 12:11:17Z mrook $
copyright:  � 2001,2002 THYRELL. All rights reserved


[ Top ]


Class Variables

$msg =

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]

$recipient =

[line 35]



Tags:

access:  protected

Type:   mixed


[ Top ]

$subject =

[line 37]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method addText [line 72]

void addText( $msg)

Supporting the <mail>Message</mail> syntax.



Parameters:

   $msg  

[ Top ]

method main [line 41]

void main( )



Overrides Task::main() (Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.)

[ Top ]

method setMessage [line 52]

void setMessage( $msg)

alias setter



Parameters:

   $msg  

[ Top ]

method setMsg [line 47]

void setMsg( $msg)

setter for message



Parameters:

   $msg  

[ Top ]

method setRecipient [line 62]

void setRecipient( $recipient)

setter for recipient *



Parameters:

   $recipient  

[ Top ]

method setSubject [line 57]

void setSubject( $subject)

setter for subject *



Parameters:

   $subject  

[ Top ]

method setTo [line 67]

void setTo( $recipient)

alias for recipient *



Parameters:

   $recipient  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:13 +0200 by phpDocumentor 1.4.3