The End command. LYRIS 11.1 b
Reklamë
Reklamë
The End command
The "end" command tells ListManager that there are no more email commands to process in this message. ListManager will stop processing your message when it sees the "end" command. The "end" command is optional. If you do not include it,
ListManager will automatically scan to the bottom of your message for commands.
Here is an example: subscribe jazztalk set jazztalk digest end
If you add the word "quiet" to the end command, ListManager will not send a confirming message back, even if there was a problem executing the command.
Administrator Email Commands
ListManager has a number of commands specific to administrators to allow adding or unsubscribing members, moderating messages, and retrieving list information.
The administrator must write to the listmanager@ server address using a list, site or server administrator email address, and use the login command to provide the admin password.
Note that if you are using a script to subscribe members using admin email commands, you may need to put in a loop exception for the admin email address. You may also want to use the end quiet command so notification about the command is not returned.
Login
All administrator email commands require the admin password to be provided in a login command in the first line to authenticate the sender as an admin with the rights to use the administrator commands.
Syntax: login password
ListManager will use the email address the message is sent from to identify the sender as a Server, Site or List Administrator, and then check the password provided in the login command. If the password you specified with the login command is correct, it will proceed to process the commands in the message. If it is not, processing of your message will stop.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 880
When ListManager detects a login command, it replaces the password with an XXX in the archived copy it keeps, and in the acknowledgement message that is sent back to you. The reason for this is so that other people looking at your email message, either in your mailbox, or in the incoming mail web page, will not be able to determine your password.
However, including a password in an email message is inherently insecure. If you are concerned about password security, do not use email commands that require a login command.
End [quiet]
Like non-administrative members, administrators may also use the end command to indicate that ListManager should stop processing any additional text in the message. end quiet
The quiet modifier is optional.
When the command interpreter encounters the end command, it stops processing the message immediately. Thus, if you use end, you must be certain to have all of your commands above it. If you use the quiet modifier, you will not receive notification from
ListManager regarding that command message.
Adding Members (Administrators)
add
The add command lets a list administrator add a member to their list. The syntax of the
add command in its simplest form is: add listname [sendconfirm] emailaddress [name] [quiet]
The sendconfirm, user name and quiet modifiers are optional. Here is an example: add jazztalk [email protected] Bob Smith
The add command without modifiers subscribes the member as a normal member and sends them the default hello message. The administrator sending the command receives email notification if the command succeeded or failed. To suppress this notification message, the admin may end the message with end quiet.
If you do not specify a user name, the user will be created with no name in their member record.
If the list you are adding the user to is set to require passwords, one will be created automatically for that member. It is useful if you include the %%url.resetpassword%% tag in your hello message allowing the recipient to reset the password.
ListManager will not resubscribe existing members, or change a membership status from unsub to normal unless the subform modifier is used.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 881
sendconfirm
The sendconfirm modifier subscribes the member in confirm status and sends a confirmation message asking the member to confirm.
Example: add jazztalk sendconfirm [email protected] Bob Smith
quiet
The quiet modifier suppresses sending the new member the default hello message.
Example:add jazztalk [email protected] Bob Smith quiet
This command adds the member without sending the member notification. The administrator sending the add command will still receive notification of the success or failure of the add command unless the message ends with the end quiet command.
subform
Unless the subform modifer is used, the add command will not change the subscription status of current members. The subform modifier adds members so their membership status will be normal, even if they were previously in the list in an inactive status.
For example: add jazztalk subform [email protected] would change the status of [email protected] from unsubscribed to normal.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 882
Adding Many Members
The add command requires all the information for the command to be on one line. To add multiple members with one add command, line continuation characters may be used. The same modifiers for adding single members may be used for adding many members.
The syntax below uses the ‘<’ and ‘>’ operators to delimit a list of names to be added.
The syntax to add many members is: add listname [quiet] [sendconfirm] [subform] <
User Name1 [email protected]
User Name2 [email protected]
>
If you want to add members with user names, the user name must be before the email address.
Example: add jazztalk quiet <
User Name1 [email protected]
User Name2 [email protected]
>
Any text that is not a legal email address is assumed to be a name. For example, if you attempted to add user1@example@com, the address would not be added or shown as part of the list of email addresses successfully added, nor would there be an error message. It would be considered part of the name for the next address to be added if there is one, or ignored.
quiet, sendconfirm and subform
The quiet, sendconfirm and subform modifiers are optional, and work exactly as they do when adding a single member. In the case where you add many members, a quiet modifier suppresses the "hello" message, a sendconfirm modifer sends a confirmation message to each member, and a subform modifer sets the membership status of currently subscribed members to normal regardless of previous membership status.
Line Continuation with \ or &
Alternatively, you can use the "\" or "&" characters to separate each name, rather than delimiting the entire group. The example below uses "&" to continue the line: add jazztalk quiet & [email protected] & [email protected]
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 883
Full List
If the site or server administrator has limited the membership size of a list , ListManager will send you a message if you are approaching the member limit. While ListManager is processing your add request, it also checks to see how close you are to your member limit. If your add request brings your list to within 5% of the limit, ListManager will inform you in the email notification you receive unless the message uses the end quiet command.
Below is an example of what ListManager sends you when your member list is approaching its limit:
Note: This list is close to its maximum subscriber limit, with only 5 new subscriber positions available.
Adding To Many Lists
The administrator add command may also be used to add members to many lists at once as an extension of the regular syntax: add listname1 listname2 listname3 [onehello][oneconfirm | sendconfirm] emailaddress
The onehello, oneconfirm, and sendconfirm modifiers are optional. You can use either
sendconfirm or oneconfirm, but not both.
onehello
If you specify the onehello modifier, the new member will receive a single hello document, from the first list listed. This allows you to add a member at once to many lists without bombarding them with a slew of hello documents.
Example: add jazztalk ticketlist concertgroup onehello [email protected]
The above example adds [email protected] to the jazztalk, ticketlist, and concertgroup lists, and only sends the hello document from ‘jazztalk’.
oneconfirm
If you specify the oneconfirm modifier, the new member will receive a single confirmation request. Responding to the single confirmation will confirm all lists.
Example: add greenlist redlist bluelist oneconfirm [email protected]
The address [email protected] will be added to the greenlist, redlist, and bluelist lists, and sets his membership status to confirm. Since greenlist, redlist, and bluelist are set
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 884
to require confirmations, a single confirmation will be sent to him, which he can reply to in order to confirm for all three lists.
sendconfirm
The sendconfirm modifier sends the new member a confirmation message for each list you add them to, as long as the list requires confirmation.
Example: add greenlist redlist bluelist sendconfirm [email protected]
The address [email protected] will receive a separate confirmation message from greenlist, redlist, and bluelist, assuming they are all lists which require confirmation.
Adding Many Members to Many Lists
You may add many email addresses to many lists, all in a single add command: add jazztalk ticketlist oneconfirm onehello < [email protected] [email protected] [email protected]
>
Become
The become commands allows administrators to "become" an address, assuming their email address and name, and issue ListManager commands on their behalf. For instance, an administrator can become another person, and issue the "subscribe" command for them and then "set" other membership options.
There are two possible syntaxes for the become command: become email-address become email-address Full Name
The first format only specifies an email address. The name is then left blank.
The second format species both the email address and name of the person you are becoming. All words after the email address are understood as being the name.
The become command is only available to administrators. You must issue the admin login command before using the become command.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 885
Example Using become
login p@55w9rd become [email protected] set jazztalk digest set jazztalk [email protected] set jazztalk setfield(address="150 Main St. Anywhere, CA 94704") end quiet
Delete (Unsubscribe)
The Delete command lets an administrator unsubscribe a member. You must issue the admin login command before using the Delete command.
The syntax of the Delete command is: delete listname emailaddress [quiet]
The quiet modifier is optional. The abbreviation del may be used instead of the word
Delete. For example: del jazztalk [email protected]
By default, the member unsubscribed will receive the goodbye message for the list. To suppress this message, use the quiet modifier: delete jazztalk [email protected] quiet
However, if the Delete command does not succeed, such as if the email address is not a member, you (the person submitting the Delete command) will be notified unless the message ends with end quiet.
NOTE: The delete command does not actually delete the member from the database.
The member is still part of the list, but is unsubscribed. They will not receive normal postings from the list.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 886
Delete with Member ID
As an alternative to providing an email address, you can use the member id of the member you wish to delete. For example, if you know member with id 1234 needs to be removed from the list, but you don't know that member's email address, you can use the member id without a problem. An example: delete jazztalk 1234
You can specify any number of members to delete on the command line. For example, to delete the users "[email protected]" and "[email protected]", you would write: delete jazztalk [email protected] [email protected] or delete jazztalk < [email protected] [email protected]
>
Delete from All Lists
To delete an address from all lists, replace the list name with an asterisk *.
Example: delete * [email protected]
You may use this syntax to delete multiple members from all lists on your server: delete * [email protected] [email protected] or delete * < [email protected] [email protected]
>
Delete all members in a List
To unsubscribe all members (except admins) from a list, substitute "all" for the email address.
Example: delete jazztalk all
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 887
Send
The send command is only available to administrators. You must issue the admin login command before using the send command.
The send command allows you to email a ListManager document to any number of email addresses. For instance, if you receive a request to join a private list, you might want to send the applicant a document describing the guidelines for being allowed into the mailing list. Or, if you have an announcement you would like to make to a number of people, you can use the send command to send a "one time message" to them, without the work of creating a mailing list.
The syntax of send command is: send document-name email-address [email-address] …
The document-name must be a currently existing ListManager document.
You can also use line-continuation characters to specify as many email addresses as you like, without being restricted by the length of a line.
For example: send I_am_going_on_vacation \ [email protected] \ [email protected] \ [email protected] \ [email protected] or send I_am_going_on_vacation < [email protected] [email protected] [email protected] [email protected]
>
The From: and Reply-To: of the message sent is by default the email address and name that you are issuing the send command from. If you would like the From: and
Reply-To: to be something else, you can use the
become
command to assume another identity, and then use the send command with that identity.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 888
Member
The member command allows administrators to accept a member who has subscribed to a private mailing list .
The syntax of the member command is: member approve member-id … member reject member-id …
The only options for the member command are to either approve or reject a membership application to a private mailing list.
You can specify more than one Member ID on the member command line.
If you are a list administrator set to receive admin mail, and your mailing list is set to private, then you will receive email notifications of applications to join your private mailing list. The notification message will include the member command you need to send back to approve or reject the member. In addition, if there are any other pending members, these will also be listed, at the bottom of the notification message, along with commands to approve or reject them.
Example
Here is an example of a notification message an administrator receives when someone applies to join a private mailing list:
List: test-l
Name: Some Name
Email: [email protected]
A request from '[email protected]' to join the private list
'test-l' has been received.
Their subscription request will not be activated until an administrator approves it.
---
To approve this member, send the following two line message to [email protected] login (enter your password here) member approve 122
---
To reject (delete) this member, send the following two line message to [email protected] login (enter your password here) member reject 122
----------------------------------------------------
The following members are currently pending:
* Member 116 ([email protected])
* Member 117 ([email protected])
* Member 118 ([email protected])
* Member 120 ([email protected])
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 889
* Member 121 ([email protected])
* Member 122 ([email protected])
---
To approve these members, send the following two line message to [email protected] login (enter your password here) member approve 116 117 118 120 121 122
---
To reject (delete) these members, send the following two line message to
login (enter your password here)
member reject 116 117 118 120 121 122
If you approve a member, they will receive this email message
(and the Hello document, if your list defined one):
Your request to join 'test-l' has been approved.
You are now a member of 'test-l'.
If you reject a member, they will receive this email message:
Your request to join 'test-l' has been rejected.
If you wish to discuss this with a mailing list administrator, you can send email to [email protected]
Which (for admins)
The which command allows an administrator to determine which mailing lists a particular person belongs to.
The syntax of the which command is: which emailaddress
You can specify as many email addresses on the which command line as you like.
For example, the follow commands are valid: which [email protected] which [email protected] [email protected]
NOTE: If you do not first login as an administrator, the which command will tell you which lists you are on.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 890
Moderate
The moderate command allows administrators to act upon a moderated message contributed to a mailing list.
The options for the moderate command are to either approve or reject a contributed message to a moderated mailing list. If you are a list administrator set to receive moderated message notifications, then you will receive email notifications of each moderated message. The notification message will include the moderate command you need to send back to approve or reject the messages. In addition, if there are any other pending messages, these will also be listed, at the bottom of the notification message, along with commands to approve or reject them.
The basic syntax of the moderate command is: moderate [approve | reject] moderate-id
You can specify more than one Moderate ID on the moderate command line.
Example: moderate approve 2345 2346
This command approves and immediately sends the messages with the moderate ID nubmers 2345 and 2346.
Scheduling a Message Using moderate
Alternatively, you can schedule a message to be released at a specific time, or resubmit a message such that it sends again after a specified period of time. To schedule a message for release at a specific time, the syntax is: moderate time [hh:mm | yyyy/mm/dd] moderate-id
Example: moderate time 13:10 2007/01/01
Thus, if you want to schedule a message to be released today, you can specify the exact time you want the message to go out, in 24-hour format (24:00). If you want to schedule the message for release for some date in the future, you must specify the date in yyyy/mm/dd format, such as 2000/05/02 (May 2, 2000).
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 891
Resubmitting a Message for Auto-Approval Using moderate
To resubmit a message for auto-approval on a periodic basis, the syntax is: moderate resubmit numdays moderate-id
Example: moderate resubmit 30 2112
In the above example, the message with ID 2112 would be resubmitted and automatically approved every 30 days.
Moderation Notification Messages
By default, ListManager sends out MIME-digest moderated message notification. The digest consists of two parts: the first part is the notification with the message appended, and the second part is the message all by itself.
If the message contains mail merge tags, ListManager will merge them in prior to sending the moderated message notification to you. Thus, you can view the message exactly as it will go out to the list.
The following message is an example of a moderated message notification. The beginning of the message explains the purpose of the message, and at what time (if any) the message will be automatically approved. Commands for approving or rejecting this message via email are given. The message in question is then displayed. At the bottom of the email message, the currently pending moderated messages are summarized, and commands for approving or rejecting them in bulk is also given.
The following message destined for bach has been received. This message requires your approval before it will be sent to the list.
If you take no action, this message will be automatically approved at midnight tonight.
---
To approve this message, send the following two line message to [email protected] login (enter your password here) moderate approve 103
---
To reject (delete) this message, send the following two line message to [email protected] login (enter your password here) moderate reject 103
---
From: [email protected]
Subject: Great new CD that new recording of the Brandenburg Concerto is really good!
Michael Smith
-----------------------------------------------------
The following moderated messages are currently pending:
* Message 100
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 892
* Subject: Best recording available?
* Message 102
* Subject: My new piano
* Message 103
* Subject: Great new CD
---
To approve these messages, send the following two line message to [email protected] login (enter your password here) moderate approve 100 102 103
---
To reject (delete) these messages, send the following two line message to [email protected] login (enter your password here) moderate reject 100 102 103
You can configure ListManager to send out MIME-digest moderated message notifications or standard moderated message notifications by using the command line option
"moderatenotification" with either old (standard) or new (MIMEdigest).
Report
The report command returns a "normal" Subscribe/Unsubscribe/Confirmation report.
The syntax of the report command is: report listname [nochart | detail | CSV] [yyyymmdd-yyyymmdd]
The yyyymmdd-yyyymmdd modifier allows you to specify a starting and ending date.
For example, to retrieve a report from January 1, 2000, to March 15, 2000, you would use the range 20000101-20000315, as shown in this example: report jazztalk 20000101-20000315
By default the report is generated with a one-month history. Thus, if you do not specify a date range, the starting date will be one month prior to today, and the ending date will be today.
The nochart, detail, and CSV modifiers allow you to specify the format of the report you will receive. These modifiers are mutually exclusive.
When you use the nochart modifier, the report excludes dates that do not contain any data. For instance, if no one subscribed on 3/14/00, the report will not include that date in the 'subscribe' section.
When you use the detail modifier, the report has an additional section at the end of the general data section. This additional section includes the email addresses associated with the data points present in the general data section.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 893
The CSV modifier tells ListManager that you would like the report sent to you as a series of comma separated files. When you use this, the ListManager will send you an email that includes as attachments up to seven data files. These are data files, and are not designed to be human-readable. However, they are readable by most spreadsheet and database programs. Specifically, the format of these files is known as comma separated values (*.CSV).
You can use these files to synchronize your external database with your ListManager database. Since most database programs can read CSV files, these can be loaded directly into your database, where you can quickly run an update to put your database in synch with the ListManager database.
Six of the possible attachment files conform to the possible report types from the current report option. They are:
Normal (subscribed) Members: The new subscribers for the report period will be provided in the file "sub.csv".
Unsubscribed Member: Those members that unsubscribed during the report period will be listed in file "unsub.csv".
Held Member: Members who were put on hold during the report period will be listed in the "held.csv" file.
Unconfirmed Members: Those members that subscribed during the report period but have not yet confirmed will be listed in file "notcon.csv".
Expired Members: Those memberships that expired during the report period will be listed in the "expired.csv" file.
Unapproved (private) Members: The members who have subscribed to private lists and are still awaiting List Admin approval will be listed in "private.csv."
These data files are only attached to the email if they have any entries. For example, if no members were put on hold during the report period, there will not be a held data file attached to the email.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 894
The column layout for these first six attachments is identical for all files. It is:
Member ID,
Email Address,
Full Name,
List,
Date Joined,
Expire Date,
Number Bounces,
Date Bounce,
Confirm Date,
Date Held,
Date Unsubscribed,
User ID,
Comment,
Additional
If any of the fields is missing data (this is common), then nothing is displayed.
The seventh file attachment is the totals. This has the same information as the report command but in a vertical arrangement. There are two columns of data, the total description and the value for that section:
Total normal members
Total unsubscribed members
Total held members
Total expired members
Total unapproved (private) members
Total unconfirmed members
New normal members
New unsubscribed members
New held members
New expired members
New unapproved (private) members
New unconfirmed members
This file is attached if there is any data at all.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 895
Insertclicktracking
The insertclicktracking command allows an administrator to insert a clickthrough event into the ListManager database via an email command.
Like other admin email commands, it requires the
login
command.
This command takes key-value pairs in fieldname "value" pairs.
Example: insertclicktracking IPAddress_ "127.0.0.1" MemberID_ "123"
MessageID_ "456" StreamWebPageName_ "homepage" TimeClicked_
"2004-03-04"
Any \ or " characters within the quotes must be escaped with a \ .
All of the clicktracking_ fields except the ClickID_ field may be populated with this command:
GroupID_
IPAddress_
MemberID_
MessageID_
StreamWebPageName_
TimeClicked_
UrlID_
If not specified, GroupID_ will be set to 0, and TimeClicked_ to the time inserted into the database.
Lyris, Inc. | 6401 Hollis Street, Suite 125 | Emeryville CA 94608 USA |
www.lyris.com
Toll free +1.800.768.2929 | International calls +1.510.844.1600å | Fax +1.510.844.1598
Page 896
Shkarko
Reklamë