Back to index

enigmail  1.4.3
Public Member Functions | Public Attributes
nsIEnigmail Interface Reference

The nsIEnigmail provides an openPGP-based encryption/decryption service. More...

import "nsIEnigmail.idl";

List of all members.

Public Member Functions

void initialize (in nsIDOMWindow domWindow, in string version, in nsIPrefBranch enigmailPrefs)
void reinitialize ()
void finalize ()
boolean mimeInitialized ()
boolean useGpgAgent ()
void stillActive ()
string getLogDirectoryPrefix ()
nsIPipeTransport encryptMessageStart (in nsIDOMWindow parent, in nsIPrompt prompter, in unsigned long uiFlags, in string fromMailAddr, in string toMailAddr, in string bccMailAddr, in string hashAlgorithm, in unsigned long sendFlags, in nsIStreamListener listener, out unsigned long statusFlags, out wstring errorMsg)
long encryptMessageEnd (in nsIDOMWindow parent, in nsIPrompt prompter, in unsigned long uiFlags, in unsigned long sendFlags, in unsigned long outputLen, in nsIPipeTransport pipeTransport, out unsigned long statusFlags, out wstring errorMsg)
nsIPipeTransport decryptMessageStart (in nsIDOMWindow parent, in nsIPrompt prompter, in boolean verifyOnly, in boolean noOutput, in nsIStreamListener listener, out unsigned long statusFlags, out wstring errorMsg)
long decryptMessageEnd (in unsigned long uiFlags, in unsigned long outputLen, in nsIPipeTransport pipeTransport, in boolean verifyOnly, in boolean noOutput, out unsigned long statusFlags, out wstring keyId, out wstring userId, out wstring sigDetails, out wstring errorMsg, out wstring blockSeparation)
boolean stripWhitespace (in unsigned long sendFlags)
string locateArmoredBlock (in string text, in long offset, in string indentStr, out long beginIndex, out long endIndex, out string foundIndentStr)
long determineHashAlgorithm (in nsIPrompt prompter, in unsigned long uiFlags, in string fromMailAddr, out wstring hashAlgorithm)
string extractSignaturePart (in string signatureBlock, in long part)
wstring encryptMessage (in nsIDOMWindow parent, in unsigned long uiFlags, in string hashAlgorithm, in string plainText, in string fromMailAddr, in string toMailAddr, in string bccMailAddr, in unsigned long sendFlags, out long exitCode, out unsigned long statusFlags, out wstring errorMsg)
wstring decryptMessage (in nsIDOMWindow parent, in unsigned long uiFlags, in string cipherText, inout string signature, out long exitCode, out unsigned long statusFlags, out wstring keyId, out wstring userId, out wstring sigDetails, out wstring errorMsg, out wstring blockSeparation)
boolean deleteMessageURI (in string uri)
boolean selectPanel (in string url)
string getGnupgConfig (out long exitCodeObj, out wstring errorMsgObj)
long addPhoto (in nsIDOMWindow parent, in string keyId, in nsIFile photoFile, out wstring errorMsg)
string getKeySig (in string keyId, out long exitCode, out wstring errorMsg)
string getKeyDetails (in string keyId, in boolean uidOnly)
string showKeyPhoto (in string keyId, in long photoNumber, out long exitCode, out wstring errorMsg)
string extractKey (in nsIDOMWindow parent, in unsigned long exportFlags, in string userId, in nsIFile outputFile, out long exitCode, out wstring errorMsg)
long importKey (in nsIDOMWindow parent, in unsigned long uiFlags, in string msgText, in string keyId, out wstring errorMsg)
long importKeyFromFile (in nsIDOMWindow parent, in nsIFile inputFile, out string errorMsg, out wstring importedKeys)
string createMessageURI (in string originalUrl, in string contentType, in string contentCharset, in string contentData, in boolean persist)
string getUserIdList (in boolean secretOnly, in boolean refresh, out long exitCode, out unsigned long statusFlags, out wstring errorMsg)
void invalidateUserIdList ()
string encryptAttachment (in nsIDOMWindow parent, in string fromMailAddr, in string toMailAddr, in string bccMailAddr, in unsigned long sendFlags, in nsIFile inFile, in nsIFile outFile, out long exitCode, out unsigned long statusFlags, out wstring errorMsg)
wstring getAttachmentFileName (in nsIDOMWindow parent, in nsIIPCBuffer ipcBuffer)
boolean decryptAttachment (in nsIDOMWindow parent, in nsIFile outFile, in string displayName, in nsIIPCBuffer ipcBuffer, out long exitCode, out unsigned long statusFlags, out wstring errorMsg)
long verifyAttachment (in nsIDOMWindow parent, in nsIFile verifyFile, in nsIFile sigFile, out unsigned long statusFlags, out wstring errorMsg)
boolean getRulesData (out nsIDOMDocument rulesList)
void addRule (in boolean appendToEnd, in string toAddress, in string keyList, in long sign, in long encrypt, in long pgpMime, in long flags)
boolean saveRulesFile ()
void clearRules ()
string getCardStatus (out long exitCode, out wstring errorMsg)
long genCardKey (in nsIDOMWindow parent, in string name, in string email, in string comment, in string expiry, in string backupPasswd, in nsIEnigMimeReadCallback requestObserver, out wstring errorMsg)
long cardAdminData (in nsIDOMWindow parent, in string name, in string firstname, in string lang, in string sex, in string url, in string login, in long forcepin, out wstring errorMsg)
long cardChangePin (in nsIDOMWindow parent, in long action, in string oldPin, in string newPin, in string adminPin, in nsIEnigMimeReadCallback requestObserver, out wstring errorMsg)

