Skip to main content

glossary

global​

auth​

  • fn create_header(ctx: State<StatefulCtxReceived>, params: ?) -> String
  • fn add_header(ctx: State<StatefulCtxReceived>, params: ?) -> ()

context​

  • fn to_debug(ctx: State<StatefulCtxReceived>) -> String
  • fn set_routing_path(ctx: State<StatefulCtxReceived>, rcpt: Recipient>, path: String) -> Result<()>
  • fn client_address(ctx: State<StatefulCtxReceived>) -> String
  • fn get client_ip(ctx: State<StatefulCtxReceived>) -> String
  • fn client_port(ctx: State<StatefulCtxReceived>) -> int
  • fn server_address(ctx: State<StatefulCtxReceived>) -> String
  • fn server_ip(ctx: State<StatefulCtxReceived>) -> String
  • fn server_port(ctx: State<StatefulCtxReceived>) -> int
  • fn connection_timestamp(ctx: State<StatefulCtxReceived>) -> OffsetDateTime
  • fn server_name(ctx: State<StatefulCtxReceived>) -> String
  • fn is_secured(_ctx: State<StatefulCtxReceived>) -> bool
  • fn get helo(ctx: State<StatefulCtxReceived>) -> Result<String>
  • fn get sender(ctx: State<StatefulCtxReceived>) -> ?>
  • fn get recipients(ctx: State<StatefulCtxReceived>) -> Array>
  • fn get domain(ctx: Mailbox) -> String
  • fn get domain(ctx: Recipient>) -> String
  • fn get local_part(ctx: Recipient>) -> String
  • fn get address(ctx: Recipient>) -> String
  • fn get is_null(mailbox: ?) -> bool
  • fn mail_timestamp(ctx: State<StatefulCtxReceived>) -> OffsetDateTime>
  • fn get message_id(ctx: State<StatefulCtxReceived>) -> Result<String>

crypto​

  • fn load_pem_rsa_pkcs8_file(filepath: String) -> EvalAltResult>>
  • fn load_pem_rsa_pkcs1_file(filepath: String) -> EvalAltResult>>
  • fn load_pem_ed_pkcs8_file(filepath: String) -> EvalAltResult>>

dkim​

  • fn create_sign(mail: RwLock<Mail>>, params: ?) -> String
  • fn add_signature(mail: RwLock<Mail>>, params: ?) -> ()
  • fn to_debug(v: Shared<Vec<DkimVerificationResult>>) -> String
  • fn verify(ctx: RwLock<Mail>>, params: ?) -> Shared<Vec<DkimVerificationResult>>
  • fn store(ctx: State<StatefulCtxReceived>, dkim_result: Shared<Vec<DkimVerificationResult>>) -> ()

dmarc​

  • op ==(lhs: Value, rhs: String) -> bool
  • op !=(lhs: Value, rhs: String) -> bool
  • fn get value(res: Dmarc>) -> Value
  • fn get policy(res: Dmarc>) -> String
  • fn check(ctx: State<StatefulCtxReceived>, params: ?) -> Dmarc>
  • fn store(ctx: State<StatefulCtxReceived>, dmarc_result: Dmarc>) -> ()

dns​

  • fn resolver(params: ?) -> Result<DnsResolver>
  • fn lookup(dns: DnsResolver, host: String) -> Array>
  • fn rlookup(dns: DnsResolver, ip: String) -> Array>

envelop​

  • fn rw_mail_from(ctx: State<StatefulCtxReceived>, new_addr: String) -> Result<()>
  • fn rw_rcpt(ctx: State<StatefulCtxReceived>, old_addr: String, new_addr: String) -> Result<()>
  • fn add_rcpt(ctx: State<StatefulCtxReceived>, new_addr: String) -> Result<()>
  • fn bcc(ctx: State<StatefulCtxReceived>, new_addr: String) -> Result<()>
  • fn rm_rcpt(ctx: State<StatefulCtxReceived>, addr: String) -> Result<()>

iprev​

  • fn to_debug(res: IpRevResult) -> String
  • op ==(lhs: Value, rhs: String) -> bool
  • op !=(lhs: Value, rhs: String) -> bool
  • fn get value(res: IpRevResult) -> Value
  • fn check(params: ?) -> IpRevResult
  • fn store(ctx: State<StatefulCtxReceived>, iprev: IpRevResult)

message​

  • fn mail_str(ctx: State<StatefulCtxReceived>) -> Result<String>
  • fn get mail(ctx: State<StatefulCtxReceived>) -> RwLock<Mail>>>
  • fn to_debug(mail: RwLock<Mail>>) -> String
  • fn has_header(ctx: State<StatefulCtxReceived>, header: String) -> Result<bool>
  • fn count_header(ctx: State<StatefulCtxReceived>, header: String) -> int>
  • fn get_header(ctx: State<StatefulCtxReceived>, header: String) -> ?>
  • fn get_all_headers(ctx: State<StatefulCtxReceived>) -> Array>
  • fn get_all_headers(ctx: State<StatefulCtxReceived>, name: String) -> Array>
  • fn get_header_untouched(ctx: State<StatefulCtxReceived>, name: String) -> Array>
  • fn append_header(ctx: State<StatefulCtxReceived>, name: String, body: String) -> Result<()>
  • fn prepend_header(ctx: State<StatefulCtxReceived>, header: String, value: String) -> Result<()>
  • fn set_header(ctx: State<StatefulCtxReceived>, header: String, value: String) -> Result<()>
  • fn rename_header(ctx: State<StatefulCtxReceived>, old: String, new: String) -> Result<()>
  • fn rm_header(ctx: State<StatefulCtxReceived>, header: String) -> Result<bool>
  • fn rw_mail_from(ctx: State<StatefulCtxReceived>, new_addr: String) -> Result<()>
  • fn rw_rcpt(ctx: State<StatefulCtxReceived>, old_addr: String, new_addr: String) -> Result<()>
  • fn add_rcpt(ctx: State<StatefulCtxReceived>, new_addr: String) -> Result<()>
  • fn rm_rcpt(ctx: State<StatefulCtxReceived>, addr: String) -> Result<()>
  • fn body_string(ctx: State<StatefulCtxReceived>) -> Result<String>

net​

  • fn rg_192() -> RangeIPv4
  • fn rg_172() -> RangeIPv4
  • fn rg_10() -> RangeIPv4
  • fn non_routable() -> Array

process​

  • fn to_debug(ctx: Shared<ProcessOutput>) -> String
  • fn get stderr(ctx: Shared<ProcessOutput>) -> String
  • fn get stdout(ctx: Shared<ProcessOutput>) -> String
  • fn run(args: ?) -> Shared<ProcessOutput>

sasl​

  • fn get is_authenticated(ctx: State<StatefulCtxReceived>) -> bool
  • fn get sasl(ctx: State<StatefulCtxReceived>) -> SaslAuthProps
  • fn get mechanism(ctx: SaslAuthProps) -> String
  • fn get authid(ctx: SaslAuthProps) -> String
  • fn get password(ctx: SaslAuthProps) -> String

spf​

  • fn to_debug(v: Shared<SpfResult>) -> String
  • op ==(lhs: Shared<SpfResult>, rhs: String) -> bool
  • op !=(lhs: Shared<SpfResult>, rhs: String) -> bool
  • fn store(ctx: State<StatefulCtxReceived>, identity: String, spf_result: Shared<SpfResult>) -> ()
  • fn check_host(params: ?) -> Shared<SpfResult>