Xbasic

FILE.SEND Function

Syntax

result as L = FILE.Send(C filenames [,C emailaddress[,C options[,C zipname[,C comment[,L use_A5_email_client [,L store_in_outbox [,L show_client ]]]]]]])

Arguments

filenamesCharacter

A string of comma-delimited file names. You must specify the full drive and path of each file in filenames. Wildcard specifications can be used in the list of file names.

emailaddressCharacter

Destination email address.

optionsCharacter

If you specify more than one file, you must use the "C" or "Z" option flag to compress the files into a single zip file. If wildcards are used, the "C" option flag must be specified.

zipnameCharacter

Required if wildcards are used. The name of the zip file to create. Otherwise the zip file has the same name as the first file in the list.

commentCharacter

A comment about the files that goes into the subject line.

use_A5_email_clientLogical

Default = .F. (FALSE). If .T., use Alpha Anywhere email client. If .F., use default MAPI email client.

store_in_outboxLogical

Only if use_A5_email_client is .T.. If .T., a copy of the message is stored in the Alpha Anywhere email outbox (typically A_EMAIL.DBF in the Alpha Anywhere program folder). If .F., a copy of the message is not stored in the Alpha Anywhere email outbox.

show_clientLogical

Default = .T. (TRUE). Only if the optional Email_Address is specified and Use_A5_Email_Client is .T. Determines whether the Alpha Anywhere email client is displayed before sending files in the case where you select the Alpha Anywhere email client option. If .T., show Alpha Anywhere email client before sending email. If .F., do not show Alpha Anywhere email client.

Returns

resultLogical

Returns .T. if the operation is successful, otherwise .F..

Description

Send one or more files to an address. Options: C or Z = compress (i.e. zip) files before sending.

Discussion

The FILE.SEND() method sends multiple files via the current MAPI email client, or the built-in Alpha Anywhere email client.

If, for example, Use_A5_Email_Client is .F., and the current MAPI email client is Microsoft Outlook, Alpha Anywhere will open Outlook. Similarly, if the email client is Eudora, or Netscape Mail, Alpha Anywhere will open the appropriate email program.

Example 

This script will send two files. It compress the files first into a zip file called myfiles.zip.

dim filelist as C
Filelist = "c:\data\file1.txt,c:\data\file2.txt"
FILE.SEND(filelist,"","C","myfiles")
This method is only supported in Desktop applications. To send email in a Web application, use the email_send_noprofile() or email_send_SparkPost() functions.

Limitations

Desktop Applications Only

See Also