Public Attributes

readonly attribute string agentType
readonly attribute string agentVersion
readonly attribute nsIFile agentPath
readonly attribute boolean isWin32
readonly attribute boolean isDosLike
readonly attribute nsIIPCRequest keygenRequest
readonly attribute long maxIdleMinutes
readonly attribute boolean initialized
attribute boolean initializationAttempted
readonly attribute string initializationError
readonly attribute boolean composeSecure
readonly attribute
nsIFileOutputStream 
logFileStream
const long SIGNATURE_TEXT = 1
const long SIGNATURE_HEADERS = 2
const long SIGNATURE_ARMOR = 3
const long UI_INTERACTIVE = 0x01
const long UI_ALLOW_KEY_IMPORT = 0x02
const long UI_UNVERIFIED_ENC_OK = 0x04
const long UI_PGP_MIME = 0x08
const long UI_TEST = 0x10
const long UI_RESTORE_STRICTLY_MIME = 0x20
const long SEND_SIGNED = 0x001
const long SEND_ENCRYPTED = 0x002
const long SEND_DEFAULT = 0x004
const long SEND_LATER = 0x008
const long SEND_WITH_CHECK = 0x010
const long SEND_ALWAYS_TRUST = 0x020
const long SEND_ENCRYPT_TO_SELF = 0x040
const long SEND_PGP_MIME = 0x080
const long SEND_TEST = 0x100
const long SAVE_MESSAGE = 0x200
const long SEND_STRIP_WHITESPACE = 0x400
const long SEND_ATTACHMENT = 0x800
const long GOOD_SIGNATURE = 0x000001
const long BAD_SIGNATURE = 0x000002
const long UNVERIFIED_SIGNATURE = 0x000004
const long EXPIRED_SIGNATURE = 0x000008
const long EXPIRED_KEY_SIGNATURE = 0x000010
const long EXPIRED_KEY = 0x000020
const long REVOKED_KEY = 0x000040
const long NO_PUBKEY = 0x000080
const long NO_SECKEY = 0x000100
const long IMPORTED_KEY = 0x000200
const long INVALID_RECIPIENT = 0x000400
const long MISSING_PASSPHRASE = 0x000800
const long BAD_PASSPHRASE = 0x001000
const long BAD_ARMOR = 0x002000
const long NODATA = 0x004000
const long DECRYPTION_INCOMPLETE = 0x008000
const long DECRYPTION_FAILED = 0x010000
const long DECRYPTION_OKAY = 0x020000
const long UNTRUSTED_IDENTITY = 0x040000
const long TRUSTED_IDENTITY = 0x00080000
const long PGP_MIME_SIGNED = 0x00100000
const long PGP_MIME_ENCRYPTED = 0x00200000
const long DISPLAY_MESSAGE = 0x00400000
const long INLINE_KEY = 0x00800000
const long PARTIALLY_PGP = 0x01000000
const long PHOTO_AVAILABLE = 0x02000000
const long OVERFLOWED = 0x04000000
const long CARDCTRL = 0x08000000
const long SC_OP_FAILURE = 0x10000000
const long UNKNOWN_ALGO = 0x20000000
const long SIG_CREATED = 0x40000000
const unsigned long END_ENCRYPTION = 0x80000000
const long EXTRACT_SECRET_KEY = 0x01
const long SEARCH_KEY = 0x01
const long DOWNLOAD_KEY = 0x02
const long UPLOAD_KEY = 0x04
const long REFRESH_KEY = 0x08
const long CARD_PIN_CHANGE = 1
const long CARD_PIN_UNBLOCK = 2
const long CARD_ADMIN_PIN_CHANGE = 3

