Class: MailConfig

ShardingMaster.ShardMasterConfig. MailConfig


new MailConfig()

Configuration for the Shard Master. This config will be updated during runtime if it is edited. Relevant settings may be sent to each shard during each initial setup. These settings are related to informing sysadmins of important updates.
Source:

Members


args :Array.<string>

Additional arguments to pass to the mail command. `%ATTACHMENT%` is replaced with the absolute path to the file to attach.
Type:
  • Array.<string>
Default Value:
  • ["-a","%ATTACHMENT%","-s Automated Sharding Update","--","sysadmin@spikeybot.com"]
Source:

command :string

The command that will be used to send the email.
Type:
  • string
Default Value:
  • mutt
Source:

enabled :boolean

Is the mail system enabled. It must also be configured properly on the system in order for it to work.
Type:
  • boolean
Default Value:
  • true
Source:

failArgs :Array.<string>

Additional arguments to pass to the mail command, when a failure has occurred.
Type:
  • Array.<string>
Default Value:
  • ["-s Automated Sharding Update FAILURE","--","sysadmin@spikeybot.com"]
Source:

shardConfigCreateFailMessage :string

The message to send in the email when a shard config file was created successfully and has been attached to the emai.
Type:
  • string
Source:

shardConfigCreateMessage :string

The message to send in the email when a shard config file was created successfully and has been attached to the emai.
Type:
  • string
Source:

spawnOpts :object

Options to pass to the spawn function when calling the command. https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options.
Type:
  • object
Default Value:
  • {"env":null,"timeout":120000}
Source: