IMP_Indices_Copy_Notepad
extends IMP_Indices_Copy
in package
Copy a message to a notepad.
Tags
Table of Contents
Constants
- NOTEPAD_EDIT = "notepad\x00"
Methods
- copy() : bool
- Copy/move messages.
- getNotepads() : array<string|int, mixed>
- match() : bool
- Does the mailbox name match this action?
- _create() : bool
- Copy/move messages.
Constants
NOTEPAD_EDIT
public
mixed
NOTEPAD_EDIT
= "notepad\x00"
Methods
copy()
Copy/move messages.
public
copy(string $mbox, IMP_Indices $indices, bool $move) : bool
Parameters
- $mbox : string
-
The mailbox name to copy/move the task to.
- $indices : IMP_Indices
-
An indices object.
- $move : bool
-
Move if true, copy if false.
Return values
bool —True on success.
getNotepads()
public
getNotepads([mixed $notify = false ]) : array<string|int, mixed>
Parameters
- $notify : mixed = false
Return values
array<string|int, mixed>match()
Does the mailbox name match this action?
public
match(mixed $mbox) : bool
Parameters
- $mbox : mixed
-
The mailbox name.
Return values
bool —True if the mailbox matches this action.
_create()
Copy/move messages.
protected
_create(mixed $mbox, mixed $subject, mixed $body) : bool
Parameters
- $mbox : mixed
-
The mailbox name to copy/move the task to.
- $subject : mixed
-
Subject.
- $body : mixed
-
Message body.
Return values
bool —True on success.