Detailed Description

The nsIEnigmail provides an openPGP-based encryption/decryption service.

Definition at line 58 of file nsIEnigmail.idl.


Member Function Documentation

long nsIEnigmail::addPhoto ( in nsIDOMWindow  parent,
in string  keyId,
in nsIFile  photoFile,
out wstring  errorMsg 
)
void nsIEnigmail::addRule ( in boolean  appendToEnd,
in string  toAddress,
in string  keyList,
in long  sign,
in long  encrypt,
in long  pgpMime,
in long  flags 
)
long nsIEnigmail::cardAdminData ( in nsIDOMWindow  parent,
in string  name,
in string  firstname,
in string  lang,
in string  sex,
in string  url,
in string  login,
in long  forcepin,
out wstring  errorMsg 
)
long nsIEnigmail::cardChangePin ( in nsIDOMWindow  parent,
in long  action,
in string  oldPin,
in string  newPin,
in string  adminPin,
in nsIEnigMimeReadCallback  requestObserver,
out wstring  errorMsg 
)
string nsIEnigmail::createMessageURI ( in string  originalUrl,
in string  contentType,
in string  contentCharset,
in string  contentData,
in boolean  persist 
)
boolean nsIEnigmail::decryptAttachment ( in nsIDOMWindow  parent,
in nsIFile  outFile,
in string  displayName,
in nsIIPCBuffer  ipcBuffer,
out long  exitCode,
out unsigned long  statusFlags,
out wstring  errorMsg 
)
wstring nsIEnigmail::decryptMessage ( in nsIDOMWindow  parent,
in unsigned long  uiFlags,
in string  cipherText,
inout string  signature,
out long  exitCode,
out unsigned long  statusFlags,
out wstring  keyId,
out wstring  userId,
out wstring  sigDetails,
out wstring  errorMsg,
out wstring  blockSeparation 
)
long nsIEnigmail::decryptMessageEnd ( in unsigned long  uiFlags,
in unsigned long  outputLen,
in nsIPipeTransport  pipeTransport,
in boolean  verifyOnly,
in boolean  noOutput,
out unsigned long  statusFlags,
out wstring  keyId,
out wstring  userId,
out wstring  sigDetails,
out wstring  errorMsg,
out wstring  blockSeparation 
)
nsIPipeTransport nsIEnigmail::decryptMessageStart ( in nsIDOMWindow  parent,
in nsIPrompt  prompter,
in boolean  verifyOnly,
in boolean  noOutput,
in nsIStreamListener  listener,
out unsigned long  statusFlags,
out wstring  errorMsg 
)
long nsIEnigmail::determineHashAlgorithm ( in nsIPrompt  prompter,
in unsigned long  uiFlags,
in string  fromMailAddr,
out wstring  hashAlgorithm 
)
string nsIEnigmail::encryptAttachment ( in nsIDOMWindow  parent,
in string  fromMailAddr,
in string  toMailAddr,
in string  bccMailAddr,
in unsigned long  sendFlags,
in nsIFile  inFile,
in nsIFile  outFile,
out long  exitCode,
out unsigned long  statusFlags,
out wstring  errorMsg 
)
wstring nsIEnigmail::encryptMessage ( in nsIDOMWindow  parent,
in unsigned long  uiFlags,
in string  hashAlgorithm,
in string  plainText,
in string  fromMailAddr,
in string  toMailAddr,
in string  bccMailAddr,
in unsigned long  sendFlags,
out long  exitCode,
out unsigned long  statusFlags,
out wstring  errorMsg 
)
long nsIEnigmail::encryptMessageEnd ( in nsIDOMWindow  parent,
in nsIPrompt  prompter,
in unsigned long  uiFlags,
in unsigned long  sendFlags,
in unsigned long  outputLen,
in nsIPipeTransport  pipeTransport,
out unsigned long  statusFlags,
out wstring  errorMsg 
)
nsIPipeTransport nsIEnigmail::encryptMessageStart ( in nsIDOMWindow  parent,
in nsIPrompt  prompter,
in unsigned long  uiFlags,
in string  fromMailAddr,
in string  toMailAddr,
in string  bccMailAddr,
in string  hashAlgorithm,
in unsigned long  sendFlags,
in nsIStreamListener  listener,
out unsigned long  statusFlags,
out wstring  errorMsg 
)
string nsIEnigmail::extractKey ( in nsIDOMWindow  parent,
in unsigned long  exportFlags,
in string  userId,
in nsIFile  outputFile,
out long  exitCode,
out wstring  errorMsg 
)
string nsIEnigmail::extractSignaturePart ( in string  signatureBlock,
in long  part 
)
long nsIEnigmail::genCardKey ( in nsIDOMWindow  parent,
in string  name,
in string  email,
in string  comment,
in string  expiry,
in string  backupPasswd,
in nsIEnigMimeReadCallback  requestObserver,
out wstring  errorMsg 
)
wstring nsIEnigmail::getAttachmentFileName ( in nsIDOMWindow  parent,
in nsIIPCBuffer  ipcBuffer 
)
string nsIEnigmail::getCardStatus ( out long  exitCode,
out wstring  errorMsg 
)
string nsIEnigmail::getGnupgConfig ( out long  exitCodeObj,
out wstring  errorMsgObj 
)
string nsIEnigmail::getKeyDetails ( in string  keyId,
in boolean  uidOnly 
)
string nsIEnigmail::getKeySig ( in string  keyId,
out long  exitCode,
out wstring  errorMsg 
)
boolean nsIEnigmail::getRulesData ( out nsIDOMDocument  rulesList)
string nsIEnigmail::getUserIdList ( in boolean  secretOnly,
in boolean  refresh,
out long  exitCode,
out unsigned long  statusFlags,
out wstring  errorMsg 
)
long nsIEnigmail::importKey ( in nsIDOMWindow  parent,
in unsigned long  uiFlags,
in string  msgText,
in string  keyId,
out wstring  errorMsg 
)
long nsIEnigmail::importKeyFromFile ( in nsIDOMWindow  parent,
in nsIFile  inputFile,
out string  errorMsg,
out wstring  importedKeys 
)
void nsIEnigmail::initialize ( in nsIDOMWindow  domWindow,
in string  version,
in nsIPrefBranch  enigmailPrefs 
)
string nsIEnigmail::locateArmoredBlock ( in string  text,
in long  offset,
in string  indentStr,
out long  beginIndex,
out long  endIndex,
out string  foundIndentStr 
)
boolean nsIEnigmail::selectPanel ( in string  url)
string nsIEnigmail::showKeyPhoto ( in string  keyId,
in long  photoNumber,
out long  exitCode,
out wstring  errorMsg 
)
boolean nsIEnigmail::stripWhitespace ( in unsigned long  sendFlags)
long nsIEnigmail::verifyAttachment ( in nsIDOMWindow  parent,
in nsIFile  verifyFile,
in nsIFile  sigFile,
out unsigned long  statusFlags,
out wstring  errorMsg 
)

