ButterflyClient

Undocumented in source.

final

class ButterflyClient {

this(Address endpoint);

void authenticate(string username, string password);

string editMail(string mailPath, JSONValue messageBlock);

void sendMail(JSONValue messageBlock);

string[] listFolder(string folderPath);

void deleteFolder(string folderPath);

void createFolder(string folderPath);

string[] listMail(string folderPath);

string storeMail(string folderPath, JSONValue messageBlock);

JSONValue fetchMail(string folderPath, string mailID);

void register(string username, string password);

}

Constructors

this this(Address endpoint): Creates a new ButterflyClient connected to the butterfly server specified by the Address endpoint.

Members

Functions

authenticate void authenticate(string username, string password): Authenticate to the server with the given username and password.
createFolder void createFolder(string folderPath): Creates a new folder under the path specified by folderPath.
deleteFolder void deleteFolder(string folderPath): Deletes an existing folder under the path specified by folderPath.
editMail string editMail(string mailPath, JSONValue messageBlock): Undocumented in source. Be warned that the author may not have intended to support it.
fetchMail JSONValue fetchMail(string folderPath, string mailID): Fetches the message block (mail message JSON) of the mail message specified by mailID located in the folder specified by folderPath. Returns it as a JSONValue.
listFolder string[] listFolder(string folderPath): Returns a string[] of the folder names in the given folder, folderPath
listMail string[] listMail(string folderPath): Returns a string[] of the mail IDs within the given folder, folderPath.
register void register(string username, string password): Registers a new account with the given username and password.
sendMail void sendMail(JSONValue messageBlock): Send the provided JSONValue mail messageBlock
storeMail string storeMail(string folderPath, JSONValue messageBlock): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

libutterfly client classes

ButterflyClient