├── COPYING ├── INSTALL ├── LICENSE ├── README.md ├── com.github.chsturm.spamfilter.plist ├── install.sh ├── spamfilter-rules.json └── spamfilter.applescript /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | -------------------------------------------------------------------------------- /INSTALL: -------------------------------------------------------------------------------- 1 | spamfilter for Apple Mail.app 2 | 3 | This spamfilter lets you easily define keyword-based filter rules for each of your email accounts individually. It makes use of Mail.app's scripting interface for Applescript and JXA. Spam messages are marked as Junk and moved to the trash folder. 4 | 5 | 6 | INSTALLATION 7 | There are two invokation modes for the spamfilter script that impose different installation tasks. The first mode relies on Mail.app's rule infrastructure to automate handling of new incoming messages dedicated to default inboxes: 8 | 9 | 1. Download spamfilter.zip from Releases 10 | 2. Extract zip archive, open Terminal and change working directory to spamfilter directory via 'cd path/to/spamfilter_dir' 11 | 3. Run 'sh install.sh' 12 | 4. Open Mail.app's preferences pane and go to "Rules" 13 | 5. Add a new rule with action "Run Applescript" choosing spamfilter.scpt 14 | 15 | As rule invokation is restricted to default inboxes it might be desirable to also enable filtering on other mailboxes. The second mode checks all mailboxes in a 15 minutes interval by setting up a launch agent for launchd daemon: Perform the steps stated above, except step 3: Run 'sh install.sh -launchagent' to set up the default launch agent or 'sh install.sh -launchagent 600' to configure your own interval in seconds, e.g., 600 for 10 minutes. 16 | 17 | 18 | CONFIGURATION 19 | The configuration of the script as well as your custom rules are stored in spamfilter-rules.json. Edit this file using the text editor of your choice. A sample might look like this: 20 | 21 | { 22 | "shouldAlertMatchDetails": false, 23 | "rulesList": [ 24 | { 25 | "email": "me@example.com", 26 | "fromWhitelist": {"shouldTest": false, "list": []}, 27 | "senderBlacklist": {"list": ["John Doe", "@evil.org", "GitHub"]}, 28 | "subjectBlacklist": {"list": ["50% off", "Account suspended"]}, 29 | "contentBlacklist": {"list": ["Dear customer"]} 30 | }, 31 | { 32 | "email": "foo@bar.com", 33 | "fromWhitelist": {"shouldTest": true, "list": ["GitHub"]}, 34 | "senderBlacklist": {"list": ["Jane Doe", "support@evil.org"]}, 35 | "subjectBlacklist": {"list": []}, 36 | "contentBlacklist": {"list": ["Dear customer"]}, 37 | "mailboxList": [{"name": "Another Mailbox", 38 | "fromWhitelist": {"shouldTest": false, "list": []}, 39 | "senderBlacklist": {"list": []}, 40 | "subjectBlacklist": {"list": ["50% off"]}, 41 | "contentBlacklist": {"list": []} 42 | }] 43 | } 44 | ] 45 | } 46 | 47 | Apart from your account-specific rules the JSON object above comprises general settings like shouldAlertMatchDetails that always affect the filtering regardless of your rules. shouldAlertMatchDetails set to true (boolean) helps debugging false-positives by telling you which rule has matched. 48 | 49 | The rulesList property contains the array of mail accounts for which you want to enable filtering. Accounts not listed there are not filtered at all. Here's a description of an account rule for its default INBOX: 50 | 51 | - 'email' indicates the mail address of your account. 52 | - 'fromWhitelist' controls the test wether the sender contains a full name (first name and last name) or just a single word. If shouldTest is true, one-word names are considered as spam matches. Whitelist exceptions are likely to be necessary then, e.g., for GitHub in the foo@bar.com rule above. 53 | - 'senderBlacklist' compares the "From" header of the message with all items in the corresponding blacklist. Those items can be names, email addresses or only string components of them. 54 | - 'subjectBlacklist' compares the "Subject" header of the message with all items in the blacklist. 55 | - 'contentBlacklist' compares the message content with all items in the blacklist. Only text content is tested. Binary data is skipped. 56 | - 'mailboxList' [optional] a list of rule objects for additional mailboxes different from the default INBOX. Those rules work analogously to the ones above, but only for a specific mailbox. 57 | 58 | All comparisons with list items are case-sensitive. 59 | 60 | 61 | DEINSTALLATION 62 | Unload launch agent in terminal: 63 | launchctl unload -w ~/Library/LaunchAgents/com.github.chsturm.spamfilter.plist 64 | 65 | Remove the following files: 66 | - ~/Library/Application Scripts/com.apple.mail/spamfilter.scpt 67 | - ~/Library/Application Scripts/com.apple.mail/spamfilter-rules.json 68 | - ~/Library/LaunchAgents/com.github.chsturm.spamfilter.plist 69 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | spamfilter for Apple Mail.app 2 | Copyright (c) 2023 Christian Sturm 3 | 4 | This program is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | This program is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with this program. If not, see . 16 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # spamfilter for Apple Mail.app 2 | This spamfilter lets you easily define keyword-based filter rules for each of your email accounts individually. It makes use of Mail.app's scripting interface for Applescript and JXA. 3 | Spam messages are marked as Junk and moved to the trash folder. 4 | 5 | ## Installation 6 | There are two invokation modes for the spamfilter script that impose different installation tasks. The first mode relies on Mail.app's rule infrastructure to automate handling of new incoming messages dedicated to default inboxes: 7 | 1. Download `spamfilter.zip` from [Releases](https://github.com/chsturm/spamfilter/releases) 8 | 2. Extract zip archive, open Terminal and change working directory to spamfilter directory via `cd path/to/spamfilter` 9 | 3. Run `sh install.sh` 10 | 4. Open Mail.app's preferences pane and go to "Rules" 11 | 5. Add a new rule with action "Run Applescript" choosing spamfilter.scpt 12 | 13 | As rule invokation is restricted to default inboxes it might be desirable to also enable filtering on other mailboxes. The second mode checks all mailboxes in a 15 minutes interval by setting up a launch agent for `launchd` daemon: 14 | Perform the steps stated above, except step 3: Run `sh install.sh -launchagent` to set up the default launch agent or `sh install.sh -launchagent 600` to configure your own interval in seconds, e.g., 600 for 10 minutes. 15 | 16 | ## Configuration 17 | The configuration of the script as well as your custom rules are stored in `spamfilter-rules.json`. Edit this file using the text editor of your choice. A sample might look like this: 18 | 19 | ```javascript 20 | { 21 | "shouldAlertMatchDetails": false, 22 | "rulesList": [ 23 | { 24 | "email": "me@example.com", 25 | "fromWhitelist": {"shouldTest": false, "list": []}, 26 | "senderBlacklist": {"list": ["John Doe", "@evil.org", "GitHub"]}, 27 | "subjectBlacklist": {"list": ["50% off", "Account suspended"]}, 28 | "contentBlacklist": {"list": ["Dear customer"]}, 29 | "headerBlacklist": [{"name": "received", "list": ["from mta.eval.to"]}, 30 | {"name": "content-type", "list": ["application/"]} 31 | ] 32 | }, 33 | { 34 | "email": "foo@bar.com", 35 | "fromWhitelist": {"shouldTest": true, "list": ["GitHub"]}, 36 | "senderBlacklist": {"list": ["Jane Doe", "support@evil.org"]}, 37 | "subjectBlacklist": {"list": []}, 38 | "contentBlacklist": {"list": ["Dear customer"]}, 39 | "mailboxList": [{"name": "Another Mailbox", 40 | "fromWhitelist": {"shouldTest": false, "list": []}, 41 | "senderBlacklist": {"list": []}, 42 | "subjectBlacklist": {"list": ["50% off"]}, 43 | "contentBlacklist": {"list": []} 44 | }] 45 | } 46 | ] 47 | } 48 | ``` 49 | 50 | Apart from your account-specific rules the JSON object above comprises general settings like `shouldAlertMatchDetails` that always affect the filtering regardless of your rules. shouldAlertMatchDetails set to true (boolean) helps debugging false-positives by telling you which rule has matched. 51 | 52 | The `rulesList` property contains the array of mail accounts for which you want to enable filtering. Accounts not listed there are not filtered at all. Here's a description of an account rule for its default INBOX: 53 | * `email` indicates the mail address of your account. 54 | * `fromWhitelist` controls the test wether the sender contains a full name (first name and last name) or just a single word. If `shouldTest` is true, one-word names are considered as spam matches. Whitelist exceptions are likely to be necessary then, e.g., for GitHub in the foo@bar.com rule above. 55 | * `senderBlacklist` compares the "From" header of the message with all items in the corresponding blacklist. Those items can be names, email addresses or only string components of them. 56 | * `subjectBlacklist` compares the "Subject" header of the message with all items in the blacklist. 57 | * `contentBlacklist` compares the message content with all items in the blacklist. Only text content is tested. Binary data is skipped. 58 | * `headerBlacklist` [optional] compares arbitrary message headers defined by the `name` property (lower-case) with all items in the corresponding blacklist. 59 | * `mailboxList` [optional] a list of rule objects for additional mailboxes different from the default INBOX. Those rules work analogously to the ones above, but only for a specific mailbox. 60 | 61 | All comparisons with list items are case-sensitive. 62 | 63 | ## Deinstallation 64 | Unload launch agent in terminal: 65 | 66 | `launchctl unload -w ~/Library/LaunchAgents/com.github.chsturm.spamfilter.plist` 67 | 68 | Remove the following files: 69 | - `~/Library/Application Scripts/com.apple.mail/spamfilter.scpt` 70 | - `~/Library/Application Scripts/com.apple.mail/spamfilter-rules.json` 71 | - `~/Library/LaunchAgents/com.github.chsturm.spamfilter.plist` 72 | 73 | ## Further notes 74 | ### Automatic filtering 75 | In addition to your own rules there are some more tests that are always performed and lead to spam matches: 76 | * Self-addressed messages, i.e. sender = receiver, without your full name as sender 77 | * Certain file extensions of binaries sent within messages, e.g., ".exe" 78 | * Certain charsets, e.g., "gb2312" for Chinese 79 | * Zero-width whitespace chars, e.g., "U+FEFF" 80 | 81 | ### Bugs in Mail.app 82 | There seems to be a bug in Mail.app preventing the correct processing of all messages in case you receive multiple messages at once. A bug circumvention was added to spamfilter.scpt. However, if you still note unprocessed messages, you can trigger the spamfilter by selecting any remaining messages and running Mail.app rules manually via `alt+cmd+L` or via its right-click context menu. 83 | Mail only triggers its built-in rule system for new messages stored to the default INBOX, but not in other mailboxes your server may provide. Automatic filtering on all mailboxes is therefore performed as soon as a new message is received in INBOX. 84 | 85 | ## Acknowledgments 86 | * [JXA-Cookbook](https://github.com/JXA-Cookbook/JXA-Cookbook/wiki) 87 | * [base64-js lib](https://github.com/beatgammit/base64-js) 88 | * [quoted-printable](https://github.com/ronomon/quoted-printable/blob/master/index.js) 89 | -------------------------------------------------------------------------------- /com.github.chsturm.spamfilter.plist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Label 6 | com.github.chsturm.spamfilter 7 | ProgramArguments 8 | 9 | osascript 10 | HOME_DIR/Library/Application Scripts/com.apple.mail/spamfilter.scpt 11 | 12 | 13 | RunAtLoad 14 | 15 | StartInterval 16 | LAUNCH_INTERVAL 17 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | launchagent_flag=$1 4 | interval=$2 5 | script_dir="$HOME/Library/Application Scripts/com.apple.mail" 6 | rules_file="spamfilter-rules.json" 7 | launchagent_file="com.github.chsturm.spamfilter.plist" 8 | launchagent_path="$HOME/Library/LaunchAgents/$launchagent_file" 9 | 10 | # copy spamfilter script 11 | cp spamfilter.scpt $script_dir 12 | 13 | # copy filter rules file 14 | if [ -e "$script_dir/$rules_file" ] 15 | then 16 | echo "Overwrite existing $rules_file? (y/n)" 17 | read user_input 18 | if [ $user_input == "y" ] 19 | then 20 | cp $rules_file $script_dir 21 | fi 22 | else 23 | cp $rules_file $script_dir 24 | fi 25 | 26 | 27 | # create launch agent 28 | if [ $# -gt 0 ] && [ $launchagent_flag == "-launchagent" ] 29 | then 30 | echo "Setting up launch agent" 31 | cp $launchagent_file "$HOME/Library/LaunchAgents" 32 | sed -i "" "s+HOME_DIR+$HOME+g" $launchagent_path 33 | 34 | # configure launch interval in seconds 35 | itvl=900 36 | if [ $# -eq 2 ] && [ $interval -gt 0 ] 37 | then 38 | itvl=$interval 39 | fi 40 | sed -i "" "s+LAUNCH_INTERVAL+$itvl+g" $launchagent_path 41 | 42 | launchctl load -w $launchagent_path 43 | fi -------------------------------------------------------------------------------- /spamfilter-rules.json: -------------------------------------------------------------------------------- 1 | { 2 | "shouldAlertMatchDetails": false, 3 | "rulesList": [ 4 | { 5 | "email": "me@example.com", 6 | "fromWhitelist": {"shouldTest": false, "list": []}, 7 | "senderBlacklist": {"list": ["John Doe", "@evil.org", "GitHub"]}, 8 | "subjectBlacklist": {"list": ["50% off", "Account suspended"]}, 9 | "contentBlacklist": {"list": ["Dear customer"]}, 10 | "headerBlacklist": [{"name": "received", "list": ["from mta.eval.to"]}, 11 | {"name": "content-type", "list": ["application/"]} 12 | ] 13 | }, 14 | { 15 | "email": "foo@bar.com", 16 | "fromWhitelist": {"shouldTest": true, "list": ["GitHub"]}, 17 | "senderBlacklist": {"list": ["Jane Doe", "support@evil.org"]}, 18 | "subjectBlacklist": {"list": []}, 19 | "contentBlacklist": {"list": ["Dear customer"]}, 20 | "mailboxList": [{"name": "Another Mailbox", 21 | "fromWhitelist": {"shouldTest": false, "list": []}, 22 | "senderBlacklist": {"list": []}, 23 | "subjectBlacklist": {"list": ["50% off"]}, 24 | "contentBlacklist": {"list": []} 25 | }] 26 | } 27 | ] 28 | } 29 | -------------------------------------------------------------------------------- /spamfilter.applescript: -------------------------------------------------------------------------------- 1 | /* 2 | spamfilter for Apple Mail.app 3 | Copyright (c) 2024 Christian Sturm 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . 17 | */ 18 | 19 | 20 | 'use strict'; 21 | 22 | // start web inspector panel 23 | //debugger 24 | 25 | var shouldAlertMatchDetails = false // true: alert rule item if a rule match is found 26 | const shouldLogActivity = false // true: log details about message tests to file 27 | const mutexLifetime = 600 // duration in seconds after which a mutex lock will be reset 28 | 29 | 30 | const mail = Application.currentApplication().name == "Mail" 31 | ? Application.currentApplication() : Application("Mail") 32 | mail.includeStandardAdditions = true 33 | if (!mail.running()) { 34 | delay(10) 35 | if (!mail.running()) throw "Mail.app not running" 36 | } 37 | 38 | 39 | ObjC.import('Foundation') 40 | //ObjC.import('stdlib') 41 | ObjC.import('stdio') 42 | ObjC.import('unistd') 43 | 44 | var rulesHandler = new RulesHandler() 45 | 46 | 47 | /** These chars are usually not used within normal text, 48 | but to prevent word-based blacklisting in spam. 49 | e.g. zero-width spaces like byte order mark 50 | */ 51 | const cheatChars = ['\uFEFF','\u200B', '\u200C', '\u2060'] 52 | 53 | /** uncommon file extensions */ 54 | const fileExtensions = ['.7z', '.exe', '.jpg.zip'] 55 | 56 | /** uncommon charsets (in lowercase) */ 57 | const charsetBlacklist = ['windows-1251'/* cyrillic*/, 'gb2312'/*chinese*/, 'gb18030'/*chinese*/] 58 | 59 | 60 | /** Construct blacklist rules handler */ 61 | function RulesHandler(path = null) { 62 | this.rulesList = null 63 | if (path) 64 | this.path = path 65 | else { 66 | this.path = mail.pathTo("library folder", {from: "user domain", folderCreation: false}).toString() + "/Application Scripts/com.apple.mail/spamfilter-rules.json" 67 | } 68 | } 69 | 70 | /** Load json object from rules file */ 71 | RulesHandler.prototype.loadConfigFromFile = function() { 72 | var config = null, 73 | fm = $.NSFileManager.defaultManager 74 | if (!fm.fileExistsAtPath(this.path)) { 75 | mail.displayDialog("No rules file found!", {withIcon: "caution", givingUpAfter: 10}) 76 | return config 77 | } 78 | var contents = fm.contentsAtPath(this.path) // NSData 79 | contents = $.NSString.alloc.initWithDataEncoding(contents, $.NSUTF8StringEncoding); 80 | var configJsonStr = ObjC.unwrap(contents) 81 | 82 | if (configJsonStr != "") 83 | config = JSON.parse(configJsonStr) 84 | else 85 | console.log("No rules in file!") 86 | return config 87 | } 88 | 89 | /** Setup rules and configuration from json object */ 90 | RulesHandler.prototype.loadRulesList = function() { 91 | try { 92 | var config = this.loadConfigFromFile() 93 | } catch (e) { 94 | console.log(e.name +': '+ e.message) 95 | if (e instanceof SyntaxError && !config) 96 | mail.displayDialog("JSON syntax error in rules file on line "+ e.lineNumber +": " 97 | + e.message) 98 | } 99 | 100 | if (!config || !config.rulesList) return false 101 | 102 | if (config.shouldAlertMatchDetails === true || config.shouldAlertMatchDetails !== "false") 103 | shouldAlertMatchDetails = config.shouldAlertMatchDetails 104 | this.rulesList = config.rulesList 105 | return true 106 | } 107 | 108 | /** Get rules for given email address resp. account */ 109 | RulesHandler.prototype.getRulesForAddress = function(address) { 110 | return this.rulesList.find(function(rule) { 111 | return address === rule.email 112 | }) 113 | } 114 | 115 | 116 | /** handler called by terminal via osascript -l JavaScript */ 117 | function run () { 118 | mail.downloadHtmlAttachments = false 119 | const accountList = mail.accounts() //.whose({_match: [ObjectSpecifier().enabled, true]})() 120 | var shouldDisplayNotification = false 121 | if (!rulesHandler.loadRulesList()) return 122 | 123 | accountList.forEach(function(account){ 124 | try { 125 | if (account.enabled() === false) return 126 | } catch (e) { 127 | // account.enabled throws error on Big Sur 128 | //ActivityLog.log(e.message) 129 | } 130 | 131 | const filterHandler = new SpamFilterHandler() 132 | filterHandler.account = new Account(account) 133 | if (!filterHandler.loadAccountRules()) { 134 | //ActivityLog.log("no-rules/"+ filterHandler.account.emailAddressList[0] +" (CLI invoked)") 135 | return 136 | } 137 | 138 | const accountMutex = new RunCoordinator(filterHandler.account.id) 139 | if (accountMutex.tryLock() !== true) { 140 | ActivityLog.log("CLI:no-lock/"+ filterHandler.accountRules.email) 141 | return 142 | } 143 | //ActivityLog.log("got-lock/"+ filterHandler.accountRules.email +" (CLI invoked)") 144 | 145 | filterHandler.invokedBy = 'CLI:'; 146 | filterHandler.filterAccountMailboxes() 147 | shouldDisplayNotification |= filterHandler.hasNewMessages 148 | accountMutex.unlock() 149 | }) 150 | ActivityLog.finish() 151 | if (shouldDisplayNotification) newMailNotification() 152 | } 153 | 154 | /** handler called by Apple Mail when applying rules on messages */ 155 | function performMailActionWithMessages (messages, manualProperties) { 156 | mail.downloadHtmlAttachments = false 157 | if (!rulesHandler.loadRulesList()) return 158 | 159 | // skip remaining messages if identical to first one due to bug in Mail.app 160 | // wrap Mail JXA API 161 | var messageList = null 162 | if (messages.length > 1 && messages[0].id() !== messages[1].id()) 163 | messageList = messages.map(function(raw){return new Message(raw)}) 164 | else 165 | messageList = [new Message(messages[0])] 166 | 167 | const filterHandler = new SpamFilterHandler() 168 | filterHandler.filterMessageList(messageList) 169 | 170 | // return if no rules exist 171 | if (!filterHandler.mailboxRule) { 172 | ActivityLog.finish() 173 | return 174 | } 175 | 176 | /* no bug circumvention needed if only one message in list or user-selected list, 177 | already in trash or other spamfilter instance running on account 178 | */ 179 | // try to get lock of current account if more messages are available to filter 180 | const accountMutex = new RunCoordinator(filterHandler.mailbox.account.id) 181 | if (messageList.length > 1 // user-selected list 182 | || ["Deleted Messages", "Trash"].includes(filterHandler.mailbox.name) 183 | || accountMutex.tryLock() !== true) { 184 | if (accountMutex.gotLock() === false) 185 | ActivityLog.log("no-lock/"+ filterHandler.mailboxRule.email) 186 | ActivityLog.finish() 187 | return 188 | } 189 | if (accountMutex.gotLock() === true) 190 | ActivityLog.log("got-lock/"+ filterHandler.mailboxRule.email) 191 | 192 | // filter messages not dealt with above due to bugs in Mail.app 193 | // => filter the whole mailbox of the first message given in messages arg 194 | mail.checkForNewMail(filterHandler.mailbox.account) 195 | delay(1) 196 | filterHandler.mailbox.refreshMessageList() 197 | if (messages.length > 1 || filterHandler.mailbox.unreadCount > 0) 198 | filterHandler.filterCurrentMailbox() 199 | 200 | // also filter custom mailboxes having some rules defined 201 | filterHandler.filterAccountMailboxes() 202 | 203 | accountMutex.unlock() 204 | ActivityLog.finish() 205 | if (filterHandler.hasNewMessages) newMailNotification() 206 | } 207 | 208 | /** Display notification for new messages in mailboxes other than INBOX */ 209 | function newMailNotification(retryOnError = true) { 210 | const app = Application.currentApplication() // displayNotification only works in currApp 211 | app.includeStandardAdditions = true 212 | try { 213 | app.displayNotification('New messages in Mail.app', {withTitle: "Spamfilter"}) 214 | } catch (err) { 215 | console.log("Notification error: "+ err.message) 216 | if (retryOnError) newMailNotification(false) 217 | } 218 | } 219 | 220 | /** Handles all spam filter operations on single messages, message lists, mailboxes and accounts 221 | */ 222 | function SpamFilterHandler () { 223 | this.mailbox = null 224 | this.mailboxRule = null 225 | this.accountRules = null 226 | this.account = null 227 | this.accountMailboxes = null 228 | this.invokedBy = '' 229 | this.hasNewMessages = false 230 | } 231 | /** Applies spam filter operation on given message list; 232 | Defines mailbox, rules and account properties for subsequent filtering 233 | */ 234 | SpamFilterHandler.prototype.filterMessageList = function(messageList) { 235 | if (!Array.isArray(rulesHandler.rulesList)) { 236 | mail.displayDialog("No rules list found in json file") 237 | return 238 | } 239 | 240 | for (var message of messageList) { 241 | // search matching rule based on email address 242 | const mailbox = message.mailbox 243 | const rule = this.getRuleAndAccountFromMailbox(mailbox) 244 | 245 | if (!rule) { 246 | ActivityLog.log("no-rules/"+ this.account.emailAddressList[0]) 247 | return 248 | } 249 | 250 | // store mailbox and account rule of first message to test remaining ones 251 | if (!this.mailbox) { 252 | this.mailbox = mailbox 253 | this.mailboxRule = rule 254 | //messageMeta.accountRules = accountRules 255 | if (Progress) Progress.description = rule.email 256 | delay(0.2) 257 | } 258 | 259 | ActivityLog.logMessage(message, "firstrun-test/"+ rule.email) 260 | this.filterMessage(rule, message) 261 | } 262 | } 263 | 264 | /** Get account rules from general rules list */ 265 | SpamFilterHandler.prototype.loadAccountRules = function() { 266 | if (!this.account) { 267 | ActivityLog.log("loadAccountRules() failed: this.account not defined"); 268 | return false 269 | } 270 | const accountAddressList = this.account.emailAddressList 271 | 272 | // search account specific rules object 273 | var accountRules = null 274 | for (let address of accountAddressList) { 275 | if (accountRules = rulesHandler.getRulesForAddress(address)) break 276 | } 277 | if (!accountRules) return false 278 | this.accountRules = accountRules 279 | 280 | // add default INBOX rule to mailboxList if not already included 281 | if (!accountRules.mailboxList) accountRules.mailboxList = [] 282 | if (accountRules.mailboxList.some(function(rule){ 283 | return rule.name === 'INBOX' 284 | })) return true 285 | 286 | accountRules.mailboxList.push({ 287 | name: 'INBOX', 288 | email: accountRules.email, 289 | fromWhitelist: accountRules.fromWhitelist, 290 | senderBlacklist: accountRules.senderBlacklist, 291 | subjectBlacklist: accountRules.subjectBlacklist, 292 | contentBlacklist: accountRules.contentBlacklist, 293 | headerBlacklist: accountRules.headerBlacklist 294 | }) 295 | return true 296 | } 297 | 298 | /** Returns the correct rule in json rules file for given mailbox; 299 | Sets account rule set 300 | */ 301 | SpamFilterHandler.prototype.getRuleAndAccountFromMailbox = function(mailbox) { 302 | this.account = mailbox.account 303 | const boxName = mailbox.name 304 | 305 | if (!this.loadAccountRules()) return null; 306 | 307 | // choose either the default rule for INBOX or one for cutom mailboxes 308 | let rule = null 309 | if (Array.isArray(this.accountRules.mailboxList) 310 | && this.accountRules.mailboxList.length > 0) { 311 | rule = this.accountRules.mailboxList.find(function(rule){ 312 | return boxName === rule.name 313 | }) 314 | if (rule) rule.email = this.accountRules.email 315 | } 316 | return rule 317 | } 318 | 319 | /** Applies spam filter operation on given message */ 320 | SpamFilterHandler.prototype.filterMessage = function(rule, message) { 321 | // delete message as soon as a blacklist match is detected 322 | 323 | if (testSelfAddressedForFullName(rule.email, message) 324 | || testSenderForFullName(rule.fromWhitelist, message) 325 | || testMessageField('sender', rule.senderBlacklist, message) 326 | || testMessageField('subject', rule.subjectBlacklist, message) 327 | || testHeaders(rule.headerBlacklist, message) 328 | || testMessageField('source', rule.contentBlacklist, message)) { 329 | // mark message as processed by spamfilter for debugging 330 | /*message.flagIndex = 6; // grey 331 | message.flaggedStatus = true;*/ 332 | 333 | this.moveToTrash(message) 334 | delay(0.6) // avoid DoS of your mail server 335 | return true 336 | } else { 337 | //console.log("No blacklist matches found") 338 | return false 339 | } 340 | } 341 | /** moves specified message to trash folder of its mail account */ 342 | SpamFilterHandler.prototype.moveToTrash = function(mes) { 343 | mes.junkMailStatus = true 344 | //mes.deletedStatus = true // message lost in the Nirwana 345 | 346 | if (!this.account) mail.displayDialog("Account of mailbox undefined") 347 | 348 | // get trash mailbox of account 349 | const boxList = this.accountMailboxes || (this.accountMailboxes = this.account.mailboxList) 350 | if (!boxList || boxList.length === 0) mail.displayDialog("Mailbox list undefined") 351 | 352 | var trash = boxList.find(function(box){ 353 | const boxName = box.name, exists = boxName.includes("Deleted Messages") 354 | return exists || boxName.includes("Trash") 355 | }); 356 | if (!trash) { 357 | mail.displayDialog("Trash undefined for account " + this.account.name) 358 | return 359 | } 360 | 361 | mes.moveToMailbox(trash) 362 | //mail.checkForNewMail(account) 363 | } 364 | 365 | 366 | /** Applies spam filter operation once on given mailbox using given rule */ 367 | SpamFilterHandler.prototype.filterMailbox = function(boxRule, mailbox) { 368 | // message list: chronological join of 'Deleted Messages' since startup and 'INBOX' 369 | var msgIdx = 0, unreadCount = mailbox.unreadCount, initMessageCount = mailbox.messageCount 370 | 371 | while (msgIdx < unreadCount && msgIdx < mailbox.messageCount 372 | && mailbox.messageCount == initMessageCount) { 373 | const message = mailbox.getMessageByIndex(msgIdx), 374 | readStatus = message.readStatus 375 | if (readStatus === null) { 376 | ActivityLog.log("readStatus = null") 377 | mailbox.refreshMessageList() 378 | return false 379 | } 380 | const junkStatus = message.junkMailStatus 381 | 382 | ActivityLog.logMessage(message, this.invokedBy +"secrun-test/"+ boxRule.email +"/idx." 383 | + msgIdx) 384 | 385 | // don't count already tested spam messages or read messages 386 | if (junkStatus || readStatus) unreadCount++ 387 | 388 | // test message (again) 389 | if (!readStatus) { 390 | this.filterMessage(boxRule, message) 391 | if (mailbox.unreadCount === 0) break 392 | } 393 | 394 | msgIdx++ 395 | 396 | // watchdog for Mail.app bugs, e.g., new message not yet in messages list of mailbox 397 | // causing big useless message loop 398 | if (msgIdx % 5 == 0) { 399 | if (Date.now() - Date.parse(message.getField('dateReceived')) > 86400000*20) { 400 | ActivityLog.log("stop filtering: messages older than 20 days") 401 | break 402 | } 403 | mailbox.refreshMessageList() 404 | } 405 | } 406 | return true 407 | } 408 | 409 | /** Applies spam filter operation on predefined mailbox, e.g., by filterMessageList(). 410 | This method is more reliable than filterMailbox() due to bugs in Mail.app 411 | */ 412 | SpamFilterHandler.prototype.filterCurrentMailbox = function() { 413 | if (!this.mailbox || !this.account) return 414 | 415 | this.accountMailboxes = this.account.mailboxList 416 | this.filterMailboxInLoops(this.mailboxRule, this.mailbox) 417 | } 418 | 419 | /** Applies multiple iterations of spam filter operation on given mailbox using given rule */ 420 | SpamFilterHandler.prototype.filterMailboxInLoops = function(boxRule, mailbox) { 421 | // try multiple times to catch all unread messages in INBOX 422 | var iterations = 2 423 | for (var i=0; i 0) { 427 | ActivityLog.log(this.invokedBy +"more-messages/"+ boxRule.email +"/box." 428 | + mailbox.name +"/loop."+ i +": " + unreadCount) 429 | if (Progress) Progress.description = boxRule.email +": Mailbox test" 430 | if (!this.filterMailbox(boxRule, mailbox) && iterations == 2) iterations = 3 431 | } else break 432 | } 433 | 434 | // display notification if new messages in secondary mailboxes 435 | if (mailbox.name == 'INBOX') return 436 | if (mailbox.unreadCount > 0) this.hasNewMessages = true 437 | } 438 | 439 | /** Applies spam filter operation on custom mailboxes of predefined account */ 440 | SpamFilterHandler.prototype.filterAccountMailboxes = function() { 441 | if (!this.account || !this.accountRules.mailboxList) return 442 | 443 | this.accountMailboxes = this.account.mailboxList 444 | const self = this, firstMsgBoxName = this.mailbox ? this.mailbox.name : null 445 | this.accountRules.mailboxList.forEach(function(boxRule){ 446 | if (boxRule.name === firstMsgBoxName) return 447 | 448 | var mailbox = self.accountMailboxes.find(function(box){ 449 | return box.name === boxRule.name 450 | }) 451 | if (!mailbox) return 452 | 453 | boxRule.email = self.accountRules.email 454 | self.filterMailboxInLoops(boxRule, mailbox) 455 | }) 456 | } 457 | 458 | 459 | /** log all message tests in separate file for debugging if shouldLogActivity == true */ 460 | const ActivityLog = (function() { 461 | if (!shouldLogActivity) { 462 | // return dummy methods if logging switched off 463 | const dummyFnc = function(){} 464 | return {log: dummyFnc, 465 | logMessage: dummyFnc, 466 | finish: dummyFnc 467 | } 468 | } 469 | 470 | const path = ObjC.wrap(mail.pathTo("library folder", {from: "user domain", folderCreation: false}).toString() + "/Application Scripts/com.apple.mail/spamfilter.log") 471 | .stringByStandardizingPath 472 | var fh = $.NSFileHandle.fileHandleForWritingAtPath(path) 473 | if (fh.isNil()) { 474 | console.log("create new log file") 475 | $.NSFileManager.defaultManager.createFileAtPathContentsAttributes(path, undefined, undefined) 476 | fh = $.NSFileHandle.fileHandleForWritingAtPath(path) 477 | } 478 | if (fh.isNil()) { 479 | console.log("couldn't get file handle for logging") 480 | return 481 | } 482 | fh.seekToEndOfFile 483 | 484 | try { 485 | const stderrFd = $.NSFileHandle.fileHandleWithStandardError.fileDescriptor 486 | //$.freopen(path.UTF8String, ObjC.wrap("a+").UTF8String, stderrFd) 487 | $.dup2(fh.fileDescriptor, stderrFd) 488 | } catch (e) { 489 | console.log(e.message) 490 | } 491 | 492 | /** general log function appending entry as a line to file */ 493 | var log = function(str) { 494 | try { 495 | fh.seekToEndOfFile 496 | fh.writeData(ObjC.wrap(str +"\n").dataUsingEncoding($.NSUTF8StringEncoding)) 497 | } catch (e) { 498 | console.log("failed writing to log file: "+ e.name +", "+ e.message) 499 | mail.displayDialog("failed writing to log file: "+ e.name +", "+ e.message) 500 | return false 501 | } 502 | return true 503 | } 504 | 505 | /** log given message along with run type of test */ 506 | var logMessage = function(msg, runType) { 507 | log(runType +",ts."+ Date.now() +": "+ msg.getField('dateReceived') 508 | +",id."+ msg.id +",box."+ msg.mailbox.name +","+ 509 | msg.getField('sender') +", "+ msg.getField('subject')) 510 | } 511 | 512 | /** close file before quit */ 513 | var finish = function() { 514 | try { 515 | fh.closeFile 516 | } catch (e) { 517 | console.log("failed closing log file: "+ e.name +", "+ e.message) 518 | } 519 | } 520 | 521 | return {log: log, 522 | logMessage: logMessage, 523 | finish: finish 524 | } 525 | })() 526 | 527 | /** manages mutex locks accessible to different spamfilter instances (osascript processes) */ 528 | const RunCoordinator = (function() { 529 | const dir = mail.pathTo("library folder", {from: "user domain", folderCreation: false} 530 | ).toString() + "/Application Scripts/com.apple.mail/" 531 | var path = '', mutex = null, gotLock = null 532 | 533 | /** constructor creates path to mutex file */ 534 | function RunCoordinator (resourceId) { 535 | path = ObjC.wrap(dir +'.'+ resourceId +'.spamfilter.lock') 536 | } 537 | 538 | /** try to get lock for specified resource id and return result */ 539 | RunCoordinator.prototype.tryLock = function() { 540 | mutex = $.NSDistributedLock.lockWithPath(path) 541 | 542 | // force unlock if older than mutexLifetime (600) sec as normal unlocking seemed to fail 543 | if (!mutex.lockDate.isNil()) { 544 | // Foundation.fw bug: lockDate set to reference date (docs say nil) if no lock present 545 | var nowIntvl = Math.abs(ObjC.unwrap(mutex.lockDate.timeIntervalSinceNow)), 546 | refIntvl = ObjC.unwrap(mutex.lockDate.timeIntervalSinceReferenceDate) 547 | if (nowIntvl < refIntvl && nowIntvl > mutexLifetime) 548 | mutex.breakLock 549 | } 550 | 551 | try { 552 | gotLock = ObjC.unwrap(mutex.tryLock) 553 | } catch (e) { 554 | console.log("mutex locking error: "+ e.message) 555 | } 556 | return gotLock 557 | } 558 | 559 | /** returns true if got lock else false; null if tryLock() not yet called */ 560 | RunCoordinator.prototype.gotLock = function() { 561 | return gotLock 562 | } 563 | 564 | /** unlock existing mutex */ 565 | RunCoordinator.prototype.unlock = function() { 566 | if (mutex) mutex.unlock 567 | } 568 | 569 | return RunCoordinator 570 | })() 571 | 572 | /** alert item that matched a rule; useful for enhancing rules */ 573 | function alertMatchDetails (field, item) { 574 | if (!shouldAlertMatchDetails) return 575 | mail.displayDialog(field +': '+ item, {withTitle: 'Spamfilter match details'}) 576 | } 577 | 578 | /** returns spam match (true) if self addressed email (sender === receiver address) doesn't include account owner's full name */ 579 | function testSelfAddressedForFullName (accountEmail, message) { 580 | var from = message.getField('sender') 581 | if (from == "") return true // no sender provided 582 | if (from.includes(accountEmail)) { 583 | const res = !from.includes(message.mailbox.account.fullName) 584 | if (res) alertMatchDetails('Sender == receiver test', 'Self addressed without full name') 585 | return res 586 | } 587 | return false 588 | } 589 | 590 | /** returns spam match (true) if sender's name consists of only one word not included in whitelist and whitelist.shouldTest == true */ 591 | function testSenderForFullName (whitelist, message) { 592 | if (!whitelist.shouldTest) return false 593 | const from = message.getField('sender') 594 | const addressIdx = from.indexOf("<") // e.g. X Y 595 | if (addressIdx <= 0) return false 596 | const name = from.substring(0, addressIdx).trim().replace(/"/g, '') 597 | if (name === "" || name.indexOf(" ") > 0) return false 598 | const res = !whitelist.list.includes(name) 599 | if (res) alertMatchDetails('Sender with full name test', 'Found only one word') 600 | return res 601 | } 602 | 603 | /** returns spam match (true) if at least one entry in blacklist matches */ 604 | function testHeaders (headerBlacklist, message) { 605 | if (!headerBlacklist) return false 606 | 607 | return headerBlacklist.some(function(item) { 608 | return testMessageField(item.name, item, message) 609 | }) 610 | } 611 | 612 | /** tests for matches between message field and blacklist */ 613 | function testMessageField (field, blacklist, message) { 614 | const searchContent = message.getField(field) 615 | 616 | if (field === "source") { 617 | // determine boundary for multipart messages 618 | //const headers = message.allHeaders() 619 | var boundary = '' 620 | } else { // i.e. sender, subject 621 | if (searchContent.length == 0) return false 622 | 623 | // delete unicode cheat chars 624 | const normalizedContent = cheatChars.reduce(function(res, item) { 625 | return res.replace(new RegExp(item, 'g'), '') 626 | }, searchContent) 627 | 628 | return blacklist.list.some(function(item) { 629 | // skip empty strings created by accident 630 | if (item.length === 0) return false 631 | 632 | const res = normalizedContent.includes(item); // true if match in blacklist 633 | if (res) alertMatchDetails('Field "'+ field +'"', item) 634 | return res 635 | }) 636 | } 637 | 638 | // search message body from raw source 639 | var initSearchPos = 0 640 | const messageComponentsHandler = new MessageComponentsHandler(searchContent, initSearchPos, boundary) 641 | while (messageComponentsHandler.hasNextPart()) { 642 | // search for blacklist item within current message part 643 | var part = messageComponentsHandler.getNextPart(); 644 | if (part === false) 645 | // message not searchable 646 | return false; 647 | 648 | // check for evil file name or file extensions 649 | if (part.fileName !== null) { 650 | if (fileExtensions.some(function(c) { 651 | const res = part.fileName.indexOf(c) >= 0 652 | if (res) alertMatchDetails('File extension', c) 653 | return res 654 | }) 655 | ) 656 | return true 657 | continue 658 | } 659 | // check for evil charsets 660 | if (part.type !== null) { 661 | if (charsetBlacklist.some(function(c) { 662 | const res = part.type.indexOf(c) >= 0 663 | if (res) alertMatchDetails('Charset', c) 664 | return res 665 | }) 666 | ) 667 | return true 668 | } 669 | 670 | var searchTarget = searchContent 671 | var searchPartStart = part.start 672 | 673 | if (part.encoding === "base64" || part.type.indexOf("html") >= 0 674 | || part.encoding === "quoted-printable") { 675 | // choose decoded string as search target 676 | var decodedContent = part.decode(searchTarget) 677 | if (typeof decodedContent !== "undefined") { 678 | searchTarget = decodedContent 679 | searchPartStart = 0 // decoded text is unrelated to part positioning of original message! 680 | } 681 | } 682 | 683 | var searchPart = searchTarget.substring(searchPartStart, part.end) 684 | 685 | // check for cheating zero-width spaces once per message part 686 | if (messageComponentsHandler.isParsed === false && cheatChars.some(function(c) { 687 | const idx = searchPart.indexOf(c, 1), res = idx > 0 688 | if (res) { 689 | const unicode = 'U+'+ c.codePointAt(0).toString(16).toUpperCase() 690 | alertMatchDetails('Cheat char at idx '+ idx, unicode) 691 | } 692 | return res 693 | }) 694 | ) 695 | return true // cheat char detected => spam mail 696 | 697 | if (blacklist.list.some(function(item) { 698 | const res = searchPart.indexOf(item) !== -1 && item.length > 0 699 | if (res) alertMatchDetails('Text content', item) 700 | return res 701 | }) 702 | ) 703 | return true // match in blacklist 704 | } 705 | return false // no matches in blacklist 706 | } 707 | 708 | // helper functions 709 | /** includes all properties and actions required for message part handling */ 710 | function MessagePart (start, end, type, encoding) { 711 | this.start = start // start position of message part content 712 | this.end = end // end position of message part content 713 | this.type = type.toLowerCase() // content-type of message part 714 | this.fileName = null // set if part contains a binary file 715 | this.encoding = encoding.toLowerCase() // content-transfer-encoding of message part 716 | this.multiBoundary = '' // boundary at the very end of the part (multipart/...) 717 | this.decoded = null // decoded message part content if raw data is b64 encoded or html entities might be included 718 | } 719 | /** sets end position of message part only if not already set */ 720 | MessagePart.prototype.setEnd = function(e) { 721 | if (this.end === 0) this.end = e 722 | } 723 | 724 | /** true, when end position is set */ 725 | MessagePart.prototype.hasEnd = function() { 726 | return this.end !== 0 727 | } 728 | 729 | /** sets and returns decoded message part content if raw data is b64/qp encoded; normalize umlauts and decode &#ddd; chars in html*/ 730 | MessagePart.prototype.decode = function(rawMsg) { 731 | if (this.decoded !== null) return this.decoded 732 | 733 | // extract charset from content-type 734 | var charset = "", charsetIdx = this.type.indexOf("charset=") 735 | if (charsetIdx > 0) { 736 | charset = this.type.substr(charsetIdx+8).trim() 737 | if (charset[0] === '"') // omit leading/ trailing quote marks 738 | charset = charset.substr(1, charset.length-2).trim() 739 | } 740 | 741 | var inputStr = rawMsg.substring(this.start, this.end) // encoded message part 742 | 743 | // handle transfer encoding 744 | if (this.encoding === "base64") { 745 | const firstLine = inputStr.substring(0, 80) 746 | if (firstLine && firstLine.indexOf(" ") >= 0) { 747 | this.decoded = inputStr 748 | console.log("not a real base64 encoding") 749 | } else { 750 | var wsFreeStr = inputStr.replace(/\s+/g, "") 751 | if (wsFreeStr.startsWith("77u/")) // skip binary indicator before decode 752 | wsFreeStr = wsFreeStr.substring(4) 753 | this.decoded = b64DecodeUnicode(wsFreeStr, charset) 754 | } 755 | } 756 | else if (this.encoding === "quoted-printable") { 757 | this.decoded = qpDecodeUnicode(inputStr, charset) 758 | } 759 | 760 | if (this.type.indexOf("html") >= 0) { 761 | if (this.decoded == null) this.decoded = inputStr 762 | this.decoded = htmlDecodeUnicode(this.decoded) 763 | } 764 | return this.decoded 765 | } 766 | 767 | /** returns content of next specified header as well as start and end position of the header line relative to searchContent */ 768 | function getLocalHeader (headerName, searchContent, startPos) { 769 | headerName += ":" 770 | // find first occurence case-insensitive, e.g., "\nContent-Type:" or "\ncontent-type:" 771 | var headerStartPos = searchContent.substring(startPos) 772 | .search(new RegExp("\\n"+ headerName, "i")) 773 | if (headerStartPos === -1) return false // header not found 774 | 775 | // make index from substring() relative to searchContent and skip leading "\n" by +1 776 | headerStartPos += startPos + 1 777 | 778 | var headerEndPos = searchContent.indexOf("\n", headerStartPos + headerName.length) 779 | var line = searchContent.substring(headerStartPos + headerName.length, headerEndPos).trim() 780 | var lineEndPos = headerEndPos 781 | 782 | while (line[line.length-1] === ";") { 783 | // another parameter in next line 784 | headerEndPos = searchContent.indexOf("\n", headerEndPos+1) 785 | // skip empty lines 786 | if (headerEndPos-1 === lineEndPos) continue 787 | 788 | line = searchContent.substring(lineEndPos+1, headerEndPos).trim() 789 | lineEndPos = headerEndPos 790 | } 791 | 792 | return {headerContent: searchContent.substring(headerStartPos + headerName.length, headerEndPos).trim(), 793 | lineStartPos: headerStartPos, 794 | lineEndPos: headerEndPos} 795 | } 796 | 797 | /** Parses message body and builds list of message parts */ 798 | function MessageComponentsHandler (rawMessage, contentStartPos, boundary) { 799 | this.rawMessage = rawMessage 800 | this.contentStartPos = contentStartPos 801 | this.searchPos = contentStartPos 802 | this.boundary = boundary 803 | this.boundaryList = boundary ? [boundary] : [] 804 | this.partsList = [] 805 | this.partIdx = 0 // INTERNAL part index 806 | this.isParsed = false 807 | } 808 | MessageComponentsHandler.prototype.hasNextPart = function() { 809 | return (this.partsList.length > this.partIdx) || !this.isParsed 810 | } 811 | 812 | MessageComponentsHandler.prototype.resetIterator = function() { 813 | this.partIdx = 0 814 | } 815 | MessageComponentsHandler.prototype.getNextPart = function() { 816 | if (!this.hasNextPart()) 817 | // index out of bounds 818 | return false 819 | 820 | if (this.isParsed === true) 821 | // get message part set during iteration for previous search item 822 | return this.partsList[this.partIdx++] 823 | 824 | // search for further content headers as long as list of parts is incomplete 825 | var contentTransEncoding = getLocalHeader("Content-Transfer-Encoding", this.rawMessage, this.searchPos) 826 | var contentType = getLocalHeader("Content-Type", this.rawMessage, this.searchPos) 827 | 828 | if ((contentTransEncoding || contentType) == false) { 829 | // no more relevant search content left 830 | this.isParsed = true 831 | this.resetIterator() 832 | return false 833 | } 834 | 835 | // define new additional message part 836 | if (!contentTransEncoding || !contentType) { 837 | var beyondHeadersPos = contentType.lineEndPos 838 | var dummy = {headerContent: "", lineStartPos: undefined, lineEndPos: undefined} 839 | if (beyondHeadersPos == undefined) { 840 | contentType = dummy 841 | beyondHeadersPos = contentTransEncoding.lineEndPos 842 | } else 843 | contentTransEncoding = dummy 844 | } else { 845 | var minHeader = Math.min(contentType.lineEndPos, contentTransEncoding.lineEndPos) 846 | var corruptedHeader = this.rawMessage.indexOf("\n\n", minHeader) 847 | if (contentType.lineEndPos > corruptedHeader || contentTransEncoding.lineEndPos > corruptedHeader) { 848 | // one of the two headers is missing 849 | var beyondHeadersPos = contentType.lineEndPos 850 | contentTransEncoding.headerContent = "" // header for wrong part 851 | } else 852 | var beyondHeadersPos = Math.max(contentType.lineEndPos, contentTransEncoding.lineEndPos) // points to first \n after headers 853 | } 854 | 855 | var freeLinePos = this.rawMessage.indexOf("\n\n", beyondHeadersPos) 856 | var part = new MessagePart( 857 | freeLinePos+2, 858 | 0, 859 | contentType.headerContent, 860 | contentTransEncoding.headerContent 861 | ) 862 | 863 | var innerBoundary = MessageComponentsHandler.getBoundary(contentType.headerContent) 864 | if (innerBoundary !== "") { 865 | part.multiBoundary = innerBoundary 866 | this.boundaryList.push(innerBoundary) 867 | part.start-- 868 | } 869 | 870 | var searchable = this.determineSearchableContent(part) 871 | if (searchable === -1) { 872 | // only, e.g., binary base64 content left 873 | this.isParsed = true 874 | return false 875 | } 876 | if (searchable === -2) 877 | // parse remaining message content 878 | return this.getNextPart() 879 | 880 | // determine end of part 881 | this.determinePartEnd(part) 882 | 883 | this.partsList.push(part) 884 | this.searchPos = part.end + 1 // proceed with next message part 885 | this.partIdx++ 886 | return part 887 | } 888 | 889 | MessageComponentsHandler.prototype.determineSearchableContent = function(part) { 890 | // binary data only searchable by filename and file extensions 891 | if (part.type.includes("application/")) { 892 | var fileNameStart = part.type.indexOf("name=", 12) 893 | var fileNameEnd = part.type.indexOf("\n", fileNameStart+5) 894 | if (fileNameEnd < 0) fileNameEnd = part.type.length 895 | part.fileName = part.type.substring(fileNameStart, fileNameEnd) 896 | return true 897 | } 898 | 899 | // multipart component treated as empty message part 900 | if (part.type.includes("multipart/")) { 901 | /*var firstChildPos = this.rawMessage.indexOf(part.multiBoundary, part.start); 902 | part.setEnd(firstChildPos + part.multiBoundary.length);*/ 903 | return true 904 | } 905 | 906 | if (part.encoding !== "base64" || part.type.includes("text/") 907 | || part.type.includes("message/")) 908 | return true 909 | 910 | // only accessed once per base64 part, because messagePartsList excludes them 911 | if (this.boundaryList.length === 0) { 912 | part.setEnd(this.rawMessage.length-1) 913 | return -1 // whole message is non-text => can't search 914 | } 915 | 916 | var pos = -1, i = this.boundaryList.length-1 917 | for (i; i>-1; i--) { 918 | var pos = this.rawMessage.indexOf(this.boundaryList[i], part.start) 919 | if (pos > -1) break 920 | } 921 | this.searchPos = pos // skip message part 922 | 923 | // remove last boundary from list if not used anymore 924 | if (i < this.boundaryList.length-1) 925 | this.boundaryList.pop() 926 | 927 | this.searchPos += this.boundaryList[i].length 928 | return -2 // don't append to messagePartsList 929 | } 930 | 931 | MessageComponentsHandler.prototype.determinePartEnd = function(part) { 932 | // determine search limit 933 | if (this.boundaryList.length === 0) { 934 | // message consists of 1 part 935 | part.setEnd(this.rawMessage.length-1) 936 | return 937 | } 938 | 939 | // determine end position for search within current part 940 | if (part.end < 1) { 941 | var searchPartEnd = -1, i = this.boundaryList.length-1 942 | for (i; i>-1; i--) { 943 | var searchPartEnd = this.rawMessage.indexOf(this.boundaryList[i], part.start) 944 | if (searchPartEnd > -1) break 945 | } 946 | // remove last boundary from list if not used anymore 947 | if (i < this.boundaryList.length-1) 948 | this.boundaryList.pop() 949 | } else 950 | var searchPartEnd = part.end 951 | 952 | if (searchPartEnd-- === -1) 953 | searchPartEnd = this.rawMessage.length-1 // if missing final boundary 954 | 955 | // hardening against inconsistent boundaries 956 | var lastNewLinePos = this.rawMessage.lastIndexOf("\n", searchPartEnd) 957 | 958 | part.setEnd(lastNewLinePos) 959 | } 960 | 961 | 962 | /** extract boundary from given content-type header string if possible*/ 963 | MessageComponentsHandler.getBoundary = function(str){ 964 | var boundaryPos = str.indexOf("boundary="), boundary = "" 965 | if (boundaryPos !== -1) { 966 | boundary = str.substr(boundaryPos+9).trim() 967 | if (boundary[0] == '"') 968 | boundary = boundary.substr(1, boundary.length-2) // omit enclosing quotes 969 | // omit leading and trailing sequences of '-' 970 | boundary = boundary.replace(/^-+|-+$/g, '') 971 | } 972 | return boundary 973 | } 974 | 975 | 976 | /** html special entities decoding function */ 977 | function htmlDecodeUnicode (rawStr, charset = "") { 978 | var idx = 0, res = '' 979 | var htmlEntities = {"ä":"ä", "Ä":"Ä", "ö":"ö", "&Öuml;":"Ö", "ü":"ü", "Ü":"Ü", "ß":"ß", "‌":"", "<\/?[Ss][^>]*>":"", "<\/?(?:font|FONT)[^>]*>":"" /*, "Ȁ[cC];":"","ä":"ä", "Ä":"Ä", "ö":"ö", "Ö":"Ö", "ü":"ü", "Ü":"Ü", "ß":"ß", "€":"€"*/} 980 | // code points of, e.g., ‌ 981 | var customCodePointRplc = {"8204":"", "65279":"", "x200c":"", "x200C":""} 982 | 983 | var regexMap = {} 984 | for (var str in htmlEntities) { 985 | regexMap[str] = new RegExp(str, "g") 986 | } 987 | 988 | var delimiter = null, maxDelimiterOffset = 0 989 | 990 | while (idx < rawStr.length) { 991 | if (rawStr[idx] === '&') { 992 | // special html entities 993 | delimiter = ';' 994 | maxDelimiterOffset = 7 995 | } 996 | else if (rawStr[idx] === '<') { 997 | // html tags 998 | delimiter = '>' 999 | maxDelimiterOffset = 30 1000 | } 1001 | else { 1002 | res += rawStr[idx++] 1003 | continue 1004 | } 1005 | 1006 | // determine offset of end delimiter 1007 | var delimiterFound = false 1008 | for (var delimiterOffset=2; delimiterOffset <= maxDelimiterOffset; delimiterOffset++) { 1009 | if (idx + delimiterOffset >= rawStr.length) break 1010 | 1011 | if (rawStr[idx + delimiterOffset] === delimiter) { 1012 | delimiterFound = true 1013 | break 1014 | } 1015 | } 1016 | if (delimiterFound) { 1017 | var entity = '' 1018 | if (delimiter === ';' && rawStr[idx+1] === '#') { 1019 | // decode all special decimal entities to unicode chars 1020 | entity = rawStr.substr(idx+2, delimiterOffset-2) 1021 | if (customCodePointRplc[entity] !== undefined) 1022 | entity = customCodePointRplc[entity] 1023 | else 1024 | entity = String.fromCodePoint(entity | 0) 1025 | } 1026 | else { 1027 | entity = rawStr.substr(idx, delimiterOffset+1) 1028 | for (var str in htmlEntities) { 1029 | // replace with unicode char/ empty string if regex matches htmlEntities 1030 | entity = entity.replace(regexMap[str], htmlEntities[str]) 1031 | } 1032 | } 1033 | res += entity 1034 | idx += delimiterOffset + 1 1035 | } 1036 | else 1037 | res += rawStr[idx++] // no special entity 1038 | } 1039 | return res 1040 | } 1041 | 1042 | /** base64 decoding function */ 1043 | function b64DecodeUnicode (rawStr, charset = "") { 1044 | var arr = base64Handler.decode(rawStr) 1045 | if (charset === "iso-8859-1") 1046 | return decodeBinaryAsIso88591Str(arr) 1047 | return decodeBinaryAsUtf8Str(arr) 1048 | } 1049 | 1050 | /** QuotedPrintable decoding function */ 1051 | function qpDecodeUnicode (rawStr, charset = "") { 1052 | var res = QuotedPrintableHandler.decode(rawStr) 1053 | //mail.displayDialog(res.arr.toString()); 1054 | if (charset === "iso-8859-1") 1055 | return decodeBinaryAsIso88591Str(res.arr, res.length) 1056 | return decodeBinaryAsUtf8Str(res.arr, res.length) 1057 | } 1058 | 1059 | /** takes UTF-8 byte array and converts to unicode string */ 1060 | function decodeBinaryAsUtf8Str (arr, len = 0) { 1061 | var res = '' 1062 | var idx = 0, arrLength = len > 0 ? len : arr.length 1063 | 1064 | /* 1 byte char 0x00 0xxxxxxx; 0x80 10000000 bitmask 1065 | 2 byte char 0xC0 110xxxxx; 0xE0 11100000 bitmask 1066 | 3 byte char 0xE0 1110xxxx; 0xF0 11110000 bitmask 1067 | 4 byte char 0xF0 11110xxx; 0xF8 11111000 bitmask 1068 | following byte 0x80 10xxxxxx; 0xC0 11000000 bitmask 1069 | */ 1070 | while (idx < arrLength) { 1071 | if ((arr[idx] & 0x80) === 0x00) { // 1 byte char 1072 | res += String.fromCharCode(arr[idx++]) 1073 | } 1074 | else if ((arr[idx] & 0xE0) === 0xC0 && (arr[idx+1] & 0xC0) === 0x80) { 1075 | // 2 bytes char 1076 | res += String.fromCharCode(((arr[idx++]&0x1F) << 6) | (arr[idx++]&0x3F)) 1077 | } 1078 | else if ((arr[idx] & 0xF0) === 0xE0 && (arr[idx+1] & 0xC0) === 0x80 1079 | && (arr[idx+2] & 0xC0) == 0x80) { 1080 | // 3 bytes char 1081 | var code = ((arr[idx++]&0x0F) << 12) | ((arr[idx++]&0x3F) << 6) 1082 | | (arr[idx++]&0x3F) 1083 | try { 1084 | res += String.fromCodePoint(code) 1085 | } catch (e){ 1086 | //console.log('decoded part: '+res) 1087 | //console.log('error 3 bytes: '+e + ', '+ code.toString(16)) 1088 | res += code == 0xEFBBBF ? '\uFEFF' : '\uFFFD' 1089 | } 1090 | } 1091 | else if ((arr[idx] & 0xF8) === 0xF0 && (arr[idx+1] & 0xC0) === 0x80 1092 | && (arr[idx+2] & 0xC0) === 0x80 && (arr[idx+3] & 0xC0) === 0x80) { 1093 | // 4 bytes char 1094 | var code = ((arr[idx++]&0x07) << 18) | ((arr[idx++]&0x3F) << 12) | ((arr[idx++]&0x3F) << 6) 1095 | | (arr[idx++]&0x3F) 1096 | try { 1097 | res += String.fromCodePoint(code) 1098 | } catch (e) { 1099 | //console.log('decoded part: '+res) 1100 | //console.log('error 4 bytes: '+e + ', '+ code.toString(16)) 1101 | res += code == 0xEFBBBF ? '\uFEFF' : '\uFFFD' 1102 | } 1103 | } 1104 | else { 1105 | res += '\uFFFD' 1106 | idx++ 1107 | } 1108 | } 1109 | //console.log('decoded unicode: '+res) 1110 | return res 1111 | } 1112 | 1113 | /** takes ISO 8859-1 (Latin-1) byte array and converts to unicode string */ 1114 | function decodeBinaryAsIso88591Str (arr, len = 0) { 1115 | var res = '' 1116 | var idx = 0, arrLength = len > 0 ? len : arr.length 1117 | 1118 | for (idx; idx 0 && (len+2) % 4 > 0) { 1142 | console.log("error: "+len+' '+b64.slice(-50)); 1143 | throw new Error('Invalid string. Length '+len+' must be a multiple of 4') 1144 | } 1145 | return b64[len - 2] === '=' ? 2 : b64[len - 1] === '=' ? 1 : 0 1146 | } 1147 | 1148 | function byteLength (b64) { 1149 | // base64 is 4/3 + up to two characters of the original data 1150 | return (b64.length * 3 / 4) - placeHoldersCount(b64) 1151 | } 1152 | 1153 | return {decode: function (b64) { 1154 | var i, j, l, tmp, placeHolders, arr 1155 | var len = b64.length 1156 | try { 1157 | placeHolders = placeHoldersCount(b64) 1158 | } catch (err) { 1159 | mail.displayDialog("B64 decode error: " + err.message); 1160 | return null 1161 | } 1162 | arr = new Arr((len * 3 / 4) - placeHolders) 1163 | 1164 | // if there are placeholders, only get up to the last complete 4 chars 1165 | l = placeHolders > 0 ? len - 4 : len 1166 | var L = 0 1167 | 1168 | for (i = 0, j = 0; i < l; i += 4, j += 3) { 1169 | tmp = (revLookup[b64.charCodeAt(i)] << 18) | (revLookup[b64.charCodeAt(i + 1)] << 12) | (revLookup[b64.charCodeAt(i + 2)] << 6) | revLookup[b64.charCodeAt(i + 3)] 1170 | arr[L++] = (tmp >> 16) & 0xFF 1171 | arr[L++] = (tmp >> 8) & 0xFF 1172 | arr[L++] = tmp & 0xFF 1173 | } 1174 | 1175 | if (placeHolders === 2) { 1176 | tmp = (revLookup[b64.charCodeAt(i)] << 2) | (revLookup[b64.charCodeAt(i + 1)] >> 4) 1177 | arr[L++] = tmp & 0xFF 1178 | } else if (placeHolders === 1) { 1179 | tmp = (revLookup[b64.charCodeAt(i)] << 10) | (revLookup[b64.charCodeAt(i + 1)] << 4) | (revLookup[b64.charCodeAt(i + 2)] >> 2) 1180 | arr[L++] = (tmp >> 8) & 0xFF 1181 | arr[L++] = tmp & 0xFF 1182 | } 1183 | return arr} 1184 | } 1185 | })() 1186 | 1187 | // based on https://github.com/ronomon/quoted-printable/blob/master/index.js and https://github.com/mathiasbynens/quoted-printable/blob/master/src/quoted-printable.js 1188 | const QuotedPrintableHandler = (function () { 1189 | var Arr = typeof Uint8Array !== 'undefined' ? Uint8Array : Array 1190 | var decodeTable = (function(){ 1191 | var alphabet = '0123456789ABCDEFabcdef' 1192 | var table = new Arr(256) 1193 | for (var index = 0, length = alphabet.length; index < length; index++) { 1194 | var char = alphabet[index]; 1195 | // Add 1 to all values so that we can detect hex digits with the same table. 1196 | // Subtract 1 when needed to get to the integer value of the hex digit. 1197 | table[char.charCodeAt(0)] = parseInt(char, 16) + 1; 1198 | } 1199 | return table 1200 | })() 1201 | 1202 | return {decode: function (src, useQEncoding = false) { 1203 | var getLineBreakSize = function(){ 1204 | if (byteSrc[sIdx] === 13 && sIdx+1 < len && byteSrc[sIdx+1] === 10) 1205 | return 2 1206 | if (byteSrc[sIdx] === 13 || byteSrc[sIdx] === 10) 1207 | return 1 1208 | return 0 1209 | } 1210 | var len = src.length, byteSrc = new Arr(len), res = new Arr(len) 1211 | 1212 | // convert char to binary 1213 | for (var i=0; i transport encoding 1235 | resIdx-- 1236 | sIdx += getLineBreakSize() 1237 | } 1238 | else { 1239 | // add line break CR and/or LF 1240 | for (var i = getLineBreakSize(); i>0; i--) 1241 | res[resIdx++] = byteSrc[sIdx++] 1242 | } 1243 | } 1244 | else if (useQEncoding === true && byteSrc[sIdx] === 95) { 1245 | // replace '_' with ' ' 1246 | res[resIdx++] = 32 1247 | sIdx++ 1248 | } 1249 | else { 1250 | res[resIdx++] = byteSrc[sIdx++] 1251 | } 1252 | } 1253 | 1254 | // remove trailing whitespace padding 1255 | var rewindIdx = sIdx 1256 | while (resIdx > 0 && rewindIdx > 0 1257 | && (byteSrc[rewindIdx-1] === 9 || byteSrc[rewindIdx-1] === 32)) { 1258 | resIdx-- 1259 | rewindIdx-- 1260 | } 1261 | 1262 | return {arr: res, length: resIdx+1}} 1263 | } 1264 | })() 1265 | 1266 | 1267 | // Mail JXA API wrappers 1268 | function Message(raw) { 1269 | this._raw = raw 1270 | this._id = null 1271 | this._mailbox = null 1272 | } 1273 | Object.defineProperties(Message.prototype, { 1274 | 'id': {get: function(){return this._id || (this._id = this._raw.id()) }}, 1275 | 'mailbox': {get: function(){ 1276 | return this._mailbox || (this._mailbox = new Mailbox(this._raw.mailbox())) }}, 1277 | 'junkMailStatus': {get: function(){return this._raw.junkMailStatus()}, 1278 | set: function(status){this._raw.junkMailStatus = status }}, 1279 | 'readStatus': {get: function(){ 1280 | if (this._raw && this._raw.readStatus) { 1281 | try { 1282 | return this._raw.readStatus() 1283 | } catch (e) { 1284 | console.log('readStatus exception: ['+ e.name +'] '+ e.message) 1285 | return null 1286 | } 1287 | } else { 1288 | console.log('raw message object not found') 1289 | return null 1290 | } 1291 | }} 1292 | }) 1293 | Message.prototype.moveToMailbox = function(box){ 1294 | this._raw.mailbox = box._raw() 1295 | this._mailbox = new Mailbox(box._raw) 1296 | } 1297 | Message.prototype.getField = function(key){ 1298 | if (this[key]) return this[key] 1299 | 1300 | try { 1301 | this[key] = this._raw[key]() 1302 | } catch (err) { 1303 | //const header = this._raw.headers.byName(key) 1304 | const headersFiltered = this._raw.headers.whose({name: {_equals: key}}), 1305 | header = Array.prototype.reduce.call(headersFiltered, (acc, item) => { 1306 | return `${acc}\n ${item.content()}` 1307 | }, '') 1308 | 1309 | this[key] = header 1310 | } 1311 | 1312 | return this[key] 1313 | } 1314 | 1315 | function Mailbox(raw) { 1316 | this._raw = raw 1317 | this._name = null 1318 | this._account = null 1319 | this._messageList = null // big array 1320 | this._messages = null // raw objects 1321 | this.lazyMessageList = null 1322 | } 1323 | Object.defineProperties(Mailbox.prototype, { 1324 | 'name': {get: function(){return this._name || (this._name = this._raw.name()) }}, 1325 | 'account': {get: function(){ 1326 | return this._account || (this._account = new Account(this._raw.account())) }}, 1327 | 'unreadCount': {get: function(){return this._raw.unreadCount() }}, 1328 | 'messageList': {get: function(){ // possibly very big array 1329 | return this._messageList || (this._messageList = this._raw.messages() 1330 | .map(function(raw){return new Message(raw)})) }}, 1331 | 'messageCount': {get: function(){ 1332 | if (!this._messages) this._messages = this._raw.messages() 1333 | return this._messages.length }} 1334 | }) 1335 | Mailbox.prototype.getMessageByIndex = function(idx){ 1336 | if (!this._messages) this._messages = this._raw.messages() 1337 | if (!this.lazyMessageList) this.lazyMessageList = [] 1338 | if (!this.lazyMessageList[idx]) 1339 | this.lazyMessageList[idx] = new Message(this._messages[idx]) 1340 | return this.lazyMessageList[idx] 1341 | } 1342 | Mailbox.prototype.refreshMessageList = function(){ 1343 | this._messages = this._raw.messages() 1344 | this._messageList = null 1345 | this.lazyMessageList = null 1346 | } 1347 | 1348 | function Account(raw) { 1349 | this._raw = raw 1350 | this._id = null 1351 | this._name = null 1352 | this._fullName = null 1353 | this._emailAddresses = null 1354 | this._mailboxes = null 1355 | } 1356 | Object.defineProperties(Account.prototype, { 1357 | 'id': {get: function(){return this._id || (this._id = this._raw.id()) }}, 1358 | 'name': {get: function(){return this._name || (this._name = this._raw.name()) }}, 1359 | 'fullName': {get: function(){ 1360 | return this._fullName || (this._fullName = this._raw.fullName()) }}, 1361 | 'emailAddressList': {get: function(){ 1362 | return this._emailAddresses || (this._emailAddresses = this._raw.emailAddresses()) }}, 1363 | 'mailboxList': {get: function(){ 1364 | return this._mailboxes || (this._mailboxes = this._raw.mailboxes() 1365 | .map(function(raw){return new Mailbox(raw)})) }} 1366 | }) 1367 | --------------------------------------------------------------------------------