 |
|
 |
|
 |
AspEmail 4.2 Manual What is AspEmail 4.2 AspEmail 4.2 is an active server component for sending email messages using an external SMTP server in an ASP or VB environment. AspEmail 4.2 supports multiple recipients, multiple CC, multiple Bcc, multiple file attachments, HTML format, embedded images, and non-US ASCII character sets. AspEmail 4.2 is free except for the image embedding functionality, Quoted-Printable encoding support and message queuing described below. A free copy of AspEmail can be downloaded from www.aspemail.com/download.html. Changing from AspMail to AspEmail It is extremely simple to change your ASP or VB script from using AspEmail in the direct sending mode to EmailAgent-assisted queue mode. All you need to do is replace all the Mail.Send calls by Mail.SendToQueue. For example: ** Note from BP Tech Support: Your mail host should be "mail.yourdomain.com" or "mail.yourdomain.net", etc., as applicable. ** <%Set Mail = Server.CreateObject("Persits.MailSender") Mail.Host = "mail.mydomain.com" Mail.From = "sales@mycompany.com" Mail.FromName = "Sales Department" Mail.AddAddress "jsmith@company1.com", "John Smith" Mail.Subject = "Sales Receipt" Mail.Body = "Dear John:" & chr(13) & chr(10) & "Thank you for your business." On Error Resume Next Mail.SendToQueue If Err <> 0 Then Response.Write "An error occurred: " & Err.Description End If %> When the SendToQueue method is called, a message is not sent directly to the SMTP server for delivery. Instead, it is packaged into a file with the extension .stg and placed into the message queue. >Using AspEmail To use AspEmail in an ASP environment, you must create an instance of the AspEmail object in your ASP script as follows: <% To use AspEmail in a VB environment, open a VB project, go to Project/References... and check the box next to Persits Software AspEmail 4.2. Declare an AspEmail object variable as follows: Dim Mail As MailSender Create an instance of the AspEmail object as follows: Set Mail = New MailSender To send email messages, AspEmail "talks" to an SMTP server. You must specify the SMTP host address and, optionally, port number as follows: ** Note from BP Tech Support: Your mail host should be "mail.yourdomain.com" or "mail.yourdomain.net", etc., as applicable. ** Mail.Host = "mail.mydomain.com"
You must also specify the sender's email address and, optionally, name as follows: Mail.From = "sales@mycompany.com"
To add the message recipients, CCs, BCCs, and Reply-To's, use the AddAddress, AddCC, AddBcc and AddReplyTo methods, respectively. These methods accept two parameters: the email address and, optionally, name. Notice that you must not use an '=' sign to pass values to the methods. For example, < /FONT> Mail.AddAddress "jsmith@company1.com", "John
Smith" Use the Subject and Body properties to specify the message subject and body text, respectively. A body can be in a text or HTML format. In the latter case, you must also set the IsHTML property to True. For example, Mail.Subject = "Sales Receipt"
or Mail.Subject = "Sales Receipt"
To send a file attachment with the message, use the AddAttachment method. It accepts the full path to the file being attached. Call this method as many times as you have attachments. Notice that you must not use the '=' sign to pass a value to the method: < /FONT> ** Note from BP Tech Support: the path below is correct for you. Make sure that you put your attachment in this directory first. Dont' forget that "yourdomaincom" may be "yourdomainnet", etc., as applicable. ** Mail.AddAttachment "d:\html\users\yourdomaincom\filename.doc" To send a message, call the Send method. The method throws exceptions in case of an error. You may choose to handle them by using the On Error Resume Next statement, as follows: On Error Resume Next
Starting with Build 4.0.0.3, AspEmail is capable of generating encrypted and/or signed mail in the industry-standard S/MIME format. To send secure mail, AspEmail must be used in conjunction with the AspEncrypt cryptographic component from Persits Software, Inc. For more information on how to send secure mail using the AspEmail and AspEncrypt components, and to download your free trial copy of AspEncrypt, visit the web site http://www.aspencrypt.com/. >Premium Feature: Support for Message Queuing ** Note from BP Tech Support - We have the EmailAgent installed. ** AspEmail 4.2 has a new method, SendToQueue, which does not attempt to send a message directly to the SMTP server. Instead, the message is placed in a queue from where it is later retrieved and sent out by the EmailAgent NT service, a background process. Your mail-sending ASP script no longer has to wait until a message is sent, which means a better client-response time. >Premium Feature: Sending Messages with Embedded Images and Sounds AspEmail can send email messages with embedded images. The following example uses the file margin.gif (included with the component) as the background image for a message: ** Note from BP Tech Support: the paths below are correct for you. Make sure that you put your attachment in this directory first. Don't forget that "yourdomaincom" may be "yourdomainnet", etc., as applicable. ** ...
The method AddEmbeddedImage takes two parameters: the full path to an image file and a Content ID which is simply a string without spaces which your body HTML references as follows: "cid:<ContentID>" In the example above we use the Content ID "My-Background-Image" which is referenced by the BACKGROUND attribute of a <BODY> tag. We can use the same technique to embed an image inside the message body using an <IMG> tag: Mail.Body=
"<HTML>....<IMGSRC=""cid:My-Company-Logo"">...</HTML>"
In a similar manner, you can embed a sound file in your message using the <BGSOUND> tag, for example: Mail.Body
="<HTML><BGSOUND=""cid:My-Sound""></BGSOUND>...</HTML>"
Note: Content-IDs are case-sensitive. Make sure the values specified by "cid:..." and AddEmbeddedImage fully match. To make your script more readable, you may choose to
place your message body in a separate file and import it into the Body
property using the method AppendBodyFromFile which accepts the full path
to a text ot HTML file containing the message body. For example, your HTML file
may look like this: <BODY
BACKGROUND="cid:My-Background-Image"> .... </BODY>
To use this file as a message body, use the following code: Mail.AppendBodyFromFile
"d:\html\users\yourdomaincom\filename.html" The AppendBodyFromFile method can be used instead of, or in conjunction with, the Body property. >Premium Feature: Support for Alphabets Other Than US-ASCII AspEmail is capable of sending messages in alphabets other than US-ASCII by supporting the "Quoted-Printable" format. This format is described in RFC-2045. The idea of the format is that characters less than 33 and greater than 126 are represented by an "=" followed by a two digit hexadecimal representation of the character's value. For example, the decimal value 12 (US-ASCII form feed) is represented by "=0C", and the decimal value 61 (US-ASCII "=") can be represented by "=3D". AspEmail encodes the message body in the Quoted-Printable format automatically if the ContentTransferEncoding property is set to "quoted-printable". You may also set the CharSet property to the appropriate character set. The following code snippet sends
a message in Russian in the KOI8 standard from a text file (not shown
here):
** Note from BP Tech Support: These files are available at ... ** AspEmail is shipped with a sample ASP application that allows you to create and send email messages with attachments over the Web. The application consists of the following files: global.asa (collection object
creation) To upload file attachments from a client machine to the server where the script is running, the application uses a trial version of AspUpload, a powerful file upload component from Persits Software. The file AspUpload.dll is shipped with AspEmail and must be registered on your system for the sample application to function. For complete documentation on the AspUpload component, or to purchase AspUpload, visit http://www.aspupload.com/. >Object Reference AspEmail Properties
AspEmail Methods
Error Codes
Copyright (c) 1999 Persits Software, Inc. |
|
©
Copyright 1999-2000. BuildersPlanet.com
All rights
reserved..
|