Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(17 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_mailSend|Options|property}}
 
{{#parentPage:PXV:op_mailSend|Options|property}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 12: Line 11:
 
! '''Value'''
 
! '''Value'''
 
|-
 
|-
| class="op_param_name" | Mode
+
| class="op_param_name" id="Mode"| Mode
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies a way how the email will be sent.
 
Possible values are:
 
Possible values are:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
| class="op_enum_value" | '''-1''' (Auto) || ...
+
| class="op_enum_value" | '''-1''' (Auto) || User can choose sending mode manually.
 
|-
 
|-
| class="op_enum_value" | '''0''' (MailClient) || ...
+
| class="op_enum_value" | '''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.
 
|-
 
|-
| class="op_enum_value" | '''1''' (SMTP) || ...
+
| class="op_enum_value" | '''1''' (SMTP) || Send email through external SMTP server (need to set '''SMTP''' parameters).
 
|-
 
|-
| class="op_enum_value" | '''2''' (Local) || ...
+
| class="op_enum_value" | '''2''' (Local) || Save email in folder which name consist of '''[[#LocalFolder|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: <tt>'''-1''' (Auto)</tt>
 
Default value: <tt>'''-1''' (Auto)</tt>
Line 30: Line 29:
 
| class="op_param_name" | [[#SMTP|SMTP]]
 
| class="op_param_name" | [[#SMTP|SMTP]]
 
| style="text-align:center" | Dictionary
 
| style="text-align:center" | Dictionary
| Specifies...
+
| Specifies parameters of SMTP server if '''Mode''' set to <tt>'''1''' (SMTP)</tt>.
 
|-
 
|-
 
| class="op_param_name" | From
 
| class="op_param_name" | From
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a sender email address.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | To
 
| class="op_param_name" | To
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies recipients email address.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Cc
 
| class="op_param_name" | Cc
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies an email address for send copy of letter.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | BCc
 
| class="op_param_name" | BCc
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies an email address for send hidden copy of letter.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Subject
 
| class="op_param_name" | Subject
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a title of letter.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Message
 
| class="op_param_name" | Message
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a text of letter.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | ResolveAddressBook
 
| class="op_param_name" | ResolveAddressBook
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| Allow or forbid to use address book if [[#Mode|'''Mode''']] set to <tt>'''0''' (MailClient)</tt>.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|-
 
|-
 
| class="op_param_name" | ShowClientWindow
 
| class="op_param_name" | ShowClientWindow
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| If [[#Mode|'''Mode''']] set to <tt>'''0''' (MailClient)</tt> and this property is <tt>true</tt>, then mail client program will be opened in own window and will give a possibility to redact the email.
 
Default value: <tt>'''true'''</tt>
 
Default value: <tt>'''true'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Priority
 
| class="op_param_name" | Priority
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies a priority mark for letter (see below). Priority letters can be accented in a recipient mailbox.
 
Possible values are:
 
Possible values are:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
| class="op_enum_value" | '''0''' (Low) || ...
+
| class="op_enum_value" | '''0''' (Low) || Low priority.
 
|-
 
|-
| class="op_enum_value" | '''1''' (Normal) || ...
+
| class="op_enum_value" | '''1''' (Normal) || Normal priority.
 
|-
 
|-
| class="op_enum_value" | '''2''' (High) || ...
+
| class="op_enum_value" | '''2''' (High) || High priority.
 
|}
 
|}
 
Default value: <tt>'''1''' (Normal)</tt>
 
Default value: <tt>'''1''' (Normal)</tt>
 
|-
 
|-
| class="op_param_name" | PackAttachmentsMode
+
| class="op_param_name" id="PackAttachmentsMode"| PackAttachmentsMode
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies a method for compressing attachment files (if it exists). We use only ZIP algorithm.
 
Possible values are:
 
Possible values are:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
| class="op_enum_value" | '''0''' (NoComress) || ...
+
| class="op_enum_value" | '''0''' (NoComress) || Without compressing.
 
|-
 
|-
| class="op_enum_value" | '''1''' (CompressEach) || ...
+
| class="op_enum_value" | '''1''' (CompressEach) || Each file will be compressed separately. as result you will have several attached files.
 
|-
 
|-
| class="op_enum_value" | '''2''' (CompressAllToOne) || ...
+
| class="op_enum_value" | '''2''' (CompressAllToOne) || All files will be compressed into one with name defined in [[#OnePackName|'''OnePackName''']] parameter. As result you will have one attached file.
 
|}
 
|}
 
Default value: <tt>'''0''' (NoComress)</tt>
 
Default value: <tt>'''0''' (NoComress)</tt>
Line 102: Line 101:
 
| class="op_param_name" | HideOptionsBtnOnErrorMsg
 
| class="op_param_name" | HideOptionsBtnOnErrorMsg
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| if <tt>true</tt> then options button '''will be present''' on the error message box.
 
Default value: <tt>'''true'''</tt>
 
Default value: <tt>'''true'''</tt>
 
|-
 
|-
 
| class="op_param_name" | OpenLocalFolder
 
| class="op_param_name" | OpenLocalFolder
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| If [[#Mode|'''Mode''']] set to <tt>'''2''' (Local)</tt> and this property is <tt>true</tt>, after saving email will be open folder which contain it.
 
Default value: <tt>'''true'''</tt>
 
Default value: <tt>'''true'''</tt>
 
|-
 
|-
| class="op_param_name" | LocalFolder
+
| class="op_param_name" id="LocalFolder"| LocalFolder
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a folder name which used for saving email if [[#Mode|'''Mode''']] set to <tt>'''2''' (Local)</tt> . If [[#Mode|'''Mode''']] set to '''2''' and this property is empty, used user's document folder or "C:\\Documents" as a local folder.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
| class="op_param_name" | OnePackName
+
| class="op_param_name" id="OnePackName" | OnePackName
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a name which used for naming an attached archive file, if in [[#PackAttachmentsMode|'''PackAttachmentsMode''']] parameter set to <tt>'''2''' (CompressAllToOne)</tt>.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | ParentWnd
 
| class="op_param_name" | ParentWnd
 
| style="text-align:center" | Integer64
 
| style="text-align:center" | Integer64
| Specifies...
+
| Specifies a window identifier for using as parent window for showing messages about progress of sending email. If this property value is <tt>0</tt> then the main window will be selected automatically.
 
Default value: <tt>'''0'''</tt>
 
Default value: <tt>'''0'''</tt>
 
|}
 
|}
Line 135: Line 134:
 
| class="op_param_name" | ServerURL
 
| class="op_param_name" | ServerURL
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a SMTP server address.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | ServerPort
 
| class="op_param_name" | ServerPort
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies a SMTP server port.
 
Default value: <tt>'''25'''</tt>
 
Default value: <tt>'''25'''</tt>
 
|-
 
|-
 
| class="op_param_name" | NeedAuth
 
| class="op_param_name" | NeedAuth
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| Specifies whether a SMTP need authentication.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|-
 
|-
 
| class="op_param_name" | User
 
| class="op_param_name" | User
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a username for SMTP if it need authentication.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Password
 
| class="op_param_name" | Password
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies a user password for SMTP if it need authentication.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | NeedTLS
 
| class="op_param_name" | NeedTLS
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| Set <tt>true</tt> for using TLS protocol for doing your connection to SMTP server safe. If '''UseSSL''' property is <tt>true</tt> then this property is ignored.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|-
 
|-
 
| class="op_param_name" | UseSSL
 
| class="op_param_name" | UseSSL
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies...
+
| Set <tt>true</tt> for using SSL protocol for doing your connection to SMTP server safe. If it <tt>true</tt> then '''NeedTLS''' property is ignored.
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
 
|}
 
|}

Latest revision as of 07:17, 5 June 2015


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