Dell PowerConnect W Clearpass 100 Software 3.9 Deployment Guide - Page 314

SMTP Receipt Fields, smtp_email_field

Page 314 highlights

SMTP Receipt Fields The behavior of email receipt operations can be customized with certain guest account fields. You do this on a per user basis.  smtp_enabled - This field may be set to a non-zero value to enable sending an email receipt. If unset, the default value from the email receipt configuration is used. The special values "_Auto" (Always autosend guest receipts by email), "_AutoField" (Auto-send guest receipts by email with a special field set), "_Click" (Display a link enabling a guest receipt via email), and "_Cc" (Send an email to a list of fixed addresses) may also be used.  smtp_subject - This field specifies the subject line for the email message. Template variables appearing in the value will be expanded. If the value is "default", the default subject line from the email receipt configuration is used.  smtp_template_id - This field specifies the print template ID to use for the email receipt. If blank or unset, the default value from the email receipt configuration is used.  smtp_receipt_format - This field specifies the email format to use for the receipt. It may be one of "plaintext" (No skin - plain text only), "html_embedded" (No skin - HTML only), "receipt" (No skin - Native receipt format), "default" (Use the default skin), or the plugin ID of a skin plugin to specify that skin. If blank or unset, the default value from the email receipt configuration is used.  smtp_email_field - This field specifies the name of the field that contains the visitor's email address. If blank or unset, the default value from the email receipt configuration is used. Additionally, the special value "_None" indicates that the visitor should not be sent any email.  smtp_auto_send_field - This field specifies the name of the field that contains the auto-send flag. If blank or unset, the default value from the email receipt configuration is used. Additionally, the special values "_Disabled" and "_Enabled" may be used to never send email or always send email, respectively.  smtp_cc_list - This field specifies a list of additional email addresses that will receive a copy of the visitor account receipt. If the value is "default", the default carbon-copy list from the email receipt configuration is used.  smtp_cc_action - This field specifies how to send copies of email receipts. It may be one of "never", "always_cc", "always_bcc", "conditional_cc", or "conditional_bcc". If blank or unset, the default value from the email receipt configuration is used. The logic used to send an email receipt is:  If email receipts are disabled, take no action.  Otherwise, check the auto-send field.  If it is "_Disabled" then no receipt is sent.  If it is "_Enabled" then continue processing.  If it is any other value, assume the auto-send field is the name of another guest account field. Check the value of that field, and if it is zero or the empty string then no receipt is sent.  Determine the email recipients:  Address the email to the value specified by the email field in the visitor account. If the email field is "_None" then do not send an email directly to the visitor.  Depending on the value of the Send Copies setting, add the email addresses from the Copies To: list to the email's "Cc:" or "Bcc:" list.  If there are any "To:", "Cc:" or "Bcc:" recipients, generate an email message using the specified print template and send it to the specified recipient list.  smtp_warn_before_subject - This field overrides what is specified in the subject line under Logout Warnings on the email receipt. If the value is "default", the default subject line under the Logout Warnings section on the email receipt configuration is used. 314 | Guest Management ClearPass Guest 3.9 | Deployment Guide

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380
  • 381
  • 382
  • 383
  • 384
  • 385
  • 386
  • 387
  • 388
  • 389
  • 390
  • 391
  • 392
  • 393
  • 394
  • 395
  • 396
  • 397
  • 398
  • 399
  • 400
  • 401
  • 402
  • 403
  • 404
  • 405
  • 406
  • 407
  • 408
  • 409
  • 410
  • 411
  • 412
  • 413
  • 414
  • 415
  • 416
  • 417
  • 418
  • 419
  • 420
  • 421
  • 422
  • 423
  • 424
  • 425
  • 426
  • 427
  • 428
  • 429
  • 430
  • 431
  • 432
  • 433
  • 434
  • 435
  • 436
  • 437
  • 438
  • 439
  • 440
  • 441
  • 442
  • 443
  • 444
  • 445
  • 446
  • 447
  • 448
  • 449
  • 450
  • 451
  • 452
  • 453
  • 454
  • 455
  • 456
  • 457
  • 458
  • 459
  • 460
  • 461
  • 462
  • 463
  • 464
  • 465
  • 466
  • 467
  • 468
  • 469
  • 470
  • 471
  • 472
  • 473
  • 474
  • 475
  • 476
  • 477
  • 478
  • 479
  • 480
  • 481
  • 482
  • 483
  • 484
  • 485
  • 486
  • 487
  • 488
  • 489
  • 490
  • 491
  • 492
  • 493
  • 494
  • 495
  • 496
  • 497
  • 498
  • 499
  • 500
  • 501
  • 502
  • 503
  • 504
  • 505
  • 506
  • 507
  • 508
  • 509
  • 510
  • 511
  • 512
  • 513
  • 514
  • 515
  • 516
  • 517
  • 518

314
|
Guest Management
ClearPass Guest 3.9
|
Deployment Guide
SMTP Receipt Fields
The behavior of email receipt operations can be customized with certain guest account fields. You do this
on a per user basis.
smtp_enabled
– This field may be set to a non-zero value to enable sending an email receipt. If unset,
the default value from the email receipt configuration is used. The special values “_Auto” (Always auto-
send guest receipts by email), “_AutoField” (Auto-send guest receipts by email with a special field set),
“_Click” (Display a link enabling a guest receipt via email), and “_Cc” (Send an email to a list of fixed
addresses) may also be used.
smtp_subject
– This field specifies the subject line for the email message. Template variables appearing
in the value will be expanded. If the value is “default”, the default subject line from the email receipt
configuration is used.
smtp_template_id
– This field specifies the print template ID to use for the email receipt. If blank or
unset, the default value from the email receipt configuration is used.
smtp_receipt_format
– This field specifies the email format to use for the receipt. It may be one of
“plaintext” (No skin – plain text only), “html_embedded” (No skin – HTML only), “receipt” (No skin –
Native receipt format), “default” (Use the default skin), or the plugin ID of a skin plugin to specify that
skin. If blank or unset, the default value from the email receipt configuration is used.
smtp_email_field
– This field specifies the name of the field that contains the visitor’s email address. If
blank or unset, the default value from the email receipt configuration is used. Additionally, the special
value “_None” indicates that the visitor should not be sent any email.
smtp_auto_send_field
– This field specifies the name of the field that contains the auto-send flag. If
blank or unset, the default value from the email receipt configuration is used. Additionally, the special
values “_Disabled” and “_Enabled” may be used to never send email or always send email, respectively.
smtp_cc_list
– This field specifies a list of additional email addresses that will receive a copy of the
visitor account receipt. If the value is “default”, the default carbon-copy list from the email receipt
configuration is used.
smtp_cc_action
– This field specifies how to send copies of email receipts. It may be one of “never”,
“always_cc”, “always_bcc”, “conditional_cc”, or “conditional_bcc”. If blank or unset, the default value
from the email receipt configuration is used.
The logic used to send an email receipt is:
If email receipts are disabled, take no action.
Otherwise, check the auto-send field.
If it is “_Disabled” then no receipt is sent.
If it is “_Enabled” then continue processing.
If it is any other value, assume the
auto-send
field is the name of another guest account field. Check
the value of that field, and if it is zero or the empty string then no receipt is sent.
Determine the email recipients:
Address the email to the value specified by the
email
field in the visitor account. If the
email
field is
“_None” then do not send an email directly to the visitor.
Depending on the value of the Send Copies setting, add the email addresses from the Copies To: list
to the email’s “Cc:” or “Bcc:” list.
If there are any “To:”, “Cc:” or “Bcc:” recipients, generate an email message using the specified print
template and send it to the specified recipient list.
smtp_warn_before_subject
– This field overrides what is specified in the subject line under Logout
Warnings on the email receipt. If the value is “default”, the default subject line under the Logout
Warnings section on the email receipt configuration is used.