Inheritance diagram for OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule:

Collaboration diagram for OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule:

Public Member Functions
void	Initialise (IConfigSource config)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

void	InsertEmail (UUID to, Email email)

void	SendEmail (UUID objectID, string address, string subject, string body)
	SendMail function utilized by llEMail More...

Email	GetNextEmail (UUID objectID, string sender, string subject)

Properties
string	Name `[get]`

Type	ReplaceableInterface `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Detailed Description

Definition at line 45 of file EmailModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 123 of file EmailModule.cs.

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 156 of file EmailModule.cs.

Email OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.GetNextEmail	(	UUID	objectID,
		string	sender,
		string	subject
	)

inline

Parameters

objectID
sender
subject

Returns

Implements OpenSim.Region.Framework.Interfaces.IEmailModule.

Definition at line 362 of file EmailModule.cs.

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.Initialise ( IConfigSource source )

inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 79 of file EmailModule.cs.

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.InsertEmail	(	UUID	to,
		Email	email
	)

inline

Definition at line 176 of file EmailModule.cs.

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.PostInitialise ( )

inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 152 of file EmailModule.cs.

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 170 of file EmailModule.cs.

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 148 of file EmailModule.cs.

void OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.SendEmail	(	UUID	objectID,
		string	address,
		string	subject,
		string	body
	)

inline

SendMail function utilized by llEMail

Parameters

objectID
address
subject
body

Implements OpenSim.Region.Framework.Interfaces.IEmailModule.

Definition at line 255 of file EmailModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.Name

get

Definition at line 161 of file EmailModule.cs.

Type OpenSim.Region.CoreModules.Scripting.EmailModules.EmailModule.ReplaceableInterface

get

Definition at line 166 of file EmailModule.cs.

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

Region/CoreModules/Scripting/EMailModules/EmailModule.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation