@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/update/update-mail-server-settings/UpdateMailServerSettingsDefinition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var MailServerSettingsOptions = require('../../../options/MailServerSettingsOptions.js');
var EBGSession = require('../../../sessions/EBGSession.js');

/*
 * Copyright (c) 2019 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
const UpdateMailServerSettingsDefinition = {
    name: "mail-server",
    aliases: ["ms"],
    type: "command",
    handler: __dirname + "/UpdateMailServerSettings.handler",
    description: "Update the mail server settings for Endevor bridge for git",
    summary: "Update the mail server settings",
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    positionals: [MailServerSettingsOptions.MailServerSettingsOptions.HOST, MailServerSettingsOptions.MailServerSettingsOptions.PORT],
    options: [
        MailServerSettingsOptions.MailServerSettingsOptions.USERNAME,
        MailServerSettingsOptions.MailServerSettingsOptions.PASSWORD,
        MailServerSettingsOptions.MailServerSettingsOptions.MAILFROM,
        MailServerSettingsOptions.MailServerSettingsOptions.STARTTLSENABLED,
        MailServerSettingsOptions.MailServerSettingsOptions.STARTTLSREQUIRED,
        MailServerSettingsOptions.MailServerSettingsOptions.SSLENABLED,
    ],
    examples: [
        {
            description: "Update existing mail server settings using the default EBG profile",
            options: "MAIL-HOST MAIL-PORT --username mailAdmin --password mailPass --mail-from noreply@company.org --start-tls-enabled true \n" +
                "--start-tls-required true --ssl-enabled true",
        },
    ],
};

exports.UpdateMailServerSettingsDefinition = UpdateMailServerSettingsDefinition;