new Mailbox(mailboxId, name, accessId, password, satelliteGatewayName, enabled)
infra/database/models/Mailbox.js, line 15
Represents a Mailbox on the satellite message gateway
Name | Type | Description |
---|---|---|
mailboxId |
string | number |
Unique mailbox/account ID |
name |
string |
A logical identifier for the mailbox |
accessId |
string |
The username credential |
password |
string |
The password credential (encrypted when stored) |
satelliteGatewayName |
string |
The shorthand name of the gateway host |
enabled |
boolean |
Flag whether to include mailbox in operations |
Methods
-
passwordGet(secret)
infra/database/models/Mailbox.js, line 52 -
Returns the unencrypted password from storage
Name Type Description secret
string The encryption secret
-
passwordSet(password, secret)
infra/database/models/Mailbox.js, line 44 -
Encrypts the password for storage
Name Type Description password
string The password (unencrypted)
secret
string The encryption secret