/usr/share/doc/libpirl-java/api/PIRL/Conductor/Notify.html is in libpirl-java-doc 2.3.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Tue Nov 20 23:14:27 UTC 2012 -->
<title>Notify</title>
<meta name="date" content="2012-11-20">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Notify";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../PIRL/Conductor/Native_Methods.html" title="class in PIRL.Conductor"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Conductor/Pipeline_Source_Manager.html" title="class in PIRL.Conductor"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Conductor/Notify.html" target="_top">Frames</a></li>
<li><a href="Notify.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">PIRL.Conductor</div>
<h2 title="Class Notify" class="title">Class Notify</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>PIRL.Conductor.Notify</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Notify</span>
extends <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><i>Notify</i> is a mechanism for delivering messages to
destinations.
<p>
Each of Notify's destinations is represented by a <a href="/usr/share/doc/default-jdk-doc/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> address which specifies the recipient of the message
and the protocol to be used to deliver it. The mailto URI, which
specifies how to deliver an e-mail message, is typical. If the
address does not specify a protocol, it is treated as a mailto URI.
If, for any reason, a destination cannot be used during the delivery
of the notice, that destination is added to a Vector of
undeliverable destinations.
<p>
Notify's message consists of text that is delivered to each
destination via a <a href="/usr/share/doc/default-jdk-doc/api/java/net/URLConnection.html?is-external=true" title="class or interface in java.net"><code>URLConnection</code></a>. The message
contents may be provided by a resource specifier which may be a
local resource - either a system filename or path within an
enclosing jar file - or an external resource via a URL. The message
may also be specified directly on the command line. The size of the
message may be limited to a maximum number of lines and the number
of last lines to always be retained in the message body may also be
controlled. This is particularly useful for preventing unexpectedly
large message files from causing memory exhaustion while still
delivering the beginning and end of the message.
<p>
For mailto deliveries a From and Reply-To address and a Subject
line may be provided.
<p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#CANNOT_READ_MESSAGE_FILE">CANNOT_READ_MESSAGE_FILE</a></strong></code>
<div class="block">Exit status values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#DEFAULT_SMTP_SERVER">DEFAULT_SMTP_SERVER</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#FILENAME_MARKER">FILENAME_MARKER</a></strong></code>
<div class="block">Marker for a message source as opposed to a message string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#ID">ID</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#ILLEGAL_SYNTAX">ILLEGAL_SYNTAX</a></strong></code>
<div class="block">Exit status values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#NO_DESTINATION">NO_DESTINATION</a></strong></code>
<div class="block">Exit status values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#SUCCESS">SUCCESS</a></strong></code>
<div class="block">Exit status values.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/Conductor/Notify.html#Notify()">Notify</a></strong>()</code>
<div class="block">Constructs a Notify object with no destinations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/Conductor/Notify.html#Notify(java.util.Vector)">Notify</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> destinations)</code>
<div class="block">Constructs a Notify object with the specified destinations.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Deliver()">Deliver</a></strong>()</code>
<div class="block">Delivers the notice to each destination.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Deliver(java.util.Vector)">Deliver</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> destinations)</code>
<div class="block">Delivers the notice to each destination.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Destinations()">Destinations</a></strong>()</code>
<div class="block">Gets the list of destinations to which the notice will be
delivered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Destinations(java.util.Vector)">Destinations</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> destinations)</code>
<div class="block">Sets the list of destinations to which the message will be
delivered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#From()">From</a></strong>()</code>
<div class="block">Gets the From address for e-mail deliveries of the notice.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#From(java.lang.String)">From</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> from_address)</code>
<div class="block">Sets the From address for e-mail deliveries of the notice.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#main(java.lang.String[])">main</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
<div class="block">Processes the command line arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Max_Last_Lines()">Max_Last_Lines</a></strong>()</code>
<div class="block">Gets the maximum number of message last lines to be delivered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Max_Last_Lines(int)">Max_Last_Lines</a></strong>(int max_lines)</code>
<div class="block">Sets the maximum number of message last lines to be delivered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Max_Message_Lines()">Max_Message_Lines</a></strong>()</code>
<div class="block">Gets the maximum number of message lines to be delivered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Max_Message_Lines(int)">Max_Message_Lines</a></strong>(int max_lines)</code>
<div class="block">Sets the maximum number of message lines to be delivered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Message_Source(java.lang.String)">Message_Source</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)</code>
<div class="block">Reads a message from a named source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Message_Source(java.lang.String, boolean, boolean)">Message_Source</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source,
boolean convert_escapes,
boolean append)</code>
<div class="block">Reads a message from a named source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Message()">Message</a></strong>()</code>
<div class="block">Gets the message to be delivered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Message(java.lang.String)">Message</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code>
<div class="block">Sets the message to be delivered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Message(java.lang.String, boolean, boolean)">Message</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message,
boolean convert_escapes,
boolean append)</code>
<div class="block">Sets the message to be delivered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Reply_To()">Reply_To</a></strong>()</code>
<div class="block">Gets the Reply-To address for e-mail deliveries of the notice.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Reply_To(java.lang.String)">Reply_To</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> reply_to_address)</code>
<div class="block">Sets the Reply-To address for e-mail deliveries of the notice.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#SMTP_Server()">SMTP_Server</a></strong>()</code>
<div class="block">Gets the current SMTP Server setting.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#SMTP_Server(java.lang.String)">SMTP_Server</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> smtp_server)</code>
<div class="block">Sets the outgoing SMTP server hostname.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Subject()">Subject</a></strong>()</code>
<div class="block">Gets the Subject line for e-mail deliveries of the notice.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Subject(java.lang.String)">Subject</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> subject_line)</code>
<div class="block">Sets the Subject line for e-mail deliveries of the notice.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Undeliverable()">Undeliverable</a></strong>()</code>
<div class="block">Gets the list of destinations to which the notice could not be
delivered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Conductor/Notify.html#Usage(int)">Usage</a></strong>(int exit_status)</code>
<div class="block">Prints the command line usage.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ID</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ID</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Conductor.Notify.ID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FILENAME_MARKER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FILENAME_MARKER</h4>
<pre>public static final char FILENAME_MARKER</pre>
<div class="block">Marker for a message source as opposed to a message string.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Conductor.Notify.FILENAME_MARKER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SUCCESS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SUCCESS</h4>
<pre>public static final int SUCCESS</pre>
<div class="block">Exit status values.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Conductor.Notify.SUCCESS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ILLEGAL_SYNTAX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ILLEGAL_SYNTAX</h4>
<pre>public static final int ILLEGAL_SYNTAX</pre>
<div class="block">Exit status values.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Conductor.Notify.ILLEGAL_SYNTAX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="NO_DESTINATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_DESTINATION</h4>
<pre>public static final int NO_DESTINATION</pre>
<div class="block">Exit status values.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Conductor.Notify.NO_DESTINATION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CANNOT_READ_MESSAGE_FILE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CANNOT_READ_MESSAGE_FILE</h4>
<pre>public static final int CANNOT_READ_MESSAGE_FILE</pre>
<div class="block">Exit status values.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Conductor.Notify.CANNOT_READ_MESSAGE_FILE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_SMTP_SERVER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_SMTP_SERVER</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_SMTP_SERVER</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Conductor.Notify.DEFAULT_SMTP_SERVER">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Notify(java.util.Vector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Notify</h4>
<pre>public Notify(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> destinations)</pre>
<div class="block">Constructs a Notify object with the specified destinations.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>destinations</code> - The Vector of destinations to which the
notification message will be delivered.</dd></dl>
</li>
</ul>
<a name="Notify()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Notify</h4>
<pre>public Notify()</pre>
<div class="block">Constructs a Notify object with no destinations.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="SMTP_Server(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SMTP_Server</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> SMTP_Server(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> smtp_server)</pre>
<div class="block">Sets the outgoing SMTP server hostname.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>smtp_server</code> - The hostname of the outgoing SMTP server. The
default hostname is <a href="../../PIRL/Conductor/Notify.html#DEFAULT_SMTP_SERVER"><code>DEFAULT_SMTP_SERVER</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd></dl>
</li>
</ul>
<a name="SMTP_Server()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SMTP_Server</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SMTP_Server()</pre>
<div class="block">Gets the current SMTP Server setting.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The SMTP hostname String</dd></dl>
</li>
</ul>
<a name="Destinations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Destinations</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> Destinations()</pre>
<div class="block">Gets the list of destinations to which the notice will be
delivered.
<p>
Notify will attempt to deliver to each of these destinations on the
next invocation of the <a href="../../PIRL/Conductor/Notify.html#Deliver()"><code>Deliver()</code></a> method. A failed delivery
will add that destination to the list of undeliverable destinations.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the destinations list as a Vector</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Undeliverable()"><code>Undeliverable()</code></a></dd></dl>
</li>
</ul>
<a name="Destinations(java.util.Vector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Destinations</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Destinations(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> destinations)</pre>
<div class="block">Sets the list of destinations to which the message will be
delivered.
<p>
Redundant destination addresses are removed from the list.
<p>
Setting the destinations list has the side effect of resetting the
list of undeliverable destinations.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>destinations</code> - The Vector of destination URIs.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Undeliverable()"><code>Undeliverable()</code></a></dd></dl>
</li>
</ul>
<a name="Undeliverable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Undeliverable</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> Undeliverable()</pre>
<div class="block">Gets the list of destinations to which the notice could not be
delivered.
<p>
Whenever a <a href="../../PIRL/Conductor/Notify.html#Deliver()"><code>Deliver</code></a>y cycle is done destinations
to which the notice could not be delivered - for whatever reason -
are added to a list of undeliverable destinations.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The Vector of undeliverable destinations.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Deliver()"><code>Deliver()</code></a></dd></dl>
</li>
</ul>
<a name="From()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>From</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> From()</pre>
<div class="block">Gets the From address for e-mail deliveries of the notice.
<p>
The From address is not used for other types of deliveries.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The From address String.</dd></dl>
</li>
</ul>
<a name="From(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>From</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> From(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> from_address)</pre>
<div class="block">Sets the From address for e-mail deliveries of the notice.
<p>
The From address is not used for other types of deliveries.
Furthermore, if the From address is null, it will not be used at
all. In this case, the underlying Java e-mail delivery mechanism
(the mailto URL handler) will attempt to use an appropriate From
address based on the owner of the Notify process.
<p>
Note that there is no checking provided to ensure that the From
address is a valid e-mail address. The address should be a regular
e-mail address and not a mailto URL.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from_address</code> - The From address String.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd></dl>
</li>
</ul>
<a name="Reply_To()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Reply_To</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Reply_To()</pre>
<div class="block">Gets the Reply-To address for e-mail deliveries of the notice.
<p>
The Reply-To address is not used for other types of deliveries.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The Reply-To address String (may be null).</dd></dl>
</li>
</ul>
<a name="Reply_To(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Reply_To</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Reply_To(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> reply_to_address)</pre>
<div class="block">Sets the Reply-To address for e-mail deliveries of the notice.
<p>
The Reply-To address is not used for other types of deliveries.
Furthermore, if the Reply-To address is null, it will not be used
at all.
<p>
Note that there is no checking provided to ensure that the Reply-To
address is a valid e-mail address. The address should be a regular
e-mail address and not a mailto URL.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reply_to_address</code> - The Reply-To address String.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd></dl>
</li>
</ul>
<a name="Subject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Subject</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Subject()</pre>
<div class="block">Gets the Subject line for e-mail deliveries of the notice.
<p>
The Subject line is not used for other types of deliveries.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The Subject line String.</dd></dl>
</li>
</ul>
<a name="Subject(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Subject</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Subject(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> subject_line)</pre>
<div class="block">Sets the Subject line for e-mail deliveries of the notice.
<p>
The Subject line is not used for other types of deliveries.
Furthermore, if the Subject line is null, it will not be used at
all.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>subject_line</code> - The Subject line String.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd></dl>
</li>
</ul>
<a name="Max_Message_Lines()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Max_Message_Lines</h4>
<pre>public int Max_Message_Lines()</pre>
<div class="block">Gets the maximum number of message lines to be delivered.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The maximum number of message lines to be delivered.</dd></dl>
</li>
</ul>
<a name="Max_Message_Lines(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Max_Message_Lines</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Max_Message_Lines(int max_lines)</pre>
<div class="block">Sets the maximum number of message lines to be delivered.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>max_lines</code> - The maximum number of message lines to be
delivered. If this is less than or equal to 0, the <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>maximum integer value</code></a> will be used. If it is
less than <a href="../../PIRL/Conductor/Notify.html#Max_Last_Lines()"><code>Max_Last_Lines()</code></a> then <a href="../../PIRL/Conductor/Notify.html#Max_Last_Lines()"><code>Max_Last_Lines()</code></a> will be lowered to the same value and there
will be no initial message lines.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd></dl>
</li>
</ul>
<a name="Max_Last_Lines()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Max_Last_Lines</h4>
<pre>public int Max_Last_Lines()</pre>
<div class="block">Gets the maximum number of message last lines to be delivered.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The maximum number of message last lines to be delivered.</dd></dl>
</li>
</ul>
<a name="Max_Last_Lines(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Max_Last_Lines</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Max_Last_Lines(int max_lines)</pre>
<div class="block">Sets the maximum number of message last lines to be delivered.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>max_lines</code> - The maximum number of message lines to be
delivered. If this is less than 0, 0 will be used. If it is
greater than <a href="../../PIRL/Conductor/Notify.html#Max_Message_Lines()"><code>Max_Message_Lines()</code></a> then <a href="../../PIRL/Conductor/Notify.html#Max_Message_Lines()"><code>Max_Message_Lines()</code></a> will be used and there will be no initial
message lines.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd></dl>
</li>
</ul>
<a name="Message()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Message</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Message()</pre>
<div class="block">Gets the message to be delivered.
<p>
The message is composed of two parts: The initial lines of the
message and the last lines of the message. No more than <a href="../../PIRL/Conductor/Notify.html#Max_Message_Lines()"><code>Max_Message_Lines()</code></a> user provided lines - where a line is a sequence
of characters terminated by a line separator - will be included. If
this limit is exceeded additional lines will be dropped; however,
the last <a href="../../PIRL/Conductor/Notify.html#Max_Last_Lines()"><code>Max_Last_Lines()</code></a> lines will always be included. In
this case the initial lines will be separated from the last lines
by a line of the form:
<p>
... [<i>number</i>> lines omitted]
<p>
where <i>number></i> is number of user provided lines that were
omitted from the message.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The message String.</dd></dl>
</li>
</ul>
<a name="Message_Source(java.lang.String, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Message_Source</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Message_Source(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source,
boolean convert_escapes,
boolean append)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Reads a message from a named source.
<p>
The source can be the name of a local file, the full pathname to
that file, the name of a file contained within a jar that packages
Notify, a file URL that points to a local file, or a URL that
points to an external resource.
<p>
Only <a href="../../PIRL/Conductor/Notify.html#Max_Message_Lines()"><code>Max_Message_Lines()</code></a> lines - where a line is a sequence
of characters terminated by a line separator - will be retained. The
last <a href="../../PIRL/Conductor/Notify.html#Max_Last_Lines()"><code>Max_Last_Lines()</code></a> lines from the source will be saved
separately so they will be included in the delivered message
regardless of the total number of lines available from the source
(@see #Message()).
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - The name of the message file. If null an empty
message is used.</dd><dd><code>convert_escapes</code> - If true, any escape sequences
in the message are converted to their character equivalents;
otherwise the string is unchanged.</dd><dd><code>append</code> - If true, the message is appended to any existing
message; otherwise the any existing message is replaced.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an input stream cannot be obtained
from the message source or if there is a problem reading
from the input stream.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Utilities/Streams.html#Get_Stream(java.lang.String)"><code>Streams.Get_Stream(String)</code></a>,
<a href="../../PIRL/Strings/String_Buffer.html#escape_to_special()"><code>String_Buffer.escape_to_special()</code></a></dd></dl>
</li>
</ul>
<a name="Message_Source(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Message_Source</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Message_Source(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Reads a message from a named source.
<p>
Any escape sequences are converted and any existing message
appended.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - The name of the message file. If null the
message is set to the empty String.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an input stream cannot be obtained
from the message source or if there is a problem reading
from the input stream.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Message_Source(java.lang.String, boolean, boolean)"><code>Message_Source(String, boolean, boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Message(java.lang.String, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Message</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Message(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message,
boolean convert_escapes,
boolean append)</pre>
<div class="block">Sets the message to be delivered.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - The message String. A null message is empty.</dd><dd><code>convert_escapes</code> - If true, any escape sequences in the message
are converted to their character equivalents; otherwise the
string is unchanged.</dd><dd><code>append</code> - If true, the message is appended to any existing
message; otherwise an existing message is replaced.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/String_Buffer.html#escape_to_special()"><code>String_Buffer.escape_to_special()</code></a></dd></dl>
</li>
</ul>
<a name="Message(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Message</h4>
<pre>public <a href="../../PIRL/Conductor/Notify.html" title="class in PIRL.Conductor">Notify</a> Message(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre>
<div class="block">Sets the message to be delivered.
<p>
Any escape sequences are expanded. Any existing message is cleared.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - The message String to be delivered. A null message
is empty.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Notify object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Message(java.lang.String, boolean, boolean)"><code>Message(String, boolean, boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Deliver()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Deliver</h4>
<pre>public int Deliver()</pre>
<div class="block">Delivers the notice to each destination.
<p>
The list of undeliverable destinations (destinations for which, for
whatever reason, the delivery could not be made) is cleared prior
to delivery.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The number of successful destinations.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Undeliverable()"><code>Undeliverable()</code></a></dd></dl>
</li>
</ul>
<a name="Deliver(java.util.Vector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Deliver</h4>
<pre>public int Deliver(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> destinations)</pre>
<div class="block">Delivers the notice to each destination.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>destinations</code> - The Vector of desinations.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of successful destinations.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Deliver()"><code>Deliver()</code></a></dd></dl>
</li>
</ul>
<a name="main(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre>
<div class="block">Processes the command line arguments.
<p>
All error messages are written to stderr. If any destinations
are undeliverable, they are listed.
<p>
The exit status will be one of:
<ul>
<li>0 - SUCCESS
<li>1 - ILLEGAL_SYNTAX
<li>2 - NO_DESTINATION
<li>3 - CANNOT_READ_MESSAGE_FILE
</ul>
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - The array of command line arguments.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Conductor/Notify.html#Usage(int)"><code>Usage(int)</code></a></dd></dl>
</li>
</ul>
<a name="Usage(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Usage</h4>
<pre>public static void Usage(int exit_status)</pre>
<div class="block">Prints the command line usage.
<p>
<blockquote><pre>
Usage: <b>Notify</b> <<i>Switches</i>>
Switches -
[<b>-<u>T</u>o</b>] <<i>address | URI</i>>[<b>,</b>...]
[<b>-<u>F</u>rom</b> <<i>address</i>>] (default: username)
[<b>-<u>R</u>eply-to</b> <<i>address</i>>]
[<b>-<u>S</u>ubject</b> <<i>subject line</i>>]
[<b>-<u>M</u>essage</b> <<i>message</i>> | <b>@</b><<i>source</i>>]
[<b>-<u>L</u>imit</b>[<b>_<u>L</u>ast</b>] <<i>lines</i>> (default: message 1000, last 50)
[<b>-<u>O</u>utgoing_server</b>] <<i>hostname</i>> (default: localhost)
[<b>-<u>V</u>ersion</b>
[<b>-<u>H</u>elp</b>
</pre></blockquote>
<p>
At least one destination (To) address must be provided. Each
destination is treated as a URI. If the address does not specify a
protocol, it is treated as a mailto URI. A comma separated list of
addresses may be provided.
<p>
The From and Reply-to addresses are optional and only used in
association with mailto destinations. By default the user's
address, if available, will be used for the From address. If no
Reply-to address is provided, none will be used.
<p>
The Subject line is optional and only used in association with
mailto destinations. If none is provided, none will be used.
<p>
To message may be any text. If the message text begins with the
<a href="../../PIRL/Conductor/Notify.html#FILENAME_MARKER"><code>FILENAME_MARKER</code></a> ('@') the text without the marker is
interpreted as a file or URL resource specifiction. This may be a
local resource, either a system filename or path within an enclosing
jar file, or it may refer to an external resource via a URL.
<p>
Multiple messages may be specified. They will be concatenated in
the order they occur on the command line.
<p>
The size of the message may be limited to a maximum number of lines.
Excess lines will be dropped but the last lines of the message - the
number may be specified - will be retained.
<p>
The hostname of an SMTP server to which the message will be transmitted
may be specified. The default hostname is "localhost".
<p>
<b>N.B.</b>: Command line options are applied in the order in which
they are encountered. Thus, for example, message limit values should
be set before the message body is specified.
<p>
The -Version option causes the class <a href="../../PIRL/Conductor/Notify.html#ID"><code>ID</code></a> to be written to
stdout followed by a System.exit.
<p>
<b>N.B.</b>: This method always results in a System.exit.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>exit_status</code> - The exit status code. The usage statement is
written to the stdout if the exit_status is <a href="../../PIRL/Conductor/Notify.html#SUCCESS"><code>SUCCESS</code></a>,
otherwise to stderr.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../PIRL/Conductor/Native_Methods.html" title="class in PIRL.Conductor"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Conductor/Pipeline_Source_Manager.html" title="class in PIRL.Conductor"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Conductor/Notify.html" target="_top">Frames</a></li>
<li><a href="Notify.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|