kerio::jsonapi::webmail::mails::Mails Interface Reference

import "Mails.idl";

Public Member Functions
void	get (out MailList list, out long totalItems, in kerio::web::KIdList folderIds, in kerio::web::SearchQuery query)
void	getPageWithId (out MailList list, out long start, out long totalItems, in kerio::web::KIdList folderIds, in kerio::web::SearchQuery query, in kerio::web::KId id)
void	getById (out kerio::web::ErrorList errors, out MailList result, in kerio::web::KIdList ids)
void	create (out kerio::web::ErrorList errors, out CreateResultList result, in MailList mails)
void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void	set (out kerio::web::ErrorList errors, out SetResultList result, in MailList mails)
void	setAllSeen (in kerio::web::KId folderId)
void	copy (out kerio::web::ErrorList errors, out CreateResultList result, in kerio::web::KIdList ids, in kerio::web::KId folder)
void	move (out kerio::web::ErrorList errors, out CreateResultList result, in kerio::web::KIdList ids, in kerio::web::KId folder)
void	exportAttachments (out kerio::web::Download fileDownload, in kerio::web::KIdList attachmentIds)

Detailed Description

Mail store manager class

Member Function Documentation

void kerio::jsonapi::webmail::mails::Mails::copy	(	out kerio::web::ErrorList	errors,
		out CreateResultList	result,
		in kerio::web::KIdList	ids,
		in kerio::web::KId	folder
	)

Copy existing e-mails to folder

Parameters

errors	- error message list
ids	- list of global identifiers of mails to be copied
folder	- target folder

void kerio::jsonapi::webmail::mails::Mails::create	(	out kerio::web::ErrorList	errors,
		out CreateResultList	result,
		in MailList	mails
	)

Save e-mail to folder Templates or send and save to folder Sent Items

Parameters

errors	- error message list
result	- list of ID of crated mails.
mails	- new mails.

Errors: ErrorCodePartialSuccess - Failed to create mail but mail was successfully sent. ErrorCodeQuotaReached - Failed to create mail. Items quota or disk size quota was reached. ErrorCodeSendingFailed - Failed to send email and failed to create mail.

void kerio::jsonapi::webmail::mails::Mails::exportAttachments	(	out kerio::web::Download	fileDownload,
		in kerio::web::KIdList	attachmentIds
	)

Export attachments from mail and pack them into zip.

Parameters

fileDownload	- description of output file
attachmentIds	- list of global identifiers of attachments. All attachments must be from the same e-mail.

void kerio::jsonapi::webmail::mails::Mails::get	(	out MailList	list,
		out long	totalItems,
		in kerio::web::KIdList	folderIds,
		in kerio::web::SearchQuery	query
	)

Get a list of e-mails.

Parameters

list	- all found e-mails
totalItems	- number of mails found if there is no limit
folderIds	- list of global identifiers of folders to be listed.
query	- query attributes and limits

void kerio::jsonapi::webmail::mails::Mails::getById	(	out kerio::web::ErrorList	errors,
		out MailList	result,
		in kerio::web::KIdList	ids
	)

Get one particular email. All members of struct Mail are filed in response.

Parameters

errors	- list of email that failed to obtain
result	- found emails
ids	- global identifiers of requested emails

void kerio::jsonapi::webmail::mails::Mails::getPageWithId	(	out MailList	list,
		out long	start,
		out long	totalItems,
		in kerio::web::KIdList	folderIds,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	id
	)

Get a list of e-mails.

Parameters

list	- all found e-mails
totalItems	- number of mails found if there is no limit
folderIds	- list of global identifiers of folders to be listed
query	- query attributes and limits. Mind that offset is not used
id	- global identifier of requested email

void kerio::jsonapi::webmail::mails::Mails::move	(	out kerio::web::ErrorList	errors,
		out CreateResultList	result,
		in kerio::web::KIdList	ids,
		in kerio::web::KId	folder
	)

Move existing e-mails to folder

Parameters

errors	- error message list
ids	- list of global identifiers of e-mails to be moved
folder	- target folder

void kerio::jsonapi::webmail::mails::Mails::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove a list of mails.

Parameters

errors	- list of mails that failed to remove
ids	- list of global identifiers of mails to be removed

void kerio::jsonapi::webmail::mails::Mails::set	(	out kerio::web::ErrorList	errors,
		out SetResultList	result,
		in MailList	mails
	)

Set existing e-mail in folder Templates or send and save to folder Sent

Parameters

errors	- error message list
mails	- modifications of mails.

Errors: ErrorCodePartialSuccess - Failed to move mail after update. ErrorCodeSendingFailed - Failed to send email and failed to update mail.

void kerio::jsonapi::webmail::mails::Mails::setAllSeen

(

in kerio::web::KId

folderId

)

Set all e-mail in folder as seen.

Parameters

folderId

- target folder

---

The documentation for this interface was generated from the following file:

• Mails.idl