mail.js

"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports.mailSignPreference = exports.mailSendPublicKey = exports.mailSendEncryptionKey = exports.mailSendCertificateRequest = exports.mailSend = exports.mailScanUnread = exports.mailSavePreference = exports.mailRequestNewPublicKey = exports.mailRequestNewName = exports.mailRequestCrossCert = exports.mailOpen = exports.mailForwardAsAttachment = exports.mailForward = exports.mailEncryptSentPreference = exports.mailEncryptSavedPreference = exports.mailComposeMemo = exports.mailAddress = exports._notes = void 0;
const tslib_1 = require("tslib");
/**
 * @file Mail
 * @module mail
 * @category Mail
 */
const notesc = tslib_1.__importStar(require("../notes/mail"));
exports._notes = notesc;
//-----------------------------
// Notes @Commands mail
/**
 * Displays the Select Addresses dialog box, where the user can select people and
 * groups to include in an address field of a mail document.
 * @throws {Error} no plans to implement
 */
function mailAddress() {
    return notesc.MailAddress();
}
exports.mailAddress = mailAddress;
/**
 * Creates and displays a blank mail document. Notes/Domino uses the default form
 * for the user's mail database. This is a Memo document unless the user has
 * changed it.
 * @throws {Error} no plans to implement
 */
function mailComposeMemo() {
    return notesc.MailComposeMemo();
}
exports.mailComposeMemo = mailComposeMemo;
/**
 * Indicates whether the user has selected "Encrypt saved mail" in the User
 * Preferences dialog box.
 * @throws {Error} no plans to implement
 */
function mailEncryptSavedPreference() {
    return notesc.MailEncryptSavedPreference();
}
exports.mailEncryptSavedPreference = mailEncryptSavedPreference;
/**
 * Indicates whether the user has selected "Encrypt sent mail" in the User
 * Preferences dialog box.
 * @throws {Error} no plans to implement
 */
function mailEncryptSentPreference() {
    return notesc.MailEncryptSentPreference();
}
exports.mailEncryptSentPreference = mailEncryptSentPreference;
/**
 * Forwards the current document by placing its contents into a mail memo, which
 * the user then addresses and sends like any other mail memo.
 * @throws {Error} no plans to implement
 */
function mailForward() {
    return notesc.MailForward();
}
exports.mailForward = mailForward;
/**
 * In cc:Mail, forwards a Notes/Domino document as a cc:Mail attachment.
 * @throws {Error} no plans to implement
 */
function mailForwardAsAttachment() {
    return notesc.MailForwardAsAttachment();
}
exports.mailForwardAsAttachment = mailForwardAsAttachment;
/**
 * Opens the user's mail database to the view or navigator to which it was most
 * recently open.
 * @throws {Error} no plans to implement
 */
function mailOpen() {
    return notesc.MailOpen();
}
exports.mailOpen = mailOpen;
/**
 * Displays the Choose ID to be Cross-Certified dialog box, which allows an
 * administrator to send a safe copy of a Certifier ID to another administrator,
 * who can certify it with a different Certifier ID to create a cross certificate.
 * @throws {Error} no plans to implement
 */
function mailRequestCrossCert() {
    return notesc.MailRequestCrossCert();
}
exports.mailRequestCrossCert = mailRequestCrossCert;
/**
 * Displays the Change User Name dialog box, which allows the user to send a
 * portion of the Notes® user ID to a Notes/Domino administrator, who can change
 * the user name associated with the ID and return the ID to the user. The user
 * then merges the updated portion back into the existing user ID.
 * @throws {Error} no plans to implement
 */
function mailRequestNewName() {
    return notesc.MailRequestNewName();
}
exports.mailRequestNewName = mailRequestNewName;
/**
 * Displays the Mail New Public Key Request dialog box, which allows the user to
 * send a portion of his or her Notes/Domino ID to an administrator, who can create
 * a new public key for the ID and return the ID to the user. The user then merges
 * the updated portion back into the existing user ID.
 * @throws {Error} no plans to implement
 */
function mailRequestNewPublicKey() {
    return notesc.MailRequestNewPublicKey();
}
exports.mailRequestNewPublicKey = mailRequestNewPublicKey;
/**
 * Indicates which option the user has selected for the "Save sent mail"setting in
 * the User Preferences dialog box.
 * @throws {Error} no plans to implement
 */
function mailSavePreference() {
    return notesc.MailSavePreference();
}
exports.mailSavePreference = mailSavePreference;
/**
 * Opens the user's mail database to the first unread document in the view to which
 * the database was most recently open.
 * @throws {Error} no plans to implement
 */
function mailScanUnread() {
    return notesc.MailScanUnread();
}
exports.mailScanUnread = mailScanUnread;
/**
 * Displays the Mail Send dialog box, which lets the user choose whether or not to
 * encrypt, sign, or send the selected memo.
 * @throws {Error} no plans to implement
 */
function mailSend() {
    return notesc.MailSend(); // note: there is also a MailSend notes function in the miscellaneous category
}
exports.mailSend = mailSend;
/**
 * Displays the Mail Certificate Request dialog box. This lets the user send a safe
 * copy of the Notes/Domino user ID to an administrator, who certifies and then
 * returns it; the user then merges the updated safe copy back into the user ID.
 * @throws {Error} no plans to implement
 */
function mailSendCertificateRequest() {
    return notesc.MailSendCertificateRequest();
}
exports.mailSendCertificateRequest = mailSendCertificateRequest;
/**
 * Displays the User ID dialog box, where the user can define and send encryption
 * keys. If the user's ID is password-protected, the user will be required to
 * enter the password before being allowed access to the dialog box.
 * @throws {Error} no plans to implement
 */
function mailSendEncryptionKey() {
    return notesc.MailSendEncryptionKey();
}
exports.mailSendEncryptionKey = mailSendEncryptionKey;
/**
 * Displays the Mail Public Key dialog box. This lets the user send the public key
 * to another user (typically to an administrator who can then paste the public key
 * into that user's Person record in the Domino® Directory).
 * @throws {Error} no plans to implement
 */
function mailSendPublicKey() {
    return notesc.MailSendPublicKey();
}
exports.mailSendPublicKey = mailSendPublicKey;
/**
 * Indicates whether the user has selected "Sign sent mail" in the User Preferences
 * dialog box.
 * @throws {Error} no plans to implement
 */
function mailSignPreference() {
    return notesc.MailSignPreference();
}
exports.mailSignPreference = mailSignPreference;
//# sourceMappingURL=mail.js.map