Mail API QML: Difference between revisions

From KDE Community Wiki
Line 22: Line 22:
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:


==== void setSubject() ====
===Properties:===
 
 
===Functions:===
 
=== void setSubject() ===


Recieves the text input as QString from the editor in QML.   
Recieves the text input as QString from the editor in QML.   
Line 37: Line 42:


Sets the BCC field in the recepients list.
Sets the BCC field in the recepients list.
===SLOTS:===


=== void addAttachment() ===
=== void addAttachment() ===
Line 50: Line 57:
Will send the message using MessageComposer::MessageSender
Will send the message using MessageComposer::MessageSender


=== void drafts() ===
=== void saveDraft() ===


Saves the created text message as draft.
Saves the created text message as draft.
=== void sendLater() ===
Queues the message to be sent later.
===void forward()===
Forwards a received mail.
===void replySender()===
Composes mail with the sender's address in reply field
===void replyToAll()===
Sends the message to multiple selected recipients.
===void replyToMailingList()===
Sends the message to mailing list.

Revision as of 08:29, 9 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:

Properties:

Functions:

void setSubject()

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

void setReplyTo()

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.

SLOTS:

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 saveDraft()

Saves the created text message as draft.


void sendLater()

Queues the message to be sent later.

void forward()

Forwards a received mail.

void replySender()

Composes mail with the sender's address in reply field

void replyToAll()

Sends the message to multiple selected recipients.

void replyToMailingList()

Sends the message to mailing list.