Product Logo

SMTPit Pro

Next Generation Email plug-in

Functions

SMTPit_Configure

NameSMTPit_Configure
Description

Calling this function with no parameters will open the SMTPit Pro Configuration Dialog. You can optionally open to a specific tab by specifying the name of the tab as the “Option” parameter. This function also allows you to get or set any preference found in the Configuration Dialog.

Valid PrefNames:

“AddHelp” - If True, Function specific Help will be added to Calculations when inserting the Plug-in’s Functions.
“Host” - The Domain Name or IP Address of the Default SMTP Mail Server.
“From” - The Default From Email Address.
“ReplyTo” - The Default Reply-To Email Address. (Leave blank for no Reply-To.)
“Subject” - The Default Email Subject.
“Priority” - The Default Email Priority. (Default Priority is ‘Normal’.)
“Timeout” - The Number of Seconds to wait for the Mail Server to respond to a Connection Attempt. (Default Timeout is 30 seconds.)
“LineBreak” - The Number of Characters per line in an Encoded Email. (Default Line Break Column is 80.)
“TextHeader” - Default Text Body Header.
“TextFooter” - Default Text Body Footer.
“HTMLHeader” - Default HTML Body Header.
“HTMLFooter” - Default HTML Body Footer.
“Attachments” - Default Email Attachments.
“HTMLImages” - Default Email Inline Images.
“EmailHeaders” - Default Extra Email Headers.
“ContentTypes” - Attachment and Inline Image Content-Types.
“AuthType” - The Type of Authentication your mail server requires. (Specify “Plain”, “Login”, “CRAM-MD5”, or “Auto”.)
“Username” - The Username to use when connecting to your mail server.
“Password” - The Password to use when connecting to your mail server.
“TLSType” - The type of TLS/SSL your mail server requires. (Specify “None”, “AfterConnect”, or “BeforeConnect”.)
“PopupSent” - If True, SMTPit Pro will popup an “Email Sent Successfully.” or Error Dialog after sending an email.
“ClearAll” - If True, SMTPit Pro will clear all the items in the list of items to clear from the Configuration Dialog.
“Clears” - A list of items to clear after sending an email.
“CharSet” - The character set for the email. (See the associated setting in the Configuration Dialog for possible values.
“BreakOnBadRcpt” - If True, SMTPit Pro will abort sending an email if any recipient is deemed invalid by the mail server.
“Port” - The TCP/IP Port for your mail server.
“UseOldFunctions” - If True, the old-style External(“SMTP-XXX”) functions will be available.
“UseNewFunctions” - If True, the new-style SMTPit_XXX functions will be available.

Return TypeVaries
FormatSMTPit_Configure ( Option ; PrefName ; PrefValue )
Optional Parameters
Option

Specify the name of a Tab in the Configuration Dialog to show it opened to that tab.
Specify “Get” with the PrefName parameter to get a preference value. (If not found, and PrefValue is defined, PrefValue will be returned.)
Specify “Set” with the PrefName and PrefValue parameters to set a preference value.

PrefName

The Name of the Preference to Get or Set. (See the Function Description for a list of valid PrefNames.)

PrefValue

The Value of the Preference to Set. (See the Function Description for some possible values.)

Examples
Example 1

Opens the SMTPit Pro Configuration Dialog. (Because the "Option" parameter is not used, the dialog will open to the "Basics" tab.)

SMTPit_Configure
Example 2

Opens the SMTPit Pro Configuration Dialog to the "About" tab.

SMTPit_Configure( "About" )
Example 3

Returns the value of the 'Host' setting from the Configuration Dialog.

SMTPit_Configure( "Get" ; "Host" )
Example 4

Sets the 'Subject' setting in the Configuration Dialog to "My Subject".

SMTPit_Configure( "Set" ; "Subject" ; "My Subject" )