Remote Administration Commands

Remote Administration Commands

The Business and Corporate Editions of MailList King permit the management of many mailing list functions via e-mail. For example, you can create, lock or allow member sending to a group by sending a command e-mail to MailList King.

To permit processing of Remote Administration Commands select File > Options, Commands and click the "Remote Admin. Commands" button.

Once enabled any messages containing remote admin. commands found in your mailing list folder (as specified under "Email Processing Options") will be automatically processed and replied to with a message advising success or failure.

The following options need to be specified:

Accept commands from the following addresses or domains:

Specify the list of e-mail addresses or domains that are permitted to send administration messages (e.g. just messages from me@mycompany.com or *@mycompany.com for any address of the mycompany.com domain).

You must also specify if the address can manage all mailing list groups or only specific ones.

Not Recommended: If anyone is allowed to manage your mailing list (including issuing sending commands) you can specify *@* as an address

Require the following password to be specified...

To avoid unauthorized users from using Remote Admin Commands maliciously (e.g. by spoofing the e-mail address of an actual administrator) you should enable the password option

This will require you to specify a password after the command in the format Password:MyPassword (or short form PW:MyPassword).

For example CreateGroup NewGroup Password:123456

Send a copy of all response messages to...

When MailList King process a remote admin. command it always sends a message advising the successful or failed processing. Use this option to specify the address of anyone who should receive a copy of every response message.

Sending Remote Admin Commands

To issue a command to MailList King send a message to the address that handles other mailing list commands (i.e. so that it is placed in the folder specified under "Email Checking Options").

You need to specify the command in the subject line of the message. For the SubscribeList, UnsubscribeList and BounceList commands also need to specify e-mail addresses within the body of the message (one address per line)

Remote Admin Command List

