twisted.mail.interfaces.IMessageIMAPCopier(Interface) interface documentation

Part of twisted.mail.interfaces View Source (View In Hierarchy)
No interface docstring
Method copy Copy the given message object into this mailbox.
def copy(messageObject): (source)

Copy the given message object into this mailbox.

The message object will be one which was previously returned by IMailboxIMAP.fetch.

Implementations which wish to offer better performance than the default implementation should implement this interface.

If this interface is not implemented by the mailbox, IMailboxIMAP.addMessage will be used instead.

ReturnsEither the UID of the message or a Deferred which fires with the UID when the copy finishes. (type: Deferred or int)
API Documentation for Twisted, generated by pydoctor at 2017-09-23 19:45:03.