Options

From Tracker Software PDF SDK
Jump to: navigation, search


Options Table

Name Type Value
Mode Integer Specifies a way how the email will be sent.

Possible values are:

-1 (Auto) User can choose sending mode manually.
0 (MailClient) Send email through installed by default in the operating system email client program. This program must support works with Messaging Application Programming Interface (Simple MAPI is enough), eg. Microsoft Outlook, Mozilla's Thunderbird, The Bat!, etc.
1 (SMTP) Send email through external SMTP server (need to set SMTP parameters).
2 (Local) Save email in folder which name consist of LocalFolder parameter plus "\Mail Send" plus "\Current date and time". Eg. "C:\Users\root\Documents\Mail Send\2015_06_05_03_15_59". Body of letter will be saved in this folder as Message.txt file. Attached files will be copied into this folder too.

Default value: -1 (Auto)

SMTP Dictionary Specifies parameters of SMTP server if Mode set to 1 (SMTP).
From String Specifies a sender email address.

Default value: Empty String

To String Specifies recipients email address.

Default value: Empty String

Cc String Specifies an email address for send copy of letter.

Default value: Empty String

BCc String Specifies an email address for send hidden copy of letter.

Default value: Empty String

Subject String Specifies a title of letter.

Default value: Empty String

Message String Specifies a text of letter.

Default value: Empty String

ResolveAddressBook Boolean Allow or forbid to use address book if Mode set to 0 (MailClient).

Default value: false

ShowClientWindow Boolean If Mode set to 0 (MailClient) and this property is true, then mail client program will be opened in own window and will give a possibility to redact the email.

Default value: true

Priority Integer Specifies a priority mark for letter (see below). Priority letters can be accented in a recipient mailbox.

Possible values are:

0 (Low) Low priority.
1 (Normal) Normal priority.
2 (High) High priority.

Default value: 1 (Normal)

PackAttachmentsMode Integer Specifies a method for compressing attachment files (if it exists). We use only ZIP algorithm.

Possible values are:

0 (NoComress) Without compressing.
1 (CompressEach) Each file will be compressed separately. as result you will have several attached files.
2 (CompressAllToOne) All files will be compressed into one with name defined in OnePackName parameter. As result you will have one attached file.

Default value: 0 (NoComress)

HideOptionsBtnOnErrorMsg Boolean if true then options button will be present on the error message box.

Default value: true

OpenLocalFolder Boolean If Mode set to 2 (Local) and this property is true, after saving email will be open folder which contain it.

Default value: true

LocalFolder String Specifies a folder name which used for saving email if Mode set to 2 (Local) . If Mode set to 2 and this property is empty, used user's document folder or "C:\\Documents" as a local folder.

Default value: Empty String

OnePackName String Specifies a name which used for naming an attached archive file, if in PackAttachmentsMode parameter set to 2 (CompressAllToOne).

Default value: Empty String

ParentWnd Integer64 Specifies a window identifier for using as parent window for showing messages about progress of sending email. If this property value is 0 then the main window will be selected automatically.

Default value: 0

SMTP Table

Name Type Value
ServerURL String Specifies a SMTP server address.

Default value: Empty String

ServerPort Integer Specifies a SMTP server port.

Default value: 25

NeedAuth Boolean Specifies whether a SMTP need authentication.

Default value: false

User String Specifies a username for SMTP if it need authentication.

Default value: Empty String

Password String Specifies a user password for SMTP if it need authentication.

Default value: Empty String

NeedTLS Boolean Set true for using TLS protocol for doing your connection to SMTP server safe. If UseSSL property is true then this property is ignored.

Default value: false

UseSSL Boolean Set true for using SSL protocol for doing your connection to SMTP server safe. If it true then NeedTLS property is ignored.

Default value: false