Command	Explanation	Example Usage
CreateGroup GROUP_NAME *	Create a group of the specified name	CreateGroup NewGroup CreateGroup Group1,Group2,Group3
LockGroup GROUP_NAME	Block new users from joining the specified group	LockGroup SomeGroup LockGroup Group1,Group2,Group3
UnlockGroup GROUP_NAME	Remove blocking of new users from joining the specified group	UnlockGroup SomeGroup UnlockGroup Group1,Group2,Group3
EnableMemberSending GROUP_NAME	Remove blocking of members from sending messages to the specified group (has no effect if you have not enabled member sending)	EnableMemberSending SomeGroup EnableMemberSending Group1,Group2
DisableMemberSending GROUP_NAME	Block members from sending messages to the specified group (has no effect if you have not enabled member sending)	DisableMemberSending SomeGroup DisableMemberSending Group1,Group2
SendToGroup GROUP_NAME	Remotely send a message to your mailing list. Specify the intended message subject after the SendToGroup GROUP_NAME command. The reply address will be that specified under File > Options, Sending	SendToGroup SomeGroup This is my Message SendToGroup Group1,Group2 This is my Message SendToGroup ALL This is my Message to all members
RelayToGroup GROUP_NAME	Same as SendToGroup but uses the e-mail address of the sender (rather than the default admin address)	RelayToGroup SomeGroup This is my Message RelayToGroup ALL This is my Message to all members
SubscribeList GROUP_NAME	Subscribe all addresses contained in body of the email to the specified group. Specify one address per line (optionally specifying a name in the format Full Name <email@domain.com>)	Subject: SubscribeList AGroup Body: john@mycompany.com Jane <jane@mycompany.com> Bill Odie <bill@goodies.com>
UnsubscribeList GROUP_NAME	Unsubscribe all of the addresses contained in the body of the email from the specified group (or the entire mailing list if no group is specified)	Subject: UnsubscribeList ALL Body: Jane <jane@mycompany.com> Bill Odie <bill@goodies.com> john@mycompany.com
BounceList	Process all of the addresses contained in the body of the email as undeliverable (increase their bounce count and remove them if they exceed the maximum bounce count you have specified)	Subject: BounceList Body: Jane <jane@mycompany.com> Bill Odie <bill@goodies.com> john@mycompany.com
ProcessScript *	Process all commands listed in the body of an email. Each line can be a Remote Admin Command or a standard mailing list commands	Subject: ProcessScript Body: Subscribe jane@mycompany.com MyGroup SetMemberField jane@mycompany.com FullName=Jane Doe SetMemberField jane@mycompany.com Company=Has Bean Ltd. Unsubscribe john@smith.com BounceHard jill@smith.com
EnableMemberCanSend EMAIL_ADDRESS *	Permit the specified member to send to your mailing list (has no effect if you have not enabled member sending)	EnableMemberCanSend john@smith.com
DisableMemberCanSend EMAIL_ADDRESS *	Blocks the specified member from sending to your mailing list (has no effect if you have not enabled member sending)	DisableMemberCanSend john@smith.com
SetMemberField EMAIL_ADDRESS FIELD=NEW_VALUE *	Change a value of a field for the specified member. Any database field can be set. For date fields "TODAY" is supported. For number fields you can use plus or minus a prefix to increase or decrease a value.	SetMemberField js@abc.com Name=John Smith SetMemberField js@abc.com LastActivity=TODAY (set Last activity date to today) SetMemberField js@abc.com BounceCount=0 (Reset the member's bounce count) SetMemberField js@abc.com ActivityCount=+1 (increase the member's activity count) SetMemberField js@abc.com BebopsRemaining=-10 (Reduce value of custom field by ten) SetMemberField js@abc.com Group=ABC (Change member's group membership to only "ABC")
AddGroupAdmin EMAIL_ADDRESS GROUP_NAME *	Adds the specified address as a new administrator address (as specified under File > Options, Commands, Remote Admin Commands) so they can manage the specified group using Remote Admin Commands	AddGroupAdmin john@smith.com SomeGroup AddGroupAdmin john@smith.com ALL
RemoveGroupAdmin EMAIL_ADDRESS GROUP_NAME *	Removes the specified address as an administrator address for the specified group or all groups (as specified under File > Options, Commands, Remote Admin Commands)	RemoveGroupAdmin john@smith.com SomeGroup RemoveGroupAdmin john@smith.com ALL
ExportMailingList GROUP_NAME	Export the mailing list or specified group and send it to the reply address	ExportMailingList ALL ExportMailingList SomeGroup
BackupMailingList *	Performs the default backup procedure	BackupMailingList
GetMLKStatus *	Return the current status of MailList King (current mailing list, number of members, subscribes, etc)	GetMLKStatus
BounceSoft EMAIL_ADDRESS	Increase the "Undeliverable Count" for the message sender or specified email address	BounceSoft bill@goodies.com
BounceHard EMAIL_ADDRESS	Increase the "Undeliverable Count" for the message sender or specified email address by 3	BounceHard bill@goodies.com
BounceRemove EMAIL_ADDRESS	Remove the message sender or specified email address from the mailing list due to being undeliverable	BounceRemove bill@goodies.com
DeleteMessagesOfMember EMAIL_ADDRESS	If there are any pending messages to be sent to the specified member (in MLK's Outbox or Automated Emails folder) they will be deleted (the member's record is not affected). Note: Only unique messages to member are deleted, not messages where there are other recipients	DeleteMessagesOfMember bill@goodies.com
ProcessRead EMAIL_ADDRESS/USERID	Marks the member has having read the latest message, in the same way as if a "Read Receipt" message had processed (i.e. updating the members' Read Date and Count fields)	ProcessRead bill@goodies.com ProcessRead UID12345 ProcessRead 12345
ProcessResponse EMAIL_ADDRESS/USERID OPTIONAL_COMMENT	Marks the member has having responded to the latest message so that they can be tracked in Sending Properties (updating the members' Response Date and Count fields). You can optionally specify details that will be available in history	ProcessResponse bill@goodies.com ProcessResponse bill@goodies.com Purchased latest version ProcessResponse UID12345 ProcessResponse 12345 ProcessResponse 12345 Requested further information

Notes:

Of course you can also use all standard mailing list commands, such as Subscribe, Unsubscribe, Update
Commands marked by an asterisk (*) can only be issued by administrators who have access to all mailing list groups. Other commands can be issued by administrators of the specified group, or all groups
Multiple groups can be specified by comma separating them, e.g. CreateGroup Group1,Group2
For SubscribeList and UnsubscribeList acknowledgement messages, Welcome messages and Double Opt-in messages will be sent! You can disable message sending by specifying SILENT after the command, e.g. "SubscribeList SILENT"