Mail API QML: Difference between revisions

From KDE Community Wiki
Line 18: Line 18:
</syntaxhighlight>
</syntaxhighlight>


===Composer===
==Composer==


This Composer Api will be exposed through QML. The backend contains the basic functions of a message composer. This will be further extended in future. The basic Api plan is as follows:
This Composer Api will be exposed through QML. The backend contains the basic functions of a message composer. This will be further extended in future. The basic Api plan is as follows:

Revision as of 19:57, 1 June 2014

DRAFT

This document just serves as draft for developing a QML Mail API.

API

Accounts

Folders

MessageList

Message

Message {

}

Composer

This Composer Api will be exposed through QML. The backend contains the basic functions of a message composer. This will be further extended in future. The basic Api plan is as follows:

void setSubject()

Recieves the text input as QString from the editor in QML.


void setRecepients()

Will set the address of receiver. It will also be received as QString. Recepient count will be set.


void cc()

Sets the CC field in recepients list.


void bcc()

Sets the BCC field in the recepients list.

void setMessage()

The message body wil be set using QString.


void addAttachment()

Adds attachments to the message using KMime content part.


void insertSignature()

Inserts saved signature.

void send()

Will send the message using MessageComposer::MessageSender


void drafts()

Saves the created text message as draft.