API Reference

• aiospamc package
  • Submodules
  • aiospamc.cli module
    • Output
      • Output.Json
      • Output.Text
    • CliClientBuilder
      • CliClientBuilder.__init__()
      • CliClientBuilder.build()
      • CliClientBuilder.with_connection()
      • CliClientBuilder.set_timeout()
      • CliClientBuilder.add_verify()
      • CliClientBuilder.add_ca_cert()
      • CliClientBuilder.add_client_cert()
    • CommandRunner
      • CommandRunner.__init__()
      • CommandRunner.run()
      • CommandRunner.to_json()
      • CommandRunner.exit()
    • ping()
    • read_message()
    • check()
    • learn()
    • forget()
    • report()
    • revoke()
    • version_callback()
    • debug_callback()
    • main()
  • aiospamc.client module
    • Client
      • Client.__init__()
      • Client.request()
  • aiospamc.connections module
    • Timeout
      • Timeout.__init__()
    • ConnectionManagerBuilder
      • ConnectionManagerBuilder.ManagerType
      • ConnectionManagerBuilder.__init__()
      • ConnectionManagerBuilder.build()
      • ConnectionManagerBuilder.with_unix_socket()
      • ConnectionManagerBuilder.with_tcp()
      • ConnectionManagerBuilder.add_ssl_context()
      • ConnectionManagerBuilder.set_timeout()
    • ConnectionManager
      • ConnectionManager.__init__()
      • ConnectionManager.logger
      • ConnectionManager.request()
      • ConnectionManager.open()
      • ConnectionManager.connection_string
    • TcpConnectionManagerBuilder
      • TcpConnectionManagerBuilder.__init__()
      • TcpConnectionManagerBuilder.build()
      • TcpConnectionManagerBuilder.set_host()
      • TcpConnectionManagerBuilder.set_port()
      • TcpConnectionManagerBuilder.set_ssl_context()
      • TcpConnectionManagerBuilder.set_timeout()
    • TcpConnectionManager
      • TcpConnectionManager.__init__()
      • TcpConnectionManager.open()
    • UnixConnectionManagerBuilder
      • UnixConnectionManagerBuilder.__init__()
      • UnixConnectionManagerBuilder.build()
      • UnixConnectionManagerBuilder.set_path()
      • UnixConnectionManagerBuilder.set_timeout()
    • UnixConnectionManager
      • UnixConnectionManager.__init__()
      • UnixConnectionManager.open()
    • SSLContextBuilder
      • SSLContextBuilder.__init__()
      • SSLContextBuilder.build()
      • SSLContextBuilder.with_context()
      • SSLContextBuilder.add_ca_file()
      • SSLContextBuilder.add_ca_dir()
      • SSLContextBuilder.add_ca()
      • SSLContextBuilder.add_default_ca()
      • SSLContextBuilder.add_client()
      • SSLContextBuilder.dont_verify()
  • aiospamc.exceptions module
    • ClientException
    • BadRequest
    • BadResponse
    • AIOSpamcConnectionFailed
    • TimeoutException
    • ClientTimeoutException
    • ParseError
      • ParseError.__init__()
    • NotEnoughDataError
    • TooMuchDataError
  • aiospamc.frontend module
    • FrontendClientBuilder
      • FrontendClientBuilder.__init__()
      • FrontendClientBuilder.build()
      • FrontendClientBuilder.with_connection()
      • FrontendClientBuilder.add_verify()
      • FrontendClientBuilder.add_client_cert()
      • FrontendClientBuilder.set_timeout()
    • check()
    • headers()
    • ping()
    • process()
    • report()
    • report_if_spam()
    • symbols()
    • tell()
  • aiospamc.header_values module
    • HeaderValue
      • HeaderValue.__bytes__()
      • HeaderValue.to_json()
      • HeaderValue.__annotations_cache__
    • BytesHeaderValue
      • BytesHeaderValue.value
      • BytesHeaderValue.to_json()
      • BytesHeaderValue.__init__()
    • GenericHeaderValue
      • GenericHeaderValue.value
      • GenericHeaderValue.encoding
      • GenericHeaderValue.to_json()
      • GenericHeaderValue.__init__()
    • CompressValue
      • CompressValue.algorithm
      • CompressValue.to_json()
      • CompressValue.__init__()
    • ContentLengthValue
      • ContentLengthValue.length
      • ContentLengthValue.to_json()
      • ContentLengthValue.__init__()
    • MessageClassOption
      • MessageClassOption.spam
      • MessageClassOption.ham
    • MessageClassValue
      • MessageClassValue.value
      • MessageClassValue.to_json()
      • MessageClassValue.__init__()
    • ActionOption
      • ActionOption.local
      • ActionOption.remote
      • ActionOption.__init__()
    • SetOrRemoveValue
      • SetOrRemoveValue.action
      • SetOrRemoveValue.to_json()
      • SetOrRemoveValue.__init__()
    • SpamValue
      • SpamValue.value
      • SpamValue.score
      • SpamValue.threshold
      • SpamValue.to_json()
      • SpamValue.__init__()
    • UserValue
      • UserValue.name
      • UserValue.to_json()
      • UserValue.__init__()
    • Headers
      • Headers.get_header()
      • Headers.set_header()
      • Headers.get_bytes_header()
      • Headers.set_bytes_header()
      • Headers.compress
      • Headers.content_length
      • Headers.message_class
      • Headers.set_
      • Headers.remove
      • Headers.did_set
      • Headers.did_remove
      • Headers.spam
      • Headers.user
  • aiospamc.incremental_parser module
    • States
      • States.Status
      • States.Header
      • States.Body
      • States.Done
    • Parser
      • Parser.__init__()
      • Parser.state
      • Parser.parse()
      • Parser.status()
      • Parser.header()
      • Parser.body()
    • parse_request_status()
    • parse_response_status()
    • parse_message_class_value()
    • parse_content_length_value()
    • parse_compress_value()
    • parse_set_remove_value()
    • parse_spam_value()
    • parse_user_value()
    • parse_header_value()
    • parse_header()
    • parse_body()
    • header_value_parsers
    • RequestParser
      • RequestParser.__init__()
    • ResponseParser
      • ResponseParser.__init__()
  • aiospamc.requests module
    • Request
      • Request.__init__()
      • Request.body
      • Request.to_json()
  • aiospamc.responses module
    • Status
      • Status.EX_OK
      • Status.EX_USAGE
      • Status.EX_DATAERR
      • Status.EX_NOINPUT
      • Status.EX_NOUSER
      • Status.EX_NOHOST
      • Status.EX_UNAVAILABLE
      • Status.EX_SOFTWARE
      • Status.EX_OSERR
      • Status.EX_OSFILE
      • Status.EX_CANTCREAT
      • Status.EX_IOERR
      • Status.EX_TEMPFAIL
      • Status.EX_PROTOCOL
      • Status.EX_NOPERM
      • Status.EX_CONFIG
      • Status.EX_TIMEOUT
    • Response
      • Response.__init__()
      • Response.status_code
      • Response.body
      • Response.raise_for_status()
      • Response.to_json()
    • ResponseException
      • ResponseException.__init__()
    • UsageException
      • UsageException.__init__()
    • DataErrorException
      • DataErrorException.__init__()
    • NoInputException
      • NoInputException.__init__()
    • NoUserException
      • NoUserException.__init__()
    • NoHostException
      • NoHostException.__init__()
    • UnavailableException
      • UnavailableException.__init__()
    • InternalSoftwareException
      • InternalSoftwareException.__init__()
    • OSErrorException
      • OSErrorException.__init__()
    • OSFileException
      • OSFileException.__init__()
    • CantCreateException
      • CantCreateException.__init__()
    • IOErrorException
      • IOErrorException.__init__()
    • TemporaryFailureException
      • TemporaryFailureException.__init__()
    • ProtocolException
      • ProtocolException.__init__()
    • NoPermissionException
      • NoPermissionException.__init__()
    • ConfigException
      • ConfigException.__init__()
    • ServerTimeoutException
      • ServerTimeoutException.__init__()
  • aiospamc.user_warnings module
    • raise_warnings()
    • warn_spamd_bug_7183()
  • Module contents