Member Data Documentation

readonly attribute nsIFile nsIEnigmail::agentPath

Definition at line 63 of file nsIEnigmail.idl.

readonly attribute string nsIEnigmail::agentType

Definition at line 60 of file nsIEnigmail.idl.

readonly attribute string nsIEnigmail::agentVersion

Definition at line 61 of file nsIEnigmail.idl.

const long nsIEnigmail::BAD_ARMOR = 0x002000

Definition at line 201 of file nsIEnigmail.idl.

const long nsIEnigmail::BAD_PASSPHRASE = 0x001000

Definition at line 200 of file nsIEnigmail.idl.

const long nsIEnigmail::BAD_SIGNATURE = 0x000002

Definition at line 189 of file nsIEnigmail.idl.

Definition at line 371 of file nsIEnigmail.idl.

Definition at line 369 of file nsIEnigmail.idl.

Definition at line 370 of file nsIEnigmail.idl.

const long nsIEnigmail::CARDCTRL = 0x08000000

Definition at line 215 of file nsIEnigmail.idl.

readonly attribute boolean nsIEnigmail::composeSecure

Definition at line 76 of file nsIEnigmail.idl.

const long nsIEnigmail::DECRYPTION_FAILED = 0x010000

Definition at line 204 of file nsIEnigmail.idl.

