All Classes Namespaces Files Functions Variables Groups
kerio::jsonapi::webmail::certificates::Certificates Interface Reference

import "Certificates.idl";

Public Member Functions

void init (in string password, in boolean isLoginPassword)
void open (in string password)
void close ()
void get (out CertificateList certificates)
void getById (out Certificate certificate, in kerio::web::KId id)
void getStatus (out CertStoreStatus status)
void toSource (out string source, in kerio::web::KId id)
void openWithOldLoginPassword (in string oldPassword)
void openEditWithOldLoginPassword (in string oldPassword)
void reset (in string loginPassword)
void openEdit (in string password)
void closeEdit ()
void setPreferred (in kerio::web::KId id)
void changePassword (in string oldPassword, in string newPassword, in boolean isLoginPassword)
void importPKCS12 (in kerio::web::KId fileId, in string password)
void exportPKCS12 (out kerio::web::Download fileDownload, in string newPassword, in kerio::web::KId id)
void remove (in kerio::web::KId id)

Detailed Description

the personal certificate store manager class

Member Function Documentation

void kerio::jsonapi::webmail::certificates::Certificates::close ( )

Close the personal certificate store

void kerio::jsonapi::webmail::certificates::Certificates::closeEdit ( )

Lock edit functions

void kerio::jsonapi::webmail::certificates::Certificates::exportPKCS12 ( out kerio::web::Download  fileDownload,
in string  newPassword,
in kerio::web::KId  id 
)

Export of certificate and private key Note: "export" is a keyword in C++, so the name of the method must be changed: exportPrivateKey

Parameters
id- ID of the certificate
fileDownload- description of the output file
void kerio::jsonapi::webmail::certificates::Certificates::get ( out CertificateList  certificates)

Obtain a list of certificates

Parameters
certificates- current list of certificates
void kerio::jsonapi::webmail::certificates::Certificates::getById ( out Certificate  certificate,
in kerio::web::KId  id 
)

Obtain particular certificate

Parameters
certificate- a certificate
certificate- global identifier
void kerio::jsonapi::webmail::certificates::Certificates::getStatus ( out CertStoreStatus  status)

Obtain a list of certificates

Parameters
certificates- current list of certificates
void kerio::jsonapi::webmail::certificates::Certificates::init ( in string  password,
in boolean  isLoginPassword 
)

Initialize the personal certificate store

Parameters
password- password of certificate store
isLoginPassword- given password is the same which user uses to log in
void kerio::jsonapi::webmail::certificates::Certificates::open ( in string  password)

Open the personal certificate store

Parameters
password- password of certificate store
void kerio::jsonapi::webmail::certificates::Certificates::openEdit ( in string  password)

Unlock edit functions

Parameters
password- password of certificate store
void kerio::jsonapi::webmail::certificates::Certificates::openWithOldLoginPassword ( in string  oldPassword)

Open certificate store uses old password and if successful then updated password to current login password. Calling is valid only if login password is used as well for certificate store.

Parameters
oldPassword- password to certificate store (old login password)
void kerio::jsonapi::webmail::certificates::Certificates::reset ( in string  loginPassword)

Reset personal certificate store to uninitialized state. All current store will be removed!

Parameters
loginPassword- current login password to verify user)
void kerio::jsonapi::webmail::certificates::Certificates::setPreferred ( in kerio::web::KId  id)

Set preferred flag to one of certificates for particular email address. Preferred flag is removed from other certificates issued for the same email address.

Parameters
id- ID of the certificate
void kerio::jsonapi::webmail::certificates::Certificates::toSource ( out string  source,
in kerio::web::KId  id 
)

Obtain source (plain-text representation) of the certificate

Parameters
source- certificate in plain text
id- global identifier

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