Revision control
Copy as Markdown
Other Tools
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
const { AccountCreationUtils } = ChromeUtils.importESModule(
);
const { AccountConfig } = ChromeUtils.importESModule(
);
const { Sanitizer } = ChromeUtils.importESModule(
);
const { OAuth2Providers } = ChromeUtils.importESModule(
);
const { gAccountSetupLogger, standardPorts, assert } = AccountCreationUtils;
import { AccountHubStep } from "./account-hub-step.mjs";
/**
* Account Hub Email Outgoing Form Template
* Template ID: #accountHubEmailOutgoingFormTemplate (from accountHubEmailOutgoingFormTemplate.inc.xhtml)
*/
class EmailOutgoingForm extends AccountHubStep {
/**
* The current email outgoing config form inputs.
*
* @type {Object}
*/
currentConfig;
/**
* The outgoing server username.
*
* @type {HTMLInputElement}
*/
#outgoingUsername;
/**
* The outgoing server hostname.
*
* @type {HTMLInputElement}
*/
#outgoingHostname;
/**
* The outgoing server port.
*
* @type {HTMLInputElement}
*/
#outgoingPort;
/**
* The outgoing server connection security.
*
* @type {HTMLInputElement}
*/
#outgoingConnectionSecurity;
/**
* The outgoing server authentication method.
*
* @type {HTMLInputElement}
*/
#outgoingAuthenticationMethod;
connectedCallback() {
if (this.hasConnected) {
super.connectedCallback();
return;
}
super.connectedCallback();
const template = document
.getElementById("accountHubOutgoingEmailFormTemplate")
.content.cloneNode(true);
this.appendChild(template);
this.#outgoingPort = this.querySelector("#outgoingPort");
this.#outgoingUsername = this.querySelector("#outgoingUsername");
this.#outgoingHostname = this.querySelector("#outgoingHostname");
this.#outgoingConnectionSecurity = this.querySelector(
"#outgoingConnectionSecurity"
);
this.#outgoingAuthenticationMethod = this.querySelector(
"#outgoingAuthMethod"
);
this.currentConfig = {};
}
/**
* Set up the event listeners for this workflow.
*/
setupEventListeners() {
this.#outgoingHostname.addEventListener("change", () => {
this.#adjustOAuth2Visibility();
});
this.#outgoingPort.addEventListener("change", () => {
this.#adjustSSLToPort(false);
});
this.#outgoingConnectionSecurity.addEventListener("command", () => {
this.#adjustPortToSSLAndProtocol(false);
});
this.#outgoingAuthenticationMethod.addEventListener("command", event => {
// Disable the outgoing username field if the "No Authentication" option
// is selected.
this.#outgoingUsername.disabled = event.target.value == 1;
});
}
/**
* Make OAuth2 visible as an authentication method when a hostname that
* OAuth2 can be used with is entered.
*
* @param {AccountConfig} [accountConfig] - The config to present to the user.
*/
#adjustOAuth2Visibility(accountConfig) {
// Get current config.
const config = accountConfig || this.getIncomingUserConfig();
config.outgoing.oauthSettings = {};
// If the smtp hostname supports OAuth2, enable it.
const outgoingDetails = OAuth2Providers.getHostnameDetails(
config.outgoing.hostname
);
this.querySelector("#outgoingAuthMethodOAuth2").hidden = !outgoingDetails;
if (outgoingDetails) {
gAccountSetupLogger.debug(
`OAuth2 details for outgoing server ${config.outgoing.hostname} is ${outgoingDetails}`
);
[
config.outgoing.oauthSettings.issuer,
config.outgoing.oauthSettings.scope,
] = outgoingDetails;
}
}
/**
* Automatically fill port field when connection security has changed in
* manual edit, unless the user entered a non-standard port.
*
* @param {AccountConfig} [accountConfig] - The config to present to the user.
*/
#adjustPortToSSLAndProtocol(accountConfig) {
// Get current config.
const config = accountConfig || this.getIncomingUserConfig();
if (config.outgoing.port && !standardPorts.includes(config.outgoing.port)) {
return;
}
// Implicit TLS for SMTP is on port 465.
if (config.outgoing.socketType == Ci.nsMsgSocketType.SSL) {
this.#outgoingPort.value = 465;
} else if (
(config.outgoing.port == 465 || !config.outgoing.port) &&
config.outgoing.socketType == Ci.nsMsgSocketType.alwaysSTARTTLS
) {
// Implicit TLS for SMTP is on port 465. STARTTLS won't work there.
this.#outgoingPort.value = 587;
}
config.outgoing.port = this.#outgoingPort.value;
this.currentConifg = config;
}
/**
* If the user changed the port manually, adjust the SSL value,
* (only) if the new port is impossible with the old SSL value.
*
* @param {AccountConfig} [accountConfig] - Complete AccountConfig.
*/
#adjustSSLToPort(accountConfig) {
const config = accountConfig;
if (!standardPorts.includes(config.outgoing.port)) {
return;
}
if (
config.outgoing.port == 465 &&
config.outgoing.socketType != Ci.nsMsgSocketType.SSL
) {
this.#outgoingConnectionSecurity.value = Ci.nsMsgSocketType.SSL;
} else if (
(config.outgoing.port == 587 || config.outgoing.port == 25) &&
config.outgoing.socketType == Ci.nsMsgSocketType.SSL
) {
// Port 587 and port 25 are for plain or STARTTLS. Not for Implicit TLS.
this.#outgoingConnectionSecurity.value =
Ci.nsMsgSocketType.alwaysSTARTTLS;
}
config.outgoing.socketType = this.#outgoingConnectionSecurity.value;
this.currentConfig = config;
}
/**
* Returns an Account Config object with all the sanitized user-inputted
* data for a manual config email guess attempt.
*
* @returns {AccountConfig}
*/
getOutgoingUserConfig() {
const config = new AccountConfig();
config.source = AccountConfig.kSourceUser;
// The user specified a custom SMTP server.
config.outgoing.type = "smtp";
config.outgoing.existingServerKey = null;
config.outgoing.useGlobalPreferredServer = false;
try {
const input = this.#outgoingHostname.value;
config.outgoing.hostname = Sanitizer.hostname(input);
this.#outgoingHostname.value = config.outgoing.hostname;
} catch (error) {
gAccountSetupLogger.warn(error);
}
try {
config.outgoing.port = Sanitizer.integerRange(
this.#outgoingPort.valueAsNumber,
1,
65535
);
} catch (error) {
// Include default "Auto".
config.outgoing.port = undefined;
}
config.outgoing.socketType = Sanitizer.integer(
this.#outgoingConnectionSecurity.value
);
config.outgoing.auth = Sanitizer.integer(
this.#outgoingAuthenticationMethod.value
);
return config;
}
/**
* Updates the fields with the confirmed AccountConfig from
* guessConfig, called by parent template.
*
* @param {AccountConfig} config - The config to present to the user.
*/
updateFields(config) {
assert(config instanceof AccountConfig);
this.#outgoingHostname.value = config.outgoing.hostname;
this.#outgoingUsername.value = config.outgoing.username;
this.#outgoingConnectionSecurity.value = Sanitizer.enum(
config.outgoing.socketType,
[0, 1, 2, 3],
0
);
this.#outgoingAuthenticationMethod.value = Sanitizer.enum(
config.outgoing.auth,
[0, 1, 3, 4, 5, 6, 10],
0
);
// If a port number was specified other than "Auto"
if (config.outgoing.port) {
this.#outgoingPort.value = config.outgoing.port;
} else {
this.#adjustPortToSSLAndProtocol(config);
}
this.#adjustOAuth2Visibility(config);
}
/**
* Return the current state of the email setup form.
*/
captureState() {
return this.currentConfig;
}
}
customElements.define("email-manual-outgoing-form", EmailOutgoingForm);