const long nsIEnigmail::DECRYPTION_INCOMPLETE = 0x008000

Definition at line 203 of file nsIEnigmail.idl.

const long nsIEnigmail::DECRYPTION_OKAY = 0x020000

Definition at line 205 of file nsIEnigmail.idl.

const long nsIEnigmail::DISPLAY_MESSAGE = 0x00400000

Definition at line 210 of file nsIEnigmail.idl.

const long nsIEnigmail::DOWNLOAD_KEY = 0x02

Definition at line 280 of file nsIEnigmail.idl.

const unsigned long nsIEnigmail::END_ENCRYPTION = 0x80000000

Definition at line 219 of file nsIEnigmail.idl.

const long nsIEnigmail::EXPIRED_KEY = 0x000020

Definition at line 193 of file nsIEnigmail.idl.

const long nsIEnigmail::EXPIRED_KEY_SIGNATURE = 0x000010

Definition at line 192 of file nsIEnigmail.idl.

const long nsIEnigmail::EXPIRED_SIGNATURE = 0x000008

Definition at line 191 of file nsIEnigmail.idl.

Definition at line 258 of file nsIEnigmail.idl.

const long nsIEnigmail::GOOD_SIGNATURE = 0x000001

Definition at line 188 of file nsIEnigmail.idl.

const long nsIEnigmail::IMPORTED_KEY = 0x000200

Definition at line 197 of file nsIEnigmail.idl.

Definition at line 73 of file nsIEnigmail.idl.

readonly attribute string nsIEnigmail::initializationError

Definition at line 74 of file nsIEnigmail.idl.

readonly attribute boolean nsIEnigmail::initialized

Definition at line 72 of file nsIEnigmail.idl.

const long nsIEnigmail::INLINE_KEY = 0x00800000

Definition at line 211 of file nsIEnigmail.idl.

const long nsIEnigmail::INVALID_RECIPIENT = 0x000400

Definition at line 198 of file nsIEnigmail.idl.

readonly attribute boolean nsIEnigmail::isDosLike

Definition at line 66 of file nsIEnigmail.idl.

readonly attribute boolean nsIEnigmail::isWin32

Definition at line 65 of file nsIEnigmail.idl.

readonly attribute nsIIPCRequest nsIEnigmail::keygenRequest

Definition at line 68 of file nsIEnigmail.idl.

readonly attribute nsIFileOutputStream nsIEnigmail::logFileStream

Definition at line 77 of file nsIEnigmail.idl.

readonly attribute long nsIEnigmail::maxIdleMinutes

Definition at line 70 of file nsIEnigmail.idl.

const long nsIEnigmail::MISSING_PASSPHRASE = 0x000800

Definition at line 199 of file nsIEnigmail.idl.

const long nsIEnigmail::NO_PUBKEY = 0x000080

Definition at line 195 of file nsIEnigmail.idl.

const long nsIEnigmail::NO_SECKEY = 0x000100

Definition at line 196 of file nsIEnigmail.idl.

const long nsIEnigmail::NODATA = 0x004000

Definition at line 202 of file nsIEnigmail.idl.

const long nsIEnigmail::OVERFLOWED = 0x04000000

Definition at line 214 of file nsIEnigmail.idl.

const long nsIEnigmail::PARTIALLY_PGP = 0x01000000

Definition at line 212 of file nsIEnigmail.idl.

const long nsIEnigmail::PGP_MIME_ENCRYPTED = 0x00200000

Definition at line 209 of file nsIEnigmail.idl.

const long nsIEnigmail::PGP_MIME_SIGNED = 0x00100000

Definition at line 208 of file nsIEnigmail.idl.

const long nsIEnigmail::PHOTO_AVAILABLE = 0x02000000

Definition at line 213 of file nsIEnigmail.idl.

const long nsIEnigmail::REFRESH_KEY = 0x08

Definition at line 282 of file nsIEnigmail.idl.

const long nsIEnigmail::REVOKED_KEY = 0x000040

Definition at line 194 of file nsIEnigmail.idl.

const long nsIEnigmail::SAVE_MESSAGE = 0x200

Definition at line 171 of file nsIEnigmail.idl.

const long nsIEnigmail::SC_OP_FAILURE = 0x10000000

Definition at line 216 of file nsIEnigmail.idl.

const long nsIEnigmail::SEARCH_KEY = 0x01

Definition at line 279 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_ALWAYS_TRUST = 0x020

Definition at line 167 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_ATTACHMENT = 0x800

Definition at line 173 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_DEFAULT = 0x004

Definition at line 164 of file nsIEnigmail.idl.

Definition at line 168 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_ENCRYPTED = 0x002

Definition at line 163 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_LATER = 0x008

Definition at line 165 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_PGP_MIME = 0x080

Definition at line 169 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_SIGNED = 0x001

Definition at line 162 of file nsIEnigmail.idl.

Definition at line 172 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_TEST = 0x100

Definition at line 170 of file nsIEnigmail.idl.

const long nsIEnigmail::SEND_WITH_CHECK = 0x010

Definition at line 166 of file nsIEnigmail.idl.

const long nsIEnigmail::SIG_CREATED = 0x40000000

Definition at line 218 of file nsIEnigmail.idl.

Definition at line 148 of file nsIEnigmail.idl.

Definition at line 147 of file nsIEnigmail.idl.

Definition at line 146 of file nsIEnigmail.idl.

const long nsIEnigmail::TRUSTED_IDENTITY = 0x00080000

Definition at line 207 of file nsIEnigmail.idl.

Definition at line 155 of file nsIEnigmail.idl.

const long nsIEnigmail::UI_INTERACTIVE = 0x01

Definition at line 154 of file nsIEnigmail.idl.

const long nsIEnigmail::UI_PGP_MIME = 0x08

Definition at line 157 of file nsIEnigmail.idl.

Definition at line 159 of file nsIEnigmail.idl.

const long nsIEnigmail::UI_TEST = 0x10

Definition at line 158 of file nsIEnigmail.idl.

Definition at line 156 of file nsIEnigmail.idl.

const long nsIEnigmail::UNKNOWN_ALGO = 0x20000000

Definition at line 217 of file nsIEnigmail.idl.

const long nsIEnigmail::UNTRUSTED_IDENTITY = 0x040000

Definition at line 206 of file nsIEnigmail.idl.

const long nsIEnigmail::UNVERIFIED_SIGNATURE = 0x000004

Definition at line 190 of file nsIEnigmail.idl.

const long nsIEnigmail::UPLOAD_KEY = 0x04

Definition at line 281 of file nsIEnigmail.idl.


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