1RT-MAILGATE(1) User Contributed Perl Documentation RT-MAILGATE(1)
2
6 rt-mailgate - Mail interface to RT.
7
9 rt-mailgate --help : this text
10 Usual invocation (from MTA):
12 rt-mailgate --action (correspond|comment|...) --queue queuename
14 --url http://your.rt.server/
15 [ --debug ]
16 [ --extension (queue|action|ticket) ]
17 [ --timeout seconds ]
18
20 "--action"
21 Specifies what happens to email sent to this alias. The avaliable
22 basic actions are: "correspond", "comment". Additional actions,
23 such as "take" or "resolve", may be available depending on your
24 local @MailPlugins configuration.
25 You can execute two or more actions on a single message using a "-"
27 separated list. RT will execute the actions in the listed order.
28 For example you can use "take-comment", "correspond-resolve" or
29 "take-comment-resolve" as actions.
30 Note that "take" and "resolve" actions ignore message text if used
32 alone. Include a "comment" or "correspond" action if you want RT
33 to record the incoming message.
34 The default action is "correspond".
36 "--queue"
38 This flag determines which queue this alias should create a ticket
39 in if no ticket identifier is found.
40 "--url"
42 This flag tells the mail gateway where it can find your RT server.
43 You should probably use the same URL that users use to log into RT.
44 If you have a self-signed SSL certificate, you may also need to pass
46 "--ca-file" or "--no-verify-ssl", below.
47 "--ca-file" path
49 Specifies the path to the public SSL certificate for the certificate
50 authority that should be used to verify the website's SSL
51 certificate. If your webserver uses a self-signed certificate, you
52 should preferentially use this option over "--no-verify-ssl", as it
53 will ensure that the self-signed certificate that the mailgate is
54 seeing the right self-signed certificate.
55 "--no-verify-ssl"
57 This flag tells the mail gateway to trust all SSL certificates,
58 regardless of if their hostname matches the certificate, and
59 regardless of CA. This is required if you have a self-signed
60 certificate, or some other certificate which is not traceable back
61 to an certificate your system ultimitely trusts.
62 "--extension" OPTIONAL
64 Some MTAs will route mail sent to user-foo@host or user+foo@host to
65 user@host and present "foo" in the environment variable $EXTENSION.
66 By specifying the value "queue" for this parameter, the queue this
67 message should be submitted to will be set to the value of
68 $EXTENSION. By specifying "ticket", $EXTENSION will be interpreted
69 as the id of the ticket this message is related to. "action" will
70 allow the user to specify either "comment" or "correspond" in the
71 address extension.
72 "--debug" OPTIONAL
74 Print debugging output to standard error
75 "--timeout" OPTIONAL
77 Configure the timeout for posting the message to the web server.
78 The default timeout is 3 minutes (180 seconds).
79
81 The RT mail gateway is the primary mechanism for communicating with RT
82 via email. This program simply directs the email to the RT web server,
83 which handles filing correspondence and sending out any required mail.
84 It is designed to be run as part of the mail delivery process, either
85 called directly by the MTA or "procmail", or in a .forward or
86 equivalent.
87
89 Much of the set up of the mail gateway depends on your MTA and mail
90 routing configuration.
91 You need to route mail to "rt-mailgate" for the queues you're
93 monitoring. For instance, if you're using /etc/aliases and you have a
94 "bugs" queue, you will want something like this:
95 bugs: "|/usr/bin/rt-mailgate --queue bugs --action correspond
97 --url http://rt.mycorp.com/"
98 bugs-comment: "|/usr/bin/rt-mailgate --queue bugs --action comment
100 --url http://rt.mycorp.com/"
101 Note that you don't have to run your RT server on your mail server, as
103 the mail gateway will happily relay to a different machine.
104
106 EXTENSION
107 Some MTAs will route mail sent to user-foo@host or user+foo@host to
108 user@host and present "foo" in the environment variable
109 "EXTENSION". Mailgate adds value of this variable to message in the
110 "X-RT-Mail-Extension" field of the message header.
111 See also "--extension" option. Note that value of the environment
113 variable is always added to the message header when it's not empty
114 even if "--extension" option is not provided.
115perl v5.32.0 2020-07-29 RT-MAILGATE(1)