org.mule.extension.email.internal.commands

Class SetFlagCommand

java.lang.Object

org.mule.extension.email.internal.commands.SetFlagCommand

public class SetFlagCommand
extends Object

Represents an operation that sets flags in email messages.

This operation works only for emails retrieved from UIDFolder, this means that email messages must contain an UID (unique identifier) in the specified folder.

The POP3 protocol does not have support for retrieving an email from it's UID, on the other side the IMAP protocol is fully capable of doing the described action.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
SetFlagCommand()

Method Summary

Modifier and Type	Method and Description
void	setByNumber(MailboxConnection connection, String folderName, javax.mail.Flags.Flag flag, int number) Sets the specified flag to the email of mailbox number number
void	setByUID(MailboxConnection connection, String folderName, javax.mail.Flags.Flag flag, long emailId) Sets the specified flag into the email of UID (unique identifier) emailId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetFlagCommand

public SetFlagCommand()

Method Detail

setByUID

public void setByUID(MailboxConnection connection,
                     String folderName,
                     javax.mail.Flags.Flag flag,
                     long emailId)

Sets the specified flag into the email of UID (unique identifier) emailId.

This method only works for UIDFolders, that are handled by the IMAP protocol

Parameters:

connection - the associated MailboxConnection.

folderName - the name of the folder where the emails are stored.

flag - the Flags.Flag that wants to be set in the email message.

emailId - the unique identifier of the email in the corresponding UIDFolder of name folderName

setByNumber

public void setByNumber(MailboxConnection connection,
                        String folderName,
                        javax.mail.Flags.Flag flag,
                        int number)

Sets the specified flag to the email of mailbox number number

This method only works for UIDFolders, that are handled by the IMAP protocol

Parameters:

connection - the associated MailboxConnection.

folderName - the name of the folder where the emails are stored.

flag - the Flags.Flag that wants to be set in the email message.

number - the number of the email in the corresponding Folder of name folderName