2020-08-12 16:18:42 -04:00
|
|
|
/**
|
|
|
|
|
* @typedef {object} ModmailConfig
|
|
|
|
|
* @property {string} [token]
|
2020-08-16 16:53:35 -04:00
|
|
|
* @property {array} [mainServerId]
|
|
|
|
|
* @property {string} [inboxServerId]
|
|
|
|
|
* @property {string} [logChannelId]
|
2020-08-12 17:03:01 -04:00
|
|
|
* @property {array} [mainGuildId]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {string} [mailGuildId]
|
|
|
|
|
* @property {string} [prefix="!"]
|
|
|
|
|
* @property {string} [snippetPrefix="!!"]
|
|
|
|
|
* @property {string} [snippetPrefixAnon="!!!"]
|
|
|
|
|
* @property {string} [status="Message me for help!"]
|
2020-08-12 17:03:01 -04:00
|
|
|
* @property {string} [responseMessage="Thank you for your message! Our mod team will reply to you here as soon as possible."]
|
|
|
|
|
* @property {string} [closeMessage]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {boolean} [allowUserClose=false]
|
|
|
|
|
* @property {string} [newThreadCategoryId]
|
|
|
|
|
* @property {string} [mentionRole="here"]
|
|
|
|
|
* @property {boolean} [pingOnBotMention=true]
|
2020-08-12 17:03:01 -04:00
|
|
|
* @property {string} [botMentionResponse]
|
2020-08-12 20:31:48 -04:00
|
|
|
* @property {array} [inboxServerPermission=[]]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {boolean} [alwaysReply=false]
|
|
|
|
|
* @property {boolean} [alwaysReplyAnon=false]
|
|
|
|
|
* @property {boolean} [useNicknames=false]
|
|
|
|
|
* @property {boolean} [ignoreAccidentalThreads=false]
|
|
|
|
|
* @property {boolean} [threadTimestamps=false]
|
|
|
|
|
* @property {boolean} [allowMove=false]
|
|
|
|
|
* @property {boolean} [syncPermissionsOnMove=true]
|
|
|
|
|
* @property {boolean} [typingProxy=false]
|
|
|
|
|
* @property {boolean} [typingProxyReverse=false]
|
|
|
|
|
* @property {boolean} [mentionUserInThreadHeader=false]
|
|
|
|
|
* @property {boolean} [rolesInThreadHeader=false]
|
2020-08-16 17:52:24 -04:00
|
|
|
* @property {boolean} [allowStaffEdit=true]
|
|
|
|
|
* @property {boolean} [allowStaffDelete=true]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {boolean} [enableGreeting=false]
|
2020-08-12 17:03:01 -04:00
|
|
|
* @property {string} [greetingMessage]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {string} [greetingAttachment]
|
2020-08-16 18:20:59 -04:00
|
|
|
* @property {*} [serverGreetings={}]
|
|
|
|
|
* @property {*} [guildGreetings]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {number} [requiredAccountAge] Required account age to message Modmail, in hours
|
2020-08-12 17:03:01 -04:00
|
|
|
* @property {string} [accountAgeDeniedMessage="Your Discord account is not old enough to contact modmail."]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {number} [requiredTimeOnServer] Required time on server to message Modmail, in minutes
|
2020-08-12 17:03:01 -04:00
|
|
|
* @property {string} [timeOnServerDeniedMessage="You haven't been a member of the server for long enough to contact modmail."]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {boolean} [relaySmallAttachmentsAsAttachments=false]
|
|
|
|
|
* @property {number} [smallAttachmentLimit=2097152] Max size of attachment to relay directly. Default is 2MB.
|
2020-08-12 20:31:48 -04:00
|
|
|
* @property {string} [attachmentStorage="original"]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {string} [attachmentStorageChannelId]
|
2020-08-12 17:03:01 -04:00
|
|
|
* @property {*} [categoryAutomation={}]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {boolean} [updateNotifications=true]
|
|
|
|
|
* @property {array} [plugins=[]]
|
|
|
|
|
* @property {*} [commandAliases]
|
2020-08-16 12:22:50 -04:00
|
|
|
* @property {boolean} [reactOnSeen=false]
|
|
|
|
|
* @property {string} [reactOnSeenEmoji="📨"]
|
|
|
|
|
* @property {boolean} [createThreadOnMention=false]
|
2020-09-22 17:19:34 -04:00
|
|
|
* @property {boolean} [notifyOnMainServerLeave=true]
|
|
|
|
|
* @property {boolean} [notifyOnMainServerJoin=true]
|
2020-08-12 16:18:42 -04:00
|
|
|
* @property {number} [port=8890]
|
|
|
|
|
* @property {string} [url]
|
2020-08-12 17:23:59 -04:00
|
|
|
* @property {array} [extraIntents=[]]
|
2020-08-12 20:31:48 -04:00
|
|
|
* @property {*} [dbType="sqlite"]
|
2020-08-13 18:01:40 -04:00
|
|
|
* @property {object} [sqliteOptions]
|
|
|
|
|
* @property {string} sqliteOptions.filename
|
|
|
|
|
* @property {object} [mysqlOptions]
|
|
|
|
|
* @property {string} mysqlOptions.host
|
|
|
|
|
* @property {number} mysqlOptions.port
|
|
|
|
|
* @property {string} mysqlOptions.user
|
|
|
|
|
* @property {string} mysqlOptions.password
|
|
|
|
|
* @property {string} mysqlOptions.database
|
|
|
|
|
* @property {string} [mysqlOptions.timezone]
|
2020-08-12 16:18:42 -04:00
|
|
|
*/
|
