Mailvelope API

Global

Type Definitions

additionalMailHeaders

Type:
  • Object
Properties:
Name Type Description
autocrypt String

the Autocrypt header that should be

added to the outgoing mail
Source:

AsciiArmored

Ascii Armored PGP Text Block

Type:
  • String
Source:

AutocryptMailHeaders

Type:
  • Object
Properties:
Name Type Description
autocrypt String

the Autocrypt header to process
from String

the From header
date String

the Date header
Source:

BackupSyncHandler()

Parameters:
Type Description
BackupSyncPacket

object with backup data
Source:
Returns:
Type
Promise.<undefined, Error>

BackupSyncPacket

Type:
  • Object
Properties:
Name Type Description
backup AsciiArmored

encrypted key backup as PGP armored message
Source:

CssSelector

CSS Selector String

Type:
  • String
Source:

DisplayContainer

Type:
  • Object
Properties:
Name Type Description
error Error

Error object with code and message attribute
error.code = 'DECRYPT_ERROR' - generic decrypt error
error.code = 'ARMOR_PARSE_ERROR' - error while parsing the armored message
error.code = 'PWD_DIALOG_CANCEL' - user canceled password dialog
error.code = 'NO_KEY_FOUND' - no private key found to decrypt this message
Source:

DisplayContainerOptions

Type:
  • Object
Properties:
Name Type Description
senderAddress String

email address of sender, used to indentify key for signature verification
Source:

DownloadSyncHandler(downloadObj)

Parameters:
Name Type Description
downloadObj Object

meta info for download

Properties
Name Type Description
eTag String

entity tag for the current local keyring, or null if no local eTag
Source:
Returns:
  • if version on server has same eTag, then keyringMsg property of reply is empty, but eTag in reply has to be set
    if server is initial and downloadObj.eTag is not null, then the promise is resolved with empty eTag
Type
Promise.<DownloadSyncReply, Error>

DownloadSyncReply

Type:
  • Object
Properties:
Name Type Description
keyringMsg AsciiArmored

encrypted keyring as PGP armored message, or null if no newer version available
eTag String

entity tag for the current encrypted keyring message, or null if server is intial
Source:

EditorContainerOptions

Type:
  • Object
Properties:
Name Type Description
quota number

mail content (text + attachments) limit in kilobytes (default: 20480)
signMsg boolean

if true then the mail will be signed (default: false)
armoredDraft AsciiArmored

a PGP message, signed and encrypted with the default key of the user, will be used to restore a draft in the editor
The armoredDraft parameter can't be combined with the parameters: predefinedText, quotedMail... parameters, keepAttachments
predefinedText String

text that will be added to the editor
quotedMail AsciiArmored

mail that should be quoted
quotedMailIndent boolean

if true the quoted mail will be indented (default: true)
quotedMailHeader String

header to be added before the quoted mail
keepAttachments boolean

add attachments of quotedMail to editor (default: false)
Source:

KeyBackupContainerOptions

Type:
  • Object
Source:

KeyGenContainerOptions

Type:
  • Object
Properties:
Name Type Description
userIds Array.<UserId>

array of user IDs. The first entry in the array is set as the primary user ID.
keySize number

key size in bit, optional, default: 2048, valid values: 2048, 4096.
Source:

LookupResult

Type:
  • Object
Properties:
Name Type Argument Description
fingerprint String

Fingerprint of the key
lastModified Date

last time the key was modified
source String

Source the key was found at

Currently available:

* 'LOC' - local key ring

* 'WKD' - web key directory

* 'MKS' - mailvelope key server

* 'AC' - autocrypt
lastSeen Date <optional>

last time the key was seen

(not set for local keys)
armored String <optional>

Armored key that can be imported

(not set for local keys)
Source:

OpenSettingsOptions

Type:
  • Object
Source:

outgoingMailHeaders

Type:
  • Object
Properties:
Name Type Description
from String

the From header
Source:

PrivateKeyContainerOptions

Type:
  • Object
Properties:
Name Type Description
restorePassword boolean

(default: false)
Source:

RestoreSyncHandler()

Source:
Returns:
Type
Promise.<BackupSyncPacket, Error>

SettingsContainerOptions

Type:
  • Object
Properties:
Name Type Description
email String

the email address of the current user
fullName String

the full name of the current user
Source:

SyncHandlerObject

Type:
  • Object
Properties:
Name Type Description
uploadSync UploadSyncHandler

function called by Mailvelope to upload the keyring (public keys), the message is encrypted with the default private key
downloadSync DownloadSyncHandler

function called by Mailvelope to download the encrypted keyring (public keys)
backup BackupSyncHandler

function called by Mailvelope to upload a symmetrically encrypted private key backup
restore RestoreSyncHandler

function called by Mailvelope to restore a private key backup
Source:

UploadSyncHandler(uploadObj)

Parameters:
Name Type Description
uploadObj Object

object with upload data

Properties
Name Type Description
eTag String

entity tag for the uploaded encrypted keyring, or null if initial upload
keyringMsg AsciiArmored

encrypted keyring as PGP armored message
Source:
Returns:
  • if version on server has different eTag, then the promise is rejected
    if server is initial and uploadObj.eTag is not null, then the promise is rejected
Type
Promise.<UploadSyncReply, Error>

UploadSyncReply

Type:
  • Object
Properties:
Name Type Description
eTag String

entity tag for the uploaded encrypted keyring
Source:

UserId

Type:
  • Object
Properties:
Name Type Description
email String

the email address of the current user
fullName String

the full name of the current user
Source: