Module: MvPlugin

Extended by:

Plugin::Run

Included in:

AgendavMv, DavicalMv, DovecotMv, PostfixadminMv, RoundcubeMv

Defined in:

lib/mv/mv_plugin.rb

Overview

Plugins for moving (renaming) users. Moving domains is not supported.

Class Method Summary

• .dummy_runner ⇒ Class

  The “dummy” runner class associated with move plugins.

• .runner ⇒ Class

  The runner class associated with move plugins.

Instance Method Summary

• #mv_user(src, dst) ⇒ Object

  The interface for the “move a user” operation.

Methods included from Plugin::Run

dummy_runner, included, includers, run, runner

Class Method Details

.dummy_runner ⇒ Class

The “dummy” runner class associated with move plugins.

Returns:

• (Class) —

  the MvDummyRunner class.

# File 'lib/mv/mv_plugin.rb', line 23

def self.dummy_runner()
  return MvDummyRunner
end

.runner ⇒ Class

The runner class associated with move plugins.

Returns:

• (Class) —

  the MvRunner class.

# File 'lib/mv/mv_plugin.rb', line 14

def self.runner()
  return MvRunner
end

Instance Method Details

#mv_user(src, dst) ⇒ Object

The interface for the “move a user” operation. Subclasses need to implement this method so that it moves (renames) the user src to the user dst.

Parameters:

• src (User) —

  the source user to be moved.

• dst (User) —

  the destination user to which we’ll move src.

Raises:

• (NotImplementedError)

# File 'lib/mv/mv_plugin.rb', line 36

def mv_user(src, dst)
  raise NotImplementedError
end