Inherits Garbage
The SieveAction class models a single sieve action as specified in RFC 5228 section 4, ie. something a SieveScript decides to do, and that the Sieve interpreter does after sieving a message.
SieveAction objects are created by SieveCommand objects while evaluating themselves in the context of a Message.
Constructs a SieveAction of type. The constructed object is not immediately valid; depending on type you may have to call e.g. setMailbox().
Returns true if this action has finished its task, and false otherwise.
Returns what setErrorMessage() recorded, or an empty string if setErrorMessage() has not been called.
Returns whatever setExpiry() recorded, or 0 if setExpiry() hasn't been called.
Returns true if this action has failed to accomplish its task, and false if it has succeeded or the possibility of success remains.
Returns whatever setHandle() set, or an empty string if setHandle() hasn't been called.
Returns the mailbox set by setMailbox(), or 0 if setMailbox() has not been called. This value is only meaningful if type() is FileInto.
Returns whatever setMessage() recorded, or a null pointer if setMessage() hasn't been called.
Returns the address set by setRecipientAddress(), or 0 if setRecipientAddress() has not been called.
Returns the address set by setSenderAddress(), or 0 if setSenderAddress() has not been called.
Records the error message m. Only useful if the action's type() is Error.
Records that this autoresponse should suppress similar autoresponses for n days. Similarity is defined by handle(), recipientAddress() and senderAddress().
Records that the handle associated with this action is h. Only useful for the Vacation type().
Records that this action's target is mailbox, provided that its type() is FileInto. If type() has any other value, calling setMailbox() sets an unused variable.
Records that m is associated with this action. Only useful when type() is Vacation.
Records that this action's recipient is address, provided that its type() is Redirect or Vacation. If type() has any other value, calling setRecipientAddress() sets an unused variable.
Records that this action's sender target is address, provided that its type() is Redirect or Vacation. If type() has any other value, calling setSenderAddress() sets an unused variable.
Returns the action's type, as set by the constructor.
This web page based on source code belonging to The Archiveopteryx Developers. All rights reserved.